Skip to content

Add some basic info about CI/CD #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
technowhizz wants to merge 2 commits into
base: acrc
Choose a base branch
from
Open

Add some basic info about CI/CD #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
340d8c5
Fix duplication issue
technowhizz Sep 14, 2023
fe7f93b
Add basic info about CI/CD
technowhizz Sep 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions source/ci_cd_workflows.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
.. include:: vars.rst

===============================
CI/CD Workflows and Runners
===============================

CI/CD Runners
=============
There are |num_ci_runners| CI/CD runners and they are running as systemd jobs
on |control_host|.

CI/CD Workflows
================
The workflows are located in the `.github` folder of the kayobe config. They
can be run by going to the actions section of |kayobe_config_source_url|. Each
workflow has it's own configuration opetions and depending on the workflow you
choose you may be able to add limits to the command you are going to run.

For example, if you were to run the `Run Overcloud Service Deploy` workflow you
are given the option to limit the hosts that this command runs on and to limit
the services that are deployed. This is useful for making changes to the kayobe
config and limiting them to a single node to ensure everything is working as
expected.

Additonally, on every PR to the kayobe config repo, the `Config Diff` workflow
is run. This workflow will run a diff between the current kayobe config and the
proposed changes. This is useful for ensuring that the changes you are making
are what you expect them to be.
1 change: 1 addition & 0 deletions source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Contents
gpus_in_openstack
baremetal_management
rally_and_tempest
ci_cd_workflows

Indices and search
==================
Expand Down
2 changes: 1 addition & 1 deletion source/vars.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
.. |grafana_url| replace:: https://api.dl.acrc.bris.ac.uk:3000
.. |grafana_username| replace:: ``grafana_local_admin``
.. |horizon_access| replace:: via the university network (e.g. through the jump host)
.. |horizon_access| replace:: via the university network (e.g. through the jump host)
.. |horizon_theme_clone_url| replace:: <No custom theme in use>
.. |horizon_theme_name| replace:: Default
.. |horizon_url| replace:: https://api.dl.acrc.bris.ac.uk
Expand All @@ -30,6 +29,7 @@
.. |kolla_passwords| replace:: https://github.com/ACRC/dl-kayobe-config/blob/bristol/yoga/etc/kayobe/kolla/passwords.yml
.. |monitoring_host| replace:: ``controller1``
.. |network_name| replace:: demo-vxlan
.. |num_ci_runners| replace:: 3
.. |nova_rbd_pool| replace:: vms
.. |project_config_source_url| replace:: https://github.com/ACRC/openstack-config.git
.. |project_config| replace:: openstack-config
Expand Down