starlingx/docs
Code Issues Proposed changes

Armada Deprecation and Replacement

Browse Source 
First pass - generic updates only. (command input/output to be done)
Address patchset 1 review comments.
Replace examples using openstack with metrics server
Remove DS app from application-list output
Additional migration to FluxCD (snmp, auditd)
Minor textual change.
Fix merge conflict.
Revert install r5 change.

Story: 2009138
Task: 45238

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ia40ff45f12ec7b7ffa859e0d8bb5535303870d83
This commit is contained in:
Ron Stone 2022-05-30 14:49:14 -04:00
parent 0c9f834149
commit cf66f5d279
25 changed files with 383 additions and 401 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/_includes/common-openstack-labels.rest
View File

@ -1,19 +1,19 @@
.. table:: Table 1. Common OpenStack Labels
:widths: auto
+-----------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Label | Worker/Controller | Description |
+=============================+===========================+=======================================================================================================================================================================+
+=============================+===========================+==========================================================================================================================================================================================+
| **openstack-control-plane** | - Controller | Identifies a node to deploy openstack controller services on. |
| | | |
| | - All-in-One Controller | |
+-----------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **openstack-compute-node** | Worker | Identifies a node to deploy openstack compute agents on. |
| | | |
| | | .. note:: |
| | | Adding or removing this label, or removing a node with this label from a cluster, triggers the regeneration and application of the helm chart override by Armada. |
+-----------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | Adding or removing this label, or removing a node with this label from a cluster, triggers the regeneration and application of the helm chart override of the OpenStack application. |
+-----------------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **sriov** | - Worker | Identifies a node as supporting sr-iov. |
| | | |
| | - All-in-One Controller | |
+-----------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------+---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

2
doc/source/_includes/enhanced-rbac-policies.rest
View File

@ -4,7 +4,7 @@
.. r1_begin
#. Download the openstack-armada repo from |prod| in opendev
(`StarlingX OpenStack Armada App
(`StarlingX OpenStack FluxCD App
<https://opendev.org/starlingx/openstack-armada-app/src/branch/master>`__)
to a remote workstation.

89
doc/source/admintasks/kubernetes/admin-application-commands-and-helm-overrides.rst
View File

@ -33,15 +33,16 @@ commands to manage containerized applications provided as part of |prod|.
~(keystone_admin)]$ system application-list --nowrap
+--------------+---------+---------------+----------------+----------+-----------+
+--------------------------+---------+-------------------------------------------+------------------+----------+-----------+
| application | version | manifest name | manifest file | status | progress |
+--------------+---------+---------------+----------------+----------+-----------+
| platform- | 1.0-7 | platform- | manifest.yaml | applied | completed |
| integ-apps | | integration- | | | |
| | | manifest | | | |
| |prefix|-|s| | 1.0-18 | armada- | |prefix|- |s| | uploaded | completed |
| openstack | | manifest | openstack.yaml | | |
+--------------+---------+---------------+----------------+----------+-----------+
+--------------------------+---------+-------------------------------------------+------------------+----------+-----------+
| cert-manager | 1.0-34 | cert-manager-fluxcd-manifests | fluxcd-manifests | applied | completed |
| nginx-ingress-controller | 1.1-35 | nginx-ingress-controller-fluxcd-manifests | fluxcd-manifests | applied | completed |
| oidc-auth-apps | 1.0-68 | oidc-auth-apps-fluxcd-manifests | fluxcd-manifests | uploaded | completed |
| platform-integ-apps | 1.0-52 | platform-integ-apps-fluxcd-manifests | fluxcd-manifests | applied | completed |
| rook-ceph-apps | 1.0-17 | rook-ceph-manifest | manifest.yaml | uploaded | completed |
+--------------------------+---------+-------------------------------------------+------------------+----------+-----------+
- Use the following command to show details for |prod|.
@ -58,20 +59,20 @@ commands to manage containerized applications provided as part of |prod|.
.. parsed-literal::
~(keystone_admin)]$ system application-show |prefix|-openstack
~(keystone_admin)]$ system application-show cert-manager
+---------------+----------------------------------+
| Property | Value |
+---------------+----------------------------------+
| active | False |
| app_version | 1.0-18 |
| created_at | 2019-09-06T15:34:03.194150+00:00 |
| manifest_file | |prefix|-openstack.yaml |s| |
| manifest_name | armada-manifest |
| name | |prefix|-openstack |s| |
| active | True |
| app_version | 1.0-34 |
| created_at | 2022-06-21T02:21:24.218835+00:00 |
| manifest_file | fluxcd-manifests |
| manifest_name | cert-manager-fluxcd-manifests |
| name | cert-manager |
| progress | completed |
| status | uploaded |
| updated_at | 2019-09-06T15:34:46.995929+00:00 |
| status | applied |
| updated_at | 2022-06-21T03:13:01.051293+00:00 |
+---------------+----------------------------------+
- Use the following command to upload application Helm chart\(s\) and
@ -99,22 +100,21 @@ commands to manage containerized applications provided as part of |prod|.
.. parsed-literal::
~(keystone_admin)]$ system application-upload |prefix|-openstack-1.0-18.tgz
~(keystone_admin)]$ system application-upload metrics-server-1.0-17.tgz
+---------------+----------------------------------+
| Property | Value |
+---------------+----------------------------------+
| active | False |
| app_version | 1.0-18 |
| created_at | 2019-09-06T15:34:03.194150+00:00 |
| manifest_file | |prefix|-openstack.yaml |s| |
| manifest_name | armada-manifest |
| name | |prefix|-openstack |s| |
| app_version | 1.0-17 |
| created_at | 2022-06-21T15:40:36.152383+00:00 |
| manifest_file | fluxcd-manifests |
| manifest_name | metrics-server-fluxcd-manifests |
| name | metrics-server |
| progress | None |
| status | uploading |
| updated_at | None |
+---------------+----------------------------------+
Please use 'system application-list' or 'system application-show |prefix|-openstack'
to view the current progress.
Please use 'system application-list' or 'system application-show metrics-server' to view the current progress.
- To list the Helm chart overrides for the |prod|, use the following
command:
@ -344,22 +344,21 @@ commands to manage containerized applications provided as part of |prod|.
.. parsed-literal::
~(keystone_admin)]$ system application-apply |prefix|-openstack
~(keystone_admin)]$ system application-apply metrics-server
+---------------+----------------------------------+
| Property | Value |
+---------------+----------------------------------+
| active | False |
| app_version | 1.0-18 |
| created_at | 2019-09-06T15:34:03.194150+00:00 |
| manifest_file | |prefix|-openstack.yaml |s| |
| manifest_name | armada-manifest |
| name | |prefix|-openstack |s| |
| app_version | 1.0-17 |
| created_at | 2022-06-21T15:40:36.152383+00:00 |
| manifest_file | fluxcd-manifests |
| manifest_name | metrics-server-fluxcd-manifests |
| name | metrics-server |
| progress | None |
| status | applying |
| updated_at | 2019-09-06T15:34:46.995929+00:00 |
| updated_at | 2022-06-21T15:40:42.727918+00:00 |
+---------------+----------------------------------+
Please use 'system application-list' or 'system application-show |prefix|-openstack'
to view the current progress.
Please use 'system application-list' or 'system application-show metrics-server' to view the current progress.
- Use the following command to abort the current application.
@ -409,7 +408,6 @@ commands to manage containerized applications provided as part of |prod|.
| | | -manifest | _manifest.yaml | | |
| oidc-auth-apps | 20.06-26 | oidc-auth-manifest | manifest.yaml | uploaded | completed |
| platform-integ-apps | 20.06-9 | platform-integration-manifest | manifest.yaml | applied | completed |
| wr-analytics | 20.06-2 | analytics-armada-manifest | wr-analytics.yaml | applied | completed |
+--------------------------+----------+-------------------------------+---------------------------+----------+-----------+
The output indicates that the currently installed version of
@ -441,22 +439,21 @@ commands to manage containerized applications provided as part of |prod|.
.. parsed-literal::
~(keystone_admin)]$ system application-remove |prefix|-openstack
~(keystone_admin)]$ system application-remove metrics-server
+---------------+----------------------------------+
| Property | Value |
+---------------+----------------------------------+
| active | False |
| app_version | 1.0-18 |
| created_at | 2019-09-06T15:34:03.194150+00:00 |
| manifest_file | |prefix|-openstack.yaml |s| |
| manifest_name | armada-manifest |
| name | |prefix|-openstack |s| |
| app_version | 1.0-17 |
| created_at | 2022-06-21T15:40:36.152383+00:00 |
| manifest_file | fluxcd-manifests |
| manifest_name | metrics-server-fluxcd-manifests |
| name | metrics-server |
| progress | None |
| status | removing |
| updated_at | 2019-09-06T17:39:19.813754+00:00 |
| updated_at | 2022-06-21T15:45:55.204697+00:00 |
+---------------+----------------------------------+
Please use 'system application-list' or 'system application-show |prefix|-openstack'
to view the current progress.
Please use 'system application-list' or 'system application-show metrics-server' to view the current progress.
This command places the application in the uploaded state.
@ -478,5 +475,5 @@ commands to manage containerized applications provided as part of |prod|.
.. parsed-literal::
~(keystone_admin)]$ system application-delete |prefix|-openstack
Application |prefix|-openstack deleted.
~(keystone_admin)]$ system application-delete metrics-server
Application metrics-server deleted.

