Skip to content

Commit

Permalink
Merge pull request #9463 from odvarkadaniel/change-kubernetes-version…
Browse files Browse the repository at this point in the history
…-docs

📖 Change kubernetes-version in ignition/cluster generation parts of the book
  • Loading branch information
k8s-ci-robot committed Sep 19, 2023
2 parents 4e7af72 + a9a1a09 commit 56d8de5
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
18 changes: 9 additions & 9 deletions docs/book/src/clusterctl/commands/generate-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The `clusterctl generate cluster` command returns a YAML template for creating a
For example

```bash
clusterctl generate cluster my-cluster --kubernetes-version v1.16.3 --control-plane-machine-count=3 --worker-machine-count=3 > my-cluster.yaml
clusterctl generate cluster my-cluster --kubernetes-version v1.28.0 --control-plane-machine-count=3 --worker-machine-count=3 > my-cluster.yaml
```

Generates a YAML file named `my-cluster.yaml` with a predefined list of Cluster API objects; Cluster, Machines,
Expand All @@ -29,14 +29,14 @@ In case there is more than one infrastructure provider, the following syntax can
provider to use for the workload cluster:

```bash
clusterctl generate cluster my-cluster --kubernetes-version v1.16.3 \
clusterctl generate cluster my-cluster --kubernetes-version v1.28.0 \
--infrastructure aws > my-cluster.yaml
```

or

```bash
clusterctl generate cluster my-cluster --kubernetes-version v1.16.3 \
clusterctl generate cluster my-cluster --kubernetes-version v1.28.0 \
--infrastructure aws:v0.4.1 > my-cluster.yaml
```

Expand All @@ -46,7 +46,7 @@ The infrastructure provider authors can provide different types of cluster templ
to specify which flavor to use; e.g.

```bash
clusterctl generate cluster my-cluster --kubernetes-version v1.16.3 \
clusterctl generate cluster my-cluster --kubernetes-version v1.28.0 \
--flavor high-availability > my-cluster.yaml
```

Expand All @@ -62,7 +62,7 @@ for cluster templates can be used as well:
Use the `--from-config-map` flag to read cluster templates stored in a Kubernetes ConfigMap; e.g.

```bash
clusterctl generate cluster my-cluster --kubernetes-version v1.16.3 \
clusterctl generate cluster my-cluster --kubernetes-version v1.28.0 \
--from-config-map my-templates > my-cluster.yaml
```

Expand All @@ -75,28 +75,28 @@ Use the `--from` flag to read cluster templates stored in a GitHub repository, r
or from the standard input; e.g.

```bash
clusterctl generate cluster my-cluster --kubernetes-version v1.16.3 \
clusterctl generate cluster my-cluster --kubernetes-version v1.28.0 \
--from https://github.com/my-org/my-repository/blob/main/my-template.yaml > my-cluster.yaml
```

or

```bash
clusterctl generate cluster my-cluster --kubernetes-version v1.16.3 \
clusterctl generate cluster my-cluster --kubernetes-version v1.28.0 \
--from https://foo.bar/my-template.yaml > my-cluster.yaml
```

or

```bash
clusterctl generate cluster my-cluster --kubernetes-version v1.16.3 \
clusterctl generate cluster my-cluster --kubernetes-version v1.28.0 \
--from ~/my-template.yaml > my-cluster.yaml
```

or

```bash
cat ~/my-template.yaml | clusterctl generate cluster my-cluster --kubernetes-version v1.16.3 \
cat ~/my-template.yaml | clusterctl generate cluster my-cluster --kubernetes-version v1.28.0 \
--from - > my-cluster.yaml
```

Expand Down
4 changes: 3 additions & 1 deletion docs/book/src/tasks/experimental-features/ignition.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,13 @@ export AWS_NODE_MACHINE_TYPE=t3a.small

clusterctl generate cluster ignition-cluster \
--from https://github.com/kubernetes-sigs/cluster-api-provider-aws/blob/main/templates/cluster-template-flatcar.yaml \
--kubernetes-version v1.22.2 \
--kubernetes-version v1.28.0 \
--worker-machine-count 2 \
> ignition-cluster.yaml
```

NOTE: Only certain Kubernetes versions have pre-built Kubernetes AMIs. See [list](https://cluster-api-aws.sigs.k8s.io/topics/images/built-amis) of published pre-built Kubernetes AMIs.

## Apply the workload cluster

```bash
Expand Down

0 comments on commit 56d8de5

Please sign in to comment.