Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 Add doc that clusterctl generate yaml can use raw template URL #7922

Merged
merged 1 commit into from
Jan 19, 2023
Merged

📖 Add doc that clusterctl generate yaml can use raw template URL #7922

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions docs/book/src/clusterctl/commands/generate-cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,9 @@ clusterctl generate cluster my-cluster --kubernetes-version v1.16.3 \
Also following flags are available `--from-config-map-namespace` (defaults to current namespace) and `--from-config-map-key`
(defaults to `template`).

#### GitHub, local file system folder or standard input
#### GitHub, raw template URL, local file system folder or standard input

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

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

or

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

or

```bash
clusterctl generate cluster my-cluster --kubernetes-version v1.16.3 \
--from ~/my-template.yaml > my-cluster.yaml
Expand Down
4 changes: 3 additions & 1 deletion docs/book/src/clusterctl/commands/generate-yaml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@ from environment variables.
Current usage of the command is as follows:
```bash
# Generates a configuration file with variable values using a template from a
# specific URL.
# specific URL as well as a GitHub URL.
clusterctl generate yaml --from https://github.com/foo-org/foo-repository/blob/main/cluster-template.yaml

clusterctl generate yaml --from https://foo.bar/cluster-template.yaml

# Generates a configuration file with variable values using
# a template stored locally.
clusterctl generate yaml --from ~/workspace/cluster-template.yaml
Expand Down