15
doc/source/admintasks/kubernetes/kubernetes-admin-tutorials-starlingx-application-package-manager.rst
View File

@ -9,15 +9,14 @@ StarlingX Application Package Manager
Use the |prod| system application commands to manage containerized application
deployment from the command-line.
|prod| application management provides a wrapper around Airship Armada
\(see `https://opendev.org/airship/armada.git <https://opendev.org/airship/armada.git>`__\)
and Kubernetes Helm \(see `https://github.com/helm/helm <https://github.com/helm/helm>`__\)
for managing containerized applications. Armada is a tool for managing multiple
|prod| application management provides a wrapper around FluxCD and Kubernetes
Helm \(see `https://github.com/helm/helm <https://github.com/helm/helm>`__\)
for managing containerized applications. FluxCD is a tool for managing multiple
Helm charts with dependencies by centralizing all configurations in a single
Armada YAML definition and providing life-cycle hooks for all Helm releases.
FluxCD YAML definition and providing life-cycle hooks for all Helm releases.
A |prod| application package is a compressed tarball containing a metadata.yaml
file, a manifest.yaml Armada manifest file, and a charts directory containing
file, a manifest.yaml FluxCD manifest file, and a charts directory containing
Helm charts and a checksum.md5 file. The metadata.yaml file contains the
application name, version, and optional Helm repository and disabled charts
information.
@ -40,7 +39,7 @@ managing overrides to the Helm charts within the application.
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :command:`application-upload` | Upload a new application package. |
| | |
| | This command loads the application's Armada manifest and Helm charts into an internal database and automatically applies system overrides for well-known Helm charts, allowing the Helm chart to be applied optimally to the current cluster configuration. |
| | This command loads the application's FluxCD manifest and Helm charts into an internal database and automatically applies system overrides for well-known Helm charts, allowing the Helm chart to be applied optimally to the current cluster configuration. |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :command:`helm-override-list` | List system Helm charts and the namespaces with Helm chart overrides for each Helm chart. |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -56,7 +55,7 @@ managing overrides to the Helm charts within the application.
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :command:`application-apply` | Apply or reapply the application manifest and Helm charts. |
| | |
| | This command will install or update the existing installation of the application based on its Armada manifest, Helm charts and Helm charts' combined system and user overrides. |
| | This command will install or update the existing installation of the application based on its FluxCD manifest, Helm charts and Helm charts' combined system and user overrides. |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :command:`application-abort` | Abort the current application operation. |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

6
doc/source/admintasks/kubernetes/remove-ptp-notifications.rst
View File

@ -6,8 +6,8 @@
Remove PTP Notifications
========================
You can remove all pods and Kubernetes resources created during the Armada
application deployment.
You can remove all pods and Kubernetes resources created during the application
deployment.
Use the following procedure to remove |PTP| notifications.
@ -18,7 +18,7 @@ Use the following procedure to remove |PTP| notifications.
.. _remove-ptp-notifications-steps-klx-gnf-t4b:
#. Remove all pods and other Kubernetes resources created during the Armada
#. Remove all pods and other Kubernetes resources created during the
deployment, using the following command:
.. code-block:: none

2
doc/source/backup/kubernetes/backing-up-starlingx-system-data.rst
View File

@ -105,7 +105,7 @@ The backup contains details as listed below:
- item=/opt/dc-vault
- Armada manifests:
- FluxCD manifests:
- item=/opt/platform/armada/<|prefix|\_version>

4
doc/source/backup/kubernetes/restoring-starlingx-system-data-and-storage.rst
View File

@ -363,8 +363,8 @@ conditions are in place:
$ system application-apply platform-integ-apps
#. Delete completely and reapply all the applications that have
persistent volumes (WRO or custom apps). For example for WRO, run the
following commands
persistent volumes (OpenStack or custom apps). For example for
OpenStack, run the following commands
.. parsed-literal::

4
doc/source/cli_ref/system.rst
View File

@ -276,8 +276,8 @@ The :command:`host-sensor*` commands provide the ability to:
Application management
**********************
|prod| provides an application package management that combines Airship
Armada and Kubernetes Helm. The |prod| application management provides:
|prod| provides an application package management based on FluxCD and
Kubernetes Helm. The |prod| application management provides:
* System Helm overrides to automatically apply |prod| applications according
to the particular |prod| configuration currently running.

2
doc/source/deploy_install_guides/r5_release/openstack/install.rst
View File

@ -48,7 +48,7 @@ Install application manifest and helm-charts
After you select a release, helm charts are located in ``centos/outputs/helm-charts``.
#. Load the |prefix|-openstack application's package into StarlingX. The tarball
package contains |prefix|-openstack's Airship Armada manifest and
package contains |prefix|-openstack's Armada manifest and
|prefix|-openstack's set of helm charts. For example:
.. parsed-literal::

4
doc/source/deploy_install_guides/r6_release/openstack/install.rst
View File

@ -48,7 +48,7 @@ Install application manifest and helm-charts
After you select a release, helm charts are located in ``centos/outputs/helm-charts``.
#. Load the |prefix|-openstack application's package into StarlingX. The tarball
package contains |prefix|-openstack's Airship Armada manifest and
package contains |prefix|-openstack's FluxCD manifest and
|prefix|-openstack's set of helm charts. For example:
.. parsed-literal::
@ -57,7 +57,7 @@ Install application manifest and helm-charts
This will:
* Load the Armada manifest and helm charts.
* Load the FluxCD manifest and helm charts.
* Internally manage helm chart override values for each chart.
* Automatically generate system helm chart overrides for each chart based on
the current state of the underlying StarlingX Kubernetes platform and the

2
doc/source/developer_resources/backup_restore.rst
View File

@ -222,7 +222,7 @@ The backup contains the following:
ok: [localhost] => (item=/opt/patch-vault)
* Armada manifests
* FluxCD manifests
ok: [localhost] => (item=/opt/platform/armada/<SW_VERSION>)

6
doc/source/developer_resources/stx_sdo_rv.rst
View File

@ -71,7 +71,7 @@ Integration Steps
Skipping 'containers' build
All builds were successful
#. Create the Armada application using the command:
#. Create the system application using the command:
::
@ -86,7 +86,7 @@ Integration Steps
Results:
/localdisk/loadbuild/stx/flock/std/build-helm/stx/stx-sdo-1.0-2.tgz
#. Exit from the container. The SDO-RV Armada application will be found in the
#. Exit from the container. The SDO-RV system application will be found in the
following location:
::
@ -110,7 +110,7 @@ Integration Steps
source /etc/platform/openrc
#. Load the |prefix|-openstack application package into |prod|. The tarball
package contains the |prefix|-openstack Airship Armada manifest and
package contains the |prefix|-openstack FluxCD manifest and
|prefix|-openstack set of Helm charts. For example:
::

230
doc/source/fault-mgmt/kubernetes/enabling-snmp-support.rst
View File

