Skip to content

Commit 0511f0d

Browse files
committed
Add docs for ci-tenks environment
1 parent 5de84b9 commit 0511f0d

File tree

3 files changed

+112
-0
lines changed

3 files changed

+112
-0
lines changed
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
==========
2+
ci-tenks
3+
==========
4+
5+
The ``ci-tenks`` Kayobe environment is used to test seed services.
6+
It is currently a work in progress.
7+
8+
The environment is deployed using `automated-deployment.sh`. It bootstraps
9+
localhost as a hypervisor for a seed and one controller instance. The seed
10+
provisions the controller with Bifrost.
11+
12+
It currently tests:
13+
14+
* Seed hypervisor host configuration
15+
* Seed VM provisioning
16+
* Seed host configuration
17+
* Pulp deployment
18+
* Pulp container syncing (one container - Bifrost)
19+
* Bifrost overcloud provisioning
20+
21+
In the future it could test:
22+
23+
* Pulp package syncing
24+
* Overcloud host configuration, pulling packages from a local Pulp
25+
* Upgrades (Host OS and OpenStack)
26+
* Multi-node OpenStack deployments
27+
28+
* Multiple controllers
29+
* Multiple compute nodes (and live migration)
30+
* Multiple storage nodes (Ceph)
31+
32+
These extensions depend on more SMS hypervisor capacity and improved sync times
33+
for the local Pulp instance.
34+
35+
Prerequisites
36+
=============
37+
38+
* A Rocky Linux 9 or Ubuntu Noble 24.04 host
39+
* 16GB of memory
40+
* 4 cores
41+
* No LVM
42+
43+
Setup
44+
=====
45+
46+
The environment is designed to run in CI, however can also be deployed
47+
manually.
48+
49+
Access the host via SSH. You may wish to start a ``tmux`` session.
50+
51+
Download the setup script:
52+
53+
.. parsed-literal::
54+
55+
curl -LO https://raw.githubusercontent.com/stackhpc/stackhpc-kayobe-config/stackhpc/2025.1/etc/kayobe/environments/ci-tenks/automated-deployment.sh
56+
57+
Change the permissions on the script:
58+
59+
.. parsed-literal::
60+
61+
sudo chmod +x automated-deployment.sh
62+
63+
Acquire the Ansible Vault password for this repository, and store a
64+
copy at ``~/vault-pw``.
65+
66+
.. note::
67+
68+
The vault password is currently the same as for the ``ci-aio``
69+
environment.
70+
71+
Run the setup script:
72+
73+
.. parsed-literal::
74+
75+
./automated-deployment.sh

doc/source/contributor/environments/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,5 @@ The following Kayobe environments are provided with this configuration:
99
ci-aio
1010
ci-builder
1111
ci-multinode
12+
ci-tenks
1213
aufn-ceph
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# CI-Tenks Kayobe Environment
2+
3+
This Kayobe environment is designed for use in CI, primarily to test Seed
4+
service deployment and Bifrost provisioning. It is currently a work in
5+
progress.
6+
7+
The environment is deployed using the `automated-deployment.sh` script. This
8+
script bootstraps the localhost as a hypervisor for a Seed and one Controller
9+
instance. The Seed provisions the Controller using Bifrost.
10+
11+
### Current Tests
12+
13+
The environment currently tests the following:
14+
15+
* Seed Hypervisor host configuration
16+
* Seed VM provisioning
17+
* Seed host configuration
18+
* Pulp deployment
19+
* Pulp container syncing (one container - Bifrost)
20+
* Bifrost Overcloud provisioning
21+
22+
### Future Enhancements
23+
24+
Potential future tests include:
25+
26+
* Pulp package syncing
27+
* Overcloud host configuration, pulling packages from a local Pulp instance
28+
* Full openstack service deployment (AIO or otherwise)
29+
* Upgrades (Host OS and OpenStack)
30+
* Multi-node OpenStack deployments:
31+
* Multiple Controllers
32+
* Multiple Compute nodes (including live migration)
33+
* Multiple Storage nodes (e.g., Ceph)
34+
35+
These enhancements depend on increased SMS hypervisor capacity and improved
36+
synchronization times for the local Pulp instance.

0 commit comments

Comments
 (0)