Chapter 4. Documentation changes

This section details the major documentation updates delivered with Red Hat OpenStack Platform (RHOSP) 17.1, 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 4.1. Documentation changes legend

ColumnMeaning

Date

The date that the documentation change was published.

17.1 versions impacted

The RHOSP 17.1 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 documentation 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 4.2. Document changes

Date17.1 versions impactedComponentsAffected content 

4 March 2024

17.1

Networking

Replacing a bootstrap Controller node

Now you can use the original hostname and IP address for the replacement Controller node when you replace a Controller node.

29 February 2024

17.1

Deployment

Installing and managing Red Hat OpenStack Platform with director

Customizing your Red Hat OpenStack Platform deployment

Updated the content in Installing and managing Red Hat OpenStack Platform with director guide to focus only on the core tasks required to deploy a basic RHOSP environment. Content related to optional features and custom configuration are moved into a new guide: Customizing your Red Hat OpenStack Platform deployment.

16 February 2024

17.1

Security

Using Fernet keys for encryption in the overcloud

Procedure that is no longer valid for RHOSP 17 as mistral is not included. >>>>>>> common/release-notes/ref_rhosp-171-doc-changes.adoc

24 Jan 2024

17.1

Networking

Migrating the ML2 mechanism driver from OVS to OVN

Now you can migrate to OVN from OVS with VLAN tenant networks and DVR. Also clarified that the environment files shown are just examples, to be replaced with your own files.

23 Jan 2024

17.1

Security

Managing OpenStack Identity resources

Old and duplicated material is removed from the Identity resources guide

17 Jan 2024

17.1

Networking

A step was added to the two deployment topics instructing administrators to add the name server records (NS records) for the child zones that reside in the DNS server (designate) pool.

15 Jan 2024

17.1

Edge

A step was added to several procedures to instruct users to re-run the network provisioning command on the central location, if the network_data.yaml template includes additional networks which were not included when networks were provisioned for the central location.

17 Jan 2024

17.1.2

director Operator

Upgrading an overcloud on a Red Hat OpenShift Container Platform cluster with director Operator (16.2 to 17.1)

Added a chapter about how to upgrade an overcloud on RHOCP with director Operator from RHOSP 16.2 to RHOSP 17.1.

17 Jan 2024

17.1

Upgrades

Known issues that might block an upgrade

Known issues were removed for the following BZs:

  • BZ#2235621
  • BZ#2237743
  • BZ#2228818

17 Jan 2024

17.1

Updates

Updated note to describe the SKIPPED and FAILED statuses that might occur when you run a validation.

17 Jan 2024

17.1

Upgrades

Overcloud adoption for multi-cell environments

Added a new module that provides an example of adopting the overcloud in multi-cell environments.

12 Jan 2024

17.1

DCN

Managing separate heat stacks

Removed example of manually creating file that is created automatically

11 Jan 2024

17.1

Networking

Deploying Ceph in your dynamic routing environment

Added a new topic about how to deploy Red Hat Ceph Storage.

10 Jan 2024

17.1

Networking

DVR known issues and caveats

Refined an item about DHCP in an ML2/OVS, DVR environment: "For ML2/OVS environments, the DHCP server is not distributed and is deployed on a Controller node. The ML2/OVS neutron DCHP agent, which manages the DHCP server, is deployed in a highly available configuration on the Controller nodes, regardless of the routing design (centralized or DVR)."

10 Jan 2024

17.1

NFV

Other parameters

Added an IMPORTANT admonition under VhostuserSocketGroup.

10 Jan 2024

17.1

NFV

Tested NICs for NFV

Rewrote topic.

8 Jan 2024

17.1

Networking

Configuring policy-based routing

Corrected example interface entry: changed route_table: 2 to table: 2.

8 Jan 2024

17.1

NFV

Launching an RT-KVM instance

Corrected a create flavor command example.

30 November 2023

17.1

Security

Secure metadef APIs

The concept and procedure have been updated for metadef APIs

30 November 2023

17.1

Networking

Configuring the L2 population driver

The topic, "Configuring the L2 population driver" has been rewritten.

20 November 2023

17.1

Networking

Creating secure HTTP load balancers

Changed prerequisities for procedures in Chapter 9.

15 November 2023

17.1

Security

Implementing TLS-e with Ansible

Added optional step to include CertmongerKerberosRealm parameter when the IPA realm does not match the IPA domain.

15 November 2023

17.1

Edge

Deploying distributed compute node architecture with TLS-e

Removed unnecessary (but non-impactful) steps from instructions for TLSe in DCN guide

7 November 2023

17.1

All

Example: Providing feedback on Red Hat documentation

Replaced the Direct Documentation Feedback (DDF) instructions with the Create Issue Jira form link. DDF was removed for Red Hat OpenStack Platform, and feedback must now be provided in Jira.

03 November 2023

17.1

Networking

Customizing NIC mappings for pre-provisioned nodes

