Skip to content

Commit 1b9bfb7

Browse files
committed
OCPBUGS-18027: explain use of multiple AWS security groups
1 parent ea48524 commit 1b9bfb7

File tree

1 file changed

+42
-34
lines changed

1 file changed

+42
-34
lines changed

modules/machineset-yaml-aws.adoc

Lines changed: 42 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -59,49 +59,49 @@ spec:
5959
replicas: 1
6060
selector:
6161
matchLabels:
62-
machine.openshift.io/cluster-api-cluster: <infrastructure_id> <1>
62+
machine.openshift.io/cluster-api-cluster: <infrastructure_id>
6363
ifdef::edge[]
6464
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-edge-<zone>
6565
endif::edge[]
6666
ifndef::infra,edge[]
67-
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>-<zone> <2>
67+
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>-<zone>
6868
endif::infra,edge[]
6969
ifdef::infra[]
70-
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-infra-<zone> <2>
70+
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-infra-<zone>
7171
endif::infra[]
7272
template:
7373
metadata:
7474
labels:
75-
machine.openshift.io/cluster-api-cluster: <infrastructure_id> <1>
75+
machine.openshift.io/cluster-api-cluster: <infrastructure_id>
7676
ifndef::infra,edge[]
7777
machine.openshift.io/cluster-api-machine-role: <role> <3>
78-
machine.openshift.io/cluster-api-machine-type: <role> <3>
79-
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>-<zone> <2>
78+
machine.openshift.io/cluster-api-machine-type: <role>
79+
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>-<zone>
8080
endif::infra,edge[]
8181
ifdef::infra[]
8282
machine.openshift.io/cluster-api-machine-role: infra <3>
83-
machine.openshift.io/cluster-api-machine-type: infra <3>
84-
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-infra-<zone> <2>
83+
machine.openshift.io/cluster-api-machine-type: infra
84+
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-infra-<zone>
8585
endif::infra[]
8686
ifdef::edge[]
8787
machine.openshift.io/cluster-api-machine-role: edge <3>
88-
machine.openshift.io/cluster-api-machine-type: edge <3>
89-
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-edge-<zone> <2>
88+
machine.openshift.io/cluster-api-machine-type: edge
89+
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-edge-<zone>
9090
endif::edge[]
9191
spec:
9292
metadata:
9393
labels:
9494
ifndef::infra,edge[]
95-
node-role.kubernetes.io/<role>: "" <3>
95+
node-role.kubernetes.io/<role>: ""
9696
endif::infra,edge[]
9797
ifdef::infra[]
98-
node-role.kubernetes.io/infra: "" <3>
98+
node-role.kubernetes.io/infra: ""
9999
endif::infra[]
100100
ifdef::edge[]
101101
machine.openshift.io/parent-zone-name: <value_of_ParentZoneName>
102102
machine.openshift.io/zone-group: <value_of_GroupName>
103103
machine.openshift.io/zone-type: <value_of_ZoneType>
104-
node-role.kubernetes.io/edge: "" <3>
104+
node-role.kubernetes.io/edge: ""
105105
endif::edge[]
106106
providerSpec:
107107
value:
@@ -117,17 +117,21 @@ endif::edge[]
117117
name: aws-cloud-credentials
118118
deviceIndex: 0
119119
iamInstanceProfile:
120-
id: <infrastructure_id>-worker-profile <1>
120+
id: <infrastructure_id>-worker-profile
121121
instanceType: m6i.large
122122
kind: AWSMachineProviderConfig
123123
placement:
124-
availabilityZone: <zone> <6>
125-
region: <region> <7>
124+
availabilityZone: <zone> <5>
125+
region: <region> <6>
126126
securityGroups:
127127
- filters:
128128
- name: tag:Name
129129
values:
130-
- <infrastructure_id>-worker-sg <1>
130+
- <infrastructure_id>-worker-sg
131+
- filters: <7>
132+
- name: tag:Name
133+
values:
134+
- <optional_security_group>
131135
subnet:
132136
ifndef::edge[]
133137
filters:
@@ -136,18 +140,18 @@ ifndef::edge[]
136140
- <infrastructure_id>-private-<zone> <8>
137141
endif::edge[]
138142
ifdef::edge[]
139-
id: <value_of_PublicSubnetIds> <8>
143+
id: <value_of_PublicSubnetIds> <8>
140144
publicIp: true
141145
endif::edge[]
142-
tags:
143-
- name: kubernetes.io/cluster/<infrastructure_id> <1>
146+
tags: <9>
147+
- name: kubernetes.io/cluster/<infrastructure_id>
144148
value: owned
145-
- name: <custom_tag_name> <5>
146-
value: <custom_tag_value> <5>
149+
- name: <custom_tag_name>
150+
value: <custom_tag_value>
147151
userDataSecret:
148152
name: worker-user-data
149153
ifdef::infra,edge[]
150-
taints: <9>
154+
taints: <10>
151155
ifdef::infra[]
152156
- key: node-role.kubernetes.io/infra
153157
endif::infra[]
@@ -184,28 +188,32 @@ $ oc -n openshift-machine-api \
184188
-o jsonpath='{.spec.template.spec.providerSpec.value.ami.id}{"\n"}' \
185189
get machineset/<infrastructure_id>-<role>-<zone>
186190
----
187-
<5> Optional: Specify custom tag data for your cluster. For example, you might add an admin contact email address by specifying a `name:value` pair of `Email:\[email protected]`.
188-
+
189-
[NOTE]
190-
====
191-
Custom tags can also be specified during installation in the `install-config.yml` file. If the `install-config.yml` file and the machine set include a tag with the same `name` data, the value for the tag from the machine set takes priority over the value for the tag in the `install-config.yml` file.
192-
====
193-
194191
ifndef::edge[]
195-
<6> Specify the zone, for example, `us-east-1a`.
192+
<5> Specify the zone, for example, `us-east-1a`.
196193
endif::edge[]
197194
ifdef::edge[]
198-
<6> Specify the zone name, for example, `us-east-1-nyc-1a`.
195+
<5> Specify the zone name, for example, `us-east-1-nyc-1a`.
199196
endif::edge[]
200-
<7> Specify the region, for example, `us-east-1`.
197+
<6> Specify the region, for example, `us-east-1`.
198+
<7> Optional: Specify one or more additional security groups using the format shown.
199+
When you specify multiple security groups, the rules are merged and applied to the instance as described in link:https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html[{aws-short} documentation about security group rules].
200+
Refer to {aws-short} documentation for guidance on quotas and other limitations.
201201
ifndef::edge[]
202202
<8> Specify the infrastructure ID and zone.
203203
endif::edge[]
204204
ifdef::edge[]
205205
<8> The ID of the public subnet that you created in AWS {zone-type}. You created this public subnet ID when you finished the procedure for "Creating a subnet in an AWS zone".
206206
endif::edge[]
207+
<9> Optional: Specify custom tag data for your cluster in addition to the existing `kubernetes.io/cluster/<infrastructure_id>` tag.
208+
For example, you might add an admin contact email address by specifying a `name:value` pair of `Email:\[email protected]`.
209+
+
210+
[NOTE]
211+
====
212+
Custom tags can also be specified during installation in the `install-config.yml` file.
213+
If the `install-config.yml` file and the machine set include a tag with the same `name` data, the value for the tag from the machine set takes priority over the value for the tag in the `install-config.yml` file.
214+
====
207215
ifdef::infra,edge[]
208-
<9> Specify a taint to prevent user workloads from being scheduled on
216+
<10> Specify a taint to prevent user workloads from being scheduled on
209217
ifdef::infra[`infra`]
210218
ifdef::edge[`edge`]
211219
nodes.

0 commit comments

Comments
 (0)