Skip to content

Commit f807270

Browse files
jeana-redhatjeana-redhat
committed
OSDOCS-10635: Docs for Cluster API Provider OpenStack 4.18+
1 parent b5161c3 commit f807270

14 files changed

+218
-31
lines changed

Diff for: ‎_topic_maps/_topic_map.yml

+2
Original file line numberDiff line numberDiff line change
@@ -2465,6 +2465,8 @@ Topics:
24652465
File: cluster-api-config-options-gcp
24662466
- Name: Cluster API configuration options for Microsoft Azure
24672467
File: cluster-api-config-options-azure
2468+
- Name: Cluster API configuration options for Red Hat OpenStack Platform
2469+
File: cluster-api-config-options-rhosp
24682470
- Name: Cluster API configuration options for VMware vSphere
24692471
File: cluster-api-config-options-vsphere
24702472
# - Name: Cluster API resiliency and recovery

Diff for: ‎machine_management/cluster_api_machine_management/cluster-api-about.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ toc::[]
99
:FeatureName: Managing machines with the Cluster API
1010
include::snippets/technology-preview.adoc[]
1111

12-
The link:https://cluster-api.sigs.k8s.io/[Cluster API] is an upstream project that is integrated into {product-title} as a Technology Preview for {aws-first}, {gcp-first}, {azure-first} and {vmw-first}.
12+
The link:https://cluster-api.sigs.k8s.io/[Cluster API] is an upstream project that is integrated into {product-title} as a Technology Preview for {aws-first}, {gcp-first}, {azure-first}, {rh-openstack-first}, and {vmw-first}.
1313

1414
//Cluster API overview
1515
include::modules/capi-overview.adoc[leveloffset=+1]

Diff for: ‎machine_management/cluster_api_machine_management/cluster-api-configuration.adoc

+2
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,6 @@ For provider-specific configuration options for your cluster, see the following
2626

2727
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-azure.adoc#cluster-api-config-options-azure[Cluster API configuration options for {azure-full}]
2828

29+
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-rhosp.adoc#cluster-api-config-options-rhosp[Cluster API configuration options for {rh-openstack}]
30+
2931
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc#cluster-api-config-options-vsphere[Cluster API configuration options for {vmw-full}]

Diff for: ‎machine_management/cluster_api_machine_management/cluster-api-getting-started.adoc

+2
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ include::modules/capi-creating-machine-template.adoc[leveloffset=+2]
3434
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-aws.adoc#capi-yaml-machine-template-aws_cluster-api-config-options-aws[Sample YAML for a Cluster API machine template resource on {aws-full}]
3535
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-gcp.adoc#capi-yaml-machine-template-gcp_cluster-api-config-options-gcp[Sample YAML for a Cluster API machine template resource on {gcp-full}]
3636
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-azure.adoc#capi-yaml-machine-template-azure_cluster-api-config-options-azure[Sample YAML for a Cluster API machine template resource on {azure-full}]
37+
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-rhosp.adoc#capi-yaml-machine-template-rhosp_cluster-api-config-options-rhosp[Sample YAML for a Cluster API machine template resource on {rh-openstack}]
3738
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc#capi-yaml-machine-template-vsphere_cluster-api-config-options-vsphere[Sample YAML for a Cluster API machine template resource on {vmw-full}]
3839

3940
//Creating a Cluster API compute machine set
@@ -43,4 +44,5 @@ include::modules/capi-creating-machine-set.adoc[leveloffset=+2]
4344
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-aws.adoc#capi-yaml-machine-set-aws_cluster-api-config-options-aws[Sample YAML for a Cluster API compute machine set resource on {aws-full}]
4445
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-gcp.adoc#capi-yaml-machine-set-gcp_cluster-api-config-options-gcp[Sample YAML for a Cluster API compute machine set resource on {gcp-full}]
4546
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-azure.adoc#capi-yaml-machine-set-azure_cluster-api-config-options-azure[Sample YAML for a Cluster API compute machine set resource on {azure-full}]
47+
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-rhosp.adoc#capi-yaml-machine-set-rhosp_cluster-api-config-options-rhosp[Sample YAML for a Cluster API compute machine set resource on {rh-openstack}]
4648
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc#capi-yaml-machine-set-vsphere_cluster-api-config-options-vsphere[Sample YAML for a Cluster API compute machine set resource on {vmw-full}]

Diff for: ‎machine_management/cluster_api_machine_management/cluster-api-managing-machines.adoc

