Uploaded image for project: 'OpenShift Bugs'
  1. OpenShift Bugs
  2. OCPBUGS-57765

Missing description for controlPlanePort parameter in reference section

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • None
    • 4.19
    • None
    • Quality / Stability / Reliability
    • False
    • Hide

      None

      Show
      None
    • None
    • Moderate
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      Description of problem:

          The controlPlanePort parameter and its nested fields (fixedIPs, network) are missing a descriptive entry in the comprehensive "Available Installation Configuration Parameters for OpenStack" reference section [1].
      
          The OpenShift Container Platform 4.19 "Installing on OpenStack" documentation provides install-config.yaml examples that utilize the platform.openstack.controlPlanePort parameter for dual-stack network configurations [2]. This parameter includes sub-parameters such as fixedIPs (a list of subnets by name or ID) and network (the network's name or ID). Its purpose is to configure IPv4 and IPv6 address endpoints for the cluster's control plane nodes. However, when consulting "Chapter 12. Installation Configuration Parameters for OpenStack", there is no entry or description whatsoever for controlPlanePort or its nested fixedIPs and network fields. This forces users to infer the parameter's functionality and correct syntax solely from the provided examples, which can lead to confusion and incorrect configurations, especially given the nuances of dual-stack setups (e.g., CIDR matching networking.machineNetwork - The CIDR of any subnet specified in this field must match the CIDRs listed on networks.machineNetwork).

      Version-Release number of selected component (if applicable):

          OpenShift Container Platform 4.19 and before (dualstack support was added in 4.15)

      How reproducible:

          Always

      Steps to Reproduce:

          1. Access the "OpenShift Container Platform 4.19 Installing on OpenStack" documentation.
          2. Navigate to sections detailing install-config.yaml examples, particularly "3.10.6. Configuring a cluster with dual-stack networking" or "4.13.3. Setting a custom subnet for machines".
          3. Observe the inclusion and usage of the controlPlanePort parameter with its fixedIPs and network sub-parameters in the examples.
          4.Navigate to "CHAPTER 12. INSTALLATION CONFIGURATION PARAMETERS FOR OPENSTACK" and then to "12.1. Available Installation Configuration Parameters for OpenStack".
          5.Search through the tables and descriptions in this section for an entry corresponding to controlPlanePort or its nested fields (fixedIPs, network) under platform.openstack.    

      Additional info:

      [1] https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/installing_on_openstack/installation-config-parameters-openstack#installation-configuration-parameters_installation-config-parameters-openstack

      [2] https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/installing_on_openstack/installing-openstack-installer-custom#install-osp-deploy-dualstack_installing-openstack-installer-custom

              ocp-docs-bot OCP DocsBot
              juriarte@redhat.com Jon Uriarte
              None
              None
              Itshak Brown Itshak Brown
              None
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: