Skip to content

Commit d1bae63

Browse files
voidedmainvoidedmain
committed
Refactoring of Testbed doc
Signed-off-by: voidedmain <[email protected]>
1 parent 5fea52c commit d1bae63

File tree

7 files changed

+875
-845
lines changed

7 files changed

+875
-845
lines changed

‎docs/testbed.mdx

-845
This file was deleted.

‎docs/testbed/appendix.mdx

+164
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
---
2+
sidebar_label: Appendix
3+
sidebar_position: 5
4+
---
5+
6+
# Appendix
7+
8+
## Configuration
9+
10+
This section describes how to configure and customise the OSISM Testbed.
11+
12+
### Variables
13+
14+
The defaults for the OpenTofu variables are intended for [REGIO.cloud](https://regio.digital).
15+
16+
| Variable | Default | Note |
17+
|:--------------------------|:-------------------------|:-----------------------------------------|
18+
| availability_zone | `nova` | |
19+
| ceph_version | `quincy` | |
20+
| cloud_provider | `regiocloud` | |
21+
| configuration_version | `main` | |
22+
| deploy_monitoring | `false` | |
23+
| dns_nameservers | `["8.8.8.8", "9.9.9.9"]` | |
24+
| enable_config_drive | `true` | |
25+
| external_api | `false` | |
26+
| flavor_manager | `SCS-4V-16-50` | |
27+
| flavor_node | `SCS-8V-32-50` | |
28+
| image | `Ubuntu 22.04` | Only Ubuntu 22.04 is currently supported |
29+
| image_node | `Ubuntu 22.04` | Only Ubuntu 22.04 is currently supported |
30+
| keypair | `testbed` | |
31+
| manager_version | `latest` | |
32+
| network_availability_zone | `nova` | |
33+
| number_of_nodes | `3` | |
34+
| number_of_volumes | `3` | |
35+
| openstack_version | `2023.2` | |
36+
| prefix | `testbed` | |
37+
| public | `external` | |
38+
| refstack | `false` | |
39+
| volume_availability_zone | `nova` | |
40+
| volume_size_base | `30` | |
41+
| volume_size_storage | `10` | |
42+
| volume_type | `__DEFAULT__` | |
43+
44+
### Overrides
45+
46+
| Name | Description |
47+
|:-------------------------------------------|:-----------------|
48+
| `manager_boot_from_image` | |
49+
| `manager_boot_from_volume` | |
50+
| `neutron_availability_zone_hints_network` | |
51+
| `neutron_availability_zone_hints_router` | |
52+
| `neutron_router_enable_snat` | |
53+
| `nodes_boot_from_image` | |
54+
| `nodes_boot_from_volume` | |
55+
| `nodes_use_ephemeral_storage` | |
56+
57+
### Customisations
58+
59+
| Name | Description |
60+
|:----------------------|:-----------------|
61+
| `access_floatingip` | |
62+
| `access_ipv4` | |
63+
| `access_ipv6` | |
64+
| `default` | |
65+
| `external_api` | |
66+
| `neutron_floatingip` | |
67+
68+
69+
## Notes
70+
71+
* The configuration is intentionally kept quite static. Please create no PRs to make the configuration more flexible/dynamic.
72+
* The OSISM documentation uses hostnames, examples, addresses etc. from OSISM Testbed.
73+
* The third volume (`/dev/sdd`) is not enabled for Ceph by default. This is to test the scaling of Ceph.
74+
* The manager is used as pull through cache for Docker images and Ubuntu packages. This reduces the amount of traffic consumed.
75+
76+
## Supported releases
77+
78+
The following stable Ceph and OpenStack releases are supported.
79+
80+
The deployment of Ceph is based on [ceph-ansible](https://docs.ceph.com/ceph-ansible/).
81+
82+
* Ceph Quincy (**default**)
83+
* Ceph Reef
84+
* Ceph Squid
85+
86+
The deployment of OpenStack is based on [kolla-ansible](https://docs.openstack.org/kolla-ansible/latest/).
87+
88+
* OpenStack 2023.1
89+
* OpenStack 2023.2
90+
* OpenStack 2024.1 (**default**)
91+
92+
The deployment of Kubernetes is based on [k3s-ansible](https://github.com/techno-tim/k3s-ansible).
93+
94+
* Kubernetes v1.30 (**default**)
95+
96+
## Included services
97+
98+
The following services can currently be used with the OSISM Testbed without further adjustments.
99+
100+
### Infrastructure
101+
102+
* Ceph
103+
* Cluster API Management Cluster
104+
* Fluentd
105+
* Gnocchi
106+
* Grafana
107+
* Haproxy
108+
* Keepalived
109+
* Kubernetes
110+
* Mariadb
111+
* Memcached
112+
* Netbox
113+
* Netdata
114+
* Opensearch
115+
* Openvswitch
116+
* Prometheus exporters
117+
* Rabbitmq
118+
* Redis
119+
120+
### OpenStack
121+
122+
* Barbican
123+
* Ceilometer
124+
* Cinder
125+
* Designate
126+
* Glance
127+
* Horizon
128+
* Ironic
129+
* Keystone
130+
* Magnum
131+
* Manila
132+
* Neutron
133+
* Nova (with Libvirt/KVM)
134+
* Octavia
135+
* Skyline
136+
137+
## Makefile reference
138+
139+
```bash
140+
$ make help
141+
142+
Usage:
143+
make <target>
144+
help Display this help.
145+
clean Destroy infrastructure with OpenTofu.
146+
wipe-local-install Wipe the software dependencies in `venv`.
147+
create Create required infrastructure with OpenTofu.
148+
login Log in on the manager.
149+
vpn-wireguard Establish a wireguard vpn tunnel.
150+
vpn-sshuttle Establish a sshuttle vpn tunnel.
151+
bootstrap Bootstrap everything.
152+
manager Deploy only the manager service.
153+
identity Deploy only identity services.
154+
ceph Deploy only ceph services.
155+
deploy Deploy everything and then check it.
156+
prepare Run local preperations.
157+
deps Install software preconditions to `venv`.
158+
159+
$ make <TAB> <TAB>
160+
```
161+
162+
## CI jobs
163+
164+
You can inspect the [results of the daily zuul jobs](https://zuul.services.betacloud.xyz/t/osism/builds?project=osism%2Ftestbed&skip=0).

0 commit comments

Comments
 (0)