Skip to content

Commit 3926df8

Browse files
committed
update docs
1 parent f1ec537 commit 3926df8

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

website/content/en/docs/generators/helm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ func NewHelmGenerator(
2121

2222
Here:
2323
- `fsys` must be an implementation of `fs.FS`, such as `embed.FS`; or it can be passed as nil; then, all file operations will be executed on the current OS filesystem.
24-
- `chartPath` is the path containing the used Helm chart; if `fsys` was provided, this has to be a relative path; otherwise, it will be interpreted with respect to the OS filesystem (as an absolute path, or relative to the current working directory of the controller).
24+
- `chartPath` is the directory containing the used Helm chart; if `fsys` was provided, this has to be a relative path; otherwise, it will be interpreted with respect to the OS filesystem (as an absolute path, or relative to the current working directory of the controller).
2525
- `client` should be a client for the local cluster (i.e. the cluster where the component object exists).
2626

2727
It should be noted that `HelmGenerator` does not use the Helm SDK; instead it tries to emulate the Helm behavior as good as possible.

website/content/en/docs/generators/kustomize.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ func NewKustomizeGenerator(
3030
3131
Here:
3232
- `fsys` must be an implementation of `fs.FS`, such as `embed.FS`; or it can be passed as nil; then, all file operations will be executed on the current OS filesystem.
33-
- `kustomizationPath` is the path containing the (potentially templatized) kustomatization; if `fsys` was provided, this has to be a relative path; otherwise, it will be interpreted with respect to the OS filesystem (as an absolute path, or relative to the current working directory of the controller).
33+
- `kustomizationPath` is the directory containing the (potentially templatized) kustomatization; if `fsys` was provided, this has to be a relative path; otherwise, it will be interpreted with respect to the OS filesystem (as an absolute path, or relative to the current working directory of the controller).
3434
- `templateSuffx` is optional; if empty, all files under `kustomizationPath` will be subject to go templating; otherwise, only files matching the specified suffix will be considered as templates.
35-
- `client` should be a client for the local cluster (i.e. the cluster where the component object exists).
35+
- `client` should be a client for the local cluster (i.e. the cluster where the component object exists).
36+
37+
As of now, the specified kustomization must not reference files or paths outside `kustomizationPath`. Remote references are generally not supported.

0 commit comments

Comments
 (0)