Skip to content

Commit 5ceef88

Browse files
committed
docs: installation how-to
Signed-off-by: Jan Larwig <jan.larwig@digits.schwarz>
1 parent ec6fc58 commit 5ceef88

3 files changed

Lines changed: 34 additions & 10 deletions

File tree

‎README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,24 @@ Please see our [book](https://stackitcloud.github.io/cluster-api-provider-stacki
3434

3535
Use `make serve-book` to serve the book locally from this repository.
3636

37+
## Install with clusterctl
38+
39+
Create `clusterctl.yaml` with the published release URL. Replace `<version>`
40+
with the release tag you want to install.
41+
42+
```yaml
43+
providers:
44+
- name: stackit
45+
url: https://github.com/stackitcloud/cluster-api-provider-stackit/releases/download/v<version>/infrastructure-components.yaml
46+
type: InfrastructureProvider
47+
```
48+
49+
Install the provider:
50+
51+
```sh
52+
clusterctl init --config clusterctl.yaml --infrastructure stackit
53+
```
54+
3755
## Launching a Kubernetes cluster on STACKIT
3856

3957
Check out the [Quick Start](./quick-start.md) for launching a cluster on STACKIT.

‎docs/src/SUMMARY.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
- [Classic Cluster Template](usage/cluster-template.md)
88
- [ClusterClass](usage/clusterclass.md)
99
- [Workload Addons](usage/addons.md)
10-
- [clusterctl](usage/clusterctl.md)
1110
- [Workload CNI](usage/cni.md)
1211
- [Upgrade](usage/upgrade.md)
1312
- [Cleanup](usage/cleanup.md)
1413
-->
14+
- [clusterctl](usage/clusterctl.md)
1515
- [Topics](./topics/index.md)
1616
- [OS Images](./topics/images.md)
1717
- [Accessing VM instances](./topics/accessing-vm-instances.md)

‎docs/src/usage/clusterctl.md‎

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,28 @@
11
# clusterctl
22

33
Each release publishes `infrastructure-components.yaml`, `metadata.yaml`, and
4-
cluster templates as GitHub Release assets. Install a published version with:
4+
cluster templates as GitHub Release assets.
55

6-
```sh
7-
clusterctl init \
8-
--infrastructure \
9-
https://github.com/stackitcloud/cluster-api-provider-stackit/releases/download/v<version>/infrastructure-components.yaml
6+
## Install a published release
7+
8+
Create `clusterctl.yaml` with the published release URL. Replace `<version>`
9+
with the release tag you want to install.
10+
11+
```yaml
12+
providers:
13+
- name: stackit
14+
url: https://github.com/stackitcloud/cluster-api-provider-stackit/releases/download/v<version>/infrastructure-components.yaml
15+
type: InfrastructureProvider
1016
```
1117
12-
Or latest:
18+
Install the provider:
1319
1420
```sh
15-
clusterctl init \
16-
--infrastructure \
17-
https://github.com/stackitcloud/cluster-api-provider-stackit/releases/download/latest/infrastructure-components.yaml
21+
clusterctl init --config clusterctl.yaml --infrastructure stackit
1822
```
1923

24+
## Use a local provider repository
25+
2026
For local development, package the provider as a local clusterctl repository:
2127

2228
```sh

0 commit comments

Comments
 (0)