Merge pull request openshift#8477 from gryf/OCPBUGS-33973

OCPBUGS-33973: Openstack UPI - Reintroduce unique resource names.

Author: openshift-merge-bot[bot]

docs/user/openstack/install_upi.md

@@ -27,6 +27,7 @@ of this method of installation.
   - [OpenShift Configuration Directory](#openshift-configuration-directory)
   - [Red Hat Enterprise Linux CoreOS (RHCOS)](#red-hat-enterprise-linux-coreos-rhcos)
   - [API and Ingress Floating IP Addresses](#api-and-ingress-floating-ip-addresses)
+  - [Network identifier](#network-identifier)
   - [Create network, API and ingress ports](#create-network-api-and-ingress-ports)
   - [Install Config](#install-config)
     - [Configure the machineNetwork.CIDR apiVIP and ingressVIP](#configure-the-machinenetworkcidr-apivip-and-ingressvip)
@@ -270,6 +271,23 @@ api.openshift.example.com.    A 203.0.113.23
 
 They will need to be available to your developers, end users as well as the OpenShift installer process later in this guide.
 
+## Network identifier
+
+Resources like network, subnet (or subnets), router and API and ingress ports need to have unique name to not interfere with other deployments running on the same OpenStack cloud.
+Please, keep in mind, those OpenStack resources will have different name scheme then all the other resources which will be created on next steps, although they will be tagged by the infraID later on.
+Let's create environment variable `OS_NET_ID` and `netid.json` file, which will be used by ansible playbooks later on.
+
+<!--- e2e-openstack-upi: INCLUDE START --->
+```sh
+$ export OS_NET_ID="openshift-$(dd if=/dev/urandom count=4 bs=1 2>/dev/null |hexdump -e '"%02x"')"
+$ echo "{\"os_net_id\": \"$OS_NET_ID\"}" | tee netid.json
+```
+<!--- e2e-openstack-upi: INCLUDE END --->
+
+Make sure your shell session has the `$OS_NET_ID` environment variable set when you run the commands later in this document.
+
+Note, this identifier has nothing in common with OpenShift `infraID` defined later on.
+
 ## Create network, API and ingress ports
 
 Please note that value of the API and Ingress VIPs fields will be overwritten in the `inventory.yaml` with the respective addresses assigned to the Ports. Run the following playbook to create necessary resources:
@@ -336,22 +354,39 @@ values:
 
 <!--- e2e-openstack-upi: INCLUDE START --->
 ```sh
-$ python -c 'import yaml
+$ python -c 'import os
+import sys
+import yaml
+import re
+re_os_net_id = re.compile(r"{{\s*os_net_id\s*}}")
+os_net_id = os.getenv("OS_NET_ID")
+path = "common.yaml"
+facts = None
+for _dict in yaml.safe_load(open(path))[0]["tasks"]:
+    if "os_network" in _dict.get("set_fact", {}):
+        facts = _dict["set_fact"]
+        break
+if not facts:
+    print("Cannot find `os_network` in common.yaml file. Make sure OpenStack resource names are defined in one of the tasks.")
+    sys.exit(1)
+os_network = re_os_net_id.sub(os_net_id, facts["os_network"])
+os_subnet = re_os_net_id.sub(os_net_id, facts["os_subnet"])
 path = "install-config.yaml"
 data = yaml.safe_load(open(path))
 inventory = yaml.safe_load(open("inventory.yaml"))["all"]["hosts"]["localhost"]
 machine_net = [{"cidr": inventory["os_subnet_range"]}]
 api_vips = [inventory["os_apiVIP"]]
 ingress_vips = [inventory["os_ingressVIP"]]
-ctrl_plane_port = {"network": {"name": inventory["os_network"]}, "fixedIPs": [{"subnet": {"name": inventory["os_subnet"]}}]}
-if inventory.get("os_subnet6"):
+ctrl_plane_port = {"network": {"name": os_network}, "fixedIPs": [{"subnet": {"name": os_subnet}}]}
+if inventory.get("os_subnet6_range"):
+    os_subnet6 = re_os_net_id.sub(os_net_id, facts["os_subnet6"])
     machine_net.append({"cidr": inventory["os_subnet6_range"]})
     api_vips.append(inventory["os_apiVIP6"])
     ingress_vips.append(inventory["os_ingressVIP6"])
     data["networking"]["networkType"] = "OVNKubernetes"
     data["networking"]["clusterNetwork"].append({"cidr": inventory["cluster_network6_cidr"], "hostPrefix": inventory["cluster_network6_prefix"]})
     data["networking"]["serviceNetwork"].append(inventory["service_subnet6_range"])
-    ctrl_plane_port["fixedIPs"].append({"subnet": {"name": inventory["os_subnet6"]}})
+    ctrl_plane_port["fixedIPs"].append({"subnet": {"name": os_subnet6}})
 data["networking"]["machineNetwork"] = machine_net
 data["platform"]["openstack"]["apiVIPs"] = api_vips
 data["platform"]["openstack"]["ingressVIPs"] = ingress_vips

upi/openstack/bootstrap.yaml

@@ -19,7 +19,7 @@
       - "{{ os_sg_master }}"
       allowed_address_pairs:
       - ip_address: "{{ os_apiVIP }}"
-    when: os_subnet6 is not defined
+    when: os_subnet6_range is not defined
 
   - name: 'Create the bootstrap dualstack server port'
     os_port:
@@ -30,7 +30,7 @@
       allowed_address_pairs:
       - ip_address: "{{ os_apiVIP }}"
       - ip_address: "{{ os_apiVIP6 }}"
-    when: os_subnet6 is defined
+    when: os_subnet6_range is defined
 
   - name: 'Set bootstrap port tag'
     command:

upi/openstack/common.yaml

@@ -3,8 +3,14 @@
 
   vars_files:
   - metadata.json
+  - netid.json
 
   tasks:
+  - name: "Check if metadata.json exists"
+    ansible.builtin.stat:
+      path: metadata.json
+    register: sym
+
   - name: 'Compute resource names'
     set_fact:
       cluster_id_tag: "openshiftClusterID={{ infraID }}"
@@ -24,3 +30,14 @@
       os_compute_server_group_name: "{{ infraID }}-worker"
       # Ignition files
       os_bootstrap_ignition: "{{ infraID }}-bootstrap-ignition.json"
+    when: sym.stat.exists
+
+  - name: 'Compute network resource names'
+    set_fact:
+      os_network: "{{ os_net_id }}-network"
+      os_subnet: "{{ os_net_id }}-nodes"
+      os_subnet6: "{{ os_net_id }}-nodes-v6"
+      os_router: "{{ os_net_id }}-external-router"
+      # Port names
+      os_port_api: "{{ os_net_id }}-api-port"
+      os_port_ingress: "{{ os_net_id }}-ingress-port"

upi/openstack/compute-nodes.yaml

@@ -21,7 +21,7 @@
       - ip_address: "{{ os_ingressVIP }}"
     with_indexed_items: "{{ [os_port_worker] * os_compute_nodes_number }}"
     register: ports
-    when: os_subnet6 is not defined
+    when: os_subnet6_range is not defined
 
   - name: 'Create the dualstack Compute ports'
     openstack.cloud.port:
@@ -34,7 +34,7 @@
       - ip_address: "{{ os_ingressVIP6 }}"
     with_indexed_items: "{{ [os_port_worker] * os_compute_nodes_number }}"
     register: ports
-    when: os_subnet6 is defined
+    when: os_subnet6_range is defined
 
   - name: 'Set Compute ports tag'
     ansible.builtin.command:

upi/openstack/control-plane.yaml

@@ -22,7 +22,7 @@
       - ip_address: "{{ os_ingressVIP }}"
     with_indexed_items: "{{ [os_port_master] * os_cp_nodes_number }}"
     register: ports
-    when: os_subnet6 is not defined
+    when: os_subnet6_range is not defined
 
   - name: 'Create the dualstack Control Plane ports'
     openstack.cloud.port:
@@ -37,7 +37,7 @@
       - ip_address: "{{ os_ingressVIP6 }}"
     with_indexed_items: "{{ [os_port_master] * os_cp_nodes_number }}"
     register: ports
-    when: os_subnet6 is defined
+    when: os_subnet6_range is defined
 
   - name: 'Set Control Plane ports tag'
     ansible.builtin.command:

upi/openstack/inventory.yaml

@@ -4,13 +4,6 @@ all:
       ansible_connection: local
       ansible_python_interpreter: "{{ansible_playbook_python}}"
 
-      # Network resource names
-      os_network: ocp-network
-      os_port_api: ocp-api-port
-      os_port_ingress: ocp-ingress-port
-      os_router: ocp-external-router
-      os_subnet: ocp-subnet-v4
-
       # User-provided values
       os_subnet_range: '10.0.0.0/16'
       os_flavor_master: 'm1.xlarge'
@@ -73,11 +66,8 @@ all:
       # nodes is zero
       os_master_schedulable: "{{ os_compute_nodes_number | int == 0 }}"
 
-      # Name of the IPv6 subnet. Uncomment to enable dual-stack support
-      #os_subnet6: ocp-subnet-v6
-
-      # IPv6 subnet CIDR
-      os_subnet6_range: 'fd2e:6f44:5dd8:c956::/64'
+      # IPv6 subnet CIDR. Uncomment to enable dual-stack support.
+      #os_subnet6_range: 'fd2e:6f44:5dd8:c956::/64'
 
       # Modes are one of: slaac, dhcpv6-stateful or dhcpv6-stateless
       os_subnet6_address_mode: slaac

upi/openstack/network.yaml

@@ -5,6 +5,8 @@
 # openstacksdk
 # netaddr
 
+- ansible.builtin.import_playbook: common.yaml
+
 - hosts: all
   gather_facts: no
 
@@ -30,7 +32,7 @@
       ip_version: 6
       ipv6_address_mode: "{{ os_subnet6_address_mode }}"
       ipv6_ra_mode: "{{ os_subnet6_router_advertisements_mode }}"
-    when: os_subnet6 is defined
+    when: os_subnet6_range is defined
 
   - name: 'Create external router for IPv4'
     openstack.cloud.router:
@@ -40,7 +42,7 @@
     when:
     - os_external_network is defined
     - os_external_network|length>0
-    - os_subnet6 is not defined
+    - os_subnet6_range is not defined
 
   - name: 'Create external router for dualstack'
     openstack.cloud.router:
@@ -52,7 +54,7 @@
     when:
     - os_external_network is defined
     - os_external_network|length>0
-    - os_subnet6 is defined
+    - os_subnet6_range is defined
 
   - name: 'Create the API port'
     openstack.cloud.port:
@@ -62,7 +64,7 @@
       - subnet: "{{ os_subnet }}"
         ip_address: "{{ os_apiVIP }}"
     register: _api_ports
-    when: os_subnet6 is not defined
+    when: os_subnet6_range is not defined
 
   - set_fact:
       api_ports: "{{ _api_ports }}"
@@ -73,7 +75,7 @@
       name: "{{ os_port_api }}"
       network: "{{ os_network }}"
     register: _api_ports
-    when: os_subnet6 is defined
+    when: os_subnet6_range is defined
 
   - set_fact:
       api_ports: "{{ _api_ports }}"
@@ -87,7 +89,7 @@
       - subnet: "{{ os_subnet }}"
         ip_address: "{{ os_ingressVIP }}"
     register: _ingress_ports
-    when: os_subnet6 is not defined
+    when: os_subnet6_range is not defined
 
   - set_fact:
       ingress_ports: "{{ _ingress_ports }}"
@@ -98,7 +100,7 @@
       name: "{{ os_port_ingress }}"
       network: "{{ os_network }}"
     register: _ingress_ports
-    when: os_subnet6 is defined
+    when: os_subnet6_range is defined
 
   - set_fact:
       ingress_ports: "{{ _ingress_ports }}"

upi/openstack/security-groups.yaml

@@ -408,4 +408,4 @@
         port_range_min: 30000
         port_range_max: 32767
 
-    when: os_subnet6 is defined
+    when: os_subnet6_range is defined

upi/openstack/update-network-resources.yaml

@@ -22,7 +22,7 @@
   - name: 'Set tags on primary cluster subnet IPv6'
     ansible.builtin.command:
       cmd: "openstack subnet set --tag {{ cluster_id_tag }} {{ os_subnet6 }}"
-    when: os_subnet6 is defined
+    when: os_subnet6_range is defined
 
   - name: 'Set tags on the API VIP port'
     ansible.builtin.command: