Skip to content

Commit d8ecbc8

Browse files
committed
Add docs for ci-tenks environment
1 parent 4093de1 commit d8ecbc8

File tree

3 files changed

+113
-0
lines changed

3 files changed

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