diff --git a/Makefile b/Makefile index 244d08387..dbb6f60b6 100644 --- a/Makefile +++ b/Makefile @@ -100,6 +100,10 @@ docs: manifests docs-dependencies crd-to-markdown ## Build docs sed -i "s/=== Custom/== Custom/g" docs/assemblies/custom_resources.adoc cd docs; $(MAKE) html +.PHONY: docs-preview +docs-preview: docs + cd docs; $(MAKE) open-html + .PHONY: docs-clean docs-clean: rm -r docs_build diff --git a/docs/assemblies/creating-the-data-plane.adoc b/docs/assemblies/creating-the-data-plane.adoc index 98b411861..a1714fb89 100644 --- a/docs/assemblies/creating-the-data-plane.adoc +++ b/docs/assemblies/creating-the-data-plane.adoc @@ -20,6 +20,7 @@ To create and deploy a data plane, you must perform the following tasks: ** CBO is installed and configured for provisioning. ** `BareMetalHosts` registered, inspected, and have the label `app:openstack`. * You are logged on to a workstation that has access to the RHOCP cluster as a user with `cluster-admin` privileges. +* https://kustomize.io/[kustomize] version 5.0.1 or higher include::proc_creating-the-SSH-key-secrets.adoc[leveloffset=+1] diff --git a/docs/assemblies/proc_creating-a-set-of-data-plane-nodes.adoc b/docs/assemblies/proc_creating-a-set-of-data-plane-nodes.adoc index 9c2b8def2..6a980ba89 100644 --- a/docs/assemblies/proc_creating-a-set-of-data-plane-nodes.adoc +++ b/docs/assemblies/proc_creating-a-set-of-data-plane-nodes.adoc @@ -8,10 +8,31 @@ Create an `OpenStackDataPlaneNodeSet` CR for each logical grouping of nodes in y .Procedure -. Copy the sample `OpenStackDataPlaneNodeSet` CR that you require and save it to a file named `openstack-edpm.yaml` on your workstation: +. Copy the https://kustomize.io/[kustomize] examples on your workstation: -* Pre-provisioned nodes: https://github.com/openstack-k8s-operators/dataplane-operator/blob/main/config/samples/dataplane_v1beta1_openstackdataplanenodeset_with_ipam.yaml -* Bare metal nodes: https://github.com/openstack-k8s-operators/dataplane-operator/blob/main/config/samples/dataplane_v1beta1_openstackdataplanenodeset_baremetal_with_ipam.yaml + git clone -n --depth=1 --filter=tree:0 \ + https://github.com/openstack-k8s-operators/dataplane-operator + cd dataplane-operator + git sparse-checkout set --no-cone examples + git checkout + cd examples + +. Use kustomize to create the `OpenStackDataPlaneDeployment` and `OpenStackDataPlaneNodeSet` CRs: + + * Pre-provisioned nodes: + + kustomize build preprovisioned > openstack-edpm.yaml + + * Bare metal nodes: + + kustomize build baremetal > openstack-edpm.yaml + ++ +[NOTE] +==== +If desired, update the `values.yaml` file with values from your environment and add other kustomizations as needed before generating the CRs. Alternatively, the generated CRS can be directly edited before being applied. +==== ++ . The sample `OpenStackDataPlaneNodeSet` CR is connected to `cell1` by default. If you added additional Compute cells to the control plane and you want to connect the node set to one of the other cells, then you must create a custom service for the node set that includes the `Secret` CR for the cell: @@ -214,7 +235,7 @@ spec: . Save the `openstack-edpm.yaml` definition file. -. Create the data plane resources: +. Create and <> the data plane resources: + ---- $ oc create -f openstack-edpm.yaml diff --git a/docs/assemblies/proc_deploying-the-data-plane.adoc b/docs/assemblies/proc_deploying-the-data-plane.adoc index da70a66fc..337dc4e44 100644 --- a/docs/assemblies/proc_deploying-the-data-plane.adoc +++ b/docs/assemblies/proc_deploying-the-data-plane.adoc @@ -4,9 +4,9 @@ [role="_abstract"] You use the `OpenStackDataPlaneDeployment` CRD to configure the services on the data plane nodes and deploy the data plane. Create an `OpenStackDataPlaneDeployment` custom resource (CR) that deploys each of your `OpenStackDataPlaneNodeSet` CRs. -. Procedure +.Procedure -. Copy the sample `OpenStackDataPlaneDeployment` CR from https://github.com/openstack-k8s-operators/dataplane-operator/blob/main/config/samples/dataplane_v1beta1_openstackdataplanedeployment_baremetal_with_ipam.yaml and save it to a file named `openstack-edpm-deploy.yaml` on your workstation. +. Complete the steps from <> procedure, ensuring that you have a file named `openstack-edpm.yaml` on your workstation. . Optional: Update `nodeSets` to include all the `OpenStackDataPlaneNodeSet` CRs that you want to deploy: + @@ -25,12 +25,10 @@ spec: + * Replace `` with the names of the `OpenStackDataPlaneNodeSet` CRs that you want to include in your data plane deployment. -. Save the `openstack-edpm-deploy.yaml` deployment file. - . Deploy the data plane: + ---- -$ oc create -f openstack-edpm-deploy.yaml +$ oc create -f openstack-edpm.yaml ---- + You can view the Ansible logs while the deployment executes: