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

Misc documentation fixes (#1442) 

Small documentation updates.

Signed-off-by: StarlessNights <iihaja@utu.fi>
This commit is contained in:
Iisakki Jaakkola 2024-04-06 02:17:32 +03:00 committed by GitHub
parent 4528f1230e
commit 81b44c19fe
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -4,7 +4,7 @@ By contributing to `helmfile`, you accept and agree to the following DCO and lic
conditions for your present and future Contributions submitted to the `helmfile` project. conditions for your present and future Contributions submitted to the `helmfile` project.
[DCO](https://developercertificate.org/) [DCO](https://developercertificate.org/)
[License](https://github.com/helmfile/helmfile/blob/master/LICENSE) [License](https://github.com/helmfile/helmfile/blob/main/LICENSE)
# Developing helmfile # Developing helmfile
@ -15,7 +15,7 @@ $ go get github.com/helmfile/helmfile
$ cd $GOPATH/src/github.com/helmfile/helmfile $ cd $GOPATH/src/github.com/helmfile/helmfile
$ git checkout -b your-shiny-new-feature origin/master $ git checkout -b your-shiny-new-feature origin/main
... ...

7
docs/index.md
View File

@ -144,9 +144,9 @@ repositories:
url: roboll.io/charts url: roboll.io/charts
certFile: optional_client_cert certFile: optional_client_cert
keyFile: optional_client_key keyFile: optional_client_key
# username is retrieve from the environment with the format <registryNameUpperCase>_USERNAME for CI usage, here ROBOLL_USERNAME # username is retrieved from the environment with the format <registryNameUpperCase>_USERNAME for CI usage, here ROBOLL_USERNAME
username: optional_username username: optional_username
# username is retrieve from the environment with the format <registryNameUpperCase>_PASSWORD for CI usage, here ROBOLL_PASSWORD # username is retrieved from the environment with the format <registryNameUpperCase>_PASSWORD for CI usage, here ROBOLL_PASSWORD
password: optional_password password: optional_password
oci: true oci: true
passCredentials: true passCredentials: true
@ -872,6 +872,7 @@ proxy:
When you want to customize the contents of `helmfile.yaml` or `values.yaml` files per environment, use this feature. When you want to customize the contents of `helmfile.yaml` or `values.yaml` files per environment, use this feature.
You can define as many environments as you want under `environments` in `helmfile.yaml`. You can define as many environments as you want under `environments` in `helmfile.yaml`.
`environments` section should be separated from `releases` with `---`.
The environment name defaults to `default`, that is, `helmfile sync` implies the `default` environment. The environment name defaults to `default`, that is, `helmfile sync` implies the `default` environment.
The selected environment name can be referenced from `helmfile.yaml` and `values.yaml.gotmpl` by `{{ .Environment.Name }}`. The selected environment name can be referenced from `helmfile.yaml` and `values.yaml.gotmpl` by `{{ .Environment.Name }}`.
@ -897,7 +898,7 @@ releases:
## Environment Values ## Environment Values
Environment Values allows you to inject a set of values specific to the selected environment, into values.yaml templates. Environment Values allows you to inject a set of values specific to the selected environment, into `values.yaml` templates.
Use it to inject common values from the environment to multiple values files, to make your configuration DRY. Use it to inject common values from the environment to multiple values files, to make your configuration DRY.
Suppose you have three files `helmfile.yaml`, `production.yaml` and `values.yaml.gotmpl`: Suppose you have three files `helmfile.yaml`, `production.yaml` and `values.yaml.gotmpl`: