Skip to content

Commit 819c9b4

Browse files
committed
Add doc that clusterctl generate yaml can use raw template URL
Signed-off-by: Aniruddha Basak <[email protected]>
1 parent 059eb76 commit 819c9b4

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

docs/book/src/clusterctl/commands/generate-cluster.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,9 @@ clusterctl generate cluster my-cluster --kubernetes-version v1.16.3 \
6969
Also following flags are available `--from-config-map-namespace` (defaults to current namespace) and `--from-config-map-key`
7070
(defaults to `template`).
7171

72-
#### GitHub, local file system folder or standard input
72+
#### GitHub, raw template URL, local file system folder or standard input
7373

74-
Use the `--from` flag to read cluster templates stored in a GitHub repository, in a local file system folder,
74+
Use the `--from` flag to read cluster templates stored in a GitHub repository, raw template URL, in a local file system folder,
7575
or from the standard input; e.g.
7676

7777
```bash
@@ -81,6 +81,13 @@ clusterctl generate cluster my-cluster --kubernetes-version v1.16.3 \
8181

8282
or
8383

84+
```bash
85+
clusterctl generate cluster my-cluster --kubernetes-version v1.16.3 \
86+
--from https://foo.bar/my-template.yaml > my-cluster.yaml
87+
```
88+
89+
or
90+
8491
```bash
8592
clusterctl generate cluster my-cluster --kubernetes-version v1.16.3 \
8693
--from ~/my-template.yaml > my-cluster.yaml

docs/book/src/clusterctl/commands/generate-yaml.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,11 @@ from environment variables.
2020
Current usage of the command is as follows:
2121
```bash
2222
# Generates a configuration file with variable values using a template from a
23-
# specific URL.
23+
# specific URL as well as a GitHub URL.
2424
clusterctl generate yaml --from https://github.com/foo-org/foo-repository/blob/main/cluster-template.yaml
2525

26+
clusterctl generate yaml --from https://foo.bar/cluster-template.yaml
27+
2628
# Generates a configuration file with variable values using
2729
# a template stored locally.
2830
clusterctl generate yaml --from ~/workspace/cluster-template.yaml

0 commit comments

Comments
 (0)