Skip to content

Commit 5c059b7

Browse files
committed
Integrated new content to README
1 parent 5c26546 commit 5c059b7

1 file changed

Lines changed: 80 additions & 0 deletions

File tree

README.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,86 @@ pull those secrets into OCP.
5454
* [Learn more about VSO](https://developer.hashicorp.com/vault/docs/deploy/kubernetes/vso).
5555
* [VSO on catalog.redhat.com](https://catalog.redhat.com/en/software/containers/hashicorp/vault-secrets-operator-bundle/64ddcd189d40d16b88133fd8)
5656

57+
## ArgoCD orchestration principles
58+
59+
### Sync-waves
60+
61+
We’re using sync-waves annotations for specific jobs and actions.
62+
63+
The range -20;20 is reserved.
64+
65+
### Healthchecks
66+
67+
TBD
68+
69+
## Application responsibilities and content
70+
71+
### openstack-operator
72+
73+
#### Purpose
74+
75+
Installs the foundational OpenStack operators required for the deployment. Covers [Installation Documentation Chapter 1](https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html/deploying_red_hat_openstack_services_on_openshift/assembly_installing-and-preparing-the-openstack-operator) and part of [Installation Documentation Chapter 2](https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html/deploying_red_hat_openstack_services_on_openshift/assembly_preparing-rhocp-for-rhoso#proc_creating-the-openstack-namespace_preparing)
76+
77+
#### Key resources
78+
79+
* **Namespaces:** `openstack`, `openstack-operators`
80+
* **Operator Subscription:** OpenStack operator from Red Hat CDN
81+
* **RBAC:** Install plan approver service account and roles
82+
* **Job:** `approve-openstack-installplan` to "imperatively" accept the `install_plan` created by `OLM` and wait for its completion.
83+
84+
### openstack-operator-cr
85+
86+
#### Purpose
87+
88+
Creates the main OpenStack custom resource that defines the overall OpenStack deployment configuration. Covers [Installation Documentation Chapter 1](https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html/deploying_red_hat_openstack_services_on_openshift/assembly_installing-and-preparing-the-openstack-operator).
89+
90+
#### Key resources
91+
92+
* **OpenStack CR:** Primary configuration object in `openstack-operators` namespace
93+
94+
### openstack-networks
95+
96+
#### Purpose
97+
98+
Create underlying networks for controlplane and dataplane. Covers [Installation Documentation Chapter 3](https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html/deploying_red_hat_openstack_services_on_openshift/assembly_preparing-rhoso-networks_preparing).
99+
100+
#### Key resources
101+
102+
* [3.2.1. Preparing RHOCP with isolated network interfaces](https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html-single/deploying_red_hat_openstack_services_on_openshift/index#proc_preparing-RHOCP-with-isolated-network-interfaces_preparing_networks): for `NodeNetworkConfigurationPolicies` resources
103+
* [3.2.2. Attaching service pods to the isolated networks](https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html-single/deploying_red_hat_openstack_services_on_openshift/index#proc_attaching-service-pods-to-the-isolated-networks_preparing_networks): for `NetworkAttachmentDefinitions` resources
104+
* [3.2.3. Preparing RHOCP for RHOSO network VIPS](https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html-single/deploying_red_hat_openstack_services_on_openshift/index#proc_preparing-RHOCP-for-RHOSO-network-VIPs_preparing_networks) for `L2Advertisements` and `IPAdrressPool` resources
105+
* [3.3. CREATING THE DATA PLANE NETWORK](https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html-single/deploying_red_hat_openstack_services_on_openshift/index#proc_creating-the-data-plane-network_preparing_networks): for `NetConfig` resources
106+
107+
### openstack-controlplane
108+
109+
#### Purpose
110+
111+
Deploys and configures `OpenStackControlPlane` resource. Covers [Installation Documentation Chapter 4](https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html/deploying_red_hat_openstack_services_on_openshift/assembly_creating-the-control-plane)
112+
113+
#### Key resources
114+
115+
* `OpenStackControlPlane`
116+
117+
### openstack-dataplane
118+
119+
#### Purpose
120+
121+
Deploys and configures the OpenStack data plane nodes. Covers [Installation Documentation Chapter 5](https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html/deploying_red_hat_openstack_services_on_openshift/assembly_creating-the-data-plane)
122+
123+
#### Key resources
124+
125+
* `OpenStackDataPlaneNodeSet`
126+
* `OpenStackDataPlaneDeployment`
127+
128+
## What’s NOT covered by ArgoCD applications yet
129+
130+
### Dependencies installation
131+
132+
Dependencies such as `MetalLB`, `NMState` and `Cert-Manager` are not deployed nor managed using ArgoCD Application yet.
133+
134+
### Secret management and creation
135+
136+
Secrets are to be stored within a secure service, such as HashiCorp Vault, and never in Git. Our main focus for now is on the RHOSO application slicing, we will provide an ArgoCD Application definition later.
57137

58138
## Consume proposed components
59139

0 commit comments

Comments
 (0)