Chapter 5. Documentation changes This section details the major documentation updates delivered with Red Hat OpenStack Platform (RHOSP) 17.0, and the changes made to the documentation set that include adding new features, enhancements, and corrections. The section also details the addition of new titles and the removal of retired or replaced titles. Table 5.1. Table legend Column Meaning Date The date that the documentation change was published. 17.0 versions impacted The RHOSP 17.0 versions that the documentation change impacts. Unless stated otherwise, a change that impacts a particular version also impacts all later versions. Components The RHOSP components that the documenation change impacts. Affected content The RHOSP documents that contain the change or update. Description of change A brief summary of the change to the document. Table 5.2. Document changes Date 17.0 versions impacted Components Affected content Description of change 20 October 2023 17.0 Networking Exporting the DNS service pool configuration Updated the procedure to describe how to run the command inside a container. 04 October 2023 17.0 Networking Enabling custom composable networks Removing an overcloud stack Replaced networks definition file, network_data.yaml , with network_data_v2.yaml . 29 September 2023 17.0 Security Federal Information Processing Standard on Red Hat OpenStack Platform Corrected procedure so that FIPS images are uploaded to glance 11 September 2023 17.1 Networking Chapter 20. Replacing Controller nodes Changes made to Chapter 20 to address the OVN database partition issue described in BZ 2222543 07 September 2023 17.1 Networking QoS rules To Table 9.1, added footnote (#8) stating that RHOSP does not support QoS for trunk ports. 30 August 2023 17.1 Networking Overview of allowed address pairs Added a definition for a virtual port (vport). 30 August 2023 17.0 Security Creating images Removed deprecated example for building images and replaced with link to image builder documentation 10 August 2023 17.0 Security link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/17.0/html/users_and_identity_management_guide/assembly_application-credentials#proc_replacing-application-credentials_application-credentials Procedure on replacing applications credentials in undercloud.conf is rewritten to specify need for user credentials, provides more details. 07 August 2023 17.0 Security link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/17.0/html/security_and_hardening_guide/ Chapter 'Rotating service account passwords' uses a deprecated mistral workflow for execution, and has been removed. 07 August 2023 17.0 Security Replacing Application Credentials . Procedure requires use of --unrestricted flag which is not recommended; procedure is removed. 20 July 2023 17.0 All-in-One Deploying the all-in-one Red Hat OpenStack Platform environment Procedure is updated with corrected path to clouds.yaml . 12 July 2023 17.0 Security Implementing TLS-e with Ansible This procedure is updated with an optional step that is needed when the IdM domain and IDM realm do not match 27 June 2023 17.0 Edge link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/17.0/html/distributed_compute_node_and_storage_deployment/precaching-glance-images-into-nova#proc_ansible-image-cache-playbook_precaching-glance-images The procedure is updated to remove the deprecated way of producing an ansible inventory in Red Hat OpenStack Platform 21 June 2023 17.0 Networking Creating Linux bonds The example has changed for the "Linux bond set to 802.3ad LACP mode with one VLAN." 20 June 2023 17.0 Networking Adding a new leaf to a spine-leaf deployment Example for flat network mappings (step 7) updated. 13 June 2023 17.0 Networking Load-balancing service (octavia) feature support matrix Items added that specify no support for SR-IOV and DPDK. 25 May 2023 17.0 Networking Adding a composable network Removed what was previously labeled step 9, assigning predictable virtual IPs for Redis and OVNDBs. 23 May 2023 17.0 Networking Configuring existing BIND servers for the DNS service Labeled the feature integrating the RHOSP DNS service with an existing BIND infrastructure as technology preview. 11 May 2023 17.0 Networking Enabling VLAN transparency in ML2/OVN deployments Added a new step that instructs users to set --allowed-address on the VM port. 4 May 2023 17.0 Validation Framework Starting the undercloud in the High Availability for Compute Instances guide Starting the undercloud in the Director Installation and Usage guide Step 4 has been changed. The option --group pre-introspection has been added. 26 April 2023 17.0 Validation framework Running validation using the validation framework Updated Ansible inventory location and Ansible commands. 19 April 2023 17.0 Networking Networking guide Introduction to the OpenStack Dashboard Using Designate for DNS-as-a-Service Added "/puppet-generated" to various configuration file paths. 18 April 2023 17.0 Compute Configuring NVDIMM Compute nodes to provide persistent memory for instances The "Configuring NVDIMM Compute nodes to provide persistent memory for instances" content has been removed from the Configuring the Compute Service for Instance Creation guide. Red Hat has removed support for persistent memory from RHOSP 17.0 and future releases in response to the announcement by the Intel Corporation on July 28, 2022 that they are discontinuing investment in their Intel(R) OptaneTM business: Intel(R) OptaneTM Business Update: What Does This Mean for Warranty and Support Intel(R) Product Change Notification #119311-00 12 April 2023 17.0 Compute Migration constraints Updated the configuration to minimize packet loss when live migrating instances in an ML2/OVS deployment. 10 April 2023 17.0 Security Removing services from the overcloud firewall Removed invalid parameter/value pair "action: accept" from firefwall.yaml in example provided in step 2. 05 April 2023 17.0 Storage Chapter 6. Configuring the Shared File Systems service (manila) Chapter 7. Performing operations with the Shared File Systems service (manila) The Shared File Systems service (manila) content in the Storage Guide has been reorganized into two separate chapters for configuration and operations. 23 Mar 2023 17.0 Networking Configuring VLAN provider networks Step 1 under "Verification steps" has been changed. The --external and --share options have been removed. 23 Mar 2023 17.0 Security and Hardening Adding services to the overcloud firewall The example of ~/templates/firewall.yaml is updated. 23 Mar 2023 17.0 Networking Fixing OVN controllers that fail to register on edge sites A step has been added to the resolution. 20 Mar 2023 17.0 Security Replacing the IdM server for Red Hat OpenStack Platfrom with a replica A new procedure is added to ensure that critical parameters are validated to avoid future deployment failures. 16 Mar 2023 17.0 Storage Deploying Red Hat Ceph Storage and Red Hat OpenStack Platform together with director Deploying the Shared File Systems service with CephFS through NFS has been removed from the Customer Portal and the content has been moved to Deploying Red Hat Ceph Storage and Red Hat OpenStack Platform together with director . 07 Mar 2023 17.0 NFV Network Functions Virtualization Planning and Configuration Guide Code snippets that contain the devname parameter have been replaced with the address parameter. 07 Mar 2023 17.0 NFV Configuring trust between virtual and physical functions The step that instructs users to "Modify permissions to allow users the capability of creating and updating port bindings" (step 3) has been removed. 06 Mar 2023 17.0 Networking Chapter 13. Configuring distributed virtual routing (DVR) The topic "Deploying DVR with ML2 OVS" has been removed from the Networking Guide . 02 Mar 2023 17.0 Storage Deploying Red Hat Ceph Storage and Red Hat OpenStack Platform together with director Deploying the Shared File Systems service with native CephFS has been removed from the Customer Portal and the content has been moved to Deploying Red Hat Ceph Storage and Red Hat OpenStack Platform together with director . 01 Mar 2023 17.0 Compute and NFV Enabling RT-KVM for NFV Workloads Chapter 15, "Configuring real-time compute," has been moved from the Configuring the Compute Service for Instance Creation guide to the Network Functions Virtualization Planning and Configuration Guide . 28 Feb 2023 17.0 Hardware Provisioning Configuration considerations for overcloud storage nodes Provisioning bare metal nodes for the overcloud Added guidance on configuring local disk partition sizes that meet the storage and retention requirements for your storage nodes. Added an optional step, step 6, to the "Provisioning bare metal nodes for the overcloud" procedure, to configure the disk partition size allocations if the default disk partition sizes do not meet your requirements. 27 Feb 2023 17.0 Networking Chapter 4. Configuring the overcloud Rewrote this chapter to capture deployment changes introduced in RHOSP 17.0. 27 Feb 2023 17.0 Edge Updating the central location Using external Ceph keys Using a pre-installed Red Hat Ceph Storage cluster at the edge Fixed the environment file name used within the procedures. 27 Feb 2023 17.0 Hardware Provisioning Removing failed bare-metal nodes from the node definition file Added a new procedure on how to remove a failed bare-metal node if the node provisioning fails because of a node hardware or network configuration failure. 23 Feb 2023 17.0 Networking, Compute Enabling VLAN transparency in ML2/OVN deployments Previously, this procedure instructed you to set the MTU on the network. The updated procedure correctly instructs you to set the MTU on the VLAN interface of each participating VM. 22 Feb 2023 17.0 Networking Chapter 17. Configuring allowed address pairs There were several instances of arguments that used underscores (_) instead of hypens (-). 09 Feb 2023 17.0 CloudOps, Storage Storage Guide Deployment Recommendations for Specific Red Hat OpenStack Platform Services has been removed from the Customer Portal. For information about recommendations for the Object Storage service (swift), see Configuring the Object Storage service (swift) in the Storage Guide . 08 Feb 2023 17.0 NFV NFV BIOS settings Added a note about enabling SR-IOV global and NIC settings in the BIOS. 02 Feb 2023 17.0.1 Compute Creating an image for UEFI Secure Boot Image configuration parameters Flavor metadata Added content for the UEFI Secure Boot feature: New procedure for creating an image for UEFI Secure Boot. Image properties required for a UEFI Secure Boot image: os_secure_boot , hw_firmware_type , and hw_machine_type . Flavor metadata property to enable Secure Boot for instances launched with this flavor: os:secure_boot . 31 Jan 2023 17.0 Networking Configuring Network service availability zones with ML2/OVN Included new RHOSP heat parameter, OVNAvailabilityZone . 31 Jan 2023 17.0 NFV Supported Configurations for NFV Deployments and Chapter 7. Planning your OVS-DPDK deployment Note added stating that a Support Exception from Red Hat Support is needed to use OVS-DPDK on non-NFV workloads. 27 Jan 2023 17.0 Updates Chapter 1. Preparing for a minor update Removed topic about EUS repositories. 25 Jan 2023 17.0 Storage Volume allocation on multiple back ends The former Block Storage topic: Specifying back ends for volume creation, has been replaced with: Volume allocation on multiple back ends. 25 Jan 2023 17.0 Updates Chapter 3. Updating the overcloud Removed bullet point from list in Section 3.3 due to software fix. 23 Jan 2023 17.0 Networking Chapter 20. Using availability zones to make network resources highly available Several changes made to identify the distributed compute node (DCN) use case. 17 Jan 2023 17.0 Networking Chapter 2. Working with ML2/OVN Two topics have been added to Chapter 2: "Deploying a custom role with ML2/OVN" and "SR-IOV with ML2/OVN and native OVN DHCP." 17 Jan 2023 17.0 Edge Deploy the edge without storage Removed redundant step from procedure to deploy storage at the edge 16 Jan 2023 17.0 Networking Configuring a DHCP relay Added an important admonition about requiring option 79 for some DHCP relays. 13 Jan 2023 17.0 Edge Deploying storage at the edge Replaced instances of deprecated file dcn-hci.yaml with dcn-storage.yaml 13 Jan 2023 17.0 Edge Deploying storage at the edge Including the necessary deployed_ceph.yaml and central_ceph_external.yaml in example deploy command. 13 Jan 2023 17.0 Edge Using a pre-installed Red Hat Ceph Storage cluster at the edge Changed output directory of openstack overcloud export ceph to for consistency across guide 11 Jan 2023 17.0 Edge Installing the central location Fixed ceph deployment to include --stack central parameter and value 22 Dec 2023 17.0 Network Functions Virtualization Network Functions Virtualization Product Guide Removed guide because RHOSP 17.0 does not support Network Functions Virtualization (NFV). 22 Dec 2023 17.0 Network Functions Virtualization Network Functions Virtualization Planning and Configuration Guide Removed guide because RHOSP 17.0 does not support NFV. 22 Dec 2022 17.0 Security Hardening infrastructure and virtualization Added procedures for investigating and modifying containers 22 Dec 2022 17.0 Security Increasing the size of private keys Added procedure for increasing the default size of private keys 21 Dec 2022 17.0 Compute Flavor metadata Added a note about considering the underlying host OS when you use the quota:cpu_* extra specs to tune the instance CPU resource use limits. 20 Dec 2022 17.0 Networking Configuring Network service availability zones with ML2/OVN Changes have been made to steps 4 and 5. 20 Dec 2022 17.0 Edge Deploying edge nodes without storage Step two is updated, you are not required to generate the DistributedComputeScaleOut role 09 Dec 2022 17.0 Networking Configuring the Networking service for QoS policies The step (7.ii.) about resource provider hypervisors has changed. 08 Dec 2022 17.0 Networking OVN metadata agent on Compute nodes The corresponding OVN metadata namespace for Virtual Machine (VM) instances on Compute nodes has changed from ovnmeta-<datapath_uuid> to ovnmeta-<network_uuid> . 08 Dec 2022 17.0 Networking QoS rules A footnote was added to Table 9.1 stating that ML2/OVN does not support DSCP marking QoS policies on tunneled protocols. 30 Nov 2022 17.0 Networking Configuring Load-balancing service flavors The three topics in Chapter 6, "Configuring Load-balancing service flavors," erroneously instructed users to access the undercloud to run certain OpenStack commands. Instead, users should access the overcloud. 30 Nov 2022 17.0 Security Authenticating with keystone Added procedure to stop repeated failed logins 23 Nov 2022 17.0 Hardware Provisioning Provisioning bare metal nodes for the overcloud Updated the guidance on how to configure the href image property in the node definition file. 22 Nov 2022 17.0 Storage Creating and Managing Images Updated procedures to use the Image service (glance) command-line client instead of the Dashboard service (horizon) to create and manage images. 9 Nov 2022 17.0 Updates Performing a minor update of a containerized undercloud Updated the dnf update command from USD sudo dnf update -y python3-tripleoclient* ansible to USD sudo dnf update -y python3-tripleoclient ansible-* 7 Nov 2022 17.0 Updates Running the overcloud update preparation Added a prerequisite to regenerate custom NIC templates. 28 Oct 2022 17.0 Backup and Restore Installing ReaR on the undercloud node Installing ReaR on the control plane nodes Updated the command that you use to extract the static ansible inventory file. 20 Oct 2022 17.0 Compute Configuring filters and weights for the Compute scheduler service Updated the NovaSchedulerDefaultFilters parameter to NovaSchedulerEnabledFilters . 19 Oct 2022 17.0 DCN Configuring routed spine-leaf in the undercloud Added procedure for configuring spine/leaf networking on the undercloud. 19 Oct 2022 17.0 DCN Replacing DistributedComputeHCI nodes Added procedure for replacing a DCN node. 19 Oct 2022 17.0 Validation Director Installation and Usage guide Replaced tripleo validation commands with the new CLI validation commands. 19 Oct 2022 17.0 Validation Creating a validation Added procedural content about creating a validation. 19 Oct 2022 17.0 Validation Changing the validation configuration file Added procedural content about changing the validation configuration file. 14 Oct 2022 17.0 Identity Users and Identity Management Guide Added procedural content about changing the default region name. 14 Oct 2022 17.0 Identity Users and Identity Management Guide Added conceptual information about resource credential files. 14 Oct 2022 17.0 Hardware Provisioning Provisioning and deploying your overcloud Updated the provisioning step to include details on how to use your own templates instead of the default templates when provisioning the network resources for your physical networks, and when provisioning your bare metal nodes. 11 Oct 2022 17.0 Networking Configuring bridge mappings Two steps have been added to this procedure that enable customers to change the network name from the default, datacentre . 04 Oct 2022 17.0 Networking Configuring the Networking service for QoS policies The example for the SRIOV agent has changed in the in the Networking Guide topic, "Configuring the Networking service for QoS policies." 03 Oct 2022 17.0 Networking Network definition file configuration options The default value for mtu has been corrected in the Director Installation and Usage guide topic, "Network definition file configuration options." 30 Sep 2022 17.0 Networking Cleaning up after Controller node replacement The note about "bugs prevent the removal of the OVN controller and metadata agents" has been deleted from the Director Installation and Usage guide topic, "Cleaning up after Controller node replacement." 28 Sep 2022 17.0 All All In Red Hat OpenStack Platform (RHOSP) 17.0, the heat-admin user has been replaced with the tripleo-admin user. 28 Sep 2022 17.0 Networking Chapter 6. Troubleshooting networks Significant changes have been made to the "Troubleshooting networks" chapter in the Networking Guide . 21 Sep 2022 17.0 Networking Using Designate for DNS-as-a-Service In Red Hat OpenStack Platform (RHOSP) 17.0, a guide has been added to support the new RHOSP DNS service (designate). 21 Sep 2022 17.0 Upgrades Framework for Upgrades guide The Framework for Upgrades guide is not published in the RHOSP 17.0 life cycle because upgrades from versions are not supported. Upgrades will be supported in RHOSP 17.1 and the Framework for Upgrades Guide will be published. Updates from 17.0.0 to 17.0.z are supported in the RHOSP 17.0 life cycle. For more information, see Keeping Red Hat OpenStack Platform Updated . 21 Sep 2022 17.0 Networking Testing Migration of the Networking Service to the ML2/OVN Mechanism Driver guide The Migrating the Networking Service to the ML2/OVN Mechanism Driver guide is published with RHOSP 17.0 for ML2/OVN migration testing purposes only under the title Testing Migration of the Networking Service to the ML2/OVN Mechanism Driver . ML2/OVN migrations are not supported in RHOSP 17.0, because they are not needed for production. Red Hat does not support upgrades to RHOSP 17.0, and all RHOSP 17.0 deployments use the default ML2/OVN mechanism driver. Thus all RHOSP 17.0 deployments start with ML2/OVN and migration is not needed for production. 21 Sep 2022 17.0 Compute Scaling Deployments with Compute Cells guide The Scaling Deployments with Compute Cells guide is not published for RHOSP 17.0 because the Compute cells feature does not work in RHOSP 17.0. Therefore, the Scaling Deployments with Compute Cells guide has been removed until the underlying issues are fixed. 21 Sep 2022 17.0 All Director Installation and Usage guide Creating and Managing Images guide Storage Guide Transitioning to Containerized Services guide Security and Hardening Guide The Advanced Overcloud Customization guide has been removed for RHOSP 17.0 and the content has been moved to several other guides. For instance, several chapters on networking have been moved to the Director Installation and Usage guide, and the chapter "Configuring the image import method and shared staging area" has been moved to the Creating and Managing Images guide. 21 Sep 2022 17.0 Security Federate with Identity Service guide The Federate with Identity Service guide has been removed for RHOSP 17.0. Its contents are consolidated in a Red Hat knowledgebase article that is currently under development. 21 Sep 2022 17.0 Security Security and Hardening Guide The Deploy Fernet on the Overcloud guide has been removed. For information about working with Fernet keys, see the Security and Hardening Guide . 21 Sep 2022 17.0 All Product Documentation for Red Hat OpenStack Platform 17.0 The Product Documentation landing page, also known as splash page, has been reorganized. Sections have been renamed, removed, or replaced and the list of titles represents the latest set of titles. 21 Sep 2022 17.0 All Deploying Red Hat Ceph Storage and Red Hat OpenStack Platform together with director The Deploying an overcloud with containerized Red Hat Ceph guide is now called Deploying Red Hat Ceph Storage and Red Hat OpenStack Platform together with director . The content in this document has changed to reflect changes in Red Hat Ceph Storage deployment. 21 Sep 2022 17.0 All Firewall Rules for Red Hat OpenStack Platform The Firewall Rules for Red Hat OpenStack Platform guide will not be updated or published in RHOSP 17.0. Red Hat plans to update and publish the guide for RHOSP 17.1.

Commands: