Skip to content

Commit 0db23d4

Browse files
invidianinvidian
committed
docs/book/src: add Ignition support documentation
Signed-off-by: Mateusz Gozdek <[email protected]>
1 parent 933a0e4 commit 0db23d4

File tree

4 files changed

+385
-0
lines changed

4 files changed

+385
-0
lines changed

‎docs/book/src/SUMMARY_PREFIX.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,4 @@
3131
- [Userdata Privacy](./topics/userdata-privacy.md)
3232
- [Troubleshooting](./topics/troubleshooting.md)
3333
- [IAM Permissions Used](./topics/iam-permissions.md)
34+
- [Ignition support](./topics/ignition-support.md)

‎docs/book/src/crd/index.md

Lines changed: 249 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1218,6 +1218,22 @@ Parameter Storage policies. By default or with the value of secrets-manager,
12181218
will generate AWS Secrets Manager policies instead.</p>
12191219
</td>
12201220
</tr>
1221+
<tr>
1222+
<td>
1223+
<code>s3Buckets</code><br/>
1224+
<em>
1225+
<a href="#bootstrap.aws.infrastructure.cluster.x-k8s.io/v1beta1.S3Buckets">
1226+
S3Buckets
1227+
</a>
1228+
</em>
1229+
</td>
1230+
<td>
1231+
<em>(Optional)</em>
1232+
<p>S3Buckets, when enabled, will add controller nodes permissions to
1233+
create S3 Buckets for workload clusters.
1234+
TODO: This field could be a pointer, but it seems it breaks setting default values?</p>
1235+
</td>
1236+
</tr>
12211237
</table>
12221238
</td>
12231239
</tr>
@@ -1401,6 +1417,22 @@ Parameter Storage policies. By default or with the value of secrets-manager,
14011417
will generate AWS Secrets Manager policies instead.</p>
14021418
</td>
14031419
</tr>
1420+
<tr>
1421+
<td>
1422+
<code>s3Buckets</code><br/>
1423+
<em>
1424+
<a href="#bootstrap.aws.infrastructure.cluster.x-k8s.io/v1beta1.S3Buckets">
1425+
S3Buckets
1426+
</a>
1427+
</em>
1428+
</td>
1429+
<td>
1430+
<em>(Optional)</em>
1431+
<p>S3Buckets, when enabled, will add controller nodes permissions to
1432+
create S3 Buckets for workload clusters.
1433+
TODO: This field could be a pointer, but it seems it breaks setting default values?</p>
1434+
</td>
1435+
</tr>
14041436
</tbody>
14051437
</table>
14061438
<h3 id="bootstrap.aws.infrastructure.cluster.x-k8s.io/v1beta1.AWSIAMRoleSpec">AWSIAMRoleSpec
@@ -1891,6 +1923,48 @@ EC2 container registry</p>
18911923
</tr>
18921924
</tbody>
18931925
</table>
1926+
<h3 id="bootstrap.aws.infrastructure.cluster.x-k8s.io/v1beta1.S3Buckets">S3Buckets
1927+
</h3>
1928+
<p>
1929+
(<em>Appears on:</em><a href="#bootstrap.aws.infrastructure.cluster.x-k8s.io/v1beta1.AWSIAMConfigurationSpec">AWSIAMConfigurationSpec</a>)
1930+
</p>
1931+
<p>
1932+
<p>S3Buckets controls the configuration of the AWS IAM role for S3 buckets
1933+
which can be created for storing bootstrap data for nodes requiring it.</p>
1934+
</p>
1935+
<table>
1936+
<thead>
1937+
<tr>
1938+
<th>Field</th>
1939+
<th>Description</th>
1940+
</tr>
1941+
</thead>
1942+
<tbody>
1943+
<tr>
1944+
<td>
1945+
<code>enable</code><br/>
1946+
<em>
1947+
bool
1948+
</em>
1949+
</td>
1950+
<td>
1951+
<p>Enable controls whether permissions are granted to manage S3 buckets.</p>
1952+
</td>
1953+
</tr>
1954+
<tr>
1955+
<td>
1956+
<code>namePrefix</code><br/>
1957+
<em>
1958+
string
1959+
</em>
1960+
</td>
1961+
<td>
1962+
<p>NamePrefix will be prepended to every AWS IAM role bucket name. Defaults to &ldquo;cluster-api-provider-aws-&rdquo;.
1963+
AWSCluster S3 Bucket name must be prefixed with the same prefix.</p>
1964+
</td>
1965+
</tr>
1966+
</tbody>
1967+
</table>
18941968
<hr/>
18951969
<h2 id="bootstrap.cluster.x-k8s.io/v1alpha4">bootstrap.cluster.x-k8s.io/v1alpha4</h2>
18961970
Resource Types:
@@ -13534,6 +13608,23 @@ AWSIdentityReference
1353413608
<p>IdentityRef is a reference to a identity to be used when reconciling this cluster</p>
1353513609
</td>
1353613610
</tr>
13611+
<tr>
13612+
<td>
13613+
<code>s3Bucket</code><br/>
13614+
<em>
13615+
<a href="#infrastructure.cluster.x-k8s.io/v1beta1.S3Bucket">
13616+
S3Bucket
13617+
</a>
13618+
</em>
13619+
</td>
13620+
<td>
13621+
<em>(Optional)</em>
13622+
<p>S3Bucket contains options to configure a supporting S3 bucket for this
13623+
cluster - currently used for nodes requiring Ignition
13624+
(<a href="https://coreos.github.io/ignition/">https://coreos.github.io/ignition/</a>) for bootstrapping (requires
13625+
BootstrapFormatIgnition feature flag to be enabled).</p>
13626+
</td>
13627+
</tr>
1353713628
</table>
1353813629
</td>
1353913630
</tr>
@@ -14049,6 +14140,23 @@ AWSIdentityReference
1404914140
<p>IdentityRef is a reference to a identity to be used when reconciling this cluster</p>
1405014141
</td>
1405114142
</tr>
14143+
<tr>
14144+
<td>
14145+
<code>s3Bucket</code><br/>
14146+
<em>
14147+
<a href="#infrastructure.cluster.x-k8s.io/v1beta1.S3Bucket">
14148+
S3Bucket
14149+
</a>
14150+
</em>
14151+
</td>
14152+
<td>
14153+
<em>(Optional)</em>
14154+
<p>S3Bucket contains options to configure a supporting S3 bucket for this
14155+
cluster - currently used for nodes requiring Ignition
14156+
(<a href="https://coreos.github.io/ignition/">https://coreos.github.io/ignition/</a>) for bootstrapping (requires
14157+
BootstrapFormatIgnition feature flag to be enabled).</p>
14158+
</td>
14159+
</tr>
1405214160
</tbody>
1405314161
</table>
1405414162
<h3 id="infrastructure.cluster.x-k8s.io/v1beta1.AWSClusterStaticIdentity">AWSClusterStaticIdentity
@@ -14512,6 +14620,23 @@ AWSIdentityReference
1451214620
<p>IdentityRef is a reference to a identity to be used when reconciling this cluster</p>
1451314621
</td>
1451414622
</tr>
14623+
<tr>
14624+
<td>
14625+
<code>s3Bucket</code><br/>
14626+
<em>
14627+
<a href="#infrastructure.cluster.x-k8s.io/v1beta1.S3Bucket">
14628+
S3Bucket
14629+
</a>
14630+
</em>
14631+
</td>
14632+
<td>
14633+
<em>(Optional)</em>
14634+
<p>S3Bucket contains options to configure a supporting S3 bucket for this
14635+
cluster - currently used for nodes requiring Ignition
14636+
(<a href="https://coreos.github.io/ignition/">https://coreos.github.io/ignition/</a>) for bootstrapping (requires
14637+
BootstrapFormatIgnition feature flag to be enabled).</p>
14638+
</td>
14639+
</tr>
1451514640
</table>
1451614641
</td>
1451714642
</tr>
@@ -15005,6 +15130,20 @@ CloudInit is used.</p>
1500515130
</tr>
1500615131
<tr>
1500715132
<td>
15133+
<code>ignition</code><br/>
15134+
<em>
15135+
<a href="#infrastructure.cluster.x-k8s.io/v1beta1.Ignition">
15136+
Ignition
15137+
</a>
15138+
</em>
15139+
</td>
15140+
<td>
15141+
<em>(Optional)</em>
15142+
<p>Ignition defined options related to the bootstrapping systems where Ignition is used.</p>
15143+
</td>
15144+
</tr>
15145+
<tr>
15146+
<td>
1500815147
<code>spotMarketOptions</code><br/>
1500915148
<em>
1501015149
<a href="#infrastructure.cluster.x-k8s.io/v1beta1.SpotMarketOptions">
@@ -15331,6 +15470,20 @@ CloudInit is used.</p>
1533115470
</tr>
1533215471
<tr>
1533315472
<td>
15473+
<code>ignition</code><br/>
15474+
<em>
15475+
<a href="#infrastructure.cluster.x-k8s.io/v1beta1.Ignition">
15476+
Ignition
15477+
</a>
15478+
</em>
15479+
</td>
15480+
<td>
15481+
<em>(Optional)</em>
15482+
<p>Ignition defined options related to the bootstrapping systems where Ignition is used.</p>
15483+
</td>
15484+
</tr>
15485+
<tr>
15486+
<td>
1533415487
<code>spotMarketOptions</code><br/>
1533515488
<em>
1533615489
<a href="#infrastructure.cluster.x-k8s.io/v1beta1.SpotMarketOptions">
@@ -15861,6 +16014,20 @@ CloudInit is used.</p>
1586116014
</tr>
1586216015
<tr>
1586316016
<td>
16017+
<code>ignition</code><br/>
16018+
<em>
16019+
<a href="#infrastructure.cluster.x-k8s.io/v1beta1.Ignition">
16020+
Ignition
16021+
</a>
16022+
</em>
16023+
</td>
16024+
<td>
16025+
<em>(Optional)</em>
16026+
<p>Ignition defined options related to the bootstrapping systems where Ignition is used.</p>
16027+
</td>
16028+
</tr>
16029+
<tr>
16030+
<td>
1586416031
<code>spotMarketOptions</code><br/>
1586516032
<em>
1586616033
<a href="#infrastructure.cluster.x-k8s.io/v1beta1.SpotMarketOptions">
@@ -16834,6 +17001,36 @@ string
1683417001
</tr>
1683517002
</tbody>
1683617003
</table>
17004+
<h3 id="infrastructure.cluster.x-k8s.io/v1beta1.Ignition">Ignition
17005+
</h3>
17006+
<p>
17007+
(<em>Appears on:</em><a href="#infrastructure.cluster.x-k8s.io/v1beta1.AWSMachineSpec">AWSMachineSpec</a>)
17008+
</p>
17009+
<p>
17010+
<p>Ignition defines options related to the bootstrapping systems where Ignition is used.</p>
17011+
</p>
17012+
<table>
17013+
<thead>
17014+
<tr>
17015+
<th>Field</th>
17016+
<th>Description</th>
17017+
</tr>
17018+
</thead>
17019+
<tbody>
17020+
<tr>
17021+
<td>
17022+
<code>version</code><br/>
17023+
<em>
17024+
string
17025+
</em>
17026+
</td>
17027+
<td>
17028+
<em>(Optional)</em>
17029+
<p>Version defines which version of Ignition will be used to generate bootstrap data.</p>
17030+
</td>
17031+
</tr>
17032+
</tbody>
17033+
</table>
1683717034
<h3 id="infrastructure.cluster.x-k8s.io/v1beta1.IngressRule">IngressRule
1683817035
</h3>
1683917036
<p>
@@ -17355,6 +17552,58 @@ string
1735517552
</tr>
1735617553
</tbody>
1735717554
</table>
17555+
<h3 id="infrastructure.cluster.x-k8s.io/v1beta1.S3Bucket">S3Bucket
17556+
</h3>
17557+
<p>
17558+
(<em>Appears on:</em><a href="#infrastructure.cluster.x-k8s.io/v1beta1.AWSClusterSpec">AWSClusterSpec</a>)
17559+
</p>
17560+
<p>
17561+
</p>
17562+
<table>
17563+
<thead>
17564+
<tr>
17565+
<th>Field</th>
17566+
<th>Description</th>
17567+
</tr>
17568+
</thead>
17569+
<tbody>
17570+
<tr>
17571+
<td>
17572+
<code>controlPlaneIAMInstanceProfile</code><br/>
17573+
<em>
17574+
string
17575+
</em>
17576+
</td>
17577+
<td>
17578+
<p>ControlPlaneIAMInstanceProfile is a name of the IAMInstanceProfile, which will be allowed
17579+
to read control-plane node bootstrap data from S3 Bucket.</p>
17580+
</td>
17581+
</tr>
17582+
<tr>
17583+
<td>
17584+
<code>nodesIAMInstanceProfiles</code><br/>
17585+
<em>
17586+
[]string
17587+
</em>
17588+
</td>
17589+
<td>
17590+
<p>NodesIAMInstanceProfiles is a list of IAM instance profiles, which will be allowed to read
17591+
worker nodes bootstrap data from S3 Bucket.</p>
17592+
</td>
17593+
</tr>
17594+
<tr>
17595+
<td>
17596+
<code>name</code><br/>
17597+
<em>
17598+
string
17599+
</em>
17600+
</td>
17601+
<td>
17602+
<p>Name defines name of S3 Bucket to be created.</p>
17603+
</td>
17604+
</tr>
17605+
</tbody>
17606+
</table>
1735817607
<h3 id="infrastructure.cluster.x-k8s.io/v1beta1.SecretBackend">SecretBackend
1735917608
(<code>string</code> alias)</p></h3>
1736017609
<p>

‎docs/book/src/topics/iam-permissions.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ and `control-plane.cluster-api-provider-aws.sigs.k8s.io` IAM roles.
2626
{{#include ../../../../out/AWSIAMManagedPolicyControllersWithEKS.json}}
2727
```
2828

29+
### With S3 Support
30+
``` json
31+
{{#include ../../../../out/AWSIAMManagedPolicyControllersWithS3.json}}
32+
```
33+
2934
## Required by the Kubernetes AWS Cloud Provider
3035

3136
These permissions are used by the Kubernetes AWS Cloud Provider. If you are

0 commit comments

Comments
 (0)