Remove unnecessary curly brackets

Author: seunghun1ee

doc/source/configuration/ci-cd.rst

@@ -57,26 +57,26 @@ Runner Deployment
     Ideally an Infra VM could be used here or failing that the control host.
     Wherever it is deployed the host will need access to the :code:`admin_network`, :code:`public_network` and the :code:`pulp registry` on the seed.
 
-2. Edit the environment's :code:`${KAYOBE_CONFIG_PATH}/environments/${KAYOBE_ENVIRONMENT}/inventory/groups` to add the predefined :code:`github-runners` group to :code:`infra-vms`
+2. Edit the environment's :code:`$KAYOBE_CONFIG_PATH/environments/$KAYOBE_ENVIRONMENT/inventory/groups` to add the predefined :code:`github-runners` group to :code:`infra-vms`
 
 .. code-block:: ini
 
     [infra-vms:children]
     github-runners
 
-3. Edit the environment's :code:`${KAYOBE_CONFIG_PATH}/environments/${KAYOBE_ENVIRONMENT}/inventory/hosts` to define the host(s) that will host the runners.
+3. Edit the environment's :code:`$KAYOBE_CONFIG_PATH/environments/$KAYOBE_ENVIRONMENT/inventory/hosts` to define the host(s) that will host the runners.
 
 .. code-block:: ini
 
     [github-runners]
     prod-runner-01
 
-4. Provide all the relevant Kayobe :code:`group_vars` for :code:`github-runners` under :code:`${KAYOBE_CONFIG_PATH}/environments/${KAYOBE_ENVIRONMENT}/inventory/group_vars/github-runners`
+4. Provide all the relevant Kayobe :code:`group_vars` for :code:`github-runners` under :code:`$KAYOBE_CONFIG_PATH/environments/$KAYOBE_ENVIRONMENT/inventory/group_vars/github-runners`
     * `infra-vms` ensuring all required `infra_vm_extra_network_interfaces` are defined
     * `network-interfaces`
     * `python-interpreter.yml` ensuring that `ansible_python_interpreter: /usr/bin/python3` has been set
 
-5. Edit the ``${KAYOBE_CONFIG_PATH}/inventory/group_vars/github-runners/runners.yml`` file which will contain the variables required to deploy a series of runners.
+5. Edit the ``$KAYOBE_CONFIG_PATH/inventory/group_vars/github-runners/runners.yml`` file which will contain the variables required to deploy a series of runners.
    Below is a core set of variables that will require consideration and modification for successful deployment of the runners.
    The number of runners deployed can be configured by removing and extending the dict :code:`github-runners`.
    As for how many runners present three is suitable number as this would prevent situations where long running jobs could halt progress other tasks whilst waiting for a free runner.
@@ -120,7 +120,7 @@ Runner Deployment
 
 7. If the host is an actual Infra VM then please refer to upstream `Infrastructure VMs <https://docs.openstack.org/kayobe/latest/configuration/reference/infra-vms.html>`__ documentation for additional configuration and steps.
 
-8. Run :code:`kayobe playbook run ${KAYOBE_CONFIG_PATH}/ansible/deploy-github-runner.yml`
+8. Run :code:`kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/deploy-github-runner.yml`
 
 9. Check runners have registered properly by visiting the repository's :code:`Action` tab -> :code:`Runners` -> :code:`Self-hosted runners`
 
@@ -130,9 +130,9 @@ Runner Deployment
 Workflow Deployment
 -------------------
 
-1. Edit :code:`${KAYOBE_CONFIG_PATH}/inventory/group_vars/github-writer/writer.yml` in the base configuration making the appropriate changes to your deployments specific needs. See documentation for `stackhpc.kayobe_workflows.github <https://github.com/stackhpc/ansible-collection-kayobe-workflows/tree/main/roles/github>`__.
+1. Edit :code:`$KAYOBE_CONFIG_PATH/inventory/group_vars/github-writer/writer.yml` in the base configuration making the appropriate changes to your deployments specific needs. See documentation for `stackhpc.kayobe_workflows.github <https://github.com/stackhpc/ansible-collection-kayobe-workflows/tree/main/roles/github>`__.
 
-2. Run :code:`kayobe playbook run ${KAYOBE_CONFIG_PATH}/ansible/write-github-workflows.yml`
+2. Run :code:`kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/write-github-workflows.yml`
 
 3. Add all required secrets and variables to repository either via the GitHub UI or GitHub CLI (may require repository owner)
 

doc/source/configuration/lvm.rst

@@ -93,6 +93,6 @@ hosts:
 
 .. code-block:: console
 
-   mkdir -p ${KAYOBE_CONFIG_PATH}/hooks/overcloud-host-configure/pre.d
-   cd ${KAYOBE_CONFIG_PATH}/hooks/overcloud-host-configure/pre.d
+   mkdir -p $KAYOBE_CONFIG_PATH/hooks/overcloud-host-configure/pre.d
+   cd $KAYOBE_CONFIG_PATH/hooks/overcloud-host-configure/pre.d
    ln -s ../../../ansible/growroot.yml 30-growroot.yml

doc/source/configuration/swap.rst

@@ -23,6 +23,6 @@ hosts:
 
 .. code-block:: console
 
-   mkdir -p ${KAYOBE_CONFIG_PATH}/hooks/overcloud-host-configure/post.d
-   cd ${KAYOBE_CONFIG_PATH}/hooks/overcloud-host-configure/post.d
+   mkdir -p $KAYOBE_CONFIG_PATH/hooks/overcloud-host-configure/post.d
+   cd $KAYOBE_CONFIG_PATH/hooks/overcloud-host-configure/post.d
    ln -s ../../../ansible/swap.yml 10-swap.yml

doc/source/contributor/pre-commit.rst

@@ -29,12 +29,12 @@ Once done you should find `pre-commit` is available within the `kayobe` virtuale
 
 To run the playbook using the following command
 
-- ``kayobe playbook run ${KAYOBE_CONFIG_PATH}/ansible/install-pre-commit-hooks.yml``
+- ``kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/install-pre-commit-hooks.yml``
 
 Whereas to run the playbook when control host bootstrap runs ensure it registered as symlink using the following command
 
-- ``mkdir -p ${KAYOBE_CONFIG_PATH}/hooks/control-host-bootstrap/post.d``
-- ``ln -s ${KAYOBE_CONFIG_PATH}/ansible/install-pre-commit-hooks.yml ${KAYOBE_CONFIG_PATH}/hooks/control-host-bootstrap/post.d/install-pre-commit-hooks.yml``
+- ``mkdir -p $KAYOBE_CONFIG_PATH/hooks/control-host-bootstrap/post.d``
+- ``ln -s $KAYOBE_CONFIG_PATH/ansible/install-pre-commit-hooks.yml $KAYOBE_CONFIG_PATH/hooks/control-host-bootstrap/post.d/install-pre-commit-hooks.yml``
 
 All that remains is the installation of the hooks themselves which can be accomplished either by
 running `pre-commit run` or using `git commit` when you have changes that need to be committed.

doc/source/operations/bifrost-hardware-inventory-management.rst

@@ -26,7 +26,7 @@ configured to network boot on the provisioning network, the following commands
 will instruct them to PXE boot. The nodes will boot on the Ironic Python Agent
 kernel and ramdisk, which is configured to extract hardware information and
 send it to Bifrost. Note that IPMI credentials can be found in the encrypted
-file located at ``${KAYOBE_CONFIG_PATH}/secrets.yml``.
+file located at ``$KAYOBE_CONFIG_PATH/secrets.yml``.
 
 .. code-block:: console
 
@@ -56,8 +56,8 @@ in Bifrost:
    | da0c61af-b411-41b9-8909-df2509f2059b | example-hypervisor-01 | None          | power off   | enroll             | False       |
    +--------------------------------------+-----------------------+---------------+-------------+--------------------+-------------+
 
-After editing ``${KAYOBE_CONFIG_PATH}/overcloud.yml`` (or
-``${KAYOBE_CONFIG_PATH}/environments/${KAYOBE_ENVIRONMENT}/overcloud.yml``
+After editing ``$KAYOBE_CONFIG_PATH/overcloud.yml`` (or
+``$KAYOBE_CONFIG_PATH/environments/$KAYOBE_ENVIRONMENT/overcloud.yml``
 if Kayobe environment is used) to add these new hosts to
 the correct groups, import them in Kayobe's inventory with:
 
@@ -201,7 +201,7 @@ To build ipa image with extra-hardware  you need to edit ``ipa.yml`` and add thi
    - "extra-hardware"
 
 Extract introspection data from Bifrost with Kayobe. JSON files will be created
-into ``${KAYOBE_CONFIG_PATH}/overcloud-introspection-data``:
+into ``$KAYOBE_CONFIG_PATH/overcloud-introspection-data``:
 
 .. code-block:: console
 
@@ -210,7 +210,7 @@ into ``${KAYOBE_CONFIG_PATH}/overcloud-introspection-data``:
 Using ADVise
 ------------
 
-The Ansible playbook ``advise-run.yml`` can be found at ``${KAYOBE_CONFIG_PATH}/ansible/advise-run.yml``.
+The Ansible playbook ``advise-run.yml`` can be found at ``$KAYOBE_CONFIG_PATH/ansible/advise-run.yml``.
 
 The playbook will:
 
@@ -220,8 +220,8 @@ The playbook will:
 
 .. code-block:: console
 
-   cd ${KAYOBE_CONFIG_PATH}
-   ansible-playbook ${KAYOBE_CONFIG_PATH}/ansible/advise-run.yml
+   cd $KAYOBE_CONFIG_PATH
+   ansible-playbook $KAYOBE_CONFIG_PATH/ansible/advise-run.yml
 
 The playbook has the following optional parameters:
 

doc/source/operations/hotfix-playbook.rst

@@ -20,7 +20,7 @@ The playbook can be invoked with:
 
 .. code-block:: console
 
-  kayobe playbook run ${KAYOBE_CONFIG_PATH}/ansible/hotfix-containers.yml
+  kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/hotfix-containers.yml
 
 Playbook variables:
 -------------------
@@ -49,7 +49,7 @@ to a file, then add them as an extra var. e.g:
 
 .. code-block:: console
 
-  kayobe playbook run ${KAYOBE_CONFIG_PATH}/ansible/hotfix-containers.yml -e "@~/vars.yml"
+  kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/hotfix-containers.yml -e "@~/vars.yml"
 
 
 Example Variables file

doc/source/operations/octavia.rst

@@ -12,7 +12,7 @@ With your kayobe environment activated, you can build a new amphora image with:
 
 .. code-block:: console
 
-  kayobe playbook run ${KAYOBE_CONFIG_PATH}/ansible/octavia-amphora-image-build.yml
+  kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/octavia-amphora-image-build.yml
 
 The resultant image is based on Ubuntu. By default the image will be built on the
 seed, but it is possible to change the group in the ansible inventory using the
@@ -29,7 +29,7 @@ You can then run the playbook to upload the image:
 
 .. code-block:: console
 
-  kayobe playbook run ${KAYOBE_CONFIG_PATH}/ansible/octavia-amphora-image-register.yml
+  kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/octavia-amphora-image-register.yml
 
 This will rename the old image by adding a timestamp suffix, before uploading a
 new image with the name, ``amphora-x64-haproxy``. Octavia should be configured

doc/source/operations/openstack-reconfiguration.rst

@@ -10,7 +10,7 @@ service is handled less well, because of Ansible's imperative style.
 
 To remove a service, it is disabled in Kayobe's Kolla config, which prevents
 other services from communicating with it. For example, to disable
-``cinder-backup``, edit ``${KAYOBE_CONFIG_PATH}/kolla.yml``:
+``cinder-backup``, edit ``$KAYOBE_CONFIG_PATH/kolla.yml``:
 
 .. code-block:: diff
 
@@ -50,7 +50,7 @@ Use a command of this form:
 
 .. code-block:: console
 
-   kayobe# ansible-vault edit ${KAYOBE_CONFIG_PATH}/secrets.yml --vault-password-file=<Vault password file path>
+   kayobe# ansible-vault edit $KAYOBE_CONFIG_PATH/secrets.yml --vault-password-file=<Vault password file path>
 
 Concatenate the contents of the certificate and key files to create
 ``secrets_kolla_external_tls_cert``.  The certificates should be installed in
@@ -60,7 +60,7 @@ this order:
 * Any intermediate certificates
 * The TLS certificate private key
 
-In ``${KAYOBE_CONFIG_PATH}/kolla.yml``, set the following:
+In ``$KAYOBE_CONFIG_PATH/kolla.yml``, set the following:
 
 .. code-block:: yaml