Skip to content

Commit

Permalink
docs: Update docs to reflect image changes
Browse files Browse the repository at this point in the history
Signed-off-by: Din Music <[email protected]>
  • Loading branch information
MusicDin committed Apr 6, 2024
1 parent a7e355f commit 2d08ef3
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 27 deletions.
2 changes: 1 addition & 1 deletion docs/examples/full-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ cluster:
privateKeyPath: "~/.ssh/id_rsa_test"
addToKnownHosts: true
os:
distro: ubuntu
distro: ubuntu22
networkInterface: ens3 # (20)!
dns: # (21)!
- 1.1.1.1
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/ha-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ cluster:
ssh:
addToKnownHosts: true
os:
distro: ubuntu
distro: ubuntu22
nodes:
loadBalancer:
vip: 10.10.13.200
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/multi-master-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ The load balancer is then configured to distribute traffic received on port 6443
ssh:
addToKnownHosts: true
os:
distro: ubuntu
distro: ubuntu22
nodes:
loadBalancer:
instances:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/multi-worker-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ cluster:
ssh:
addToKnownHosts: true
os:
distro: ubuntu
distro: ubuntu22
nodes:
master:
instances:
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/rook-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ However, this behavior can be restricted using node selectors, which are explain
ssh:
addToKnownHosts: true
os:
distro: ubuntu
distro: ubuntu22
nodes:
master:
instances:
Expand Down Expand Up @@ -238,7 +238,7 @@ addons:
ssh:
addToKnownHosts: true
os:
distro: ubuntu
distro: ubuntu22
nodes:
master:
instances:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/single-node-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ This means that the single master node in the cluster will perform both the cont
ssh:
addToKnownHosts: true
os:
distro: ubuntu
distro: ubuntu22
nodes:
master:
default:
Expand Down
23 changes: 10 additions & 13 deletions docs/user-guide/configuration/cluster-node-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ cluster:
:material-tag-arrow-up-outline: [v2.1.0][tag 2.1.0]
&ensp;
:octicons-file-symlink-file-24: Default: `ubuntu`
:octicons-file-symlink-file-24: Default: `ubuntu22`

The operating system for virtual machines can be specified in the node template.
By default, the Ubuntu distribution is installed on all virtual machines.
Expand All @@ -48,23 +48,20 @@ You can select a desired distribution by setting the `os.distro` property.
cluster:
nodeTemplate:
os:
distro: debian # (1)!
distro: debian12 # (1)!
```

1. By default, `ubuntu` is used.
1. By default, `ubuntu22` is used.


The available operating system distribution presets are:

+ **`ubuntu`** - Latest Ubuntu 22.04 release. (default)
+ `ubuntu22` - Ubuntu 22.04 release as of *2023-10-26*.
+ `ubuntu20` - Ubuntu 20.04 release as of *2023-10-11*.
+ **`debian`** - Latest Debian 11 release.
+ `debian11` - Debian 11 release as of *2023-10-13*.
+ **`rocky`** - Latest Rocky 9 release.
+ `rocky9` - Rocky 9.2 release as of *2023-05-13*.
+ **`centos`** - Latest CentOS Stream 9 release.
+ `centos9` - CentOS Stream 9 release as of *2023-10-23*.
+ **`ubuntu20`** - Latest Ubuntu 20.04 (Focal) release.
+ **`ubuntu22`** - Latest Ubuntu 22.04 (Jammy) release. (default)
+ **`debian11`** - Latest Debian 11 (Bullseye) release.
+ **`debian12`** - Latest Debian 12 (Bookworm) release.
+ **`centos9`** - Latest CentOS Stream 9 release.
+ **`rocky9`** - Latest Rocky 9 release.

!!! warning "Important"

Expand Down Expand Up @@ -98,7 +95,7 @@ The source of an image can be either a local path on your system or a URL pointi
cluster:
nodeTemplate:
os:
distro: ubuntu
distro: ubuntu20
source: https://cloud-images.ubuntu.com/focal/current/focal-server-cloudimg-amd64.img
```

Expand Down
11 changes: 4 additions & 7 deletions docs/user-guide/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -642,20 +642,17 @@ Each configuration property is documented with 5 columns: Property name, descrip
<tr>
<td><code>cluster.nodeTemplate.os.distro</code></td>
<td>string</td>
<td>ubuntu</td>
<td>ubuntu22</td>
<td></td>
<td>
Set OS distribution. Possible values are:
<ul>
<li><code>ubuntu</code></li>
<li><code>ubuntu22</code></li>
<li><code>ubuntu20</code></li>
<li><code>debian</code></li>
<li><code>ubuntu22</code></li>
<li><code>debian11</code></li>
<li><code>rocky</code></li>
<li><code>rocky9</code></li>
<li><code>centos</code></li>
<li><code>debian12</code></li>
<li><code>centos9</code></li>
<li><code>rocky9</code></li>
</ul>
</td>
</tr>
Expand Down

0 comments on commit 2d08ef3

Please sign in to comment.