@ -27,72 +27,73 @@ In order to enable and configure |SNMP|, complete the following steps.
~(keystone_admin)]$
#. Use the following command to list the system applications and check whether
SNMP is uploaded or applied. If SNMP is already "uploaded", go to
Step 5 to configure and enable SNMP. If SNMP is already "applied", SNMP is
already configured and enabled, see, :ref:`Change Configuration of the SNMP application <change-configuration-of-SNMP>`
to make configuration changes.
|SNMP| is uploaded or applied. If |SNMP| is already "uploaded", go to Step
5 to configure and enable |SNMP|. If |SNMP| is already "applied", |SNMP| is
already configured and enabled, see, :ref:`Change Configuration of the SNMP
application <change-configuration-of-SNMP>` to make configuration changes.
.. code-block:: none
~(keystone)admin)$ system application-list
+--------------------------+-------------------------+-----------------------------------+----------------------------------------+---------------+-----------+
+--------------------------+---------+-------------------------------------------+------------------+----------+-----------+
| application | version | manifest name | manifest file | status | progress |
+--------------------------+-------------------------+-----------------------------------+----------------------------------------+---------------+-----------+
| cert-manager | 1.0-6 | cert-manager-manifest | certmanager-manifest.yaml | applied | completed |
| nginx-ingress-controller | 1.0-0 | nginx-ingress-controller-manifest | nginx_ingress_controller_manifest.yaml | applied | completed |
| oidc-auth-apps | 1.0-29 | oidc-auth-manifest | manifest.yaml | uploaded | completed |
| platform-integ-apps | 1.0-9 | platform-integration-manifest | manifest.yaml | applied | completed |
| rook-ceph-apps | app-version-placeholder | manifest-placeholder | tarfile-placeholder | upload-failed | None |
+--------------------------+-------------------------+-----------------------------------+----------------------------------------+---------------+-----------+
+--------------------------+---------+-------------------------------------------+------------------+----------+-----------+
| cert-manager | 1.0-34 | cert-manager-fluxcd-manifests | fluxcd-manifests | applied | completed |
| nginx-ingress-controller | 1.1-35 | nginx-ingress-controller-fluxcd-manifests | fluxcd-manifests | applied | completed |
| oidc-auth-apps | 1.0-68 | oidc-auth-apps-fluxcd-manifests | fluxcd-manifests | uploaded | completed |
| platform-integ-apps | 1.0-52 | platform-integ-apps-fluxcd-manifests | fluxcd-manifests | applied | completed |
| rook-ceph-apps | 1.0-17 | rook-ceph-manifest | manifest.yaml | uploaded | completed |
+--------------------------+---------+-------------------------------------------+------------------+----------+-----------+
#. In order to load the SNMP application definitions (Armada manifest and Helm
charts), where **[snmp-<Major>.<Minor>-<Build>.tgz]**, for example,
**snmp-1.0-2.tgz** is the app filename, with version **1.0-2**,
available at the following path "/usr/local/share/applications/helm",
use the following command.
#. In order to load the |SNMP| application definitions (FluxCD manifest and
Helm charts), where **[snmp-<Major>.<Minor>-<Build>.tgz]**, for example,
**snmp-1.0-2.tgz** is the app filename, with version **1.0-2**, available
at the following path "/usr/local/share/applications/helm", use the
following command.
.. code-block:: none
~(keystone)admin)$ system application-upload <path>/snmp-1.0-2.tgz
~(keystone)admin)$ system application-upload <path>/snmp-1.0-36.tgz
+---------------+----------------------------------+
| Property | Value |
+---------------+----------------------------------+
| active | False |
| app_version | 1.0-2 |
| created_at | 2020-11-30T14:45:20.442133+00:00 |
| manifest_file | snmp_manifest.yaml |
| manifest_name | snmp-manifest |
| app_version | 1.0-36 |
| created_at | 2022-06-27T10:45:42.733267+00:00 |
| manifest_file | fluxcd-manifests |
| manifest_name | snmp-fluxcd-manifests |
| name | snmp |
| progress | None |
| status | uploading |
| updated_at | None |
+---------------+----------------------------------+
#. List the SNMP application using the following command to see the status
#. List the |SNMP| application using the following command to see the status
of the upload and wait for the upload to complete.
.. code-block:: none
~(keystone)admin)$ system application-list
+--------------------------+-------------------------+-----------------------------------+----------------------------------------+---------------+-----------+
+--------------------------+---------+-------------------------------------------+------------------+----------+-----------+
| application | version | manifest name | manifest file | status | progress |
+--------------------------+-------------------------+-----------------------------------+----------------------------------------+---------------+-----------+
| cert-manager | 1.0-6 | cert-manager-manifest | certmanager-manifest.yaml | applied | completed |
| nginx-ingress-controller | 1.0-0 | nginx-ingress-controller-manifest | nginx_ingress_controller_manifest.yaml | applied | completed |
| oidc-auth-apps | 1.0-29 | oidc-auth-manifest | manifest.yaml | uploaded | completed |
| platform-integ-apps | 1.0-9 | platform-integration-manifest | manifest.yaml | applied | completed |
| rook-ceph-apps | app-version-placeholder | manifest-placeholder | tarfile-placeholder | upload-failed | None |
| snmp | 1.0-2 | snmp-manifest | snmp_manifest.yaml | uploaded | completed |
+--------------------------+-------------------------+-----------------------------------+----------------------------------------+---------------+-----------+
+--------------------------+---------+-------------------------------------------+------------------+----------+-----------+
| cert-manager | 1.0-34 | cert-manager-fluxcd-manifests | fluxcd-manifests | applied | completed |
| nginx-ingress-controller | 1.1-35 | nginx-ingress-controller-fluxcd-manifests | fluxcd-manifests | applied | completed |
| oidc-auth-apps | 1.0-68 | oidc-auth-apps-fluxcd-manifests | fluxcd-manifests | uploaded | completed |
| platform-integ-apps | 1.0-52 | platform-integ-apps-fluxcd-manifests | fluxcd-manifests | applied | completed |
| rook-ceph-apps | 1.0-17 | rook-ceph-manifest | manifest.yaml | uploaded | completed |
| snmp | 1.0-36 | snmp-fluxcd-manifests | fluxcd-manifests | uploaded | completed |
+--------------------------+---------+-------------------------------------------+------------------+----------+-----------+
#. Create a Helm chart values file (for example, user_conf.yaml) with the
definition of the **configmap:user_conf** attribute, defining your SNMP
#. Create a Helm chart values file (for example, ``user_conf.yaml``) with the
definition of the ``configmap:user_conf`` attribute, defining your |SNMP|
configuration of V2 communities, V2 trap sinks, V3 users and/or V3 trap
sessions, as shown in the example below. The **configmap:user_conf**
variable in the SNMP Helm chart is a multi-line variable that follows the
syntax of Net-SNMP's snmpd.conf file for configuring the SNMP agent, see
`http://www.net-snmp.org/docs/man/snmpd.conf.html <http://www.net-snmp.org/docs/man/snmpd.conf.html>`__,
for a detailed description of the commands.
sessions, as shown in the example below. The ``configmap:user_conf``
variable in the |SNMP| Helm chart is a multi-line variable that follows the
syntax of Net-SNMP's ``snmpd.conf`` file for configuring the |SNMP| agent,
see `http://www.net-snmp.org/docs/man/snmpd.conf.html
<http://www.net-snmp.org/docs/man/snmpd.conf.html>`__, for a detailed
description of the commands.
.. warning::
@ -127,10 +128,10 @@ In order to enable and configure |SNMP|, complete the following steps.
EOF
**\(Optional\)** You can add your own EngineID value, instead of having it
auto-created. This keeps the EngineID value the same, even when the SNMP
application restarts. The EngineID is required if you are using an SNMP
trap viewer or SNMP monitoring tool. Add the 'engineID [STRING]' value in
the **configmap:user_conf** variable, as shown below.
auto-created. This keeps the EngineID value the same, even when the |SNMP|
application restarts. The EngineID is required if you are using an |SNMP|
trap viewer or |SNMP| monitoring tool. Add the 'engineID [STRING]' value in
the ``configmap:user_conf`` variable, as shown below.
.. code-block:: none
@ -142,7 +143,7 @@ In order to enable and configure |SNMP|, complete the following steps.
...
EOF
#. Update the values of the **configmap:user_conf** attribute on the Helm
#. Update the values of the ``configmap:user_conf`` attribute on the Helm
chart using the following command.
.. code-block:: none
@ -172,45 +173,45 @@ In order to enable and configure |SNMP|, complete the following steps.
| Property | Value |
+---------------+----------------------------------+
| active | False |
| app_version | 1.0-2 |
| created_at | 2020-11-30T14:45:20.442133+00:00 |
| manifest_file | snmp_manifest.yaml |
| manifest_name | snmp-manifest |
| app_version | 1.0-36 |
| created_at | 2022-06-27T10:45:42.733267+00:00 |
| manifest_file | fluxcd-manifests |
| manifest_name | snmp-fluxcd-manifests |
| name | snmp |
| progress | None |
| status | applying |
| updated_at | 2020-11-30T14:45:23.088575+00:00 |
| updated_at | 2022-06-27T10:45:51.253949+00:00 |
+---------------+----------------------------------+
#. List the SNMP application and check the status. Wait for the SNMP
#. List the |SNMP| application and check the status. Wait for the SNMP
application to have fully started and is in the "applied" state.
.. code-block:: none
~(keystone)admin)$ system application-list
+--------------------------+-------------------------+-----------------------------------+----------------------------------------+---------------+-----------+
+--------------------------+---------+-------------------------------------------+------------------+----------+----------------------+
| application | version | manifest name | manifest file | status | progress |
+--------------------------+-------------------------+-----------------------------------+----------------------------------------+---------------+-----------+
| cert-manager | 1.0-6 | cert-manager-manifest | certmanager-manifest.yaml | applied | completed |
| nginx-ingress-controller | 1.0-0 | nginx-ingress-controller-manifest | nginx_ingress_controller_manifest.yaml | applied | completed |
| oidc-auth-apps | 1.0-29 | oidc-auth-manifest | manifest.yaml | uploaded | completed |
| platform-integ-apps | 1.0-9 | platform-integration-manifest | manifest.yaml | applied | completed |
| rook-ceph-apps | app-version-placeholder | manifest-placeholder | tarfile-placeholder | upload-failed | None |
| snmp | 1.0-2 | snmp-manifest | snmp_manifest.yaml | applied | completed |
+--------------------------+-------------------------+-----------------------------------+----------------------------------------+---------------+-----------+
+--------------------------+---------+-------------------------------------------+------------------+----------+----------------------+
| cert-manager | 1.0-34 | cert-manager-fluxcd-manifests | fluxcd-manifests | applied | completed |
| nginx-ingress-controller | 1.1-35 | nginx-ingress-controller-fluxcd-manifests | fluxcd-manifests | applied | completed |
| oidc-auth-apps | 1.0-68 | oidc-auth-apps-fluxcd-manifests | fluxcd-manifests | uploaded | completed |
| platform-integ-apps | 1.0-52 | platform-integ-apps-fluxcd-manifests | fluxcd-manifests | applied | completed |
| rook-ceph-apps | 1.0-17 | rook-ceph-manifest | manifest.yaml | uploaded | completed |
| snmp | 1.0-36 | snmp-fluxcd-manifests | fluxcd-manifests | applied | completed |
+--------------------------+---------+-------------------------------------------+------------------+----------+----------------------+
#. Create a Helm chart values file (for example, snmp_port.yaml) with UDP and
TCP port mapping rules, for the nginx-ingress-controller application, to
expose the SNMP services on the required ports. Use external ports 161/UDP
and 162/TCP.
#. Create a Helm chart values file (for example, ``snmp_port.yaml``) with UDP
and TCP port mapping rules, for the nginx-ingress-controller application,
to expose the |SNMP| services on the required ports. Use external ports
161/UDP and 162/TCP.
**kube-system/snmpd-service:161** is the standard SNMP Agent's UDP port for
receiving SNMP requests. It should be configured as mapped to external UDP
port **161**, the default for SNMP Agents. This port can be modified, see,
:ref:`Modifying 161/UDP port <modifying-161udp-port>` procedure for details
on modifying this port.
**kube-system/snmpd-service:161** is the standard |SNMP| Agent's UDP port
for receiving |SNMP| requests. It should be configured as mapped to
external UDP port **161**, the default for |SNMP| Agents. This port can be
modified, see, :ref:`Modifying 161/UDP port <modifying-161udp-port>`
procedure for details on modifying this port.
**kube-system/snmpd-service:162** is used internally by the SNMP
**kube-system/snmpd-service:162** is used internally by the |SNMP|
application to receive trap info from |prod|. It should be configured
as mapped to external TCP port **162**. This port can be modified, see
:ref:`Modifying 162/TCP port <modifying-162tcp-port>` procedure below for
@ -225,7 +226,7 @@ In order to enable and configure |SNMP|, complete the following steps.
162: "kube-system/snmpd-service:162"
EOF
#. Update the values of the SNMP port mappings in the Helm Chart for the
#. Update the values of the |SNMP| port mappings in the Helm Chart for the
nginx-ingress-controller application.
.. code-block:: none
@ -248,22 +249,22 @@ In order to enable and configure |SNMP|, complete the following steps.
.. code-block:: none
~(keystone_admin)$ system application-apply nginx-ingress-controller
+---------------+----------------------------------------+
+---------------+--------------------------------------+
| Property | Value |
+---------------+----------------------------------------+
+---------------+--------------------------------------+
| active | True |
| app_version | 1.0-0 |
| created_at | 2020-10-19T04:59:40.505583+00:00 |
| manifest_file | nginx_ingress_controller_manifest.yaml |
| manifest_name | nginx-ingress-controller-manifest |
| name | nginx-ingress-controller |
| progress | None |
| app_version | 1.0-52 |
| created_at | 2022-06-26T21:21:47.428225+00:00 |
| manifest_file | fluxcd-manifests |
| manifest_name | platform-integ-apps-fluxcd-manifests |
| name | platform-integ-apps |
| progress | none |
| status | applying |
| updated_at | 2020-11-10T17:27:21.509548+00:00 |
+---------------+----------------------------------------+
| updated_at | 2022-06-26T21:30:06.767995+00:00 |
+---------------+--------------------------------------+
#. Redirect the SNMP UDP traffic to port 161 by creating the next policies.yml
file and apply it as below.
#. Redirect the |SNMP| UDP traffic to port 161 by creating the next
``policies.yml`` file and apply it as below.
Change the ipVersion parameter value from 4 to 6 if you are using IPV6.
@ -349,10 +350,10 @@ update its configuration.
EOF
**\(Optional\)** You can add your own EngineID value, instead of having it
auto-created. This keeps the EngineID value the same, even when the SNMP
application restarts. The EngineID is required if you are using an SNMP
trap viewer or SNMP monitoring tool. Add the 'engineID [STRING]' value in
the **configmap:user_conf** variable, as shown below.
auto-created. This keeps the EngineID value the same, even when the |SNMP|
application restarts. The EngineID is required if you are using an |SNMP|
trap viewer or |SNMP| monitoring tool. Add the 'engineID [STRING]' value in
the`` configmap:user_conf`` variable, as shown below.
.. code-block:: none
@ -364,7 +365,7 @@ update its configuration.
...
EOF
#. Update the values of the **configmap:user_conf** attribute on the Helm
#. Update the values of the ``configmap:user_conf`` attribute on the Helm
chart using the following command.
.. code-block:: none
@ -392,15 +393,15 @@ update its configuration.
+---------------+----------------------------------+
| Property | Value |
+---------------+----------------------------------+
| active | True |
| app_version | 1.0-2 |
| created_at | 2020-11-10T23:25:47.226453+00:00 |
| manifest_file | snmp_manifest.yaml |
| manifest_name | snmp-manifest |
| active | False |
| app_version | 1.0-36 |
| created_at | 2022-06-27T10:45:42.733267+00:00 |
| manifest_file | fluxcd-manifests |
| manifest_name | snmp-fluxcd-manifests |
| name | snmp |
| progress | None |
| status | applying |
| updated_at | 2020-11-10T23:30:59.276031+00:00 |
| updated_at | 2022-06-27T10:45:51.253949+00:00 |
+---------------+----------------------------------+
.. _modifying-161udp-port:
@ -409,18 +410,18 @@ update its configuration.
Modifying 161/UDP port
**********************
Modify the external UDP port used for receiving SNMP requests.
Modify the external UDP port used for receiving |SNMP| requests.
.. note::
After changing this external UDP port, any external SNMP managers being
used must be updated to send their SNMP requests to |prod| using this
After changing this external UDP port, any external |SNMP| managers being
used must be updated to send their |SNMP| requests to |prod| using this
UDP port, instead of the default UDP port 161.
.. rubric:: |proc|
#. Create a Helm chart values file (for example, snmp_port.yaml) with
external ports 161/UDP and 162/TCP port mapping definitions, for the SNMP
external ports 161/UDP and 162/TCP port mapping definitions, for the |SNMP|
services for the nginx-ingress-controller's Helm chart, as shown in the
example below.
@ -460,19 +461,20 @@ Modify the external UDP port used for receiving SNMP requests.
.. code-block:: none
~(keystone_admin)$ system application-apply nginx-ingress-controller
+---------------+----------------------------------------+
+---------------+-------------------------------------------+
| Property | Value |
+---------------+----------------------------------------+
+---------------+-------------------------------------------+
| active | True |
| app_version | 1.0-0 |
| created_at | 2020-10-19T04:59:40.505583+00:00 |
| manifest_file | nginx_ingress_controller_manifest.yaml |
| manifest_name | nginx-ingress-controller-manifest |
| app_version | 1.1-35 |
| created_at | 2022-06-26T20:49:02.437688+00:00 |
| manifest_file | fluxcd-manifests |
| manifest_name | nginx-ingress-controller-fluxcd-manifests |
| name | nginx-ingress-controller |
| progress | None |
| status | applying |
| updated_at | 2020-11-10T17:27:21.509548+00:00 |
+---------------+----------------------------------------+
| updated_at | 2022-06-26T20:50:10.730709+00:00 |
+---------------+-------------------------------------------+
.. _modifying-162tcp-port:
@ -480,18 +482,18 @@ Modify the external UDP port used for receiving SNMP requests.
Modifying 162/TCP port
**********************
Modify the external port used by the SNMP application to receive trap
Modify the external port used by the |SNMP| application to receive trap
information from |prod|.
To change the port 162/TCP, you need to modify both the SNMP application Helm
To change the port 162/TCP, you need to modify both the |SNMP| application Helm
chart, and the nginx-ingress-controller Helm chart. The new port must be set
to the same port number in the two Helm charts, otherwise SNMP
to the same port number in the two Helm charts, otherwise |SNMP|
traps will not be generated.
.. rubric:: |proc|
#. Modify your SNMP Helm chart values file (for example, user_conf.yaml) by
adding the line "trap-server-port: [new port]" as shown in the example
#. Modify your |SNMP| Helm chart values file (for example, ``user_conf.yaml``)
by adding the line "trap-server-port: [new port]" as shown in the example
below \("30162" is the new port in this example\).
.. code-block:: none
@ -516,13 +518,13 @@ traps will not be generated.
#. Modify your nginx ingress controller Helm chart values file
(for example, snmp_port.yaml). Update the external port in the TCP port
mapping for internal port **kube-system/snmpd-service:162**. The example
mapping for internal port ``kube-system/snmpd-service:162``. The example
below shows the external port updated to **30162**.
- The new port number must match the port number specified in your SNMP
Helm chart values file (for example, user_conf.yaml).
- The new port number must match the port number specified in your |SNMP|
Helm chart values file (for example, ``user_conf.yaml``).
- Do not modify port number "162" in **kube-system/snmpd-service:162**.
- Do not modify port number "162" in ``kube-system/snmpd-service:162``.
.. code-block:: none

