Test samples from inline docs

Signed-off-by: Fabricio Aguiar <[email protected]>
openstack-k8s-operators · Mar 25, 2024 · 2f8207a · 2f8207a
1 parent 43288eb
commit 2f8207a
Show file tree

Hide file tree

Showing 11 changed files with 622 additions and 81 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,10 @@
 repos:
 - repo: local
   hooks:
+    - id: doc-sample
+      name: doc-sample
+      language: system
+      entry: docs/docs_to_sample.sh
     - id: gotidy
       name: gotidy
       language: system

diff --git a/docs/assemblies/creating-the-data-plane.adoc b/docs/assemblies/creating-the-data-plane.adoc
@@ -35,8 +35,8 @@ include::proc_creating-a-custom-service.adoc[leveloffset=+2]
 include::proc_configuring-a-node-set-for-a-Compute-feature-or-workload.adoc[leveloffset=+2]
 include::proc_building-a-custom-ansible-runner-image.adoc[leveloffset=+2]
 
-include::ref_example-OpenStackDataPlaneNodeSet-CR-for-preprovisioned-nodes.adoc[leveloffset=+1]
-include::ref_example-OpenStackDataPlaneNodeSet-CR-for-bare-metal-nodes.adoc[leveloffset=+1]
+include::samples/ref_example-OpenStackDataPlaneNodeSet-CR-for-preprovisioned-nodes.adoc[leveloffset=+1]
+include::samples/ref_example-OpenStackDataPlaneNodeSet-CR-for-bare-metal-nodes.adoc[leveloffset=+1]
 
 include::ref_data-plane-conditions-and-states.adoc[leveloffset=+1]
 

diff --git a/...PlaneNodeSet-CR-for-bare-metal-nodes.adoc → ...PlaneNodeSet-CR-for-bare-metal-nodes.adoc b/...PlaneNodeSet-CR-for-bare-metal-nodes.adoc → ...PlaneNodeSet-CR-for-bare-metal-nodes.adoc
@@ -10,53 +10,59 @@ kind: OpenStackDataPlaneNodeSet
 metadata:
   name: openstack-edpm-ipam
 spec:
-  env: <1>
+  env: #<1>
     - name: ANSIBLE_FORCE_COLOR
       value: "True"
-  services: <2>
+  services: #<2>
+    - bootstrap
+    - download-cache
     - configure-network
     - validate-network
     - install-os
     - configure-os
+    - ssh-known-hosts
     - run-os
+    - reboot-os
+    - install-certs
     - ovn
+    - neutron-metadata
     - libvirt
     - nova
     - telemetry
-  baremetalSetTemplate: <3>
+  baremetalSetTemplate: #<3>
     bmhLabelSelector:
       app: openstack
     ctlplaneInterface: enp1s0
     cloudUserName: cloud-admin
   nodes:
-      edpm-compute-0: <4>
+      edpm-compute-0: #<4>
         hostName: edpm-compute-0
-  networkAttachments: <5>
+  networkAttachments: #<5>
     - ctlplane
-  nodeTemplate: <6>
-    ansibleSSHPrivateKeySecret: dataplane-ansible-ssh-private-key-secret <7>
-    networks: <8>
-      - name: CtlPlane
+  nodeTemplate: #<6>
+    ansibleSSHPrivateKeySecret: dataplane-ansible-ssh-private-key-secret #<7>
+    networks: #<8>
+      - name: ctlplane
         subnetName: subnet1
         defaultRoute: true
-      - name: InternalApi
+        fixedIP: 192.168.122.100
+      - name: internalapi
         subnetName: subnet1
-      - name: Storage
+      - name: storage
         subnetName: subnet1
-      - name: Tenant
+      - name: tenant
         subnetName: subnet1
     managementNetwork: ctlplane
     ansible:
-      ansibleUser: cloud-admin <9>
+      ansibleUser: cloud-admin #<9>
       ansiblePort: 22
-      ansibleVars: <10>
+      ansibleVars: #<10>
         service_net_map:
-          nova_api_network: internal_api
-          nova_libvirt_network: internal_api
-        edpm_chrony_ntp_servers:
-          - pool.ntp.org
-        edpm_network_config_hide_sensitive_logs: false
-        edpm_network_config_template: | <11>
+          nova_api_network: internalapi
+          nova_libvirt_network: internalapi
+        timesync_ntp_servers:
+          - hostname: pool.ntp.org
+        edpm_network_config_template: | #<11>
               ---
               {% set mtu_list = [ctlplane_mtu] %}
               {% for network in role_networks %}
@@ -93,23 +99,15 @@ spec:
         # considered EDPM network defaults.
         neutron_physical_bridge_name: br-ex
         neutron_public_interface_name: eth0
-        role_networks:
-          - InternalApi
-          - Storage
-          - Tenant
-        networks_lower:
-          External: external
-          InternalApi: internal_api
-          Storage: storage
-          Tenant: tenant
         # edpm_nodes_validation
         edpm_nodes_validation_validate_controllers_icmp: false
         edpm_nodes_validation_validate_gateway_icmp: false
         gather_facts: false
         enable_debug: false
         # edpm firewall, change the allowed CIDR if needed
         edpm_sshd_configure_firewall: true
-        edpm_sshd_allowed_ranges: ['192.168.122.0/24']
+        edpm_sshd_allowed_ranges:
+        - 192.168.111.0/24
         # SELinux module
         edpm_selinux_mode: enforcing
 ----

