Documentation site based on mkdocs and Read the Docs

Ref https://github.com/roboll/helmfile/issues/1824
Ref https://github.com/roboll/helmfile/issues/1755
This commit is contained in:
Yusuke Kuoka
2022-04-03 05:04:54 +00:00
parent 498a976efb
commit 3267484f47
8 changed files with 88 additions and 0 deletions
+1
View File
@@ -0,0 +1 @@
../CONTRIBUTING.md
+1
View File
@@ -0,0 +1 @@
../README.md
+1
View File
@@ -0,0 +1 @@
../LICENSE
+60
View File
@@ -0,0 +1,60 @@
# Paths Overivew
Using manifest files in conjunction with command line argument can be a bit confusing.
A few rules to clear up this ambiguity:
- Absolute paths are always resolved as absolute paths
- Relative paths referenced *in* the helmfile manifest itself are relative to that manifest
- Relative paths referenced on the command line are relative to the current working directory the user is in
### Examples
There are several examples that we can go through in the [`/examples`](examples) folder which demonstrate this.
**Local Execution**
This is an example of a Helmfile manifest referencing a local value directly.
Indirect:
```
helmfile -f examples/deployments/local/charts.yaml sync
```
Direct:
```
cd examples/deployments/local/
helmfile sync
```
**Relative Paths in Helmfile**
This is an example of a Helmfile manifest using relative paths for values.
Indirect:
```
helmfile -f examples/deployments/dev/charts.yaml sync
```
Direct:
```
cd examples/deployments/dev/
helmfile sync
```
**Relative Paths in Helmfile w/ --values overrides**
This is an example of a Helmfile manifest using relative paths for values including an additional `--values` from the command line.
NOTE: The `--values` is resolved relative to the CWD of the terminal *not* the Helmfile manifest. You can see this with the `replicas` being adjusted to 3 now for the deployment.
Indirect:
```
helmfile -f examples/deployments/dev/charts.yaml sync --values values/replica-values.yaml
```
Direct:
```
cd examples/deployments/dev/
helmfile sync --values ../../values/replica-values.yaml
```
+22
View File
@@ -0,0 +1,22 @@
Babel==2.9.1
click==8.1.2
ghp-import==2.0.2
gitdb==4.0.9
GitPython==3.1.27
importlib-metadata==4.11.3
Jinja2==3.1.1
Markdown==3.3.6
MarkupSafe==2.1.1
mergedeep==1.3.4
mkdocs==1.3.0
mkdocs-git-revision-date-localized-plugin==1.0.1
packaging==21.3
pyparsing==3.0.7
python-dateutil==2.8.2
pytz==2022.1
PyYAML==6.0
pyyaml_env_tag==0.1
six==1.16.0
smmap==5.0.0
watchdog==2.1.7
zipp==3.7.0
+1
View File
@@ -0,0 +1 @@
../USERS.md