86
doc/source/fault-mgmt/kubernetes/uninstalling-snmp.rst
View File

@ -12,22 +12,18 @@ Use the following procedure to uninstall |SNMP|:
.. code-block:: none
~(keystone_admin)]$ system application-list
+--------------------------+-------------------------+-----------------------------------+------------------------+---------------+-----------+
+--------------------------+---------+-------------------------------------------+------------------+----------+----------------------+
| application | version | manifest name | manifest file | status | progress |
+--------------------------+-------------------------+-----------------------------------+------------------------+---------------+-----------+
| cert-manager | 1.0-6 | cert-manager-manifest | certmanager-manifest. | applied | completed |
| | | | yaml | | |
| | | | | | |
| nginx-ingress-controller | 1.0-0 | nginx-ingress-controller-manifest | nginx_ingress_controll | applied | completed |
| | | | er_manifest.yaml | | |
| | | | | | |
| oidc-auth-apps | 1.0-29 | oidc-auth-manifest | manifest.yaml | uploaded | completed |
| platform-integ-apps | 1.0-9 | platform-integration-manifest | manifest.yaml | uploaded | completed |
| rook-ceph-apps | app-version-placeholder | manifest-placeholder | tarfile-placeholder | upload-failed | None |
| snmp | 1.0-2 | snmp-manifest | snmp_manifest.yaml | applied | completed |
+--------------------------+-------------------------+-----------------------------------+------------------------+---------------+-----------+
+--------------------------+---------+-------------------------------------------+------------------+----------+----------------------+
| cert-manager | 1.0-34 | cert-manager-fluxcd-manifests | fluxcd-manifests | applied | completed |
| nginx-ingress-controller | 1.1-35 | nginx-ingress-controller-fluxcd-manifests | fluxcd-manifests | applied | completed |
| oidc-auth-apps | 1.0-68 | oidc-auth-apps-fluxcd-manifests | fluxcd-manifests | uploaded | completed |
| platform-integ-apps | 1.0-52 | platform-integ-apps-fluxcd-manifests | fluxcd-manifests | applied | completed |
| rook-ceph-apps | 1.0-17 | rook-ceph-manifest | manifest.yaml | uploaded | completed |
| snmp | 1.0-36 | snmp-fluxcd-manifests | fluxcd-manifests | applied | completed |
+--------------------------+---------+-------------------------------------------+------------------+----------+----------------------+
#. Uninstall SNMP.
#. Uninstall |SNMP|.
.. code-block:: none
@ -35,61 +31,53 @@ Use the following procedure to uninstall |SNMP|:
+---------------+----------------------------------+
| Property | Value |
+---------------+----------------------------------+
| active | True |
| app_version | 1.0-2 |
| created_at | 2020-11-12T06:26:21.526433+00:00 |
| manifest_file | snmp_manifest.yaml |
| manifest_name | snmp-manifest |
| active | False |
| app_version | 1.0-36 |
| created_at | 2022-06-27T10:45:42.733267+00:00 |
| manifest_file | fluxcd-manifests |
| manifest_name | snmp-fluxcd-manifests |
| name | snmp |
| progress | None |
| status | removing |
| updated_at | 2020-11-12T06:51:34.987085+00:00 |
| updated_at | 2022-06-27T10:45:51.253949+00:00 |
+---------------+----------------------------------+
The SNMP application is removed, but still shows as "Uploaded".
The |SNMP| application is removed, but still shows as "Uploaded".
.. code-block:: none
~(keystone_admin)]$ system application-list
+--------------------------+-------------------------+-----------------------------------+-------------------------+---------------+-----------+
+--------------------------+---------+-------------------------------------------+------------------+----------+----------------------+
| application | version | manifest name | manifest file | status | progress |
+--------------------------+-------------------------+-----------------------------------+-------------------------+---------------+-----------+
| cert-manager | 1.0-6 | cert-manager-manifest | certmanager-manifest. | applied | completed |
| | | | yaml | | |
| | | | | | |
| nginx-ingress-controller | 1.0-0 | nginx-ingress-controller-manifest | nginx_ingress_controlle | applied | completed |
| | | | r_manifest.yaml | | |
| | | | | | |
| oidc-auth-apps | 1.0-29 | oidc-auth-manifest | manifest.yaml | uploaded | completed |
| platform-integ-apps | 1.0-9 | platform-integration-manifest | manifest.yaml | uploaded | completed |
| rook-ceph-apps | app-version-placeholder | manifest-placeholder | tarfile-placeholder | upload-failed | None |
| snmp | 1.0-2 | snmp-manifest | snmp_manifest.yaml | uploaded | completed |
+--------------------------+-------------------------+-----------------------------------+-------------------------+---------------+-----------+
+--------------------------+---------+-------------------------------------------+------------------+----------+----------------------+
| cert-manager | 1.0-34 | cert-manager-fluxcd-manifests | fluxcd-manifests | applied | completed |
| nginx-ingress-controller | 1.1-35 | nginx-ingress-controller-fluxcd-manifests | fluxcd-manifests | applied | completed |
| oidc-auth-apps | 1.0-68 | oidc-auth-apps-fluxcd-manifests | fluxcd-manifests | uploaded | completed |
| platform-integ-apps | 1.0-52 | platform-integ-apps-fluxcd-manifests | fluxcd-manifests | applied | completed |
| rook-ceph-apps | 1.0-17 | rook-ceph-manifest | manifest.yaml | uploaded | completed |
| snmp | 1.0-36 | snmp-fluxcd-manifests | fluxcd-manifests | uploaded | completed |
+--------------------------+---------+-------------------------------------------+------------------+----------+----------------------+
#. Delete the uninstalled SNMP application definitions from the system.
#. Delete the uninstalled |SNMP| application definitions from the system.
.. code-block:: none
~(keystone_admin)]$ system application-delete snmp
The following message is displayed when the SNMP application is deleted
The following message is displayed when the |SNMP| application is deleted
"Application SNMP deleted".
#. Run the following command to check if the SNMP application is deleted.
#. Run the following command to check if the |SNMP| application is deleted.
.. code-block:: none
~(keystone_admin)]$ system application-list
+--------------------------+-------------------------+-----------------------------------+--------------------------+---------------+-----------+
+--------------------------+---------+-------------------------------------------+------------------+----------+----------------------+
| application | version | manifest name | manifest file | status | progress |
+--------------------------+-------------------------+-----------------------------------+--------------------------+---------------+-----------+
| cert-manager | 1.0-6 | cert-manager-manifest | certmanager-manifest. | applied | completed |
| | | | yaml | | |
| | | | | | |
| nginx-ingress-controller | 1.0-0 | nginx-ingress-controller-manifest | nginx_ingress_controller | applied | completed |
| | | | _manifest.yaml | | |
| | | | | | |
| oidc-auth-apps | 1.0-29 | oidc-auth-manifest | manifest.yaml | uploaded | completed |
| platform-integ-apps | 1.0-9 | platform-integration-manifest | manifest.yaml | uploaded | completed |
| rook-ceph-apps | app-version-placeholder | manifest-placeholder | tarfile-placeholder | upload-failed | None |
+--------------------------+-------------------------+-----------------------------------+--------------------------+---------------+-----------+
+--------------------------+---------+-------------------------------------------+------------------+----------+----------------------+
| cert-manager | 1.0-34 | cert-manager-fluxcd-manifests | fluxcd-manifests | applied | completed |
| nginx-ingress-controller | 1.1-35 | nginx-ingress-controller-fluxcd-manifests | fluxcd-manifests | applied | completed |
| oidc-auth-apps | 1.0-68 | oidc-auth-apps-fluxcd-manifests | fluxcd-manifests | uploaded | completed |
| platform-integ-apps | 1.0-52 | platform-integ-apps-fluxcd-manifests | fluxcd-manifests | applied | completed |
| rook-ceph-apps | 1.0-17 | rook-ceph-manifest | manifest.yaml | uploaded | completed |
+--------------------------+---------+-------------------------------------------+------------------+----------+----------------------+