Modified the topic, "Customizing NIC mappings for pre-provisioned nodes."

03 November 2023

17.1

Networking

Network interface configuration options

Corrected example for a Linux bond.

02 November 2023

17.1

Networking

High-level changes in Red Hat OpenStack Platform 17.1

Added item: "In ML2/OVN deployments, you can enable egress minimum and maximum bandwidth policies for hardware offloaded ports."

2 November 2023

17.1

Networking

ML2/OVS to ML2/OVN in-place migration scenarios that have not been validated

Added known issue prohibiting migration to the OVN mechanism driver if your original ML2/OVS environment includes iptables hybrid firewall and trunk ports.

01 November 2023

17.1

Networking

Migration constraints

Re-wrote sub-topic, "Live migration on ML2/OVS deployments."

31 October 2023

17.1

Networking

Removed the VIP definition file, spine-leaf-vip-data.yaml, from the overcloud deploy command example.

30 October 2023

17.1

Networking

Described how to use the CloudName{network.name} definition to set the DNS name for an API endpoint on a composable network that uses a virtual IP.

30 October 2023

17.1

NFV

Added note about Red Hat Enterprise Linux Traffic Control (TC) subsystem supporting connection tracking (conntrack) helpers or application layer gateways (ALGs).

24 October 2023

17.1

Networking

Added an important admonition about router gateway ports.

24 October 2023

17.1

Networking

Added an important admonition about internal DNS resolution for port names.

24 October 2023

17.1

Networking

Adding a new leaf to a spine-leaf deployment

Modified step 8, and added three new steps (9-11).

23 October 2023

17.1

Networking

Performing basic ICMP testing within the ML2/OVN namespace

Clarified login example (step 4).

20 October 2023

17.1

Networking

Exporting the DNS service pool configuration

Updated the procedure to describe how to run the command inside a container.

17 October 2023

17.1

Networking

Setting the subnet for virtual IP addresses

Removed mention of the VipSubnetMap parameter, plus some other changes made.

12 October 2023

17.1

Storage

Creating and managing images

Content about creating images has been moved to its own chapter called 'Creating RHEL KVM or RHOSP-compatible images'.

05 October 2023

17.1

Networking

Configuring DNS as a service

Instances of the tripleo template filename have changed from enable-designate.yaml to designate.yaml.

05 October 2023

17.1

NFV

The step about adding custom resources for OVS-DPDK with the resource_registry parameter has been removed.

05 October 2023

17.1

NFV

Tested NICs for NFV

Replaced the filename, compute-ovs-dpdk.yaml, with the phrase, "j2 network configuration template."

05 October 2023

17.1

NFV

Configuring NIC partitioning

The YAML file, os-net-config.yaml, has been changed to, roles_data.yaml.

05 October 2023

17.1

NFV

Registering and enabling repositories

The repository name, openstack-for-rhel-9-x86_64-rpms, has been changed to, openstack-17.1-for-rhel-9-x86_64-rpms.

04 October 2023

17.1

Networking

Replaced networks definition file, network_data.yaml, with network_data_v2.yaml.

02 October 2023

17.1

Networking

The FrrBgpAsn and FrrOvnBgpAgentAsn parameters are now role-based. There is a new parameter, tripleo_frr_ovn_bgp_agent_enable.

29 September 2023

17.1

Security

Corrected procedure so that FIPS images are uploaded to glance.

27 September 2023

17.1

Networking

Added item that describes high connectivity downtime during an FRR update for RHOSP dynamic routing environments.

27 September 2023

17.1, 17.0, 16.2, 16.1

Compute

The configuration for dynamic metadata you use in your Compute environment file has been updated.

26 September 2023

17.1

Networking

A new procedure, "Limiting queries to the metadata service," has been added to Configuring Red Hat OpenStack Platform networking.

25 September 2023

17.1

NFV

Configuring network functions virtualization has been updated with content from what was the Network Functions Virtualization Product Guide.

22 September 2023

17.1

Deployment

This guide is being reviewed and will be republished on the Customer Portal when the reviewed content is available for enterprise use.

20 September 2023

17.1

Networking

Added a chapter for the Technology Preview of the router flavors feature.

19 September 2023

17.1

Updates

Added note stating that only cold migration is supported when migrating virtual machines from RHEL 9.2 to RHEL 8.4 in a Multi-RHEL environment.

19 September 2023

17.1

Upgrades

Updated the parameter that sets the RHEL version on Compute nodes in a Multi-RHEL environment. Removed step to modify the skip_rhel_release.yaml file.

18 September 2023

17.1

Edge

Removed mentions of heat template podman.yaml, which is no longer needed.

18 September 2023

17.1

Updates

Added procedures to validate your RHOSP environment before the undercloud update and after the overcloud update.

12 September 2023

17.1

Networking

link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/17.1/html/configuring_the_compute_service_for_instance_creation/assembly_migrating-virtual-machine-instances-between-compute-nodes_migrating-instances#con_migration-constraints_migrating-instances

