Skip to content
This repository was archived by the owner on Aug 12, 2025. It is now read-only.

Commit 8940960

Browse files
committed
update README to describe how to use custom config
1 parent dbd00dd commit 8940960

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,20 @@ To deploy a cluster via the cluster-api:
4444

4545
#### Initialize the Cluster
4646

47-
To initialize the cluster:
47+
To initialize the cluster, you need to provider it with the path to the config file.
48+
49+
1. Download the clusterctl config file for your release.
50+
1. Use the config file.
4851

4952
```
50-
clusterctl --config=https://github.com/packethost/cluster-api-provider-packet/releases/latest/clusterctl.yaml init --infrastructure=packet
53+
VERSION=v0.3.0
54+
curl -L -o clusterctl.yaml https://github.com/packethost/cluster-api-provider-packet/releases/download/${VERSION}/clusterctl.yaml
55+
clusterctl --config=./clusterctl.yaml init --infrastructure=packet
5156
```
5257

53-
We are in the process of working with the core cluster-api team, so that you will not need the
58+
Unfortunately, clusterctl itself does not support passing a URL to `--config`, see [this issue](https://github.com/kubernetes-sigs/cluster-api/issues/3099).
59+
60+
Additionally, we are in the process of working with the core cluster-api team, so that you will not need the
5461
`--config=` option, hopefully soon.
5562

5663
#### Generate Cluster yaml
@@ -71,7 +78,7 @@ To generate your cluster yaml:
7178
1. Run the cluster generation command:
7279

7380
```
74-
clusterctl --config=https://github.com/packethost/cluster-api-provider-packet/releases/latest/clusterctl.yaml config cluster <cluster-name> > out/cluster.yaml
81+
clusterctl --config=./clusterctl.yaml config cluster <cluster-name> > out/cluster.yaml
7582
```
7683

7784
Note that the above command will make _all_ of the environment variables required. This is a limitation of

0 commit comments

Comments
 (0)