diff --git a/doc/source/admintasks/kubernetes/freeing-space-in-the-local-docker-registry.rst b/doc/source/admintasks/kubernetes/freeing-space-in-the-local-docker-registry.rst index 4124f077a..30c80a78b 100644 --- a/doc/source/admintasks/kubernetes/freeing-space-in-the-local-docker-registry.rst +++ b/doc/source/admintasks/kubernetes/freeing-space-in-the-local-docker-registry.rst @@ -37,7 +37,6 @@ associated space from the file system. To do so, you must also run the | k8s.gcr.io/kube-proxy | | k8s.gcr.io/kube-scheduler | | k8s.gcr.io/pause | - | quay.io/airshipit/armada | | quay.io/calico/cni | | quay.io/calico/kube-controllers | | quay.io/calico/node | diff --git a/doc/source/admintasks/kubernetes/index-admintasks-kub-ebc55fefc368.rst b/doc/source/admintasks/kubernetes/index-admintasks-kub-ebc55fefc368.rst index 086fa492c..184893a06 100644 --- a/doc/source/admintasks/kubernetes/index-admintasks-kub-ebc55fefc368.rst +++ b/doc/source/admintasks/kubernetes/index-admintasks-kub-ebc55fefc368.rst @@ -21,7 +21,6 @@ Application management :maxdepth: 1 kubernetes-admin-tutorials-helm-package-manager - migrate-releases-from-helm-v2-to-helm-v3-9984e7aa7374 kubernetes-admin-tutorials-starlingx-application-package-manager admin-application-commands-and-helm-overrides diff --git a/doc/source/admintasks/kubernetes/migrate-releases-from-helm-v2-to-helm-v3-9984e7aa7374.rst b/doc/source/admintasks/kubernetes/migrate-releases-from-helm-v2-to-helm-v3-9984e7aa7374.rst deleted file mode 100644 index 67f7a14e7..000000000 --- a/doc/source/admintasks/kubernetes/migrate-releases-from-helm-v2-to-helm-v3-9984e7aa7374.rst +++ /dev/null @@ -1,94 +0,0 @@ -.. _migrate-releases-from-helm-v2-to-helm-v3-9984e7aa7374: - -======================================== -Migrate Releases from Helm v2 to Helm v3 -======================================== - -.. rubric:: |context| - -After upgrading a cluster, end users' Helm releases are not upgraded from -version 2. Run a custom script to migrate the end users' Helm releases or -installs to Helm v3. - -.. rubric:: |proc| - -#. Install the /helm-2to3 plugin. - - .. code-block:: none - - export HELM_LINTER_PLUGIN_NO_INSTALL_HOOK=true - helm plugin install /usr/local/share/helm/plugins/2to3 - -#. Fetch existing helmv2 config. - - .. code-block:: none - - cat >get_helmv2_config.sh<<'EOF' - JSONPATH='{range .items[*]}{"\n"}{@.metadata.name}:{@.metadata.deletionTimestamp}{range @.status.conditions[*]}{":"}{@.type}={@.status}{end}{end}' - ARMADA_PODS=( $(kubectl get pods -n armada \ - --kubeconfig=/etc/kubernetes/admin.conf \ - --selector=application=armada,component=api \ - --field-selector status.phase=Running \ - --output=jsonpath="$JSONPATH") ) - if [ $#ARMADA_PODS[@] -eq 0 ]; then - echo "$NAME: ERROR - Could not find armada pod." - exit 1 - fi# Get first available Running and Ready armada pod, with tiller container - POD="" - for LINE in "$ARMADA_PODS[@]"; do - # match only Ready pods with nil deletionTimestamp - if [[ $LINE =~ ::.*Ready=True ]]; then - # extract pod name, it is first element delimited by : - A=$( cut -d ':' -f 1 - <<< "$LINE" ) - P=$A[0] - else - continue - fi - kubectl --kubeconfig=/etc/kubernetes/admin.conf \ - cp armada/$P:tmp/.helm "$HOME"/.helm -c tiller - RC=$? - if [ $RC -eq 0 ]; then - echo "$NAME: helmv2 config copied to $HOME/.helm" - break - else - echo "$NAME: ERROR - failed to copy helm config from helmv2 (tiller) to host. (RETURNED: $RC)" - exit 1 - fi - done - EOF - - -#. Move the helm2 config to helm3. - - .. code-block:: none - - ~(keystone-admin)]$ helm 2to3 move config - -#. Choose a Helm v2 release to migrate. - - .. code-block:: none - - ~(keystone-admin)]$ helmv2-cli -- helm list -a - -#. Migrate a helm2 release, for example, myApplication. - - .. code-block:: none - - ~(keystone-admin)]$ migrate_helm_release.py myApplication - - .. note:: - - The script ``migrate_helm_release.py`` is part of the |prod| release - package. - -#. Check if it migrated successfully. - - .. code-block:: none - - ~(keystone-admin)]$ helm list -A -a - -#. The migrated release should not appear in helm2. - - .. code-block:: none - - ~(keystone-admin)]$ helmv2-cli -- helm list -a diff --git a/doc/source/index.rst b/doc/source/index.rst index a0b40e380..bfa0ba5a3 100755 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -5,9 +5,10 @@ Welcome to the StarlingX Documentation StarlingX is a fully integrated edge cloud software stack that provides everything needed to deploy an edge cloud on one, two, or up to 100 servers. -**The most recent supported release is StarlingX R9.0.** +**The most recent supported release is StarlingX R10.0.** + +* See the :ref:`Release Notes `. -* See the :ref:`release-notes`. * Download the pre-built ISO (CentOS and Debian) and Docker images for StarlingX latest release that are located at the ``StarlingX mirror`` repos: diff --git a/doc/source/operations/k8s_cluster.rst b/doc/source/operations/k8s_cluster.rst index e1f46b56e..07776a872 100644 --- a/doc/source/operations/k8s_cluster.rst +++ b/doc/source/operations/k8s_cluster.rst @@ -93,7 +93,7 @@ Kubernetes * Persistent Volume Claims backed by Ceph * Local Docker Registry * Helm/Tiller – Kubernetes Package Manager - * FluxCD or Armada Airship (deprecated) + * FluxCD ---------------------------- Kubernetes cluster interface diff --git a/doc/source/releasenotes/index.rst b/doc/source/releasenotes/index.rst index 0b19fcead..bd6a41531 100644 --- a/doc/source/releasenotes/index.rst +++ b/doc/source/releasenotes/index.rst @@ -4,11 +4,12 @@ .. _release-notes: -.. _r8-0-release-notes-6a6ef57f4d99: +.. The Stx 10.0 RN is WIP and not ready for review. +.. Removed appearances of Armada as its not supported -================== -R9.0 Release Notes -================== +=================== +R10.0 Release Notes +=================== .. rubric:: |context| @@ -531,13 +532,14 @@ to the SR-IOV port. **Workaround**: Manually Power-Off and Power-On (or Hard-Reboot) the instance and the IP should be assigned correctly again (no information is lost). +.. Cole please + ***************************************** Error on Restoring OpenStack after Backup ***************************************** -The ansible command for restoring the app will fail with |prod-long| -Release 22.12 Patch 4 (MR2) with an error message mentioning the absence of an -Armada directory. +The ansible command for restoring the app will fail with |prod-long| Release 9.0 +with an error message mentioning the absence of an Armada directory. **Workaround**: Manually change the backup tarball adding the Armada directory using the following the steps: @@ -1279,10 +1281,10 @@ Using Helm with Container-Backed Remote CLIs and Clients If **Helm** is used within Container-backed Remote CLIs and Clients: - You will NOT see any helm installs from |prod| Platform's system - Armada applications. + FluxCD applications. **Workaround**: Do not directly use **Helm** to manage |prod| Platform's - system Armada applications. Manage these applications using + system FluxCD applications. Manage these applications using :command:`system application` commands. - You will NOT see any helm installs from end user applications, installed @@ -1499,7 +1501,14 @@ Airship Armada is deprecated .. note:: - Airship Armada will be removed in stx.9.0. + Airship Armada is removed in stx.9.0 and replaced with FluxCD. All Armada + based applications have to be removed before you perform an + upgrade from |prod-long| Release 9.0 to |prod-long| Release 10.0. + +.. note:: + + Some application repositories may still have "armada" in the file path but + are now supported by FluxCD. See https://opendev.org/starlingx/?sort=recentupdate&language=&q=armada. StarlingX Release 7.0 introduces FluxCD based applications that utilize FluxCD Helm/source controller pods deployed in the flux-helm Kubernetes namespace. @@ -1560,23 +1569,23 @@ You can find details about a release on the specific release page. - :abbr:`EOL (End of Life)` * - StarlingX R4.0 - 2020-08 - - + - - :abbr:`EOL (End of Life)` * - StarlingX R3.0 - 2019-12 - - + - - :abbr:`EOL (End of Life)` * - StarlingX R2.0.1 - 2019-10 - - + - - :abbr:`EOL (End of Life)` * - StarlingX R2.0 - 2019-09 - - + - - :abbr:`EOL (End of Life)` * - StarlingX R12.0 - 2018-10 - - + - - :abbr:`EOL (End of Life)` diff --git a/doc/source/usertasks/kubernetes/index-usertasks-kub-1291759aa985.rst b/doc/source/usertasks/kubernetes/index-usertasks-kub-1291759aa985.rst index 40ccdf74e..978683b22 100644 --- a/doc/source/usertasks/kubernetes/index-usertasks-kub-1291759aa985.rst +++ b/doc/source/usertasks/kubernetes/index-usertasks-kub-1291759aa985.rst @@ -57,7 +57,6 @@ Application management :maxdepth: 1 kubernetes-user-tutorials-helm-package-manager - migrate-releases-from-helm-v2-to-helm-v3-a6066193c2a8 --------------------- Local Docker registry diff --git a/doc/source/usertasks/kubernetes/migrate-releases-from-helm-v2-to-helm-v3-a6066193c2a8.rst b/doc/source/usertasks/kubernetes/migrate-releases-from-helm-v2-to-helm-v3-a6066193c2a8.rst deleted file mode 100644 index 9db1cde95..000000000 --- a/doc/source/usertasks/kubernetes/migrate-releases-from-helm-v2-to-helm-v3-a6066193c2a8.rst +++ /dev/null @@ -1,94 +0,0 @@ -.. _migrate-releases-from-helm-v2-to-helm-v3-a6066193c2a8: - -======================================== -Migrate Releases from Helm v2 to Helm v3 -======================================== - -.. rubric:: |context| - -After upgrading a cluster, end users' Helm releases are not upgraded from -version 2. Run a custom script to migrate the end users' Helm releases or -installs to Helm v3. - -.. rubric:: |proc| - -#. Install the /helm-2to3 plugin. - - .. code-block:: none - - export HELM_LINTER_PLUGIN_NO_INSTALL_HOOK=true - helm plugin install /usr/local/share/helm/plugins/2to3 - -#. Fetch existing helmv2 config. - - .. code-block:: none - - cat >get_helmv2_config.sh<<'EOF' - JSONPATH='{range .items[*]}{"\n"}{@.metadata.name}:{@.metadata.deletionTimestamp}{range @.status.conditions[*]}{":"}{@.type}={@.status}{end}{end}' - ARMADA_PODS=( $(kubectl get pods -n armada \ - --kubeconfig=/etc/kubernetes/admin.conf \ - --selector=application=armada,component=api \ - --field-selector status.phase=Running \ - --output=jsonpath="$JSONPATH") ) - if [ $#ARMADA_PODS[@] -eq 0 ]; then - echo "$NAME: ERROR - Could not find armada pod." - exit 1 - fi# Get first available Running and Ready armada pod, with tiller container - POD="" - for LINE in "$ARMADA_PODS[@]"; do - # match only Ready pods with nil deletionTimestamp - if [[ $LINE =~ ::.*Ready=True ]]; then - # extract pod name, it is first element delimited by : - A=$( cut -d ':' -f 1 - <<< "$LINE" ) - P=$A[0] - else - continue - fi - kubectl --kubeconfig=/etc/kubernetes/admin.conf \ - cp armada/$P:tmp/.helm "$HOME"/.helm -c tiller - RC=$? - if [ $RC -eq 0 ]; then - echo "$NAME: helmv2 config copied to $HOME/.helm" - break - else - echo "$NAME: ERROR - failed to copy helm config from helmv2 (tiller) to host. (RETURNED: $RC)" - exit 1 - fi - done - EOF - - -#. Move the helm2 config to helm3. - - .. code-block:: none - - ~(keystone-admin)]$ helm 2to3 move config - -#. Choose a Helm v2 release to migrate. - - .. code-block:: none - - ~(keystone-admin)]$ helmv2-cli -- helm list -a - -#. Migrate a helm2 release, for example, myApplication. - - .. code-block:: none - - ~(keystone-admin)]$ migrate_helm_release.py myApplication - - .. note:: - - The script ``migrate_helm_release.py`` is part of the |prod| release - package. - -#. Check if it migrated successfully. - - .. code-block:: none - - ~(keystone-admin)]$ helm list -A -a - -#. The migrated release should not appear in helm2. - - .. code-block:: none - - ~(keystone-admin)]$ helmv2-cli -- helm list -a