2
doc/source/introduction/functional_overview.rst
View File

@ -60,7 +60,7 @@ Where:
- Helm / Tiller – Kubernetes Package Manager, and
- Armada \(Airship\)
- FluxCd or Armada Airship (deprecated)
**OpenStack**
- Keystone - Identity management

12
doc/source/node_management/openstack/using-labels-to-identify-openstack-nodes.rst
View File

@ -24,22 +24,22 @@ OpenStack role.
.. table:: Table 1. Common OpenStack Labels
:widths: auto
+-----------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Label | Worker/Controller | Description |
+=============================+===========================+=======================================================================================================================================================================+
+=============================+===========================+===========================================================================================================================================================================================+
| **openstack-control-plane** | - Controller | Identifies a node to deploy openstack controller services on. |
| | | |
| | - All-in-One Controller | |
+-----------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **openstack-compute-node** | Worker | Identifies a node to deploy openstack compute agents on. |
| | | |
| | | .. note:: |
| | | Adding or removing this label, or removing a node with this label from a cluster, triggers the regeneration and application of the helm chart override by Armada. |
+-----------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | Adding or removing this label, or removing a node with this label from a cluster, triggers the regeneration and application of the helm chart overrides of the openstack application. |
+-----------------------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **sriov** | - Worker | Identifies a node as supporting sr-iov. |
| | | |
| | - All-in-One Controller | |
+-----------------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. only:: partner

15
doc/source/operations/k8s_cluster.rst
View File

@ -93,7 +93,7 @@ Kubernetes
* Persistent Volume Claims backed by Ceph
* Local Docker Registry
* Helm/Tiller – Kubernetes Package Manager
* Armada (Airship)
* FluxCD or Armada Airship (deprecated)
----------------------------
Kubernetes cluster interface
@ -152,15 +152,14 @@ StarlingX application package manager
Use the StarlingX :command:`system application-*` commands to manage
containerized application deployment from the commandline.
StarlingX application management provides a wrapper around
`Airship Armada <https:// opendev.org/airship/armada.git>`_ and
StarlingX application management provides a wrapper around FluxCD and
`Kubernetes Helm <https://github.com/helm/helm>`_ for managing containerized
applications. Armada is a tool for managing multiple Helm charts with
dependencies by centralizing all configurations in a single Armada YAML
applications. FluxCD is a tool for managing multiple Helm charts with
dependencies by centralizing all configurations in a single FluxCD YAML
definition and providing life-cycle hooks for all Helm releases.
A StarlingX application package is a compressed tarball containing a ``metadata.yaml``
file, a ``manifest.yaml`` Armada manifest file, and a charts directory containing
file, a ``manifest.yaml`` FluxCD manifest file, and a charts directory containing
Helm charts and a ``checksum.md5`` file. The ``metadata.yaml`` file contains the
application name, version, and optional Helm repository and disabled charts
information.
@ -178,7 +177,7 @@ Use the following commands with the StarlingX application manager:
Show application details such as name, status, and progress.
``application-upload``
Upload a new application package. This command loads the application’s Armada
Upload a new application package. This command loads the application’s FluxCD
manifest and Helm charts into an internal database and automatically applies
system overrides for well-known Helm charts, allowing the Helm chart to be
applied optimally to the current cluster configuration.
@ -203,7 +202,7 @@ Use the following commands with the StarlingX application manager:
``application-apply``
Apply or reapply the application manifest and Helm charts. This command
installs or updates the existing installation of the application based on its
Armada manifest, Helm charts, and Helm charts’ combined system and user overrides.
FluxCD manifest, Helm charts, and Helm charts’ combined system and user overrides.
``application-abort``
Abort the current application operation.

8
doc/source/security/kubernetes/install-vault.rst
View File

@ -6,7 +6,7 @@
Install Vault
=============
Vault is packaged as an Armada system application and is managed using
Vault is packaged as a system application and is managed using
:command:`system application`, and :command:`system helm-override` commands.
.. rubric:: |context|
@ -18,15 +18,15 @@ To install Vault, use the following procedure:
.. rubric:: |proc|
#. Locate the Vault tarball in /usr/local/share/applications/helm.
#. Locate the Vault tarball in ``/usr/local/share/applications/helm``.
For example, /usr/local/share/applications/helm/vault-20.06-9.tgz.
For example, ``/usr/local/share/applications/helm/vault-1.0-30.tgz``.
#. Upload Vault, using the following command:
.. code-block:: none
$ system application-upload /usr/local/share/applications/helm/vault-20.06-9.tgz
$ system application-upload ``/usr/local/share/applications/helm/vault-1.0-30.tgz``
#. Verify the Vault tarball has been uploaded.

4
doc/source/security/kubernetes/remove-vault.rst
View File

@ -12,7 +12,7 @@ procedure described in this section.
.. rubric:: |context|
Run the following commands to remove Vault. This will remove pods and other
resources created by the Armada installation. For more information, see
resources created by the application installation. For more information, see
:ref:`Install Vault <install-vault>`.
.. rubric:: |proc|
@ -47,5 +47,3 @@ resources created by the Armada installation. For more information, see
$ kubectl delete ns vault
$ system application-delete vault

123
doc/source/system_configuration/kubernetes/application-commands-and-helm-overrides.rst
View File

@ -33,15 +33,16 @@ commands to manage containerized applications provided as part of |prod|.
~(keystone_admin)]$ system application-list --nowrap
+-------------+---------+---------------+----------------+----------+-----------+
+--------------------------+---------+-------------------------------------------+------------------+----------+-----------+
| application | version | manifest name | manifest file | status | progress |
+-------------+---------+---------------+----------------+----------+-----------+
| platform- | 1.0-7 | platform- | manifest.yaml | applied | completed |
| integ-apps | | integration- | | | |
| | | manifest | | | |
| |prefix|- |s| | 1.0-18 | armada- | |prefix|-openstack |s| | uploaded | completed |
| openstack | | manifest | .yaml | | |
+-------------+---------+---------------+----------------+----------+-----------+
+--------------------------+---------+-------------------------------------------+------------------+----------+-----------+
| cert-manager | 1.0-34 | cert-manager-fluxcd-manifests | fluxcd-manifests | applied | completed |
| nginx-ingress-controller | 1.1-35 | nginx-ingress-controller-fluxcd-manifests | fluxcd-manifests | applied | completed |
| oidc-auth-apps | 1.0-68 | oidc-auth-apps-fluxcd-manifests | fluxcd-manifests | uploaded | completed |
| platform-integ-apps | 1.0-52 | platform-integ-apps-fluxcd-manifests | fluxcd-manifests | applied | completed |
| rook-ceph-apps | 1.0-17 | rook-ceph-manifest | manifest.yaml | uploaded | completed |
+--------------------------+---------+-------------------------------------------+------------------+----------+-----------+
- Use the following command to show details for |prod|.
@ -58,20 +59,20 @@ commands to manage containerized applications provided as part of |prod|.
.. parsed-literal::
~(keystone_admin)]$ system application-show |prefix|-openstack
~(keystone_admin)]$ system application-show cert-manager
+---------------+----------------------------------+
| Property | Value |
+---------------+----------------------------------+
| active | False |
| app_version | 1.0-18 |
| created_at | 2019-09-06T15:34:03.194150+00:00 |
| manifest_file | |prefix|-openstack.yaml |s| |
| manifest_name | armada-manifest |
| name | |prefix|-openstack |s| |
| active | True |
| app_version | 1.0-34 |
| created_at | 2022-06-21T02:21:24.218835+00:00 |
| manifest_file | fluxcd-manifests |
| manifest_name | cert-manager-fluxcd-manifests |
| name | cert-manager |
| progress | completed |
| status | uploaded |
| updated_at | 2019-09-06T15:34:46.995929+00:00 |
| status | applied |
| updated_at | 2022-06-21T03:13:01.051293+00:00 |
+---------------+----------------------------------+
- Use the following command to upload application Helm chart\(s\) and
@ -99,21 +100,21 @@ commands to manage containerized applications provided as part of |prod|.
.. parsed-literal::
~(keystone_admin)]$ system application-upload |prefix|-openstack-1.0-18.tgz
~(keystone_admin)]$ system application-upload metrics-server-1.0-17.tgz
+---------------+----------------------------------+
| Property | Value |
+---------------+----------------------------------+
| active | False |
| app_version | 1.0-18 |
| created_at | 2019-09-06T15:34:03.194150+00:00 |
| manifest_file | |prefix|-openstack.yaml |
| manifest_name | armada-manifest |
| name | |prefix|-openstack |
| app_version | 1.0-17 |
| created_at | 2022-06-21T15:40:36.152383+00:00 |
| manifest_file | fluxcd-manifests |
| manifest_name | metrics-server-fluxcd-manifests |
| name | metrics-server |
| progress | None |
| status | uploading |
| updated_at | None |
+---------------+----------------------------------+
Please use 'system application-list' or 'system application-show |prefix|-openstack' to view the current progress.
Please use 'system application-list' or 'system application-show metrics-server' to view the current progress.
- To list the Helm chart overrides for the |prod|, use the following
command:
@ -281,10 +282,10 @@ commands to manage containerized applications provided as part of |prod|.
and the following are positional arguments:
**<app\_name>**
**<app_name>**
The name of the application.
**<chart\_name>**
**<chart_name>**
The name of the chart.
**<namespace>**
@ -303,10 +304,10 @@ commands to manage containerized applications provided as part of |prod|.
where the following are positional arguments:
**<app\_name>**
**<app_name>**
The name of the application.
**<chart\_name>**
**<chart_name>**
The name of the chart.
**<namespace>**
@ -335,28 +336,28 @@ commands to manage containerized applications provided as part of |prod|.
and the following is a positional argument:
**<app\_name>**
**<app_name>**
is the name of the application to apply.
For example:
.. parsed-literal::
~(keystone_admin)]$ system application-apply |prefix|-openstack
~(keystone_admin)]$ system application-apply metrics-server
+---------------+----------------------------------+
| Property | Value |
+---------------+----------------------------------+
| active | False |
| app_version | 1.0-18 |
| created_at | 2019-09-06T15:34:03.194150+00:00 |
| manifest_file | |prefix|-openstack.yaml |s| |
| manifest_name | armada-manifest |
| name | |prefix|-openstack |s| |
| app_version | 1.0-17 |
| created_at | 2022-06-21T15:40:36.152383+00:00 |
| manifest_file | fluxcd-manifests |
| manifest_name | metrics-server-fluxcd-manifests |
| name | metrics-server |
| progress | None |
| status | applying |
| updated_at | 2019-09-06T15:34:46.995929+00:00 |
| updated_at | 2022-06-21T15:40:42.727918+00:00 |
+---------------+----------------------------------+
Please use 'system application-list' or 'system application-show |prefix|-openstack' to view the current progress.
Please use 'system application-list' or 'system application-show metrics-server' to view the current progress.
- Use the following command to abort the current application.
@ -366,14 +367,14 @@ commands to manage containerized applications provided as part of |prod|.
where:
**<app\_name>**
**<app_name>**
is the name of the application to abort.
For example:
.. parsed-literal::
~(keystone_admin)]$ system application-abort |prefix|-openstack
~(keystone_admin)]$ system application-abort metrics-server
Application abort request has been accepted. If the previous operation has not
completed/failed, it will be cancelled shortly.
@ -389,7 +390,7 @@ commands to manage containerized applications provided as part of |prod|.
where the following are optional arguments:
**<app\_name>**
**<app_name>**
The name of the application to update.
You can look up the name of an application using the :command:`application-list` command:
@ -397,24 +398,24 @@ commands to manage containerized applications provided as part of |prod|.
.. code-block:: none
~(keystone_admin)]$ system application-list
+--------------------------+----------+-------------------------------+---------------------------+----------+-----------+
+--------------------------+---------+-------------------------------------------+------------------+----------+-----------+
| application | version | manifest name | manifest file | status | progress |
+--------------------------+----------+-------------------------------+---------------------------+----------+-----------+
| cert-manager | 20.06-4 | cert-manager-manifest | certmanager-manifest.yaml | applied | completed |
| nginx-ingress-controller | 20.06-1 | nginx-ingress-controller- | nginx_ingress_controller | applied | completed |
| | | -manifest | _manifest.yaml | | |
| oidc-auth-apps | 20.06-26 | oidc-auth-manifest | manifest.yaml | uploaded | completed |
| platform-integ-apps | 20.06-9 | platform-integration-manifest | manifest.yaml | applied | completed |
+--------------------------+----------+-------------------------------+---------------------------+----------+-----------+
+--------------------------+---------+-------------------------------------------+------------------+----------+-----------+
| cert-manager | 1.0-34 | cert-manager-fluxcd-manifests | fluxcd-manifests | applied | completed |
| nginx-ingress-controller | 1.1-35 | nginx-ingress-controller-fluxcd-manifests | fluxcd-manifests | applied | completed |
| oidc-auth-apps | 1.0-68 | oidc-auth-apps-fluxcd-manifests | fluxcd-manifests | uploaded | completed |
| platform-integ-apps | 1.0-52 | platform-integ-apps-fluxcd-manifests | fluxcd-manifests | applied | completed |
| rook-ceph-apps | 1.0-17 | rook-ceph-manifest | manifest.yaml | uploaded | completed |
+--------------------------+---------+-------------------------------------------+------------------+----------+-----------+
The output indicates that the currently installed version of **cert-manager** is 20.06-4.
The output indicates that the currently installed version of **cert-manager** is 1.0-34.
**<version>**
The version to update the application to.
and the following is a positional argument which must come last:
**<tar\_file>**
**<tar_file>**
The tar file containing the application manifest, Helm charts and
configuration file.
@ -428,28 +429,28 @@ commands to manage containerized applications provided as part of |prod|.
where:
**<app\_name>**
**<app\name>**
is the name of the application to remove.
For example:
.. parsed-literal::
~(keystone_admin)]$ system application-remove |prefix|-openstack
~(keystone_admin)]$ system application-remove metrics-server
+---------------+----------------------------------+
| Property | Value |
+---------------+----------------------------------+
| active | False |
| app_version | 1.0-18 |
| created_at | 2019-09-06T15:34:03.194150+00:00 |
| manifest_file | |prefix|-openstack.yaml |s| |
| manifest_name | armada-manifest |
| name | |prefix|-openstack |s| |
| app_version | 1.0-17 |
| created_at | 2022-06-21T15:40:36.152383+00:00 |
| manifest_file | fluxcd-manifests |
| manifest_name | metrics-server-fluxcd-manifests |
| name | metrics-server |
| progress | None |
| status | removing |
| updated_at | 2019-09-06T17:39:19.813754+00:00 |
| updated_at | 2022-06-21T15:45:55.204697+00:00 |
+---------------+----------------------------------+
Please use 'system application-list' or 'system application-show |prefix|-openstack' to view the current progress.
Please use 'system application-list' or 'system application-show metrics-server' to view the current progress.
This command places the application in the uploaded state.
@ -471,5 +472,5 @@ commands to manage containerized applications provided as part of |prod|.
.. parsed-literal::
~(keystone_admin)]$ system application-delete |prefix|-openstack
Application |prefix|-openstack deleted.
~(keystone_admin)]$ system application-delete metrics-server
Application metrics-server deleted.

