public_git
/
helmfile
mirror of https://github.com/helmfile/helmfile.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

add build-in objects docs (#667) 

Signed-off-by: yxxhero <aiopsclub@163.com>
This commit is contained in:
yxxhero 2023-02-01 06:53:59 +08:00 committed by GitHub
parent d263b99b44
commit f355b297be
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 43 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
docs/builtin-objects.md Normal file
View File

@ -0,0 +1,42 @@
# helmfile template built-in objects
- `Environment`: The information about the environment. This is set by the
`--environment` flag. It has several objects inside of it:
- `Environment.Name`: The name of the environment
- `Values`: Values passed into the environment.
- `StateValues`: alias for `Values`.
- `Namespace`: The namespace to be released into
# release template built-in objects
it be used for the below case:
```
apiVersion: v1
kind: ConfigMap
metadata:
# release template
name: {{`{{ .Release.Name }}`}}-1
namespace: {{`{{ .Release.Namespace }}`}}
data:
foo: FOO
```
- `Release`: This object describes the release itself. It has several objects
inside of it:
- `Release.Name`: The release name
- `Release.Namespace`: The namespace to be released into
- `Release.Labels`: The labels to be applied to the release
- `Release.Chart`: The chart name of the release
- `Release.KubeContext`: The kube context to be used for the release
- `Values`: Values passed into the environment.
- `StateValues`: alias for `Values`.
- `Environment`: The information about the environment. This is set by the
`--environment` flag. It has several objects inside of it:
- `Environment.Name`: The name of the environment
- `Chart`: The chart name for the release.
- `KubeContext`: The kube context to be used for the release
- `Namespace`: The namespace to be released into
The built-in values always begin with a capital letter. This is in keeping with
Go's naming convention. When you define your own values and template variables, you are free to use a
convention that suits your team.

1
mkdocs.yml
View File

@ -18,6 +18,7 @@ nav:
- Getting Started:
- Paths Overview: paths.md
- Templating Funs: templating_funcs.md
- Built-in Objects: builtin-objects.md
- Advanced Features:
- Best Practices Guide: writing-helmfile.md
- Advanced Features: advanced-features.md