Skip to content

Commit

Permalink
Update configuration.md in clusterctl
Browse files Browse the repository at this point in the history
  • Loading branch information
mukul-kr committed Jun 25, 2022
1 parent 35b246b commit b00e6e3
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions docs/book/src/clusterctl/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,14 @@ Please note that the configuration above will be considered also when doing `clu

## Overrides Layer

<aside class="note warning">

<h1> Warning! </h1>

Overrides only provide file replacements; instead, provider version resolution is based only on the actual repository structure.

</aside>

`clusterctl` uses an overrides layer to read in injected provider components,
cluster templates and metadata. By default, it reads the files from
`$HOME/.cluster-api/overrides`.
Expand Down Expand Up @@ -158,11 +166,7 @@ directory in the clusterctl config file as
```yaml
overridesFolder: /Users/foobar/workspace/dev-releases
```
<aside class="note warning">
<h1> Warning! </h1>
Overrides only provide file replacements; instead, provider version resolution is based only on the actual repository structure.
</aside>
<br>
## Image overrides
Expand All @@ -173,7 +177,7 @@ Overrides only provide file replacements; instead, provider version resolution i
Image override is an advanced feature and wrong configuration can easily lead to non-functional clusters.
It's strongly recommended to test configurations on dev/test environments before using this functionality in production.
This feature must always be used in conjunction with
This feature must always be used in conjunction with
[version tag](commands/init.md#provider-version) when executing clusterctl commands.
</aside>
Expand Down

0 comments on commit b00e6e3

Please sign in to comment.