From e53858eb2044e4b5388dd44617d2401b3413c377 Mon Sep 17 00:00:00 2001 From: flynnduism Date: Thu, 25 May 2017 17:30:02 -0700 Subject: [PATCH] Apply folder/category structure of docs.helm.sh - moves Docs files from root /docs into subfolders - adds a using-helm folder (6 docs) - adds a architecture folder (1 doc) - adds a developing-charts folder (8 docs) - adds a glossary folder (1 doc) - adds a history folder (1 doc) - adds a related folder (1 doc) - renames the helm folder to helm-commands --- docs/{ => architecture}/architecture.md | 0 .../conventions.md | 0 .../index.md | 1 - .../labels.md | 5 --- .../pods.md | 2 -- .../requirements.md | 0 .../templates.md | 4 +-- .../third_party_resources.md | 0 .../values.md | 0 docs/{examples => chart-examples}/README.md | 0 .../alpine/Chart.yaml | 0 .../alpine/README.md | 0 .../alpine/templates/alpine-pod.yaml | 0 .../alpine/values.yaml | 0 .../nginx/.helmignore | 0 .../nginx/Chart.yaml | 0 .../nginx/README.md | 0 .../nginx/templates/_helpers.tpl | 0 .../nginx/templates/configmap.yaml | 0 .../nginx/templates/deployment.yaml | 0 .../nginx/templates/post-install-job.yaml | 0 .../nginx/templates/pre-install-secret.yaml | 0 .../nginx/templates/service-test.yaml | 0 .../nginx/templates/svc.yaml | 0 .../nginx/values.yaml | 0 .../accessing_files.md | 3 +- .../builtin_objects.md | 1 - .../control_structures.md | 2 +- .../data_types.md | 0 .../debugging.md | 0 .../functions_and_pipelines.md | 0 .../getting_started.md | 0 .../index.md | 0 .../named_templates.md | 0 .../notes_files.md | 0 .../subcharts_and_globals.md | 0 .../values_files.md | 0 .../variables.md | 0 .../wrapping_up.md | 0 .../yaml_techniques.md | 0 docs/{ => developer-guide}/developers.md | 2 +- .../chart_repository.md | 0 .../chart_repository_faq.md | 0 .../chart_repository_sync_example.md | 0 docs/{ => developing-charts}/chart_tests.md | 0 docs/{ => developing-charts}/charts.md | 34 +++++++++--------- docs/{ => developing-charts}/charts_hooks.md | 5 ++- .../charts_tips_and_tricks.md | 2 +- docs/{ => developing-charts}/provenance.md | 0 docs/{ => glossary}/glossary.md | 2 -- docs/{helm => helm-commands}/helm.md | 0 .../helm_completion.md | 0 docs/{helm => helm-commands}/helm_create.md | 0 docs/{helm => helm-commands}/helm_delete.md | 0 .../helm_dependency.md | 0 .../helm_dependency_build.md | 0 .../helm_dependency_list.md | 0 .../helm_dependency_update.md | 0 docs/{helm => helm-commands}/helm_fetch.md | 0 docs/{helm => helm-commands}/helm_get.md | 0 .../{helm => helm-commands}/helm_get_hooks.md | 0 .../helm_get_manifest.md | 0 .../helm_get_values.md | 0 docs/{helm => helm-commands}/helm_history.md | 0 docs/{helm => helm-commands}/helm_home.md | 0 docs/{helm => helm-commands}/helm_init.md | 0 docs/{helm => helm-commands}/helm_inspect.md | 0 .../helm_inspect_chart.md | 0 .../helm_inspect_values.md | 0 docs/{helm => helm-commands}/helm_install.md | 0 docs/{helm => helm-commands}/helm_lint.md | 0 docs/{helm => helm-commands}/helm_list.md | 0 docs/{helm => helm-commands}/helm_package.md | 0 docs/{helm => helm-commands}/helm_plugin.md | 0 .../helm_plugin_install.md | 0 .../helm_plugin_list.md | 0 .../helm_plugin_remove.md | 0 .../helm_plugin_update.md | 0 docs/{helm => helm-commands}/helm_repo.md | 0 docs/{helm => helm-commands}/helm_repo_add.md | 0 .../helm_repo_index.md | 0 .../{helm => helm-commands}/helm_repo_list.md | 0 .../helm_repo_remove.md | 0 .../helm_repo_update.md | 0 docs/{helm => helm-commands}/helm_reset.md | 0 docs/{helm => helm-commands}/helm_rollback.md | 0 docs/{helm => helm-commands}/helm_search.md | 0 docs/{helm => helm-commands}/helm_serve.md | 0 docs/{helm => helm-commands}/helm_status.md | 0 docs/{helm => helm-commands}/helm_test.md | 0 docs/{helm => helm-commands}/helm_upgrade.md | 0 docs/{helm => helm-commands}/helm_verify.md | 0 docs/{helm => helm-commands}/helm_version.md | 0 docs/{ => history}/history.md | 0 docs/index.md | 35 ------------------- docs/{ => related}/related.md | 0 docs/{ => using-helm}/install.md | 0 docs/{ => using-helm}/install_faq.md | 0 docs/{ => using-helm}/kubernetes_distros.md | 0 docs/{ => using-helm}/plugins.md | 0 docs/{ => using-helm}/quickstart.md | 0 docs/{ => using-helm}/using_helm.md | 8 ++--- 102 files changed, 29 insertions(+), 77 deletions(-) rename docs/{ => architecture}/architecture.md (100%) rename docs/{chart_best_practices => chart-best-practices}/conventions.md (100%) rename docs/{chart_best_practices => chart-best-practices}/index.md (99%) rename docs/{chart_best_practices => chart-best-practices}/labels.md (99%) rename docs/{chart_best_practices => chart-best-practices}/pods.md (99%) rename docs/{chart_best_practices => chart-best-practices}/requirements.md (100%) rename docs/{chart_best_practices => chart-best-practices}/templates.md (99%) rename docs/{chart_best_practices => chart-best-practices}/third_party_resources.md (100%) rename docs/{chart_best_practices => chart-best-practices}/values.md (100%) rename docs/{examples => chart-examples}/README.md (100%) rename docs/{examples => chart-examples}/alpine/Chart.yaml (100%) rename docs/{examples => chart-examples}/alpine/README.md (100%) rename docs/{examples => chart-examples}/alpine/templates/alpine-pod.yaml (100%) rename docs/{examples => chart-examples}/alpine/values.yaml (100%) rename docs/{examples => chart-examples}/nginx/.helmignore (100%) rename docs/{examples => chart-examples}/nginx/Chart.yaml (100%) rename docs/{examples => chart-examples}/nginx/README.md (100%) rename docs/{examples => chart-examples}/nginx/templates/_helpers.tpl (100%) rename docs/{examples => chart-examples}/nginx/templates/configmap.yaml (100%) rename docs/{examples => chart-examples}/nginx/templates/deployment.yaml (100%) rename docs/{examples => chart-examples}/nginx/templates/post-install-job.yaml (100%) rename docs/{examples => chart-examples}/nginx/templates/pre-install-secret.yaml (100%) rename docs/{examples => chart-examples}/nginx/templates/service-test.yaml (100%) rename docs/{examples => chart-examples}/nginx/templates/svc.yaml (100%) rename docs/{examples => chart-examples}/nginx/values.yaml (100%) rename docs/{chart_template_guide => chart-template-guide}/accessing_files.md (99%) rename docs/{chart_template_guide => chart-template-guide}/builtin_objects.md (99%) rename docs/{chart_template_guide => chart-template-guide}/control_structures.md (99%) rename docs/{chart_template_guide => chart-template-guide}/data_types.md (100%) rename docs/{chart_template_guide => chart-template-guide}/debugging.md (100%) rename docs/{chart_template_guide => chart-template-guide}/functions_and_pipelines.md (100%) rename docs/{chart_template_guide => chart-template-guide}/getting_started.md (100%) rename docs/{chart_template_guide => chart-template-guide}/index.md (100%) rename docs/{chart_template_guide => chart-template-guide}/named_templates.md (100%) rename docs/{chart_template_guide => chart-template-guide}/notes_files.md (100%) rename docs/{chart_template_guide => chart-template-guide}/subcharts_and_globals.md (100%) rename docs/{chart_template_guide => chart-template-guide}/values_files.md (100%) rename docs/{chart_template_guide => chart-template-guide}/variables.md (100%) rename docs/{chart_template_guide => chart-template-guide}/wrapping_up.md (100%) rename docs/{chart_template_guide => chart-template-guide}/yaml_techniques.md (100%) rename docs/{ => developer-guide}/developers.md (99%) rename docs/{ => developing-charts}/chart_repository.md (100%) rename docs/{ => developing-charts}/chart_repository_faq.md (100%) rename docs/{ => developing-charts}/chart_repository_sync_example.md (100%) rename docs/{ => developing-charts}/chart_tests.md (100%) rename docs/{ => developing-charts}/charts.md (97%) rename docs/{ => developing-charts}/charts_hooks.md (99%) rename docs/{ => developing-charts}/charts_tips_and_tricks.md (99%) rename docs/{ => developing-charts}/provenance.md (100%) rename docs/{ => glossary}/glossary.md (99%) rename docs/{helm => helm-commands}/helm.md (100%) rename docs/{helm => helm-commands}/helm_completion.md (100%) rename docs/{helm => helm-commands}/helm_create.md (100%) rename docs/{helm => helm-commands}/helm_delete.md (100%) rename docs/{helm => helm-commands}/helm_dependency.md (100%) rename docs/{helm => helm-commands}/helm_dependency_build.md (100%) rename docs/{helm => helm-commands}/helm_dependency_list.md (100%) rename docs/{helm => helm-commands}/helm_dependency_update.md (100%) rename docs/{helm => helm-commands}/helm_fetch.md (100%) rename docs/{helm => helm-commands}/helm_get.md (100%) rename docs/{helm => helm-commands}/helm_get_hooks.md (100%) rename docs/{helm => helm-commands}/helm_get_manifest.md (100%) rename docs/{helm => helm-commands}/helm_get_values.md (100%) rename docs/{helm => helm-commands}/helm_history.md (100%) rename docs/{helm => helm-commands}/helm_home.md (100%) rename docs/{helm => helm-commands}/helm_init.md (100%) rename docs/{helm => helm-commands}/helm_inspect.md (100%) rename docs/{helm => helm-commands}/helm_inspect_chart.md (100%) rename docs/{helm => helm-commands}/helm_inspect_values.md (100%) rename docs/{helm => helm-commands}/helm_install.md (100%) rename docs/{helm => helm-commands}/helm_lint.md (100%) rename docs/{helm => helm-commands}/helm_list.md (100%) rename docs/{helm => helm-commands}/helm_package.md (100%) rename docs/{helm => helm-commands}/helm_plugin.md (100%) rename docs/{helm => helm-commands}/helm_plugin_install.md (100%) rename docs/{helm => helm-commands}/helm_plugin_list.md (100%) rename docs/{helm => helm-commands}/helm_plugin_remove.md (100%) rename docs/{helm => helm-commands}/helm_plugin_update.md (100%) rename docs/{helm => helm-commands}/helm_repo.md (100%) rename docs/{helm => helm-commands}/helm_repo_add.md (100%) rename docs/{helm => helm-commands}/helm_repo_index.md (100%) rename docs/{helm => helm-commands}/helm_repo_list.md (100%) rename docs/{helm => helm-commands}/helm_repo_remove.md (100%) rename docs/{helm => helm-commands}/helm_repo_update.md (100%) rename docs/{helm => helm-commands}/helm_reset.md (100%) rename docs/{helm => helm-commands}/helm_rollback.md (100%) rename docs/{helm => helm-commands}/helm_search.md (100%) rename docs/{helm => helm-commands}/helm_serve.md (100%) rename docs/{helm => helm-commands}/helm_status.md (100%) rename docs/{helm => helm-commands}/helm_test.md (100%) rename docs/{helm => helm-commands}/helm_upgrade.md (100%) rename docs/{helm => helm-commands}/helm_verify.md (100%) rename docs/{helm => helm-commands}/helm_version.md (100%) rename docs/{ => history}/history.md (100%) delete mode 100644 docs/index.md rename docs/{ => related}/related.md (100%) rename docs/{ => using-helm}/install.md (100%) rename docs/{ => using-helm}/install_faq.md (100%) rename docs/{ => using-helm}/kubernetes_distros.md (100%) rename docs/{ => using-helm}/plugins.md (100%) rename docs/{ => using-helm}/quickstart.md (100%) rename docs/{ => using-helm}/using_helm.md (99%) diff --git a/docs/architecture.md b/docs/architecture/architecture.md similarity index 100% rename from docs/architecture.md rename to docs/architecture/architecture.md diff --git a/docs/chart_best_practices/conventions.md b/docs/chart-best-practices/conventions.md similarity index 100% rename from docs/chart_best_practices/conventions.md rename to docs/chart-best-practices/conventions.md diff --git a/docs/chart_best_practices/index.md b/docs/chart-best-practices/index.md similarity index 99% rename from docs/chart_best_practices/index.md rename to docs/chart-best-practices/index.md index 22908871d..fa1ebdb19 100644 --- a/docs/chart_best_practices/index.md +++ b/docs/chart-best-practices/index.md @@ -17,4 +17,3 @@ may find that their internal interests override our suggestions here. - Kubernetes Resources: - [Pods and Pod Specs](pods.md): See the best practices for working with pod specifications. - [Third Party Resources](third_party_resources.md): Third Party Resources (TPRs) have their own associated best practices. - diff --git a/docs/chart_best_practices/labels.md b/docs/chart-best-practices/labels.md similarity index 99% rename from docs/chart_best_practices/labels.md rename to docs/chart-best-practices/labels.md index d1fb8a598..bc72eb911 100644 --- a/docs/chart_best_practices/labels.md +++ b/docs/chart-best-practices/labels.md @@ -47,8 +47,3 @@ release | REC | This should be the `{{ .Release.Name }}`. chart | REC | This should be the chart name and version: `{{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }}`. app | OPT | This should be the app name, reflecting the entire app. Often the chart's `{{ .Chart.Name }}` is used for this. This is used by many Kubernetes manifests, and is not Helm-specific. component | OPT | This is a common label for marking the different roles that pieces may play in an application. For example, `component: frontend` - - - - - diff --git a/docs/chart_best_practices/pods.md b/docs/chart-best-practices/pods.md similarity index 99% rename from docs/chart_best_practices/pods.md rename to docs/chart-best-practices/pods.md index f79f9b4da..b9861d0a7 100644 --- a/docs/chart_best_practices/pods.md +++ b/docs/chart-best-practices/pods.md @@ -73,5 +73,3 @@ the pod. But this is even more important for sets like Deployment. Without this, the _entire_ set of labels is used to select matching pods, and this will break if you use labels that change, like version or release date. - - diff --git a/docs/chart_best_practices/requirements.md b/docs/chart-best-practices/requirements.md similarity index 100% rename from docs/chart_best_practices/requirements.md rename to docs/chart-best-practices/requirements.md diff --git a/docs/chart_best_practices/templates.md b/docs/chart-best-practices/templates.md similarity index 99% rename from docs/chart_best_practices/templates.md rename to docs/chart-best-practices/templates.md index 649140a5a..18ca3501b 100644 --- a/docs/chart_best_practices/templates.md +++ b/docs/chart-best-practices/templates.md @@ -89,7 +89,7 @@ Blocks (such as control structures) may be indented to indicate flow of the temp ``` {{ if $foo -}} {{- with .Bar }}Hello{{ end -}} -{{- end -}} +{{- end -}} ``` However, since YAML is a whitespace-oriented language, it is often not possible for code indentation to follow that convention. @@ -196,7 +196,7 @@ readable than other YAML representations. For example, this YAML is closer to the normal YAML method of expressing lists: ```yaml -arguments: +arguments: - "--dirname" - "/foo" ``` diff --git a/docs/chart_best_practices/third_party_resources.md b/docs/chart-best-practices/third_party_resources.md similarity index 100% rename from docs/chart_best_practices/third_party_resources.md rename to docs/chart-best-practices/third_party_resources.md diff --git a/docs/chart_best_practices/values.md b/docs/chart-best-practices/values.md similarity index 100% rename from docs/chart_best_practices/values.md rename to docs/chart-best-practices/values.md diff --git a/docs/examples/README.md b/docs/chart-examples/README.md similarity index 100% rename from docs/examples/README.md rename to docs/chart-examples/README.md diff --git a/docs/examples/alpine/Chart.yaml b/docs/chart-examples/alpine/Chart.yaml similarity index 100% rename from docs/examples/alpine/Chart.yaml rename to docs/chart-examples/alpine/Chart.yaml diff --git a/docs/examples/alpine/README.md b/docs/chart-examples/alpine/README.md similarity index 100% rename from docs/examples/alpine/README.md rename to docs/chart-examples/alpine/README.md diff --git a/docs/examples/alpine/templates/alpine-pod.yaml b/docs/chart-examples/alpine/templates/alpine-pod.yaml similarity index 100% rename from docs/examples/alpine/templates/alpine-pod.yaml rename to docs/chart-examples/alpine/templates/alpine-pod.yaml diff --git a/docs/examples/alpine/values.yaml b/docs/chart-examples/alpine/values.yaml similarity index 100% rename from docs/examples/alpine/values.yaml rename to docs/chart-examples/alpine/values.yaml diff --git a/docs/examples/nginx/.helmignore b/docs/chart-examples/nginx/.helmignore similarity index 100% rename from docs/examples/nginx/.helmignore rename to docs/chart-examples/nginx/.helmignore diff --git a/docs/examples/nginx/Chart.yaml b/docs/chart-examples/nginx/Chart.yaml similarity index 100% rename from docs/examples/nginx/Chart.yaml rename to docs/chart-examples/nginx/Chart.yaml diff --git a/docs/examples/nginx/README.md b/docs/chart-examples/nginx/README.md similarity index 100% rename from docs/examples/nginx/README.md rename to docs/chart-examples/nginx/README.md diff --git a/docs/examples/nginx/templates/_helpers.tpl b/docs/chart-examples/nginx/templates/_helpers.tpl similarity index 100% rename from docs/examples/nginx/templates/_helpers.tpl rename to docs/chart-examples/nginx/templates/_helpers.tpl diff --git a/docs/examples/nginx/templates/configmap.yaml b/docs/chart-examples/nginx/templates/configmap.yaml similarity index 100% rename from docs/examples/nginx/templates/configmap.yaml rename to docs/chart-examples/nginx/templates/configmap.yaml diff --git a/docs/examples/nginx/templates/deployment.yaml b/docs/chart-examples/nginx/templates/deployment.yaml similarity index 100% rename from docs/examples/nginx/templates/deployment.yaml rename to docs/chart-examples/nginx/templates/deployment.yaml diff --git a/docs/examples/nginx/templates/post-install-job.yaml b/docs/chart-examples/nginx/templates/post-install-job.yaml similarity index 100% rename from docs/examples/nginx/templates/post-install-job.yaml rename to docs/chart-examples/nginx/templates/post-install-job.yaml diff --git a/docs/examples/nginx/templates/pre-install-secret.yaml b/docs/chart-examples/nginx/templates/pre-install-secret.yaml similarity index 100% rename from docs/examples/nginx/templates/pre-install-secret.yaml rename to docs/chart-examples/nginx/templates/pre-install-secret.yaml diff --git a/docs/examples/nginx/templates/service-test.yaml b/docs/chart-examples/nginx/templates/service-test.yaml similarity index 100% rename from docs/examples/nginx/templates/service-test.yaml rename to docs/chart-examples/nginx/templates/service-test.yaml diff --git a/docs/examples/nginx/templates/svc.yaml b/docs/chart-examples/nginx/templates/svc.yaml similarity index 100% rename from docs/examples/nginx/templates/svc.yaml rename to docs/chart-examples/nginx/templates/svc.yaml diff --git a/docs/examples/nginx/values.yaml b/docs/chart-examples/nginx/values.yaml similarity index 100% rename from docs/examples/nginx/values.yaml rename to docs/chart-examples/nginx/values.yaml diff --git a/docs/chart_template_guide/accessing_files.md b/docs/chart-template-guide/accessing_files.md similarity index 99% rename from docs/chart_template_guide/accessing_files.md rename to docs/chart-template-guide/accessing_files.md index 44fc60514..9af7857bd 100644 --- a/docs/chart_template_guide/accessing_files.md +++ b/docs/chart-template-guide/accessing_files.md @@ -124,7 +124,7 @@ the returned object. For example, imagine the directory structure: ``` -foo/: +foo/: foo.txt foo.yaml bar/: @@ -222,4 +222,3 @@ data: Currently, there is no way to pass files external to the chart during `helm install`. So if you are asking users to supply data, it must be loaded using `helm install -f` or `helm install --set`. This discussion wraps up our dive into the tools and techniques for writing Helm templates. In the next section we will see how you can use one special file, `templates/NOTES.txt`, to send post-installation instructions to the users of your chart. - diff --git a/docs/chart_template_guide/builtin_objects.md b/docs/chart-template-guide/builtin_objects.md similarity index 99% rename from docs/chart_template_guide/builtin_objects.md rename to docs/chart-template-guide/builtin_objects.md index f473a2f3f..ab8d78ca1 100644 --- a/docs/chart_template_guide/builtin_objects.md +++ b/docs/chart-template-guide/builtin_objects.md @@ -49,4 +49,3 @@ In the previous section, we use `{{.Release.Name}}` to insert the name of a rele The values are available to any top-level template. As we will see later, this does not necessarily mean that they will be available _everywhere_. The built-in values always begin with a capital letter. This is in keeping with Go's naming convention. When you create your own names, you are free to use a convention that suits your team. Some teams, like the [Kubernetes Charts](https://github.com/kubernetes/charts) team, choose to use only initial lower case letters in order to distinguish local names from those built-in. In this guide, we follow that convention. - diff --git a/docs/chart_template_guide/control_structures.md b/docs/chart-template-guide/control_structures.md similarity index 99% rename from docs/chart_template_guide/control_structures.md rename to docs/chart-template-guide/control_structures.md index 22fc764cf..56b0eaf00 100644 --- a/docs/chart_template_guide/control_structures.md +++ b/docs/chart-template-guide/control_structures.md @@ -115,7 +115,7 @@ CHART PATH: /Users/mattbutcher/Code/Go/src/k8s.io/helm/_scratch/mychart Error: YAML parse error on mychart/templates/configmap.yaml: error converting YAML to JSON: yaml: line 9: did not find expected key ``` -What happened? We generated incorrect YAML because of the whitespacing above. +What happened? We generated incorrect YAML because of the whitespacing above. ```yaml # Source: mychart/templates/configmap.yaml diff --git a/docs/chart_template_guide/data_types.md b/docs/chart-template-guide/data_types.md similarity index 100% rename from docs/chart_template_guide/data_types.md rename to docs/chart-template-guide/data_types.md diff --git a/docs/chart_template_guide/debugging.md b/docs/chart-template-guide/debugging.md similarity index 100% rename from docs/chart_template_guide/debugging.md rename to docs/chart-template-guide/debugging.md diff --git a/docs/chart_template_guide/functions_and_pipelines.md b/docs/chart-template-guide/functions_and_pipelines.md similarity index 100% rename from docs/chart_template_guide/functions_and_pipelines.md rename to docs/chart-template-guide/functions_and_pipelines.md diff --git a/docs/chart_template_guide/getting_started.md b/docs/chart-template-guide/getting_started.md similarity index 100% rename from docs/chart_template_guide/getting_started.md rename to docs/chart-template-guide/getting_started.md diff --git a/docs/chart_template_guide/index.md b/docs/chart-template-guide/index.md similarity index 100% rename from docs/chart_template_guide/index.md rename to docs/chart-template-guide/index.md diff --git a/docs/chart_template_guide/named_templates.md b/docs/chart-template-guide/named_templates.md similarity index 100% rename from docs/chart_template_guide/named_templates.md rename to docs/chart-template-guide/named_templates.md diff --git a/docs/chart_template_guide/notes_files.md b/docs/chart-template-guide/notes_files.md similarity index 100% rename from docs/chart_template_guide/notes_files.md rename to docs/chart-template-guide/notes_files.md diff --git a/docs/chart_template_guide/subcharts_and_globals.md b/docs/chart-template-guide/subcharts_and_globals.md similarity index 100% rename from docs/chart_template_guide/subcharts_and_globals.md rename to docs/chart-template-guide/subcharts_and_globals.md diff --git a/docs/chart_template_guide/values_files.md b/docs/chart-template-guide/values_files.md similarity index 100% rename from docs/chart_template_guide/values_files.md rename to docs/chart-template-guide/values_files.md diff --git a/docs/chart_template_guide/variables.md b/docs/chart-template-guide/variables.md similarity index 100% rename from docs/chart_template_guide/variables.md rename to docs/chart-template-guide/variables.md diff --git a/docs/chart_template_guide/wrapping_up.md b/docs/chart-template-guide/wrapping_up.md similarity index 100% rename from docs/chart_template_guide/wrapping_up.md rename to docs/chart-template-guide/wrapping_up.md diff --git a/docs/chart_template_guide/yaml_techniques.md b/docs/chart-template-guide/yaml_techniques.md similarity index 100% rename from docs/chart_template_guide/yaml_techniques.md rename to docs/chart-template-guide/yaml_techniques.md diff --git a/docs/developers.md b/docs/developer-guide/developers.md similarity index 99% rename from docs/developers.md rename to docs/developer-guide/developers.md index 56d81b64c..f275a4f4c 100644 --- a/docs/developers.md +++ b/docs/developer-guide/developers.md @@ -139,7 +139,7 @@ The code for the Helm project is organized as follows: - The individual programs are located in `cmd/`. Code inside of `cmd/` is not designed for library re-use. - Shared libraries are stored in `pkg/`. -- The raw ProtoBuf files are stored in `_proto/hapi` (where `hapi` stands for +- The raw ProtoBuf files are stored in `_proto/hapi` (where `hapi` stands for the Helm Application Programming Interface). - The Go files generated from the `proto` definitions are stored in `pkg/proto`. - The `scripts/` directory contains a number of utility scripts. Most of these diff --git a/docs/chart_repository.md b/docs/developing-charts/chart_repository.md similarity index 100% rename from docs/chart_repository.md rename to docs/developing-charts/chart_repository.md diff --git a/docs/chart_repository_faq.md b/docs/developing-charts/chart_repository_faq.md similarity index 100% rename from docs/chart_repository_faq.md rename to docs/developing-charts/chart_repository_faq.md diff --git a/docs/chart_repository_sync_example.md b/docs/developing-charts/chart_repository_sync_example.md similarity index 100% rename from docs/chart_repository_sync_example.md rename to docs/developing-charts/chart_repository_sync_example.md diff --git a/docs/chart_tests.md b/docs/developing-charts/chart_tests.md similarity index 100% rename from docs/chart_tests.md rename to docs/developing-charts/chart_tests.md diff --git a/docs/charts.md b/docs/developing-charts/charts.md similarity index 97% rename from docs/charts.md rename to docs/developing-charts/charts.md index 209aae05b..3a4be4662 100644 --- a/docs/charts.md +++ b/docs/developing-charts/charts.md @@ -323,11 +323,11 @@ tags: In the above example all charts with the tag `front-end` would be disabled but since the `subchart1.enabled` path evaluates to 'true' in the parent's values, the condition will override the -`front-end` tag and `subchart1` will be enabled. +`front-end` tag and `subchart1` will be enabled. Since `subchart2` is tagged with `back-end` and that tag evaluates to `true`, `subchart2` will be enabled. Also note that although `subchart2` has a condition specified in `requirements.yaml`, there -is no corresponding path and value in the parent's values so that condition has no effect. +is no corresponding path and value in the parent's values so that condition has no effect. ##### Using the CLI with Tags and Conditions @@ -350,19 +350,19 @@ helm install --set tags.front-end=true --set subchart2.enabled=false #### Importing Child Values via requirements.yaml -In some cases it is desirable to allow a child chart's values to propagate to the parent chart and be -shared as common defaults. An additional benefit of using the `exports` format is that it will enable future +In some cases it is desirable to allow a child chart's values to propagate to the parent chart and be +shared as common defaults. An additional benefit of using the `exports` format is that it will enable future tooling to introspect user-settable values. -The keys containing the values to be imported can be specified in the parent chart's `requirements.yaml` file -using a YAML list. Each item in the list is a key which is imported from the child chart's `exports` field. +The keys containing the values to be imported can be specified in the parent chart's `requirements.yaml` file +using a YAML list. Each item in the list is a key which is imported from the child chart's `exports` field. To import values not contained in the `exports` key, use the [child/parent](#using-the-child/parent-format) format. Examples of both formats are described below. ##### Using the exports format -If a child chart's `values.yaml` file contains an `exports` field at the root, its contents may be imported +If a child chart's `values.yaml` file contains an `exports` field at the root, its contents may be imported directly into the parent's values by specifying the keys to import as in the example below: ```yaml @@ -379,8 +379,8 @@ exports: myint: 99 ``` -Since we are specifying the key `data` in our import list, Helm looks in the the `exports` field of the child -chart for `data` key and imports its contents. +Since we are specifying the key `data` in our import list, Helm looks in the the `exports` field of the child +chart for `data` key and imports its contents. The final parent values would contain our exported field: @@ -391,16 +391,16 @@ myint: 99 ``` -Please note the parent key `data` is not contained in the parent's final values. If you need to specify the -parent key, use the 'child/parent' format. +Please note the parent key `data` is not contained in the parent's final values. If you need to specify the +parent key, use the 'child/parent' format. ##### Using the child/parent format -To access values that are not contained in the `exports` key of the child chart's values, you will need to -specify the source key of the values to be imported (`child`) and the destination path in the parent chart's +To access values that are not contained in the `exports` key of the child chart's values, you will need to +specify the source key of the values to be imported (`child`) and the destination path in the parent chart's values (`parent`). -The `import-values` in the example below instructs Helm to take any values found at `child:` path and copy them +The `import-values` in the example below instructs Helm to take any values found at `child:` path and copy them to the parent's values at the path specified in `parent:` ```yaml @@ -415,7 +415,7 @@ dependencies: parent: myimports ``` In the above example, values found at `default.data` in the subchart1's values will be imported -to the `myimports` key in the parent chart's values as detailed below: +to the `myimports` key in the parent chart's values as detailed below: ```yaml # parent's values.yaml file @@ -424,7 +424,7 @@ myimports: myint: 0 mybool: false mystring: "helm rocks!" - + ``` ```yaml # subchart1's values.yaml file @@ -433,7 +433,7 @@ default: data: myint: 999 mybool: true - + ``` The parent chart's resulting values would be: diff --git a/docs/charts_hooks.md b/docs/developing-charts/charts_hooks.md similarity index 99% rename from docs/charts_hooks.md rename to docs/developing-charts/charts_hooks.md index 46b06fad3..f03ffdb49 100644 --- a/docs/charts_hooks.md +++ b/docs/developing-charts/charts_hooks.md @@ -80,7 +80,7 @@ hooks, the lifecycle is altered like this: 5. Tiller sorts hooks by weight (assigning a weight of 0 by default) and by name for those hooks with the same weight in ascending order. 6. Tiller then loads the hook with the lowest weight first (negative to positive) 7. Tiller waits until the hook is "Ready" -8. Tiller loads the resulting resources into Kubernetes. Note that if the `--wait` +8. Tiller loads the resulting resources into Kubernetes. Note that if the `--wait` flag is set, Tiller will wait until all resources are in a ready state and will not run the `post-install` hook until they are ready. 9. Tiller executes the `post-install` hook (loading hook resources) @@ -187,5 +187,4 @@ deterministic executing order. Weights are defined using the following annotatio Hook weights can be positive or negative numbers but must be represented as strings. When Tiller starts the execution cycle of hooks of a particular Kind it -will sort those hooks in ascending order. - +will sort those hooks in ascending order. diff --git a/docs/charts_tips_and_tricks.md b/docs/developing-charts/charts_tips_and_tricks.md similarity index 99% rename from docs/charts_tips_and_tricks.md rename to docs/developing-charts/charts_tips_and_tricks.md index 6fee3cc7b..b662285fc 100644 --- a/docs/charts_tips_and_tricks.md +++ b/docs/developing-charts/charts_tips_and_tricks.md @@ -124,7 +124,7 @@ with the old configuration resulting in an inconsistent deployment. The `sha256sum` function can be used together with the `include` function to ensure a deployments template section is updated if another -spec changes: +spec changes: ```yaml kind: Deployment diff --git a/docs/provenance.md b/docs/developing-charts/provenance.md similarity index 100% rename from docs/provenance.md rename to docs/developing-charts/provenance.md diff --git a/docs/glossary.md b/docs/glossary/glossary.md similarity index 99% rename from docs/glossary.md rename to docs/glossary/glossary.md index 07c8c6fb3..5be07ceab 100644 --- a/docs/glossary.md +++ b/docs/glossary/glossary.md @@ -179,5 +179,3 @@ These exposed variables are called _values_ in Helm parlance. Values can be set during `helm install` and `helm upgrade` operations, either by passing them in directly, or by uploading a `values.yaml` file. - - diff --git a/docs/helm/helm.md b/docs/helm-commands/helm.md similarity index 100% rename from docs/helm/helm.md rename to docs/helm-commands/helm.md diff --git a/docs/helm/helm_completion.md b/docs/helm-commands/helm_completion.md similarity index 100% rename from docs/helm/helm_completion.md rename to docs/helm-commands/helm_completion.md diff --git a/docs/helm/helm_create.md b/docs/helm-commands/helm_create.md similarity index 100% rename from docs/helm/helm_create.md rename to docs/helm-commands/helm_create.md diff --git a/docs/helm/helm_delete.md b/docs/helm-commands/helm_delete.md similarity index 100% rename from docs/helm/helm_delete.md rename to docs/helm-commands/helm_delete.md diff --git a/docs/helm/helm_dependency.md b/docs/helm-commands/helm_dependency.md similarity index 100% rename from docs/helm/helm_dependency.md rename to docs/helm-commands/helm_dependency.md diff --git a/docs/helm/helm_dependency_build.md b/docs/helm-commands/helm_dependency_build.md similarity index 100% rename from docs/helm/helm_dependency_build.md rename to docs/helm-commands/helm_dependency_build.md diff --git a/docs/helm/helm_dependency_list.md b/docs/helm-commands/helm_dependency_list.md similarity index 100% rename from docs/helm/helm_dependency_list.md rename to docs/helm-commands/helm_dependency_list.md diff --git a/docs/helm/helm_dependency_update.md b/docs/helm-commands/helm_dependency_update.md similarity index 100% rename from docs/helm/helm_dependency_update.md rename to docs/helm-commands/helm_dependency_update.md diff --git a/docs/helm/helm_fetch.md b/docs/helm-commands/helm_fetch.md similarity index 100% rename from docs/helm/helm_fetch.md rename to docs/helm-commands/helm_fetch.md diff --git a/docs/helm/helm_get.md b/docs/helm-commands/helm_get.md similarity index 100% rename from docs/helm/helm_get.md rename to docs/helm-commands/helm_get.md diff --git a/docs/helm/helm_get_hooks.md b/docs/helm-commands/helm_get_hooks.md similarity index 100% rename from docs/helm/helm_get_hooks.md rename to docs/helm-commands/helm_get_hooks.md diff --git a/docs/helm/helm_get_manifest.md b/docs/helm-commands/helm_get_manifest.md similarity index 100% rename from docs/helm/helm_get_manifest.md rename to docs/helm-commands/helm_get_manifest.md diff --git a/docs/helm/helm_get_values.md b/docs/helm-commands/helm_get_values.md similarity index 100% rename from docs/helm/helm_get_values.md rename to docs/helm-commands/helm_get_values.md diff --git a/docs/helm/helm_history.md b/docs/helm-commands/helm_history.md similarity index 100% rename from docs/helm/helm_history.md rename to docs/helm-commands/helm_history.md diff --git a/docs/helm/helm_home.md b/docs/helm-commands/helm_home.md similarity index 100% rename from docs/helm/helm_home.md rename to docs/helm-commands/helm_home.md diff --git a/docs/helm/helm_init.md b/docs/helm-commands/helm_init.md similarity index 100% rename from docs/helm/helm_init.md rename to docs/helm-commands/helm_init.md diff --git a/docs/helm/helm_inspect.md b/docs/helm-commands/helm_inspect.md similarity index 100% rename from docs/helm/helm_inspect.md rename to docs/helm-commands/helm_inspect.md diff --git a/docs/helm/helm_inspect_chart.md b/docs/helm-commands/helm_inspect_chart.md similarity index 100% rename from docs/helm/helm_inspect_chart.md rename to docs/helm-commands/helm_inspect_chart.md diff --git a/docs/helm/helm_inspect_values.md b/docs/helm-commands/helm_inspect_values.md similarity index 100% rename from docs/helm/helm_inspect_values.md rename to docs/helm-commands/helm_inspect_values.md diff --git a/docs/helm/helm_install.md b/docs/helm-commands/helm_install.md similarity index 100% rename from docs/helm/helm_install.md rename to docs/helm-commands/helm_install.md diff --git a/docs/helm/helm_lint.md b/docs/helm-commands/helm_lint.md similarity index 100% rename from docs/helm/helm_lint.md rename to docs/helm-commands/helm_lint.md diff --git a/docs/helm/helm_list.md b/docs/helm-commands/helm_list.md similarity index 100% rename from docs/helm/helm_list.md rename to docs/helm-commands/helm_list.md diff --git a/docs/helm/helm_package.md b/docs/helm-commands/helm_package.md similarity index 100% rename from docs/helm/helm_package.md rename to docs/helm-commands/helm_package.md diff --git a/docs/helm/helm_plugin.md b/docs/helm-commands/helm_plugin.md similarity index 100% rename from docs/helm/helm_plugin.md rename to docs/helm-commands/helm_plugin.md diff --git a/docs/helm/helm_plugin_install.md b/docs/helm-commands/helm_plugin_install.md similarity index 100% rename from docs/helm/helm_plugin_install.md rename to docs/helm-commands/helm_plugin_install.md diff --git a/docs/helm/helm_plugin_list.md b/docs/helm-commands/helm_plugin_list.md similarity index 100% rename from docs/helm/helm_plugin_list.md rename to docs/helm-commands/helm_plugin_list.md diff --git a/docs/helm/helm_plugin_remove.md b/docs/helm-commands/helm_plugin_remove.md similarity index 100% rename from docs/helm/helm_plugin_remove.md rename to docs/helm-commands/helm_plugin_remove.md diff --git a/docs/helm/helm_plugin_update.md b/docs/helm-commands/helm_plugin_update.md similarity index 100% rename from docs/helm/helm_plugin_update.md rename to docs/helm-commands/helm_plugin_update.md diff --git a/docs/helm/helm_repo.md b/docs/helm-commands/helm_repo.md similarity index 100% rename from docs/helm/helm_repo.md rename to docs/helm-commands/helm_repo.md diff --git a/docs/helm/helm_repo_add.md b/docs/helm-commands/helm_repo_add.md similarity index 100% rename from docs/helm/helm_repo_add.md rename to docs/helm-commands/helm_repo_add.md diff --git a/docs/helm/helm_repo_index.md b/docs/helm-commands/helm_repo_index.md similarity index 100% rename from docs/helm/helm_repo_index.md rename to docs/helm-commands/helm_repo_index.md diff --git a/docs/helm/helm_repo_list.md b/docs/helm-commands/helm_repo_list.md similarity index 100% rename from docs/helm/helm_repo_list.md rename to docs/helm-commands/helm_repo_list.md diff --git a/docs/helm/helm_repo_remove.md b/docs/helm-commands/helm_repo_remove.md similarity index 100% rename from docs/helm/helm_repo_remove.md rename to docs/helm-commands/helm_repo_remove.md diff --git a/docs/helm/helm_repo_update.md b/docs/helm-commands/helm_repo_update.md similarity index 100% rename from docs/helm/helm_repo_update.md rename to docs/helm-commands/helm_repo_update.md diff --git a/docs/helm/helm_reset.md b/docs/helm-commands/helm_reset.md similarity index 100% rename from docs/helm/helm_reset.md rename to docs/helm-commands/helm_reset.md diff --git a/docs/helm/helm_rollback.md b/docs/helm-commands/helm_rollback.md similarity index 100% rename from docs/helm/helm_rollback.md rename to docs/helm-commands/helm_rollback.md diff --git a/docs/helm/helm_search.md b/docs/helm-commands/helm_search.md similarity index 100% rename from docs/helm/helm_search.md rename to docs/helm-commands/helm_search.md diff --git a/docs/helm/helm_serve.md b/docs/helm-commands/helm_serve.md similarity index 100% rename from docs/helm/helm_serve.md rename to docs/helm-commands/helm_serve.md diff --git a/docs/helm/helm_status.md b/docs/helm-commands/helm_status.md similarity index 100% rename from docs/helm/helm_status.md rename to docs/helm-commands/helm_status.md diff --git a/docs/helm/helm_test.md b/docs/helm-commands/helm_test.md similarity index 100% rename from docs/helm/helm_test.md rename to docs/helm-commands/helm_test.md diff --git a/docs/helm/helm_upgrade.md b/docs/helm-commands/helm_upgrade.md similarity index 100% rename from docs/helm/helm_upgrade.md rename to docs/helm-commands/helm_upgrade.md diff --git a/docs/helm/helm_verify.md b/docs/helm-commands/helm_verify.md similarity index 100% rename from docs/helm/helm_verify.md rename to docs/helm-commands/helm_verify.md diff --git a/docs/helm/helm_version.md b/docs/helm-commands/helm_version.md similarity index 100% rename from docs/helm/helm_version.md rename to docs/helm-commands/helm_version.md diff --git a/docs/history.md b/docs/history/history.md similarity index 100% rename from docs/history.md rename to docs/history/history.md diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index b787463a6..000000000 --- a/docs/index.md +++ /dev/null @@ -1,35 +0,0 @@ -# Helm Documentation - -- [Quick Start](quickstart.md) - Read me first! -- [Installing Helm](install.md) - Install Helm and Tiller - - [Kubernetes Distribution Notes](kubernetes_distros.md) - - [Frequently Asked Questions](install_faq.md) -- [Using Helm](using_helm.md) - Learn the Helm tools - - [Plugins](plugins.md) -- [Developing Charts](charts.md) - An introduction to chart development - - [Chart Lifecycle Hooks](charts_hooks.md) - - [Chart Tips and Tricks](charts_tips_and_tricks.md) - - [Chart Repository Guide](chart_repository.md) - - [Syncing your Chart Repository](chart_repository_sync_example.md) - - [Signing Charts](provenance.md) - - [Writing Tests for Charts](chart_tests.md) -- [Chart Template Developer's Guide](chart_template_guide/index.md) - Master Helm templates - - [Getting Started with Templates](chart_template_guide/getting_started.md) - - [Built-in Objects](chart_template_guide/builtin_objects.md) - - [Values Files](chart_template_guide/values_files.md) - - [Functions and Pipelines](chart_template_guide/functions_and_pipelines.md) - - [Flow Control (if/else, with, range, whitespace management)](chart_template_guide/control_structures.md) - - [Variables](chart_template_guide/variables.md) - - [Named Templates (Partials)](chart_template_guide/named_templates.md) - - [Accessing Files Inside Templates](chart_template_guide/accessing_files.md) - - [Creating a NOTES.txt File](chart_template_guide/notes_files.md) - - [Subcharts and Global Values](chart_template_guide/subcharts_and_globals.md) - - [Debugging Templates](chart_template_guide/debugging.md) - - [Wrapping Up](chart_template_guide/wrapping_up.md) - - [Appendix A: YAML Techniques](chart_template_guide/yaml_techniques.md) - - [Appendix B: Go Data Types](chart_template_guide/data_types.md) -- [Related Projects](related.md) - More Helm tools, articles, and plugins -- [Architecture](architecture.md) - Overview of the Helm/Tiller design -- [Developers](developers.md) - About the developers -- [History](history.md) - A brief history of the project -- [Glossary](glossary.md) - Decode the Helm vocabulary diff --git a/docs/related.md b/docs/related/related.md similarity index 100% rename from docs/related.md rename to docs/related/related.md diff --git a/docs/install.md b/docs/using-helm/install.md similarity index 100% rename from docs/install.md rename to docs/using-helm/install.md diff --git a/docs/install_faq.md b/docs/using-helm/install_faq.md similarity index 100% rename from docs/install_faq.md rename to docs/using-helm/install_faq.md diff --git a/docs/kubernetes_distros.md b/docs/using-helm/kubernetes_distros.md similarity index 100% rename from docs/kubernetes_distros.md rename to docs/using-helm/kubernetes_distros.md diff --git a/docs/plugins.md b/docs/using-helm/plugins.md similarity index 100% rename from docs/plugins.md rename to docs/using-helm/plugins.md diff --git a/docs/quickstart.md b/docs/using-helm/quickstart.md similarity index 100% rename from docs/quickstart.md rename to docs/using-helm/quickstart.md diff --git a/docs/using_helm.md b/docs/using-helm/using_helm.md similarity index 99% rename from docs/using_helm.md rename to docs/using-helm/using_helm.md index 4860b59e7..0ee06c4a5 100755 --- a/docs/using_helm.md +++ b/docs/using-helm/using_helm.md @@ -80,7 +80,7 @@ stable/mysql 0.1.0 Chart for MySQL stable/mariadb 0.5.1 Chart for MariaDB ``` -Now you will only see the results that match your filter. +Now you will only see the results that match your filter. Why is `mariadb` in the list? Because its package description relates it to @@ -373,9 +373,9 @@ is not a full list of cli flags. To see a description of all flags, just run This defaults to 300 (5 minutes) - `--wait`: Waits until all Pods are in a ready state, PVCs are bound, Deployments have minimum (`Desired` minus `maxUnavailable`) Pods in ready state and - Services have an IP address (and Ingress if a `LoadBalancer`) before - marking the release as successful. It will wait for as long as the - `--timeout` value. If timeout is reached, the release will be marked as + Services have and IP address (and Ingress if a `LoadBalancer`) before + marking the release as successful. It will wait for as long as the + `--timeout` value. If timeout is reached, the release will be marked as `FAILED`. Note: In scenario where Deployment has `replicas` set to 1 and `maxUnavailable` is not set to 0 as part of rolling