+2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ include::modules/capi-modifying-machine-template.adoc[leveloffset=+1]
1616
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-aws.adoc#capi-yaml-machine-template-aws_cluster-api-config-options-aws[Sample YAML for a Cluster API machine template resource on {aws-full}]
1717
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-gcp.adoc#capi-yaml-machine-template-gcp_cluster-api-config-options-gcp[Sample YAML for a Cluster API machine template resource on {gcp-full}]
1818
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-azure.adoc#capi-yaml-machine-template-azure_cluster-api-config-options-azure[Sample YAML for a Cluster API machine template resource on {azure-full}]
19+
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-rhosp.adoc#capi-yaml-machine-template-rhosp_cluster-api-config-options-rhosp[Sample YAML for a Cluster API machine template resource on {rh-openstack}]
1920
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc#capi-yaml-machine-template-vsphere_cluster-api-config-options-vsphere[Sample YAML for a Cluster API machine template resource on {vmw-full}]
2021
* xref:../../machine_management/cluster_api_machine_management/cluster-api-managing-machines.adoc#machineset-modifying_cluster-api-managing-machines[Modifying a compute machine set by using the CLI]
2122
@@ -27,4 +28,5 @@ include::modules/machineset-modifying.adoc[leveloffset=+1,tag=!MAPI]
2728
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-aws.adoc#capi-yaml-machine-set-aws_cluster-api-config-options-aws[Sample YAML for a Cluster API compute machine set resource on {aws-full}]
2829
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-gcp.adoc#capi-yaml-machine-set-gcp_cluster-api-config-options-gcp[Sample YAML for a Cluster API compute machine set resource on {gcp-full}]
2930
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-azure.adoc#capi-yaml-machine-set-azure_cluster-api-config-options-azure[Sample YAML for a Cluster API compute machine set resource on {azure-full}]
31+
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-rhosp.adoc#capi-yaml-machine-set-rhosp_cluster-api-config-options-rhosp[Sample YAML for a Cluster API compute machine set resource on {rh-openstack}]
3032
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc#capi-yaml-machine-set-vsphere_cluster-api-config-options-vsphere[Sample YAML for a Cluster API compute machine set resource on {vmw-full}]

Diff for: ‎machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-rhosp.adoc

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="cluster-api-config-options-rhosp"]
3+
= Cluster API configuration options for Red{nbsp}Hat OpenStack Platform
4+
include::_attributes/common-attributes.adoc[]
5+
:context: cluster-api-config-options-rhosp
6+
7+
toc::[]
8+
9+
:FeatureName: Managing machines with the Cluster API
10+
include::snippets/technology-preview.adoc[]
11+
12+
You can change the configuration of your {rh-openstack-first} Cluster API machines by updating values in the Cluster API custom resource manifests.
13+
14+
[id="cluster-api-sample-yaml-rhosp_{context}"]
15+
== Sample YAML for configuring {rh-openstack} clusters
16+
17+
The following example YAML files show configurations for a {rh-openstack} cluster.
18+
19+
//Sample YAML for CAPI RHOSP machine template resource
20+
include::modules/capi-yaml-machine-template-rhosp.adoc[leveloffset=+2]
21+
22+
//Sample YAML for a CAPI RHOSP compute machine set resource
23+
include::modules/capi-yaml-machine-set-rhosp.adoc[leveloffset=+2]
24+
25+
// [id="cluster-api-supported-features-rhosp_{context}"]
26+
// == Enabling {rh-openstack} features with the Cluster API
27+
28+
// You can enable the following features by updating values in the Cluster API custom resource manifests.
29+
30+
//Not sure what, if anything, we can add here at this time.

Diff for: ‎modules/capi-creating-cluster-resource.adoc

+19-4
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,25 @@ spec:
4343
<2> Specify the infrastructure kind for the cluster.
4444
The following values are valid:
4545
+
46-
* `AWSCluster`: The cluster is running on {aws-first}.
47-
* `GCPCluster`: The cluster is running on {gcp-first}.
48-
* `AzureCluster`: The cluster is running on {azure-first}.
49-
* `VSphereCluster`: The cluster is running on {vmw-first}.
46+
|====
47+
|Cluster cloud provider |Value
48+
49+
|{aws-first}
50+
|`AWSCluster`
51+
52+
|{gcp-first}
53+
|`GCPCluster`
54+
55+
|{azure-first}
56+
|`AzureCluster`
57+
58+
|{rh-openstack-first}
59+
|`OpenStackCluster`
60+
61+
|{vmw-first}
62+
|`VSphereCluster`
63+
64+
|====
5065
--
5166

5267
. Create the cluster CR by running the following command:

Diff for: ‎modules/capi-creating-machine-template.adoc

+22-5
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,28 @@ spec:
3636
template:
3737
spec: # <3>
3838
----
39-
<1> Specify the machine template kind. This value must match the value for your platform. The following values are valid:
40-
* `AWSMachineTemplate`: The cluster is running on {aws-first}.
41-
* `GCPMachineTemplate`: The cluster is running on {gcp-first}.
42-
* `AzureMachineTemplate`: The cluster is running on {azure-first}.
43-
* `VSphereMachineTemplate`: The cluster is running on {vmw-first}.
39+
<1> Specify the machine template kind. This value must match the value for your platform.
40+
The following values are valid:
41+
+
42+
|====
43+
|Cluster cloud provider |Value
44+
45+
|{aws-first}
46+
|`MachineTemplate`
47+
48+
|{gcp-first}
49+
|`MachineTemplate`
50+
51+
|{azure-first}
52+
|`AzureMachineTemplate`
53+
54+
|{rh-openstack-first}
55+
|`OpenStackMachineTemplate`
56+
57+
|{vmw-first}
58+
|`VSphereMachineTemplate`
59+
60+
|====
4461
<2> Specify a name for the machine template.
4562
<3> Specify the details for your environment. These parameters are provider specific. For more information, see the sample Cluster API machine template YAML for your provider.
4663
--

Diff for: ‎modules/capi-limitations.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Using the Cluster API to manage machines is a Technology Preview feature and has
1515
Enabling this feature set cannot be undone and prevents minor version updates.
1616
====
1717
18-
* Only {aws-first}, {gcp-first}, {azure-first}, and {vmw-first} clusters can use the Cluster API.
18+
* Only {aws-first}, {gcp-first}, {azure-first}, {rh-openstack-first}, and {vmw-first} clusters can use the Cluster API.
1919
2020
* You must manually create some of the primary resources that the Cluster API requires.
2121
For more information, see "Getting started with the Cluster API".

Diff for: ‎modules/capi-modifying-machine-template.adoc

+22-5
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,28 @@ You can update the machine template resource for your cluster by modifying the Y
2525
----
2626
$ oc get <machine_template_kind> <1>
2727
----
28-
<1> Specify the value that corresponds to your platform. The following values are valid:
29-
* `AWSMachineTemplate`: The cluster is running on {aws-first}.
30-
* `GCPMachineTemplate`: The cluster is running on {gcp-first}.
31-
* `AzureMachineTemplate`: The cluster is running on {azure-first}.
32-
* `VSphereMachineTemplate`: The cluster is running on {vmw-first}.
28+
<1> Specify the value that corresponds to your platform.
29+
The following values are valid:
30+
+
31+
|====
32+
|Cluster cloud provider |Value
33+
34+
|{aws-full}
35+
|`AWSMachineTemplate`
36+
37+
|{gcp-full}
38+
|`GCPMachineTemplate`
39+
40+
|{azure-first}
41+
|`AzureMachineTemplate`
42+
43+
|{rh-openstack}
44+
|`OpenStackMachineTemplate`
45+
46+
|{vmw-full}
47+
|`VSphereMachineTemplate`
48+
49+
|====
3350
--
3451
+
3552
.Example output

Diff for: ‎modules/capi-yaml-cluster.adoc

+20-7
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,24 @@ spec:
2929
<1> Specify the name of the cluster.
3030
<2> Specify the IP address of the control plane endpoint and the port used to access it.
3131
<3> Specify the infrastructure kind for the cluster.
32-
Valid values are:
32+
The following values are valid:
3333
+
34-
--
35-
* `AWSCluster`: The cluster is running on {aws-full}.
36-
* `GCPCluster`: The cluster is running on {gcp-full}.
37-
* `AzureCluster`: The cluster is running on {azure-full}.
38-
* `VSphereCluster`: The cluster is running on {vmw-full}.
39-
--
34+
|====
35+
|Cluster cloud provider |Value
36+
37+
|{aws-full}
38+
|`AWSCluster`
39+
40+
|{gcp-short}
41+
|`GCPCluster`
42+
43+
|{azure-short}
44+
|`AzureCluster`
45+
46+
|{rh-openstack}
47+
|`OpenStackCluster`
48+
49+
|{vmw-full}
50+
|`VSphereCluster`
51+
52+
|====

