diff --git a/source/ci_cd_workflows.rst b/source/ci_cd_workflows.rst new file mode 100644 index 0000000..f482773 --- /dev/null +++ b/source/ci_cd_workflows.rst @@ -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. diff --git a/source/index.rst b/source/index.rst index f36690c..3c95c3e 100644 --- a/source/index.rst +++ b/source/index.rst @@ -30,6 +30,7 @@ Contents gpus_in_openstack baremetal_management rally_and_tempest + ci_cd_workflows Indices and search ================== diff --git a/source/vars.rst b/source/vars.rst index 19e7459..938e10e 100644 --- a/source/vars.rst +++ b/source/vars.rst @@ -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:: .. |horizon_theme_name| replace:: Default .. |horizon_url| replace:: https://api.dl.acrc.bris.ac.uk @@ -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