diff --git a/...eNodeSet-CR-for-preprovisioned-nodes.adoc → ...eNodeSet-CR-for-preprovisioned-nodes.adoc b/...eNodeSet-CR-for-preprovisioned-nodes.adoc → ...eNodeSet-CR-for-preprovisioned-nodes.adoc
@@ -10,66 +10,56 @@ kind: OpenStackDataPlaneNodeSet
 metadata:
   name: openstack-edpm-ipam
 spec:
-  env: <1>
+  env: #<1>
     - name: ANSIBLE_FORCE_COLOR
       value: "True"
-  preProvisioned: true <2>
-  services: <3>
+  preProvisioned: true #<2>
+  services: #<3>
+    - bootstrap
+    - download-cache
     - configure-network
     - validate-network
     - install-os
     - configure-os
+    - ssh-known-hosts
     - run-os
+    - reboot-os
+    - install-certs
     - ovn
+    - neutron-metadata
     - libvirt
     - nova
     - telemetry
   nodes:
-      edpm-compute-0: <4>
+      edpm-compute-0: #<4>
         hostName: edpm-compute-0
-        ansible:
-          ansibleHost: 192.168.122.100
-        networks:
-        - name: CtlPlane
-          subnetName: subnet1
-          defaultRoute: true
-          fixedIP: 192.168.122.100
-        - name: InternalApi
-          subnetName: subnet1
-        - name: Storage
-          subnetName: subnet1
-        - name: Tenant
-          subnetName: subnet1
       edpm-compute-1:
         hostName: edpm-compute-1
-        ansible:
-          ansibleHost: 192.168.122.101
-        networks:
-        - name: CtlPlane
-          subnetName: subnet1
-          defaultRoute: true
-          fixedIP: 192.168.122.101
-        - name: InternalApi
-          subnetName: subnet1
-        - name: Storage
-          subnetName: subnet1
-        - name: Tenant
-          subnetName: subnet1
-  networkAttachments: <5>
+  networkAttachments: #<5>
     - ctlplane
-  nodeTemplate: <6>
-    ansibleSSHPrivateKeySecret: dataplane-ansible-ssh-private-key-secret <7>
+  nodeTemplate: #<6>
+    ansibleSSHPrivateKeySecret: dataplane-ansible-ssh-private-key-secret #<7>
+    networks:
+    - defaultRoute: true
+      name: ctlplane
+      subnetName: subnet1
+    - name: internalapi
+      subnetName: subnet1
+    - name: storage
+      subnetName: subnet1
+    - name: tenant
+      subnetName: subnet1
     managementNetwork: ctlplane
     ansible:
-      ansibleUser: cloud-admin <8>
+      ansibleUser: cloud-admin #<8>
       ansiblePort: 22
-      ansibleVars: <9>
+      ansibleVars: #<9>
         service_net_map:
-          nova_api_network: internal_api
-          nova_libvirt_network: internal_api
-        edpm_chrony_ntp_servers:
-          - pool.ntp.org
-        edpm_network_config_template: | <10>
+          nova_api_network: internalapi
+          nova_libvirt_network: internalapi
+        timesync_ntp_servers:
+          - hostname: pool.ntp.org
+        edpm_network_config_template: | #<10>
               ---
               {% set mtu_list = [ctlplane_mtu] %}
               {% for network in role_networks %}
@@ -106,15 +96,6 @@ spec:
         # considered EDPM network defaults.
         neutron_physical_bridge_name: br-ex
         neutron_public_interface_name: eth0
-        role_networks:
-          - InternalApi
-          - Storage
-          - Tenant
-        networks_lower:
-          External: external
-          InternalApi: internal_api
-          Storage: storage
-          Tenant: tenant
         # edpm_nodes_validation
         edpm_nodes_validation_validate_controllers_icmp: false
         edpm_nodes_validation_validate_gateway_icmp: false

diff --git a/docs/docs_to_sample.sh b/docs/docs_to_sample.sh
@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+set -ex
+
+COUNT=0
+for sample in */assemblies/samples/* ; do
+    FILENAME=$(basename $sample)
+    mkdir -p tests/kuttl/tests/docs-test-0${COUNT}
+    sed "0,/----/d" $sample | sed -e '/----/,$d' > tests/kuttl/tests/docs-test-0${COUNT}/01-${FILENAME/adoc/yaml}
+    cat << __EOF__ > tests/kuttl/tests/docs-test-0${COUNT}/00-dns.yaml
+---
+apiVersion: network.openstack.org/v1beta1
+kind: DNSMasq
+metadata:
+  name: dnsmasq
+spec:
+  replicas: 1
+  options:
+  - key: server
+    values:
+    - 192.168.122.1
+  debug:
+    service: false
+__EOF__
+    COUNT=$((COUNT + 1))
+done
diff --git a/tests/kuttl/tests/docs-test-00/00-dns.yaml b/tests/kuttl/tests/docs-test-00/00-dns.yaml
@@ -0,0 +1,13 @@
+---
+apiVersion: network.openstack.org/v1beta1
+kind: DNSMasq
+metadata:
+  name: dnsmasq
+spec:
+  replicas: 1
+  options:
+  - key: server
+    values:
+    - 192.168.122.1
+  debug:
+    service: false