Diff for: ‎modules/capi-yaml-machine-set-rhosp.adoc

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-rhosp.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="capi-yaml-machine-set-rhosp_{context}"]
7+
= Sample YAML for a Cluster API compute machine set resource on {rh-openstack}
8+
9+
The compute machine set resource defines additional properties of the machines that it creates.
10+
The compute machine set also references the infrastructure resource and machine template when creating machines.
11+
12+
[source,yaml]
13+
----
14+
apiVersion: cluster.x-k8s.io/v1beta1
15+
kind: MachineSet
16+
metadata:
17+
name: <machine_set_name> # <1>
18+
namespace: openshift-cluster-api
19+
spec:
20+
clusterName: <cluster_name> # <2>
21+
replicas: 1
22+
selector:
23+
matchLabels:
24+
test: example
25+
cluster.x-k8s.io/cluster-name: <cluster_name>
26+
cluster.x-k8s.io/set-name: <machine_set_name>
27+
template:
28+
metadata:
29+
labels:
30+
test: example
31+
cluster.x-k8s.io/cluster-name: <cluster_name>
32+
cluster.x-k8s.io/set-name: <machine_set_name>
33+
node-role.kubernetes.io/<role>: ""
34+
spec:
35+
bootstrap:
36+
dataSecretName: worker-user-data # <3>
37+
clusterName: <cluster_name>
38+
infrastructureRef:
39+
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
40+
kind: OpenStackMachineTemplate # <4>
41+
name: <template_name> # <5>
42+
failureDomain: <nova_availability_zone> # <6>
43+
----
44+
<1> Specify a name for the compute machine set.
45+
<2> Specify the cluster ID as the name of the cluster.
46+
<3> For the Cluster API Technology Preview, the Operator can use the worker user data secret from the `openshift-machine-api` namespace.
47+
<4> Specify the machine template kind.
48+
This value must match the value for your platform.
49+
<5> Specify the machine template name.
50+
<6> Optional: Specify the name of the Nova availability zone for the machine set to create machines in.
51+
If you do not specify a value, machines are not restricted to a specific availability zone.

Diff for: ‎modules/capi-yaml-machine-template-rhosp.adoc

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-rhosp.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="capi-yaml-machine-template-rhosp_{context}"]
7+
= Sample YAML for a Cluster API machine template resource on {rh-openstack}
8+
9+
The machine template resource is provider-specific and defines the basic properties of the machines that a compute machine set creates.
10+
The compute machine set references this template when creating machines.
11+
12+
[source,yaml]
13+
----
14+
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
15+
kind: OpenStackMachineTemplate # <1>
16+
metadata:
17+
name: <template_name> # <2>
18+
namespace: openshift-cluster-api
19+
spec:
20+
template:
21+
spec: # <3>
22+
flavor: <openstack_node_machine_flavor> # <4>
23+
image:
24+
filter:
25+
name: <openstack_image> # <5>
26+
----
27+
<1> Specify the machine template kind.
28+
This value must match the value for your platform.
29+
<2> Specify a name for the machine template.
30+
<3> Specify the details for your environment.
31+
The values here are examples.
32+
<4> Specify the {rh-openstack} flavor to use.
33+
For more information, see link:https://docs.redhat.com/en/documentation/red_hat_openstack_platform/17.1/html/configuring_the_compute_service_for_instance_creation/assembly_creating-flavors-for-launching-instances_instance-flavors[Creating flavors for launching instances].
34+
<5> Specify the image to use.

Diff for: ‎modules/cluster-capi-operator.adoc

+10-8
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
[NOTE]
99
====
10-
This Operator is available as a link:https://access.redhat.com/support/offerings/techpreview[Technology Preview] for {aws-first}, {gcp-first}, {azure-first}, and {vmw-first} clusters.
10+
This Operator is available as a link:https://access.redhat.com/support/offerings/techpreview[Technology Preview] for {aws-first}, {gcp-first}, {azure-first}, {rh-openstack-first}, and {vmw-first} clusters.
1111
====
1212

1313
[discrete]
@@ -26,29 +26,31 @@ link:https://github.com/openshift/cluster-capi-operator[cluster-capi-operator]
2626
* `awsmachines.infrastructure.cluster.x-k8s.io`
2727
** Scope: Namespaced
2828
** CR: `awsmachine`
29-
** Validation: No
3029

3130
* `gcpmachines.infrastructure.cluster.x-k8s.io`
3231
** Scope: Namespaced
3332
** CR: `gcpmachine`
34-
** Validation: No
33+
34+
* `openstackmachines.infrastructure.cluster.x-k8s.io`
35+
** Scope: Namespaced
36+
** CR: `openstackmachine`
3537

3638
* `vspheremachines.infrastructure.cluster.x-k8s.io`
3739
** Scope: Namespaced
3840
** CR: `vspheremachine`
39-
** Validation: No
4041

4142
* `awsmachinetemplates.infrastructure.cluster.x-k8s.io`
4243
** Scope: Namespaced
4344
** CR: `awsmachinetemplate`
44-
** Validation: No
4545

4646
* `gcpmachinetemplates.infrastructure.cluster.x-k8s.io`
4747
** Scope: Namespaced
4848
** CR: `gcpmachinetemplate`
49-
** Validation: No
49+
50+
* `openstackmachinetemplates.infrastructure.cluster.x-k8s.io`
51+
** Scope: Namespaced
52+
** CR: `openstackmachinetemplate`
5053

5154
* `vspheremachinetemplates.infrastructure.cluster.x-k8s.io`
5255
** Scope: Namespaced
53-
** CR: `vspheremachinetemplate`
54-
** Validation: No
56+
** CR: `vspheremachinetemplate`

0 commit comments

Comments
 (0)