Skip to content

Commit

Permalink
add README for flavors dir
Browse files Browse the repository at this point in the history
  • Loading branch information
AshleyDumaine committed Feb 21, 2024
1 parent 7e2f510 commit d7884c0
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions templates/flavors/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Flavors

In `clusterctl` the infrastructure provider authors can provide different types
of cluster templates referred to as "flavors". You can use the `--flavor` flag
to specify which flavor to use for a cluster, e.g:

```shell
clusterctl generate cluster test-cluster --flavor clusterclass
```

To use the default flavor, omit the `--flavor` flag.

See the [`clusterctl` flavors docs](https://cluster-api.sigs.k8s.io/clusterctl/commands/generate-cluster.html#flavors) for more information.

This directory contains each of the flavors for CAPL. Each directory besides `base` will be used to
create a flavor by running `kustomize build` on the directory. The name of the directory will be
appended to the end of the cluster-template.yaml, e.g cluster-template-{directory-name}.yaml. That
flavor can be used by specifying `--flavor {directory-name}`.

To generate all CAPL flavors, run `make generate-flavors`.

0 comments on commit d7884c0

Please sign in to comment.