Removed the sub-section, "Packet loss on ML2/OVN deployments" from the section, "16.3.2. Migration constraints," in the Configuring the Compute service for instance creation guide.

12 September 2023

17.1

NFV

Chapter 6. Preparing network functions virtualization (NFV)

A new chapter, "Chapter 6. Preparing network functions virtualization (NFV)," has been added to the Framework for upgrades (16.2 to 17.1) guide.

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

08 September 2023

17.1

Backup and Restore

Backing up and restoring the undercloud and control plane nodes

Backing up and restoring the undercloud and control plane nodes is now published.

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.

31 August 2023

17.1

Networking

Configuring the leaf networks and Configuring the leaf networks

Renamed section 4.4 to "Configuring the leaf networks" in both the Configuring dynamic routing in Red Hat OpenStack Platform guide and the Configuring spine-leaf networking guide.

30 August 2023

17.1

Networking

Overview of allowed address pairs

Added a definition for a virtual port (vport).

30 August 2023

17.1

Security

Creating images

Removed deprecated example for building images and replaced with link to image builder documentation

29 August 2023

17.1

Documentation

New editions published.

28 August 2023

17.1

NFV

Planning for your RT-KVM Compute nodes

The repositories listed in this procedure have changed.

28 August 2023

17.1

NFV

Registering and enabling repositories

The repositories listed in this procedure have changed.

25 August 2023

17.1

Firewall rules for Red Hat OpenStack Platform

Firewall rules for Red Hat OpenStack Platform

New edition published.

22 August 2023

17.1

NFV

Configuring OVS PMD Auto Load Balance

The OVS Poll Mode Driver (PMD) automatic load balancing feature graduated from Technology Preview to full support. Also, the configuration procedure changed.

21 August 2023

17.1

DCN

Considerations for networking on DCN architecture

The RHOSP Load-balancing service (octavia) is no longer listed as unsupported in a DCN environment.

16 August 2023

17.1

Documentation

Configuring dynamic routing in Red Hat OpenStack Platform

A new guide for RHOSP 17.1.

16 August 2023

17.1

Documentation

  • Network Functions Virtualization Product Guide

This guide is being reviewed and will be added after the initial release. This list of unpublished guides will be updated when these guides are published.

16 August 2023

17.1

Documentation

Updated the titles for some of the guides from the 17.0 title.

16 August 2023

17.1

Documentation

This guide has been updated, restructured and rewritten. The cinder CLI commands have been replaced with openstack CLI commands, where possible.

Table 4.3. Documentation library title changes

Previous titleCurrent title

Bare Metal Provisioning

Configuring the Bare Metal Provisioning service

Block Storage Backup Guide

Backing up Block Storage volumes

Custom Block Storage Back End Deployment Guide

Deploying a custom Block Storage back end

Deployment Recommendations for Specific Red Hat OpenStack Platform Services

Removed.

Installing and managing Red Hat OpenStack Platform with director

Installing and managing Red Hat OpenStack Platform with director

Distributed compute node and storage deployment

Deploying a Distributed Compute Node (DCN) architecture

External Load Balancing for the Overcloud

Content moved to Managing high availability services.

High Availability Deployment and Usage

Managing high availability services

High Availability for Compute Instances

Configuring high availability for instances

Hyperconverged Infrastructure Guide

Deploying a hyperconverged infrastructure

Introduction to the OpenStack Dashboard

Managing cloud resources with the Openstack Dashboard

IPv6 networking for the overcloud

Configuring IPv6 networking for the overcloud

Keeping Red Hat OpenStack Platform Updated

Performing a minor update of Red Hat OpenStack Platform

Network Functions Virtualization Planning and Configuration Guide

Configuring network functions virtualization

Network Functions Virtualization Product Guide

Removed. Content will be moved to Configuring network functions virtualization.

Networking Guide

Configuring Red Hat OpenStack Platform networking

OpenStack Integration Test Suite Guide

Validating your cloud with the Red Hat OpenStack Platform Integration Test Suite

Operational Measurements

Managing overcloud observability

Partner Integration

Removed.

Product Guide

Introduction to Red Hat OpenStack Platform

Recommendations for Large Deployments

Deploying Red Hat OpenStack Platform at scale

RHOSP director Operator for OpenShift Container Platform

Deploying an overcloud in a Red Hat OpenShift Container Platform cluster with director Operator

Security and Hardening Guide

Hardening Red Hat OpenStack Platform

Spine Leaf Networking

Configuring spine-leaf networking

Standalone Deployment Guide

Removed.

Storage Guide

Configuring persistent storage

Testing Migration of the Networking Service to the ML2/OVN Mechanism Driver

Migrating to the OVN mechanism driver

Transitioning to Containerized Services

Removed

Users and Identity Management Guide

Managing OpenStack Identity resources

Using Designate for DNS-as-a-Service

Configuring DNS as a service

Using Octavia for Load Balancing-as-a-Service

Configuring load balancing as a service