35
doc/source/system_configuration/kubernetes/check-new-registry-and-reapply-application.rst
View File

@ -15,17 +15,17 @@ to controller-1 and perform the same steps.
.. code-block:: none
sudo docker login new-registry.domain.com:9001
$ sudo docker login new-registry.domain.com:9001
#. Run this command to do a test pull of the image:
.. code-block:: none
sudo docker image pull new-registry.domain.com:9001/product-abc/starlingx/docker.io/alpine:latest
crictl pull --creds docker:****** new-registry.domain.com:9001/product-abc/starlingx/docker.io/alpine:latest
$ sudo docker image pull new-registry.domain.com:9001/product-abc/starlingx/docker.io/alpine:latest
$ crictl pull --creds docker:****** new-registry.domain.com:9001/product-abc/starlingx/docker.io/alpine:latest
sudo docker image rm new-registry.domain.com:9001/product-abc/starlingx/docker.io/alpine:latest
crictl rmi new-registry.domain.com:9001/product-abc/starlingx/docker.io/alpine:latest
$ sudo docker image rm new-registry.domain.com:9001/product-abc/starlingx/docker.io/alpine:latest
$ crictl rmi new-registry.domain.com:9001/product-abc/starlingx/docker.io/alpine:latest
#. Check if an application re-apply will now properly pull from the registries.
First, remove the images for an application, such as
@ -35,7 +35,7 @@ to controller-1 and perform the same steps.
.. code-block:: none
system registry-image-tags quay.io/kubernetes-ingress-controller/nginx-ingress-controller
~(keystone_admin)]$ system registry-image-tags quay.io/kubernetes-ingress-controller/nginx-ingress-controller
+-----------+
| Image Tag |
+-----------+
@ -57,7 +57,7 @@ to controller-1 and perform the same steps.
.. code-block:: none
system application-apply nginx-ingress-controller
~(keystone_admin)]$ system application-apply nginx-ingress-controller
#. Then, debug tail ``-f /var/log/sysinv.log`` and look for the following information:
@ -73,23 +73,22 @@ to controller-1 and perform the same steps.
.. code-block:: none
system application-list
+--------------------------+----------+-----------------------------------+---------------------------------+----------+-----------+
~(keystone_admin)]$ system application-list
+--------------------------+---------+-------------------------------------------+------------------+----------+----------------------+
| application | version | manifest name | manifest file | status | progress |
+--------------------------+----------+-----------------------------------+---------------------------------+----------+-----------+
| cert-manager | 20.06-4 | cert-manager-manifest | certmanager-manifest.yaml | applied | completed |
--> | nginx-ingress-controller | 20.06-0 | nginx-ingress-controller-manifest | nginx_ingress_controller_manife | applied | completed |
| | | | st.yaml | | |
| | | | | | |
| oidc-auth-apps | 20.06-26 | oidc-auth-manifest | manifest.yaml | uploaded | completed |
| platform-integ-apps | 20.06-9 | platform-integration-manifest | manifest.yaml | uploaded | completed |
+--------------------------+----------+-----------------------------------+---------------------------------+----------+-----------+
+--------------------------+---------+-------------------------------------------+------------------+----------+----------------------+
| cert-manager | 1.0-34 | cert-manager-fluxcd-manifests | fluxcd-manifests | applied | completed |
| nginx-ingress-controller | 1.1-35 | nginx-ingress-controller-fluxcd-manifests | fluxcd-manifests | applied | completed |
| oidc-auth-apps | 1.0-68 | oidc-auth-apps-fluxcd-manifests | fluxcd-manifests | uploaded | completed |
| platform-integ-apps | 1.0-52 | platform-integ-apps-fluxcd-manifests | fluxcd-manifests | applied | completed |
| rook-ceph-apps | 1.0-17 | rook-ceph-manifest | manifest.yaml | uploaded | completed |
+--------------------------+---------+-------------------------------------------+------------------+----------+----------------------+
#. Validate that the image is in the local registry:
.. code-block:: none
system registry-image-tags quay.io/kubernetes-ingress-controller/nginx-ingress-controller
~(keystone_admin)]$ system registry-image-tags quay.io/kubernetes-ingress-controller/nginx-ingress-controller
+-----------+
| Image Tag |
+-----------+

19
doc/source/system_configuration/kubernetes/system-configuration-starlingx-application-package-manager.rst
View File

@ -9,16 +9,15 @@ StarlingX Application Package Manager
Use the |prod| system application commands to manage containerized
applications provided as part of |prod|.
StarlingX application management provides a wrapper around Airship Armada
\(see `https://opendev.org/airship/armada.git <https://opendev.org/airship/armada.git>`__\)
and Kubernetes Helm \(see `https://github.com/helm/helm <https://github.com/helm/helm>`__\)
for managing containerized applications. Armada is a tool for managing
multiple Helm charts with dependencies by centralizing all configurations
in a single Armada YAML definition and providing life-cycle hooks for all
Helm releases.
StarlingX application management provides a wrapper around FluxCD and
Kubernetes Helm \(see `https://github.com/helm/helm
<https://github.com/helm/helm>`__\) for managing containerized applications.
FluxCD is a tool for managing multiple Helm charts with dependencies by
centralizing all configurations in a single FluxCD YAML definition and
providing life-cycle hooks for all Helm releases.
A StarlingX application package is a compressed tarball containing a
metadata.yaml file, a manifest.yaml Armada manifest file, and a charts
metadata.yaml file, a manifest.yaml FluxCD manifest file, and a charts
directory containing helm charts and a checksum.md5 file. The metadata.yaml
file contains the application name, version, and optional helm repository
and disabled charts information.
@ -41,7 +40,7 @@ managing overrides to the helm charts within the application.
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :command:`application-upload` | Upload a new application package. |
| | |
| | This command loads the application's armada manifest and helm charts into an internal database and automatically applies system overrides for well-known helm charts, allowing the helm chart to be applied optimally to the current cluster configuration. |
| | This command loads the application's FluxCD manifest and helm charts into an internal database and automatically applies system overrides for well-known helm charts, allowing the helm chart to be applied optimally to the current cluster configuration. |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :command:`helm-override-list` | List system helm charts and the namespaces with helm chart overrides for each helm chart. |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -57,7 +56,7 @@ managing overrides to the helm charts within the application.
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :command:`application-apply` | Apply or reapply the application manifest and helm charts. |
| | |
| | This command will install or update the existing installation of the application based on its armada manifest, helm charts and helm charts' combined system and user overrides. |
| | This command will install or update the existing installation of the application based on its FluxCD manifest, helm charts and helm charts' combined system and user overrides. |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :command:`application-abort` | Abort the current application operation. |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

6
doc/source/system_configuration/openstack/system-configuration-overview.rst
View File

@ -6,13 +6,13 @@
Overview of Configuring StarlingX OpenStack
===========================================
|prod-os| is installed and managed as an Armada application.
|prod-os| is installed and managed as a system application.
See |prod| System Configuration: :ref:`Application Management
<system-config-helm-package-manager>`, for a description of the application
lifecycle commands for managing an Armada application.
lifecycle commands for managing a system application.
Armada Applications are a set of one or more interdependent Application Helm
System Applications are a set of one or more interdependent Application Helm
Charts. In the case of |prod|, there is generally a Helm Chart for every
OpenStack service.

2
doc/source/updates/kubernetes/software-updates-and-upgrades-software-updates.rst
View File

@ -78,7 +78,7 @@ the |prod| software:
through this mechanism, for example, **platform-integ-apps**.
For software updates for these applications, download the updated
application tarball, containing the updated Armada manifest, and updated
application tarball, containing the updated FluxCD manifest, and updated
Helm charts for the application, and apply the updates using the
:command:`system application-update` command.

2
doc/source/updates/openstack/software-updates-and-upgrades-overview.rst
View File

@ -18,7 +18,7 @@ container image\(s\).
The system application-update -n |prefix|-openstack effectively performs a
helm upgrade of one or more of the OpenStack Helm chart releases within the
Armada Application. One or all of the containerized OpenStack deployments will
FluxCD Application. One or all of the containerized OpenStack deployments will
be updated according to their deployment specification.
.. note::