diff --git a/doc/source/_includes/configuration-changes-requiring-re-installation.rest b/doc/source/_includes/configuration-changes-requiring-re-installation.rest new file mode 100644 index 000000000..859e99677 --- /dev/null +++ b/doc/source/_includes/configuration-changes-requiring-re-installation.rest @@ -0,0 +1,3 @@ +.. configuration-changes-begin + +.. configuration-changes-end diff --git a/doc/source/_includes/enroll-a-factory-installed-nondc-standalone-system.rest b/doc/source/_includes/enroll-a-factory-installed-nondc-standalone-system.rest new file mode 100644 index 000000000..3844284f8 --- /dev/null +++ b/doc/source/_includes/enroll-a-factory-installed-nondc-standalone-system.rest @@ -0,0 +1,19 @@ + +.. dmnote-begin +.. dmnote-end + +.. dm-playbook-overrides-begin +.. dm-playbook-overrides-end + +.. deployment-config-begin +.. deployment-config-end + +.. setup-stage-checks-begin +.. setup-stage-checks-end + +.. bootstrap-values-begin +.. bootstrap-values-end + +.. dmconfiguration-begin +.. dmconfiguration-end + diff --git a/doc/source/_includes/single-physical-core-for-platform-function-in-all-in-one-deployments-bec61d5a13f4.rest b/doc/source/_includes/single-physical-core-for-platform-function-in-all-in-one-deployments-bec61d5a13f4.rest index 691fc7ab8..f1ac714fb 100644 --- a/doc/source/_includes/single-physical-core-for-platform-function-in-all-in-one-deployments-bec61d5a13f4.rest +++ b/doc/source/_includes/single-physical-core-for-platform-function-in-all-in-one-deployments-bec61d5a13f4.rest @@ -1,2 +1,5 @@ .. deploy-begin -.. deploy-end \ No newline at end of file +.. deploy-end + +.. number-of-cores-begin +.. number-of-cores-end diff --git a/doc/source/dist_cloud/kubernetes/enroll-a-factory-installed-nondc-standalone-system-as-a-s-87b2fbf81be3.rst b/doc/source/dist_cloud/kubernetes/enroll-a-factory-installed-nondc-standalone-system-as-a-s-87b2fbf81be3.rst index 3913e41fa..f33e53501 100644 --- a/doc/source/dist_cloud/kubernetes/enroll-a-factory-installed-nondc-standalone-system-as-a-s-87b2fbf81be3.rst +++ b/doc/source/dist_cloud/kubernetes/enroll-a-factory-installed-nondc-standalone-system-as-a-s-87b2fbf81be3.rst @@ -263,8 +263,13 @@ The host configuration files must be specified under .. note:: Only ``localhost.yml`` is provided as part of the base configuration. It is - a sample placeholder that must be updated. The Deployment Manager - configuration and overrides file must be created. + a sample placeholder that must be updated. + +.. only:: partner + + .. include:: /_includes/enroll-a-factory-installed-nondc-standalone-system.rest + :start-after: dmnote-begin + :end-before: dmnote-end **``localhost.yml``** @@ -330,42 +335,17 @@ Example: system_local_ca_cert: system_local_ca_key -**dm-playbook-overrides.yaml** +.. only:: partner -.. note:: + .. include:: /_includes/enroll-a-factory-installed-nondc-standalone-system.rest + :start-after: dm-playbook-overrides-begin + :end-before: dm-playbook-overrides-end - This file name needs to be the same as given, otherwise automation services - will fail to find the file. +.. only:: partner -This file is only used to support the installation of Deployment Manager. - -.. code-block:: - - deployment_config:/home/sysadmin/deployment-config.yaml - deployment_manager_overrides: - /usr/local/share/applications/overrides/wind-river-cloud-platform-deployment-manager-overrides.yaml - deployment_manager_chart: - /usr/local/share/applications/helm/wind-river-cloud-platform-deployment-manager-.tgz - ansible_become_pass:#sysadminpassword - -**deployment-config.yaml** - -The ``deployment-config.yaml`` file contains configurations to be applied by -Deployment Manager to the system during the factory installation. The values in -``deployment-config.yaml`` can be used in different deployment options, -however, below are some of the guidelines that must be met: - -- Only controller-0 will be provisioned and configured during the - factory installation. The other hosts profiles should be removed from - ``deployment-config.yaml``. - -- Controller-0 should be administratively unlocked before the enrollment process. - -- Controller-0 should be reconciled at the end of the factory installation - process to be valid for enrollment. - -- Storage backends, filesystems, memory, and processors should be specified in - the configuration. + .. include:: /_includes/enroll-a-factory-installed-nondc-standalone-system.rest + :start-after: deployment-config-begin + :end-before: deployment-config-end ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ (Optional) Prepare Custom Setup, Checks, and Tests Script @@ -430,46 +410,11 @@ before proceeding with platform-automation. exit 0 -**Setup stage checks (Post-deployment-unlock)** +.. only:: partner -The scripts in ``nocloud-factory-install/factory-install/setup/`` are run after -the host is unlocked by Deployment Manager during the setup stage. For example, -``nocloud-factory-install/factory-install/setup/10-system-setup`` ensures that -the host is fully reconciled before proceeding. - -.. code-block:: - - nocloud-factory-install/factory-install/setup/10-system-setup - echo "System Setup - Start" - - echo "Wait - host goenabled" - until [ -f /var/run/goenabled ]; do - sleep 10 - done - echo "Ready - host goenabled" - - system_mode=$(awk - F= '/system_mode/ {print $2}' /etc/platform/platform.conf) - - echo "Wait - system deployment reconciled" - while true; do - if [ "$system_mode" = "duplex" ]; then - SYSTEM_RECONCILED=true - else - SYSTEM_RECONCILED=$(kubectl --kubeconfig=/etc/kubernetes/admin.conf -n deployment - fi - - HOST_RECONCILED=$(kubectl --kubeconfig=/etc/kubernetes/admin.conf -n deployment get ho - - if [ "$SYSTEM_RECONCILED" = true ] && [ "$HOST_RECONCILED" = true ]; then - break - fi - sleep10 - done - echo "Ready - system deployment reconciled" - - echo "System Setup - Complete" - - exit0 + .. include:: /_includes/enroll-a-factory-installed-nondc-standalone-system.rest + :start-after: setup-stage-checks-begin + :end-before: setup-stage-checks-end **Final checks** @@ -671,39 +616,11 @@ controller and the subcloud via |OAM| network. bmc_username: bmc username bootstrap_vlan: vlanID for the bootstrap interface -**Bootstrap values** +.. only:: partner -Bootstrap values are used during the enrollment process to update the required -configurations for essential services before Deployment Manager can update the -other configurations. - -.. code-block:: - - # values to be set to the oam network - external_oam_subnet - external_oam_gateway_address - external_oam_floating_address - external_oam_node_0_address - external_oam_node_1_address - - # values to be set to the admin network - admin_subnet: - admin_start_address: - admin_end_address: - admin_gateway_address: - - # MGMT network values are only updated on Simplex system without admin network configured. - # Cluster networks, pxeboot_subnet values are ignored - # system type, system mode, name are ignored - - systemcontroller_gateway_address: - - docker_http_proxy: - docker_no_proxy: - docker_registries: - dns_servers: - - # The other values are ignored + .. include:: /_includes/enroll-a-factory-installed-nondc-standalone-system.rest + :start-after: bootstrap-values-begin + :end-before: bootstrap-values-end **Deployment configurations** @@ -719,9 +636,11 @@ should be similar to the original deployment. - Hosts should be administratively unlocked in this configuration. -- Deployment Manager will ignore any network change at this stage. The network - reconfiguration should be controlled by the bootstrap values. +.. only:: partner + .. include:: /_includes/enroll-a-factory-installed-nondc-standalone-system.rest + :start-after: dmconfiguration-begin + :end-before: dmconfiguration-end *************************** Perform Subcloud Enrollment diff --git a/doc/source/node_management/kubernetes/host_hardware_management/configuration-changes-requiring-re-installation.rst b/doc/source/node_management/kubernetes/host_hardware_management/configuration-changes-requiring-re-installation.rst index e2b30cf98..f9cae31bf 100644 --- a/doc/source/node_management/kubernetes/host_hardware_management/configuration-changes-requiring-re-installation.rst +++ b/doc/source/node_management/kubernetes/host_hardware_management/configuration-changes-requiring-re-installation.rst @@ -10,49 +10,57 @@ Some configuration changes require a system or host re-add. .. _configuration-changes-requiring-re-installation-table-d2t-yjs-kfb: -.. table:: Table 1. Configuration Changes Requiring Reinstallation - :widths: auto +.. only:: starlingx - +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Change | Reinstall | Comments | - +==============================================================+=================+====================================================================================================================================================================================================================================================================================================================================+ - | Product type change | System | To change between Standard and All-in-one, you must perform a system reinstallation. | - +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | PXE boot network addition or removal | System | You must perform a system reinstallation. | - +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Management network subnet or range changes | System | You must perform a system reinstallation. | - +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Cluster-host subnet or range changes | System | You must perform a system reinstallation. | - +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Legacy BIOS to UEFI change | System | You must perform a system reinstallation. | - +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Security profile change | System | You must perform a system reinstallation. | - +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Controller filesystem size decrease | System | To decrease the controller filesystem size, you must perform a system reinstallation. | - +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Root disk replacement | Host (re-add) | To install the OpenStack application on a new disk, the host must be deleted and re-added (not merely reinstalled). | - +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Replacement of storage disk on SAS controller | Host (re-add) | Due to a limitation in **udev**, the device path of a disk connected through a SAS controller changes when the disk is replaced. You must lock, delete, and re-install the node. Once this is done, it is advisable to replace any storage profiles associated with the host, since the old storage profile is no longer accurate. | - +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Aborted upgrade after controller-1 and controller-0 upgraded | System | You must perform a system reinstallation. | - +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Subcloud delete and re-add | System | The subcloud system must be reinstalled. | - +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Configuration commands run from SSH | System | An error occurs if any of the :command:`sw-patch install-local` command is run from an SSH session. | - | | | | - | | | To recover, you must reinstall the system. | - +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Developer certificate or update removal | System | Required to correct Alarm 500.100 | - +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Management network netmask correction on a Duplex system | System | On a Duplex system, the minimum management netmask is /28. | - +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Host version mismatch | Host (re-add) | Required to correct Alarm 900.003 | - | | | | - | | | .. note:: | - | | | To register the new software version for Host Inventory management, the host must be deleted and re-added (not merely reinstalled) | - +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Host memory module addition or removal | Host (re-add) | For example, use ``system host-delete``, followed by ``system host-add``, or ``system host-update``, as the host may be re-added automatically by the system on discovery. Optionally, with Deployment Manager, follow the Node replacement procedure. | - +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + .. table:: Table 1. Configuration Changes Requiring Reinstallation + :widths: auto + + +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Change | Reinstall | Comments | + +==============================================================+=================+====================================================================================================================================================================================================================================================================================================================================+ + | Product type change | System | To change between Standard and All-in-one, you must perform a system reinstallation. | + +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | PXE boot network addition or removal | System | You must perform a system reinstallation. | + +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Management network subnet or range changes | System | You must perform a system reinstallation. | + +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Cluster-host subnet or range changes | System | You must perform a system reinstallation. | + +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Legacy BIOS to UEFI change | System | You must perform a system reinstallation. | + +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Security profile change | System | You must perform a system reinstallation. | + +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Controller filesystem size decrease | System | To decrease the controller filesystem size, you must perform a system reinstallation. | + +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Root disk replacement | Host (re-add) | To install the OpenStack application on a new disk, the host must be deleted and re-added (not merely reinstalled). | + +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Replacement of storage disk on SAS controller | Host (re-add) | Due to a limitation in **udev**, the device path of a disk connected through a SAS controller changes when the disk is replaced. You must lock, delete, and re-install the node. Once this is done, it is advisable to replace any storage profiles associated with the host, since the old storage profile is no longer accurate. | + +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Aborted upgrade after controller-1 and controller-0 upgraded | System | You must perform a system reinstallation. | + +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Subcloud delete and re-add | System | The subcloud system must be reinstalled. | + +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Configuration commands run from SSH | System | An error occurs if any of the :command:`sw-patch install-local` command is run from an SSH session. | + | | | | + | | | To recover, you must reinstall the system. | + +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Developer certificate or update removal | System | Required to correct Alarm 500.100 | + +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Management network netmask correction on a Duplex system | System | On a Duplex system, the minimum management netmask is /28. | + +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Host version mismatch | Host (re-add) | Required to correct Alarm 900.003 | + | | | | + | | | .. note:: | + | | | To register the new software version for Host Inventory management, the host must be deleted and re-added (not merely reinstalled) | + +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Host memory module addition or removal | Host (re-add) | For example, use ``system host-delete``, followed by ``system host-add``, or ``system host-update``, as the host may be re-added automatically by the system on discovery. | + +--------------------------------------------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. only:: partner + + .. include:: /_includes/configuration-changes-requiring-re-installation.rest + :start-after: configuration-changes-begin + :end-before: configuration-changes-end .. xbooklink - Comments in tables are not respected. These rows need to be restored as the xrefs come available: diff --git a/doc/source/node_management/kubernetes/single-physical-core-for-platform-function-in-all-in-one-deployments-bec61d5a13f4.rst b/doc/source/node_management/kubernetes/single-physical-core-for-platform-function-in-all-in-one-deployments-bec61d5a13f4.rst index 01f771e8a..fccfd69d0 100644 --- a/doc/source/node_management/kubernetes/single-physical-core-for-platform-function-in-all-in-one-deployments-bec61d5a13f4.rst +++ b/doc/source/node_management/kubernetes/single-physical-core-for-platform-function-in-all-in-one-deployments-bec61d5a13f4.rst @@ -30,8 +30,11 @@ System Engineering Guidelines. During an upgrade process, the CPU platform configuration will be retained. -The number of cores allocated to the platform function can be changed through -the system API and thru deployment manager. +.. only:: partner + + .. include:: /_includes/single-physical-core-for-platform-function-in-all-in-one-deployments-bec61d5a13f4.rest + :start-after: number-of-cores-begin + :end-before: number-of-cores-end System API: