Skip to content

Commit a059352

Browse files
committed
Fix some typos and wordings
TODO: discuss TODO items Signed-off-by: Dr. Jens Harbott <[email protected]>
1 parent ce20217 commit a059352

File tree

4 files changed

+25
-12
lines changed

4 files changed

+25
-12
lines changed

docs/guides/operations-guide/openstack/tools/flavor-manager.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ It operates as a facilitator that orchestrates compute flavors in alignment
1111
with the standard [SCS-0100: Flavor Naming](https://docs.scs.community/standards/iaas/scs-0100)
1212
by utilizing YAML files provided by the SCS project.
1313

14+
* TODO: Update to describe using `osism manage flavors` instead?
15+
1416
## Installation
1517

1618
The OpenStack Flavor Manager can be used via the OSISM CLI. This is the preferred way to use it.

docs/guides/operations-guide/openstack/tools/image-manager/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ sidebar_position: 50
88
The [OpenStack Image Manager](https://pypi.org/project/openstack-image-manager/) is a tool for managing all
99
images on an OpenStack environment
1010

11+
* TODO: Update to describe using `osism manage images` instead?
12+
1113
## Requirements
1214

1315
This information is only relevant for the operator of an OpenStack environment. You can skip this section if

docs/guides/other-guides/testbed.mdx

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -68,14 +68,14 @@ The OSISM Testbed requires at least the following project quota when using the d
6868

6969
| Quantity | Resource | Note |
7070
|:---------|:---------------------|:----------------------------------------------|
71-
| 4 | Instances | 28 VCPUs + 112 GByte RAM (3 modes, 1 manager) |
71+
| 4 | Instances | 28 VCPUs + 112 GByte RAM (3 nodes, 1 manager) |
7272
| 9 | Volumes | 90 GByte volume storage |
7373
| 1 | Floating IP | |
7474
| 1 | Keypair | |
75-
| 3 | Security group | |
75+
| 3 | Security groups | |
7676
| 16 | Security group rules | |
7777
| 1 | Network | |
78-
| 1 | Subetwork | |
78+
| 1 | Subnet | |
7979
| 6 | Ports | |
8080
| 1 | Router | |
8181

@@ -117,7 +117,7 @@ This section describes step by step how to deploy the OSISM Testbed.
117117
definition in `terraform/clouds.yaml`.
118118

119119
The user specific settings of the `clouds.yaml` file are provided by the cloud provider. Please check the
120-
documentation of the cloud provider you are using or their support for details.
120+
documentation of the cloud provider you are using or their support for details.
121121

122122
[REGIO.cloud](https://regio.digital) is used as an example here. The cloud name in `clouds.yaml`
123123
and the environment name (value of `ENVIRONMENT`) are `regiocloud` in this case. It is important that
@@ -226,7 +226,7 @@ This section describes step by step how to deploy the OSISM Testbed.
226226
make ENVIRONMENT=regiocloud login
227227
```
228228

229-
Yo can log in to the nodes of the cluster via the manager.
229+
You can log in to the nodes of the cluster via the manager.
230230

231231
```bash
232232
osism console testbed-node-0
@@ -461,17 +461,19 @@ The expiration time of the Single Sign On tokens can be controlled on multiple l
461461

462462
#### Usage of the OpenStack CLI
463463

464-
The `environments/openstack` folder contains the needed files for the openstack client:
464+
The `environments/openstack` folder contains the files needed for the `openstack` client:
465465

466466
```bash
467467
cd environments/openstack
468468
export OS_CLOUD=<the cloud environment> # i.e. admin
469469
openstack floating ip list
470470
```
471471

472+
* TODO: fill this with some useful stuff to make the reference below worthwhile
473+
472474
#### OpenStack CLI operations with OpenID Connect password
473475

474-
Using the OpenStack cli is also possible via OIDC, assuming you provisioned the user **alice** with password **password**,
476+
Using the OpenStack CLI is also possible via OIDC, assuming you provisioned the user **alice** with password **password**,
475477
then you can perform a simple `project list` operation like this:
476478

477479
See chapter "Usage the OpenStack CLI" for basic openstack usage.
@@ -494,10 +496,10 @@ project list
494496

495497
#### OpenStack CLI token issue with OpenID Connect
496498

497-
It is also possible to exchange your username/password to a token, for further use with the cli.
499+
It is also possible to exchange your username/password to a token, for further use with the CLI.
498500
The `token issue` subcommand returns an SQL table, in which the `id` column's `value` field contains the token:
499501

500-
See chapter "Usage the OpenStack CLI" for basic openstack usage.
502+
See chapter "Usage of the OpenStack CLI" for basic openstack usage.
501503

502504
```bash
503505
openstack \
@@ -541,7 +543,7 @@ OpenStack dashboard via the public IP address of the manager, the following chan
541543
of the other cloud is changed accordingly.
542544

543545
1. Add the customisation `external_api`. This customisation makes sure that the required security group rules
544-
are created for the various OpenStack APIs and the OpenStack dashboard.
546+
are created to allow access to the various OpenStack APIs and the OpenStack dashboard.
545547

546548
```
547549
# customisation:external_api
@@ -766,7 +768,7 @@ export LC_ALL=en_US.UTF-8
766768
To find out the locale used on the system `printenv` can be used.
767769
768770
```bash
769-
$ printenv | grep -i lang|locale
771+
$ printenv | egrep -i 'lang|lc_'
770772
LANG="en_US.UTF-8"
771773
LC_COLLATE="en_US.UTF-8"
772774
LC_CTYPE="UTF-8"
@@ -787,6 +789,8 @@ This section describes how to configure and customise the OSISM Testbed.
787789
788790
The defaults for the OpenTofu variables are intended for [REGIO.cloud](https://regio.digital).
789791
792+
* TODO: Ubuntu 24.04 supported? default?
793+
790794
| Variable | Default | Note |
791795
|:--------------------------|:-------------------------|:-----------------------------------------|
792796
| availability_zone | `nova` | |
@@ -853,19 +857,22 @@ The following stable Ceph and OpenStack releases are supported.
853857
854858
The deployment of Ceph is based on [ceph-ansible](https://docs.ceph.com/ceph-ansible/).
855859
860+
* TODO: check current default
856861
* Ceph Quincy (**default**)
857862
* Ceph Reef
858863
* Ceph Squid
859864
860865
The deployment of OpenStack is based on [kolla-ansible](https://docs.openstack.org/kolla-ansible/latest/).
861866
862-
* OpenStack 2023.1
863867
* OpenStack 2023.2
864868
* OpenStack 2024.1 (**default**)
869+
* OpenStack 2024.2
870+
* TODO: check current default
865871
866872
The deployment of Kubernetes is based on [k3s-ansible](https://github.com/techno-tim/k3s-ansible).
867873
868874
* Kubernetes v1.30 (**default**)
875+
* TODO: check current default
869876
870877
### Included services
871878

docs/release-notes/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ The old release notes (before OSISM 7) can be found on the archived page
1414

1515
**The latest available release of OSISM is `8.0.2`.**
1616

17+
* TODO: Osism 7 is EOL? Discuss date format
18+
1719
| Series | Status | Initial Release Date | Next Phase | EOL Date |
1820
|:---------------------|:---------------------|:---------------------|:---------------------|:-----------------|
1921
| [OSISM 8](./osism-8) | Maintained | 11. September 2024 | Maintained | |

0 commit comments

Comments
 (0)