Skip to content

Commit c3298e2

Browse files
committed
feat: high level overview of CI/CD
1 parent 839844e commit c3298e2

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

doc/source/configuration/ci-cd.rst

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,23 @@
22
CI/CD
33
=====
44

5-
What is Kayobe Automation
6-
=========================
5+
Concepts
6+
========
7+
8+
The CI/CD system developed for managing Kayobe based OpenStack clouds is composed of three main components; workflows, runners and kayobe automation.
9+
Firstly, the workflows are files which describe a series of tasks to be performed in relation to the deployed cloud.
10+
These workflows are executed on request, on schedule or in response to an event such as a pull request being opened.
11+
The workflows are designed to carry out various day-to-day activites such as; running Tempest tests, configuring running services or displaying the change to configuration files if a pull request is merged.
12+
Secondly, in order for the workflows to run against a cloud we would need private runners present within the cloud positioned in such a way they can reach the internal network and public API.
13+
Deployment of private runners is supported by all major providers with the use of community developed Ansible roles.
14+
Finally, due to the requirement that we support various different platforms tooling in the form of `Kayobe automation <https://github.com/stackhpc/kayobe-automation/>`__ was developed.
15+
This tooling is not tied to any single CI/CD platform as all tasks are a series of shell script and Ansible playbooks which are designed to run in a purpose build kayobe container.
16+
This is complemented by the use of an Ansible collection known as `stackhpc.kayobe_workflows <https://github.com/stackhpc/ansible-collection-kayobe-workflows/>`__ which aims to provide users with a quick and easy way of customising all workflows to fit within a customer's cloud.
17+
18+
Currently we support the creation and deployment of workflows for GitHub with Gitlab support being actively worked upon.
19+
20+
Kayobe Automation
21+
-----------------
722

823
`Kayobe automation <https://github.com/stackhpc/kayobe-automation/>`__ is a collection of scripts and tools that automate kayobe operations.
924
It is deployed and controlled by CI/CD platforms such as GitHub actions and GitLab pipelines.

0 commit comments

Comments
 (0)