diff --git a/docs/guides/operations-guide/openstack/day2-operations/flavor-manager.md b/docs/guides/operations-guide/openstack/day2-operations/flavor-manager.md index 164cab8479..eb89fd8153 100644 --- a/docs/guides/operations-guide/openstack/day2-operations/flavor-manager.md +++ b/docs/guides/operations-guide/openstack/day2-operations/flavor-manager.md @@ -6,31 +6,37 @@ sidebar_position: 51 ## Overview -The OpenStack Flavor Manager manages the creation, modification, and removal of flavors within an OpenStack environment. -The OpenStack Flavor Manager operates as a facilitator that orchestrates compute flavors in alignment +The OpenStack Flavor Manager manages the creation, modification, and removal of flavors. +It operates as a facilitator that orchestrates compute flavors in alignment with the standard [SCS-0100: Flavor Naming](https://docs.scs.community/standards/iaas/scs-0100) by utilizing YAML files provided by the SCS project. ## Installation -Install the `openstack-flavor-manager` package with pip. +The OpenStack Flavor Manager can be used via the OSISM CLI. This is the preferred way to use it. +No installation is then required. It is used via `osism manage flavors`. + +For use independent of OSISM install the `openstack-flavor-manager` package with pip. It is likely +that additional dependencies such as `pkg-config` or `libssl-dev` must be installed in advance. ```bash -pip install openstack-flavor-manager +$ pip install openstack-flavor-manager ``` Or clone the repository [osism/openstack-flavor-manager](https://github.com/osism/openstack-flavor-manager) and use the OpenStack Flavor Manager from source with tox. - ```bash -tox -- --help +$ tox -- --help ``` ## Usage There must be a `clouds.yml` and a `secure.yml` file in the directory where the OpenStack Flavor Manager -will be executed. The cloud profile to be used can be specified via the optional `--cloud` parameter. +will be executed. When using the OSISM CLI, the files are expected in `environments/openstack` +in your configuration repository. + +The cloud profile to be used can be specified via the optional `--cloud` parameter. By default the cloud profile with the name `admin` is used. It must be possible to create and delete flavors with the used cloud credentials. @@ -48,7 +54,8 @@ $ openstack-flavor-manager --help ╰──────────────────────────────────────────────────────────────────────────────────────────────╯ ``` -To create the mandatory flavors by the SCS Flavor Naming Standard, you run: +To create the mandatory flavors by the [SCS-0100: Flavor Naming](https://docs.scs.community/standards/iaas/scs-0100) +standard, you run: ```bash $ openstack-flavor-manager @@ -63,10 +70,10 @@ $ openstack-flavor-manager --recommended The output should look like this: ``` -2023-09-20 13:03:14 | INFO | Flavor 'SCS-1V-4' created. -2023-09-20 13:03:14 | INFO | Flavor 'SCS-2V-8' created. -2023-09-20 13:03:14 | INFO | Flavor 'SCS-4V-16' created. -2023-09-20 13:03:14 | INFO | Flavor 'SCS-8V-32' created. +2023-09-20 13:03:14 | INFO | Flavor SCS-1V-4 created +2023-09-20 13:03:14 | INFO | Flavor SCS-2V-8 created +2023-09-20 13:03:14 | INFO | Flavor SCS-4V-16 created +2023-09-20 13:03:14 | INFO | Flavor SCS-8V-32 created ... ``` @@ -74,20 +81,20 @@ All recommended flavors are now be available in your OpenStack environment. Check yourself by running: ```bash -openstack --os-cloud admin flavor list +$ openstack --os-cloud admin flavor list ``` - ## Definitions There are two flavor definitions available by default. One for [SCS](https://raw.githubusercontent.com/SovereignCloudStack/standards/main/Tests/iaas/SCS-Spec.MandatoryFlavors.verbose.yaml) and one for [OSISM](https://raw.githubusercontent.com/osism/openstack-flavor-manager/main/flavors.yaml). -Each definition has its own set of mandatory and recommended flavors. +Each definition has its own set of mandatory and recommended flavors. The definition of OSISM contains +all definitions of SCS as well as some others. To run the OpenStack Flavor Manager with a specific definition, either `scs` or `osism`, -use the optional `--name` parameter. By default the [SCS Flavor Naming Standard](https://docs.scs.community/standards/scs-0100-v3-flavor-naming) -definition will be used. +use the optional `--name` parameter. By default the [SCS-0100: Flavor Naming](https://docs.scs.community/standards/iaas/scs-0100) +standard definition will be used. ``` $ openstack-flavor-manager --name osism