From 6ebd261c4a8a08bc6531a557af880d26f4d617ca Mon Sep 17 00:00:00 2001 From: flynnduism Date: Thu, 25 May 2017 17:20:22 -0700 Subject: [PATCH 1/3] Added metadata needed to build Hugo docs site (docs.helm.sh) --- docs/architecture.md | 13 ++++++++++ docs/chart_best_practices/conventions.md | 17 +++++++++++++ docs/chart_best_practices/labels.md | 17 +++++++++++++ docs/chart_best_practices/pods.md | 17 +++++++++++++ docs/chart_best_practices/requirements.md | 17 +++++++++++++ docs/chart_best_practices/templates.md | 17 +++++++++++++ .../third_party_resources.md | 17 +++++++++++++ docs/chart_best_practices/values.md | 21 +++++++++++++--- docs/chart_repository.md | 17 +++++++++++++ docs/chart_repository_faq.md | 17 +++++++++++++ docs/chart_repository_sync_example.md | 17 +++++++++++++ docs/chart_template_guide/accessing_files.md | 17 +++++++++++++ docs/chart_template_guide/builtin_objects.md | 17 +++++++++++++ .../control_structures.md | 17 +++++++++++++ docs/chart_template_guide/data_types.md | 17 +++++++++++++ docs/chart_template_guide/debugging.md | 17 +++++++++++++ .../functions_and_pipelines.md | 17 +++++++++++++ docs/chart_template_guide/getting_started.md | 17 +++++++++++++ docs/chart_template_guide/index.md | 24 +++++++++++++++---- docs/chart_template_guide/named_templates.md | 17 +++++++++++++ docs/chart_template_guide/notes_files.md | 17 +++++++++++++ .../subcharts_and_globals.md | 17 +++++++++++++ docs/chart_template_guide/values_files.md | 17 +++++++++++++ docs/chart_template_guide/variables.md | 17 +++++++++++++ docs/chart_template_guide/wrapping_up.md | 17 +++++++++++++ docs/chart_template_guide/yaml_techniques.md | 17 +++++++++++++ docs/chart_tests.md | 17 +++++++++++++ docs/charts.md | 23 ++++++++++++++---- docs/charts_hooks.md | 17 +++++++++++++ docs/charts_tips_and_tricks.md | 17 +++++++++++++ docs/developers.md | 17 ++++++++++--- docs/glossary.md | 13 ++++++++++ docs/helm/helm.md | 18 ++++++++++---- docs/helm/helm_completion.md | 17 +++++++++++++ docs/helm/helm_create.md | 17 +++++++++++++ docs/helm/helm_delete.md | 17 +++++++++++++ docs/helm/helm_dependency.md | 17 +++++++++++++ docs/helm/helm_dependency_build.md | 17 +++++++++++++ docs/helm/helm_dependency_list.md | 17 +++++++++++++ docs/helm/helm_dependency_update.md | 17 +++++++++++++ docs/helm/helm_fetch.md | 17 +++++++++++++ docs/helm/helm_get.md | 17 +++++++++++++ docs/helm/helm_get_hooks.md | 17 +++++++++++++ docs/helm/helm_get_manifest.md | 17 +++++++++++++ docs/helm/helm_get_values.md | 17 +++++++++++++ docs/helm/helm_history.md | 17 +++++++++++++ docs/helm/helm_home.md | 17 +++++++++++++ docs/helm/helm_init.md | 17 +++++++++++++ docs/helm/helm_inspect.md | 17 +++++++++++++ docs/helm/helm_inspect_chart.md | 17 +++++++++++++ docs/helm/helm_inspect_values.md | 17 +++++++++++++ docs/helm/helm_install.md | 17 +++++++++++++ docs/helm/helm_lint.md | 17 +++++++++++++ docs/helm/helm_list.md | 17 +++++++++++++ docs/helm/helm_package.md | 17 +++++++++++++ docs/helm/helm_plugin.md | 17 +++++++++++++ docs/helm/helm_plugin_install.md | 17 +++++++++++++ docs/helm/helm_plugin_list.md | 17 +++++++++++++ docs/helm/helm_plugin_remove.md | 17 +++++++++++++ docs/helm/helm_plugin_update.md | 17 +++++++++++++ docs/helm/helm_repo.md | 17 +++++++++++++ docs/helm/helm_repo_add.md | 17 +++++++++++++ docs/helm/helm_repo_index.md | 17 +++++++++++++ docs/helm/helm_repo_list.md | 17 +++++++++++++ docs/helm/helm_repo_remove.md | 17 +++++++++++++ docs/helm/helm_repo_update.md | 17 +++++++++++++ docs/helm/helm_reset.md | 17 +++++++++++++ docs/helm/helm_rollback.md | 17 +++++++++++++ docs/helm/helm_search.md | 17 +++++++++++++ docs/helm/helm_serve.md | 17 +++++++++++++ docs/helm/helm_status.md | 17 +++++++++++++ docs/helm/helm_test.md | 17 +++++++++++++ docs/helm/helm_upgrade.md | 17 +++++++++++++ docs/helm/helm_verify.md | 17 +++++++++++++ docs/helm/helm_version.md | 17 +++++++++++++ docs/history.md | 20 ++++++++++++---- docs/install.md | 17 +++++++++++++ docs/install_faq.md | 17 +++++++++++++ docs/kubernetes_distros.md | 17 +++++++++++++ docs/plugins.md | 17 +++++++++++++ docs/provenance.md | 17 +++++++++++++ docs/quickstart.md | 17 +++++++++++++ docs/related.md | 13 ++++++++++ docs/using_helm.md | 17 +++++++++++++ 84 files changed, 1412 insertions(+), 25 deletions(-) diff --git a/docs/architecture.md b/docs/architecture.md index 752a7e12c..d7a4b0831 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -1,3 +1,16 @@ ++++ +title = "Architecture" +weight = "1" + +tags = ["stack", "architecture"] +section = "architecture" +categories = ["architecture"] +type = "page" + +slug = "architecture" + ++++ + # The Kubernetes Helm Architecture This document describes the Helm architecture at a high level. diff --git a/docs/chart_best_practices/conventions.md b/docs/chart_best_practices/conventions.md index 324ef88f9..56bc3dd3b 100644 --- a/docs/chart_best_practices/conventions.md +++ b/docs/chart_best_practices/conventions.md @@ -1,3 +1,20 @@ ++++ +title = "General Conventions" +weight = "1" + +tags = ["chart", "template", "guide"] +section = "chart-best-practices" +categories = ["chart-best-practices"] +type = "page" + +slug = "conventions" + +[menu.main] + url = "conventions" + parent = "chart-best-practices" + ++++ + # General Conventions This part of the Best Practices Guide explains general conventions. diff --git a/docs/chart_best_practices/labels.md b/docs/chart_best_practices/labels.md index d9e75c52c..d1fb8a598 100644 --- a/docs/chart_best_practices/labels.md +++ b/docs/chart_best_practices/labels.md @@ -1,3 +1,20 @@ ++++ +title = "Labels and Annotations" +weight = "5" + +tags = ["labels", "annotations"] +section = "chart-best-practices" +categories = ["chart-best-practices"] +type = "page" + +slug = "labels-and-annotations" + +[menu.main] + url = "labels-and-annotations" + parent = "chart-best-practices" + ++++ + # Labels and Annotations This part of the Best Practices Guide discusses the best practices for using diff --git a/docs/chart_best_practices/pods.md b/docs/chart_best_practices/pods.md index de679f9f5..f79f9b4da 100644 --- a/docs/chart_best_practices/pods.md +++ b/docs/chart_best_practices/pods.md @@ -1,3 +1,20 @@ ++++ +title = "Pods & PodTemplates" +weight = "6" + +tags = ["pods", "podTemplates"] +section = "chart-best-practices" +categories = ["chart-best-practices"] +type = "page" + +slug = "pods-and-podtemplates" + +[menu.main] + url = "pods-and-podtemplates" + parent = "chart-best-practices" + ++++ + # Pods and PodTemplates This part of the Best Practices Guide discusses formatting the Pod and PodTemplate diff --git a/docs/chart_best_practices/requirements.md b/docs/chart_best_practices/requirements.md index 0bbdfdfd7..c6eb19611 100644 --- a/docs/chart_best_practices/requirements.md +++ b/docs/chart_best_practices/requirements.md @@ -1,3 +1,20 @@ ++++ +title = "Requirements" +weight = "4" + +tags = ["chart", "template", "guide"] +section = "chart-best-practices" +categories = ["chart-best-practices"] +type = "page" + +slug = "requirements" + +[menu.main] + url = "requirements" + parent = "chart-best-practices" + ++++ + # Requirements Files This section of the guide covers best practices for `requirements.yaml` files. diff --git a/docs/chart_best_practices/templates.md b/docs/chart_best_practices/templates.md index db1259246..649140a5a 100644 --- a/docs/chart_best_practices/templates.md +++ b/docs/chart_best_practices/templates.md @@ -1,3 +1,20 @@ ++++ +title = "Templates" +weight = "3" + +tags = ["chart", "template", "guide"] +section = "chart-best-practices" +categories = ["chart-best-practices"] +type = "page" + +slug = "templates" + +[menu.main] + url = "templates" + parent = "chart-best-practices" + ++++ + # Templates This part of the Best Practices Guide focuses on templates. diff --git a/docs/chart_best_practices/third_party_resources.md b/docs/chart_best_practices/third_party_resources.md index cb0fcc754..8e71e0173 100644 --- a/docs/chart_best_practices/third_party_resources.md +++ b/docs/chart_best_practices/third_party_resources.md @@ -1,3 +1,20 @@ ++++ +title = "Third Party Resources" +weight = "7" + +tags = ["third", "resources", "party"] +section = "chart-best-practices" +categories = ["chart-best-practices"] +type = "page" + +slug = "third-party-resources" + +[menu.main] + url = "third-party-resources" + parent = "chart-best-practices" + ++++ + # Third Party Resources This section of the Best Practices Guide deals with creating and using Third Party Resource diff --git a/docs/chart_best_practices/values.md b/docs/chart_best_practices/values.md index 199f8048e..1cf41c5bb 100644 --- a/docs/chart_best_practices/values.md +++ b/docs/chart_best_practices/values.md @@ -1,8 +1,23 @@ ++++ +title = "Values" +weight = "2" + +tags = ["chart", "template", "guide"] +section = "chart-best-practices" +categories = ["chart-best-practices"] +type = "page" + +slug = "values" + +[menu.main] + url = "values" + parent = "chart-best-practices" + ++++ + # Values -This part of the best practices guide covers using values. In this part of the -guide, we provide recommendations on how you should structure and use your -values, with focus on designing a chart's `values.yaml` file. +This part of the best practices guide covers using values. In this part of the guide, we provide recommendations on how you should structure and use your values, with focus on designing a chart's `values.yaml` file. ## Naming Conventions diff --git a/docs/chart_repository.md b/docs/chart_repository.md index 1379573fc..1b4aefd2e 100644 --- a/docs/chart_repository.md +++ b/docs/chart_repository.md @@ -1,3 +1,20 @@ ++++ +title = "Chart Repository Guide" +weight = "4" + +tags = ["charts", "repo", "guide"] +section = "developing-charts" +categories = ["developing-charts"] +type = "page" + +slug = "chart-repo-guide" + +[menu.main] + url = "chart-repo-guide" + parent = "developing-charts" + ++++ + # The Chart Repository Guide This section explains how to create and work with Helm chart repositories. At a diff --git a/docs/chart_repository_faq.md b/docs/chart_repository_faq.md index 78e47a461..917309bf5 100644 --- a/docs/chart_repository_faq.md +++ b/docs/chart_repository_faq.md @@ -1,3 +1,20 @@ ++++ +title = "Chart Repository FAQ" +weight = "8" + +tags = ["charts", "repo", "faqs"] +section = "developing-charts" +categories = ["developing-charts"] +type = "page" + +slug = "chart-repo-faq" + +[menu.main] + url = "chart-repo-faq" + parent = "developing-charts" + ++++ + # Chart Repositories: Frequently Asked Questions This section tracks some of the more frequently encountered issues with using chart repositories. diff --git a/docs/chart_repository_sync_example.md b/docs/chart_repository_sync_example.md index 2fff70de9..76f5b9620 100644 --- a/docs/chart_repository_sync_example.md +++ b/docs/chart_repository_sync_example.md @@ -1,3 +1,20 @@ ++++ +title = "Syncing Your Chart Repo" +weight = "5" + +tags = ["charts", "syncing", "repo", "directory"] +section = "developing-charts" +categories = ["developing-charts"] +type = "page" + +slug = "syncing-your-chart-repo" + +[menu.main] + url = "syncing-your-chart-repo" + parent = "developing-charts" + ++++ + # Syncing Your Chart Repository *Note: This example is specifically for a Google Cloud Storage (GCS) bucket which serves a chart repository.* diff --git a/docs/chart_template_guide/accessing_files.md b/docs/chart_template_guide/accessing_files.md index 3911af830..44fc60514 100644 --- a/docs/chart_template_guide/accessing_files.md +++ b/docs/chart_template_guide/accessing_files.md @@ -1,3 +1,20 @@ ++++ +title = "Accessing Files Inside Templates" +weight = "9" + +tags = ["access", "template", "ConfigMap"] +section = "chart-template-guide" +categories = ["chart-template-guide"] +type = "page" + +slug = "accessing-files-inside-templates" + +[menu.main] + url = "accessing-files-inside-templates" + parent = "chart-template-guide" + ++++ + # Accessing Files Inside Templates In the previous section we looked at several ways to create and access named templates. This makes it easy to import one template from within another template. But sometimes it is desirable to import a _file that is not a template_ and inject its contents without sending the contents through the template renderer. diff --git a/docs/chart_template_guide/builtin_objects.md b/docs/chart_template_guide/builtin_objects.md index 2e1a5d8a3..f473a2f3f 100644 --- a/docs/chart_template_guide/builtin_objects.md +++ b/docs/chart_template_guide/builtin_objects.md @@ -1,3 +1,20 @@ ++++ +title = "Built-in Objects" +weight = "3" + +tags = ["objects", "template", "builtin"] +section = "chart-template-guide" +categories = ["chart-template-guide"] +type = "page" + +slug = "built-in-objects" + +[menu.main] + url = "built-in-objects" + parent = "chart-template-guide" + ++++ + # Built-in Objects Objects are passed into a template from the template engine. And your code can pass objects around (we'll see examples when we look at the `with` and `range` statements). There are even a few ways to create new objects within your templates, like with the `tuple` function we'll see later. diff --git a/docs/chart_template_guide/control_structures.md b/docs/chart_template_guide/control_structures.md index 7575ebc35..22fc764cf 100644 --- a/docs/chart_template_guide/control_structures.md +++ b/docs/chart_template_guide/control_structures.md @@ -1,3 +1,20 @@ ++++ +title = "Flow Control" +weight = "6" + +tags = ["chart", "template", "guide"] +section = "chart-template-guide" +categories = ["chart-template-guide"] +type = "page" + +slug = "flow-control" + +[menu.main] + url = "flow-control" + parent = "chart-template-guide" + ++++ + # Flow Control Control structures (called "actions" in template parlance) provide you, the template author, with the ability to control the flow of a template's generation. Helm's template language provides the following control structures: diff --git a/docs/chart_template_guide/data_types.md b/docs/chart_template_guide/data_types.md index 2e6a9f15b..cde23ef13 100644 --- a/docs/chart_template_guide/data_types.md +++ b/docs/chart_template_guide/data_types.md @@ -1,3 +1,20 @@ ++++ +title = "Appendix: Go Data Types & Templates" +weight = "15" + +tags = ["appendix", "data types", "templates"] +section = "chart-template-guide" +categories = ["chart-template-guide"] +type = "page" + +slug = "appendix-data-templates" + +[menu.main] + url = "appendix-data-templates" + parent = "chart-template-guide" + ++++ + # Appendix: Go Data Types and Templates The Helm template language is implemented in the strongly typed Go programming language. For that reason, variables in templates are _typed_. For the most part, variables will be exposed as one of the following types: diff --git a/docs/chart_template_guide/debugging.md b/docs/chart_template_guide/debugging.md index fac788cc4..05a076d31 100644 --- a/docs/chart_template_guide/debugging.md +++ b/docs/chart_template_guide/debugging.md @@ -1,3 +1,20 @@ ++++ +title = "Debugging Templates" +weight = "12" + +tags = ["debugging", "template"] +section = "chart-template-guide" +categories = ["chart-template-guide"] +type = "page" + +slug = "debugging-templates" + +[menu.main] + url = "debugging-templates" + parent = "chart-template-guide" + ++++ + # Debugging Templates Debugging templates can be tricky simply because the templates are rendered on the Tiller server, not the Helm client. And then the rendered templates are sent to the Kubernetes API server, which may reject the YAML files for reasons other than formatting. diff --git a/docs/chart_template_guide/functions_and_pipelines.md b/docs/chart_template_guide/functions_and_pipelines.md index 7eb1ca26c..1bc309acd 100644 --- a/docs/chart_template_guide/functions_and_pipelines.md +++ b/docs/chart_template_guide/functions_and_pipelines.md @@ -1,3 +1,20 @@ ++++ +title = "Template Functions and Pipelines" +weight = "5" + +tags = ["chart", "template", "guide"] +section = "chart-template-guide" +categories = ["chart-template-guide"] +type = "page" + +slug = "template-functions--pipelines" + +[menu.main] + url = "template-functions--pipelines" + parent = "chart-template-guide" + ++++ + # Template Functions and Pipelines So far, we've seen how to place information into a template. But that information is placed into the template unmodified. Sometimes we want to transform the supplied data in a way that makes it more useable to us. diff --git a/docs/chart_template_guide/getting_started.md b/docs/chart_template_guide/getting_started.md index 98a2532b0..7e121705d 100644 --- a/docs/chart_template_guide/getting_started.md +++ b/docs/chart_template_guide/getting_started.md @@ -1,3 +1,20 @@ ++++ +title = "Getting Started" +weight = "2" + +tags = ["chart", "template", "guide"] +section = "chart-template-guide" +categories = ["chart-template-guide"] +type = "page" + +slug = "getting-started-charts" + +[menu.main] + url = "getting-started-charts" + parent = "chart-template-guide" + ++++ + # Getting Started with a Chart Template In this section of the guide, we'll create a chart and then add a first template. The chart we created here will be used throughout the rest of the guide. diff --git a/docs/chart_template_guide/index.md b/docs/chart_template_guide/index.md index c2bcc8f42..fcda66d09 100644 --- a/docs/chart_template_guide/index.md +++ b/docs/chart_template_guide/index.md @@ -1,11 +1,25 @@ ++++ +title = "Intro" +weight = "1" + +tags = ["chart", "template", "guide"] +section = "chart-template-guide" +categories = ["chart-template-guide"] +type = "page" + +slug = "guide-intro" + +[menu.main] + url = "guide-intro" + parent = "chart-template-guide" + ++++ + # The Chart Template Developer's Guide -This guide provides an introduction to Helm's chart templates, with emphasis on -the template language. +This guide provides an introduction to Helm's chart templates, with emphasis on the template language. -Templates generate manifest files, which are YAML-formatted resource descriptions -that Kubernetes can understand. We'll look at how templates are structured, -how they can be used, how to write Go templates, and how to debug your work. +Templates generate manifest files, which are YAML-formatted resource descriptions that Kubernetes can understand. We'll look at how templates are structured, how they can be used, how to write Go templates, and how to debug your work. This guide focuses on the following concepts: diff --git a/docs/chart_template_guide/named_templates.md b/docs/chart_template_guide/named_templates.md index daea98b19..975aaeef7 100644 --- a/docs/chart_template_guide/named_templates.md +++ b/docs/chart_template_guide/named_templates.md @@ -1,3 +1,20 @@ ++++ +title = "Named Templates" +weight = "8" + +tags = ["partials", "template", "definition"] +section = "chart-template-guide" +categories = ["chart-template-guide"] +type = "page" + +slug = "named-templates" + +[menu.main] + url = "named-templates" + parent = "chart-template-guide" + ++++ + # Named Templates It is time to move beyond one template, and begin to create others. In this section, we will see how to define _named templates_ in one file, and then use them elsewhere. A _named template_ (sometimes called a _partial_ or a _subtemplate_) is simply a template defined inside of a file, and given a name. We'll see two ways to create them, and a few different ways to use them. diff --git a/docs/chart_template_guide/notes_files.md b/docs/chart_template_guide/notes_files.md index 5a8b78ca4..526503a78 100644 --- a/docs/chart_template_guide/notes_files.md +++ b/docs/chart_template_guide/notes_files.md @@ -1,3 +1,20 @@ ++++ +title = "Creating a NOTES.txt File" +weight = "10" + +tags = ["creating", "notes", "txt"] +section = "chart-template-guide" +categories = ["chart-template-guide"] +type = "page" + +slug = "creating-notes-file" + +[menu.main] + url = "creating-notes-file" + parent = "chart-template-guide" + ++++ + # Creating a NOTES.txt File In this section we are going to look at Helm's tool for providing instructions to your chart users. At the end of a `chart install` or `chart upgrade`, Helm can print out a block of helpful information for users. This information is highly customizable using templates. diff --git a/docs/chart_template_guide/subcharts_and_globals.md b/docs/chart_template_guide/subcharts_and_globals.md index 69d828c11..1f4f1c322 100644 --- a/docs/chart_template_guide/subcharts_and_globals.md +++ b/docs/chart_template_guide/subcharts_and_globals.md @@ -1,3 +1,20 @@ ++++ +title = "Subcharts & Global Values" +weight = "11" + +tags = ["chart", "subcharts", "global"] +section = "chart-template-guide" +categories = ["chart-template-guide"] +type = "page" + +slug = "subcharts-global-values" + +[menu.main] + url = "subcharts-global-values" + parent = "chart-template-guide" + ++++ + # Subcharts and Global Values To this point we have been working only with one chart. But charts can have dependencies, called _subcharts_, that also have their own values and templates. In this section we will create a subchart and see the different ways we can access values from within templates. diff --git a/docs/chart_template_guide/values_files.md b/docs/chart_template_guide/values_files.md index 626aca3db..44d3f8d73 100644 --- a/docs/chart_template_guide/values_files.md +++ b/docs/chart_template_guide/values_files.md @@ -1,3 +1,20 @@ ++++ +title = "Values Files" +weight = "4" + +tags = ["values", "template", "yaml"] +section = "chart-template-guide" +categories = ["chart-template-guide"] +type = "page" + +slug = "values-files" + +[menu.main] + url = "values-files" + parent = "chart-template-guide" + ++++ + # Values Files In the previous section we looked at the built-in objects that Helm templates offer. One of the four built-in objects is `Values`. This object provides access to values passed into the chart. Its contents come from four sources: diff --git a/docs/chart_template_guide/variables.md b/docs/chart_template_guide/variables.md index 34b6fa891..485b68153 100644 --- a/docs/chart_template_guide/variables.md +++ b/docs/chart_template_guide/variables.md @@ -1,3 +1,20 @@ ++++ +title = "Variables" +weight = "7" + +tags = ["variables", "template", "yaml"] +section = "chart-template-guide" +categories = ["chart-template-guide"] +type = "page" + +slug = "variables" + +[menu.main] + url = "variables" + parent = "chart-template-guide" + ++++ + # Variables With functions, pipelines, objects, and control structures under our belts, we can turn to one of the more basic ideas in many programming languages: variables. In templates, they are less frequently used. But we will see how to use them to simplify code, and to make better use of `with` and `range`. diff --git a/docs/chart_template_guide/wrapping_up.md b/docs/chart_template_guide/wrapping_up.md index 1ed7c602a..c7c3d1756 100755 --- a/docs/chart_template_guide/wrapping_up.md +++ b/docs/chart_template_guide/wrapping_up.md @@ -1,3 +1,20 @@ ++++ +title = "Next Steps" +weight = "13" + +tags = ["community", "contribute", "resources"] +section = "chart-template-guide" +categories = ["chart-template-guide"] +type = "page" + +slug = "next-steps" + +[menu.main] + url = "next-steps" + parent = "chart-template-guide" + ++++ + # Wrapping Up This guide is intended to give you, the chart developer, a strong understanding of how to use Helm's template language. The guide focuses on the technical aspects of template development. diff --git a/docs/chart_template_guide/yaml_techniques.md b/docs/chart_template_guide/yaml_techniques.md index ccada54c0..930688328 100644 --- a/docs/chart_template_guide/yaml_techniques.md +++ b/docs/chart_template_guide/yaml_techniques.md @@ -1,3 +1,20 @@ ++++ +title = "Appendix: YAML Techniques" +weight = "14" + +tags = ["appendix", "yaml"] +section = "chart-template-guide" +categories = ["chart-template-guide"] +type = "page" + +slug = "appendix-yaml-techniques" + +[menu.main] + url = "appendix-yaml-techniques" + parent = "chart-template-guide" + ++++ + # YAML Techniques Most of this guide has been focused on writing the template language. Here, diff --git a/docs/chart_tests.md b/docs/chart_tests.md index 4311ffaeb..c2b308e51 100644 --- a/docs/chart_tests.md +++ b/docs/chart_tests.md @@ -1,3 +1,20 @@ ++++ +title = "Chart Tests" +weight = "7" + +tags = ["charts", "tests", "valid", "hooks"] +section = "developing-charts" +categories = ["developing-charts"] +type = "page" + +slug = "chart-tests" + +[menu.main] + url = "chart-tests" + parent = "developing-charts" + ++++ + # Chart Tests A chart contains a number of Kubernetes resources and components that work together. As a chart author, you may want to write some tests that validate that your chart works as expected when it is installed. These tests also help the chart consumer understand what your chart is supposed to do. diff --git a/docs/charts.md b/docs/charts.md index d63df1720..209aae05b 100644 --- a/docs/charts.md +++ b/docs/charts.md @@ -1,10 +1,23 @@ ++++ +title = "Intro to Charts" +weight = "1" + +tags = ["charts", "example", "intro", "structure", "format"] +section = "developing-charts" +categories = ["developing-charts"] +type = "page" + +slug = "intro-dev-charts" + +[menu.main] + url = "intro-dev-charts" + parent = "developing-charts" + ++++ + # Charts -Helm uses a packaging format called _charts_. A chart is a collection of files -that describe a related set of Kubernetes resources. A single chart -might be used to deploy something simple, like a memcached pod, or -something complex, like a full web app stack with HTTP servers, -databases, caches, and so on. +Helm uses a packaging format called _charts_. A chart is a collection of files that describe a related set of Kubernetes resources. A single chart might be used to deploy something simple, like a memcached pod, or something complex, like a full web app stack with HTTP servers, databases, caches, and so on. Charts are created as files laid out in a particular directory tree, then they can be packaged into versioned archives to be deployed. diff --git a/docs/charts_hooks.md b/docs/charts_hooks.md index 6ac9bc2b0..46b06fad3 100644 --- a/docs/charts_hooks.md +++ b/docs/charts_hooks.md @@ -1,3 +1,20 @@ ++++ +title = "Chart Lifecycle Hooks" +weight = "2" + +tags = ["charts", "hooks", "lifecycle", "pre", "post"] +section = "developing-charts" +categories = ["developing-charts"] +type = "page" + +slug = "chart-lifecycle-hooks" + +[menu.main] + url = "chart-lifecycle-hooks" + parent = "developing-charts" + ++++ + # Hooks Helm provides a _hook_ mechanism to allow chart developers to intervene diff --git a/docs/charts_tips_and_tricks.md b/docs/charts_tips_and_tricks.md index 0ed1ab83e..6fee3cc7b 100644 --- a/docs/charts_tips_and_tricks.md +++ b/docs/charts_tips_and_tricks.md @@ -1,3 +1,20 @@ ++++ +title = "Chart Tips and Tricks" +weight = "3" + +tags = ["charts", "example", "tips", "tricks", "functions", "include"] +section = "developing-charts" +categories = ["developing-charts"] +type = "page" + +slug = "chart-tips-tricks" + +[menu.main] + url = "chart-tips-tricks" + parent = "developing-charts" + ++++ + # Chart Development Tips and Tricks This guide covers some of the tips and tricks Helm chart developers have diff --git a/docs/developers.md b/docs/developers.md index e0aeb374a..56d81b64c 100644 --- a/docs/developers.md +++ b/docs/developers.md @@ -1,3 +1,16 @@ ++++ +title = "Developers Guide" +weight = "1" + +tags = ["team", "developers", "about"] +section = "developer-guide" +categories = ["developer-guide"] +type = "page" + +slug = "developer-guide" + ++++ + # Developers Guide This guide explains how to set up your environment for developing on @@ -117,9 +130,7 @@ remains consistent, and (c) contributions follow the open source legal requirements. Our intent is not to burden contributors, but to build elegant and high-quality open source code so that our users will benefit. -Make sure you have read and understood the main CONTRIBUTING guide: - -https://github.com/kubernetes/helm/blob/master/CONTRIBUTING.md +Make sure you have read and understood the main [CONTRIBUTING guide](https://github.com/kubernetes/helm/blob/master/CONTRIBUTING.md). ### Structure of the Code diff --git a/docs/glossary.md b/docs/glossary.md index 875807268..07c8c6fb3 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -1,3 +1,16 @@ ++++ +title = "Glossary" +weight = "1" + +tags = ["glossary", "architecture"] +section = "using-helm" +categories = ["glossary"] +type = "page" + +slug = "glossary" + ++++ + # Helm Glossary Helm uses a few special terms to describe components of the diff --git a/docs/helm/helm.md b/docs/helm/helm.md index 4567049da..730071d00 100644 --- a/docs/helm/helm.md +++ b/docs/helm/helm.md @@ -1,11 +1,21 @@ -## helm ++++ +title = "Helm" +weight = "-1" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" -The Helm package manager for Kubernetes. +slug = "helm" -### Synopsis +[menu.main] + url = "helm" + parent = "helm-commands" ++++ -The Kubernetes package manager +## helm To begin working with Helm, run the 'helm init' command: diff --git a/docs/helm/helm_completion.md b/docs/helm/helm_completion.md index 4b7c540a1..e8fd988b0 100644 --- a/docs/helm/helm_completion.md +++ b/docs/helm/helm_completion.md @@ -1,3 +1,20 @@ ++++ +title = "helm completion" +weight = "2" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-completion" + +[menu.main] + url = "helm-completion" + parent = "helm-commands" + ++++ + ## helm completion Generate autocompletions script for the specified shell (bash or zsh) diff --git a/docs/helm/helm_create.md b/docs/helm/helm_create.md index 8284be8ff..47f73e16f 100644 --- a/docs/helm/helm_create.md +++ b/docs/helm/helm_create.md @@ -1,3 +1,20 @@ ++++ +title = "helm create" +weight = "3" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-create" + +[menu.main] + url = "helm-create" + parent = "helm-commands" + ++++ + ## helm create create a new chart with the given name diff --git a/docs/helm/helm_delete.md b/docs/helm/helm_delete.md index 0d15b9d02..98890cc53 100644 --- a/docs/helm/helm_delete.md +++ b/docs/helm/helm_delete.md @@ -1,3 +1,20 @@ ++++ +title = "helm delete" +weight = "4" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-delete" + +[menu.main] + url = "helm-delete" + parent = "helm-commands" + ++++ + ## helm delete given a release name, delete the release from Kubernetes diff --git a/docs/helm/helm_dependency.md b/docs/helm/helm_dependency.md index 629a27d38..8e6f0c405 100644 --- a/docs/helm/helm_dependency.md +++ b/docs/helm/helm_dependency.md @@ -1,3 +1,20 @@ ++++ +title = "helm dependency" +weight = "5" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-dependency" + +[menu.main] + url = "helm-dependency" + parent = "helm-commands" + ++++ + ## helm dependency manage a chart's dependencies diff --git a/docs/helm/helm_dependency_build.md b/docs/helm/helm_dependency_build.md index 9c5d6af78..98e1ab9eb 100644 --- a/docs/helm/helm_dependency_build.md +++ b/docs/helm/helm_dependency_build.md @@ -1,3 +1,20 @@ ++++ +title = "helm dependency build" +weight = "6" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-dependency-build" + +[menu.main] + url = "helm-dependency-build" + parent = "helm-commands" + ++++ + ## helm dependency build rebuild the charts/ directory based on the requirements.lock file diff --git a/docs/helm/helm_dependency_list.md b/docs/helm/helm_dependency_list.md index ec5e861fd..71f0fd9d7 100644 --- a/docs/helm/helm_dependency_list.md +++ b/docs/helm/helm_dependency_list.md @@ -1,3 +1,20 @@ ++++ +title = "helm dependency list" +weight = "7" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-dependency-list" + +[menu.main] + url = "helm-dependency-list" + parent = "helm-commands" + ++++ + ## helm dependency list list the dependencies for the given chart diff --git a/docs/helm/helm_dependency_update.md b/docs/helm/helm_dependency_update.md index 8fb8fd2d1..07f4ad3d9 100644 --- a/docs/helm/helm_dependency_update.md +++ b/docs/helm/helm_dependency_update.md @@ -1,3 +1,20 @@ ++++ +title = "helm dependency update" +weight = "8" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-dependency-update" + +[menu.main] + url = "helm-dependency-update" + parent = "helm-commands" + ++++ + ## helm dependency update update charts/ based on the contents of requirements.yaml diff --git a/docs/helm/helm_fetch.md b/docs/helm/helm_fetch.md index a95781997..4c8ecf28a 100644 --- a/docs/helm/helm_fetch.md +++ b/docs/helm/helm_fetch.md @@ -1,3 +1,20 @@ ++++ +title = "helm fetch" +weight = "9" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-fetch" + +[menu.main] + url = "helm-fetch" + parent = "helm-commands" + ++++ + ## helm fetch download a chart from a repository and (optionally) unpack it in local directory diff --git a/docs/helm/helm_get.md b/docs/helm/helm_get.md index efa3c458a..2feff9847 100644 --- a/docs/helm/helm_get.md +++ b/docs/helm/helm_get.md @@ -1,3 +1,20 @@ ++++ +title = "helm get" +weight = "10" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-get" + +[menu.main] + url = "helm-get" + parent = "helm-commands" + ++++ + ## helm get download a named release diff --git a/docs/helm/helm_get_hooks.md b/docs/helm/helm_get_hooks.md index d2fad8b69..14c9c3d09 100644 --- a/docs/helm/helm_get_hooks.md +++ b/docs/helm/helm_get_hooks.md @@ -1,3 +1,20 @@ ++++ +title = "helm get hooks" +weight = "11" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-get-hooks" + +[menu.main] + url = "helm-get-hooks" + parent = "helm-commands" + ++++ + ## helm get hooks download all hooks for a named release diff --git a/docs/helm/helm_get_manifest.md b/docs/helm/helm_get_manifest.md index 053ef652d..12255634e 100644 --- a/docs/helm/helm_get_manifest.md +++ b/docs/helm/helm_get_manifest.md @@ -1,3 +1,20 @@ ++++ +title = "helm get manifest" +weight = "12" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-get-manifest" + +[menu.main] + url = "helm-get-manifest" + parent = "helm-commands" + ++++ + ## helm get manifest download the manifest for a named release diff --git a/docs/helm/helm_get_values.md b/docs/helm/helm_get_values.md index 5cdcbd7d2..02f3da9e1 100644 --- a/docs/helm/helm_get_values.md +++ b/docs/helm/helm_get_values.md @@ -1,3 +1,20 @@ ++++ +title = "helm get values" +weight = "13" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-get-values" + +[menu.main] + url = "helm-get-values" + parent = "helm-commands" + ++++ + ## helm get values download the values file for a named release diff --git a/docs/helm/helm_history.md b/docs/helm/helm_history.md index 590c8a684..761a3205d 100644 --- a/docs/helm/helm_history.md +++ b/docs/helm/helm_history.md @@ -1,3 +1,20 @@ ++++ +title = "helm history" +weight = "14" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-history" + +[menu.main] + url = "helm-history" + parent = "helm-commands" + ++++ + ## helm history fetch release history diff --git a/docs/helm/helm_home.md b/docs/helm/helm_home.md index 683142f71..a52aeb0f8 100644 --- a/docs/helm/helm_home.md +++ b/docs/helm/helm_home.md @@ -1,3 +1,20 @@ ++++ +title = "helm home" +weight = "15" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-home" + +[menu.main] + url = "helm-home" + parent = "helm-commands" + ++++ + ## helm home displays the location of HELM_HOME diff --git a/docs/helm/helm_init.md b/docs/helm/helm_init.md index 2d498c554..607606995 100644 --- a/docs/helm/helm_init.md +++ b/docs/helm/helm_init.md @@ -1,3 +1,20 @@ ++++ +title = "helm init" +weight = "16" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-init" + +[menu.main] + url = "helm-init" + parent = "helm-commands" + ++++ + ## helm init initialize Helm on both client and server diff --git a/docs/helm/helm_inspect.md b/docs/helm/helm_inspect.md index 30f09a72f..3036d32aa 100644 --- a/docs/helm/helm_inspect.md +++ b/docs/helm/helm_inspect.md @@ -1,3 +1,20 @@ ++++ +title = "helm inspect" +weight = "17" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-inspect" + +[menu.main] + url = "helm-inspect" + parent = "helm-commands" + ++++ + ## helm inspect inspect a chart diff --git a/docs/helm/helm_inspect_chart.md b/docs/helm/helm_inspect_chart.md index 5e49e282b..cb6577aad 100644 --- a/docs/helm/helm_inspect_chart.md +++ b/docs/helm/helm_inspect_chart.md @@ -1,3 +1,20 @@ ++++ +title = "helm inspect chart" +weight = "18" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-inspect-chart" + +[menu.main] + url = "helm-inspect-chart" + parent = "helm-commands" + ++++ + ## helm inspect chart shows inspect chart diff --git a/docs/helm/helm_inspect_values.md b/docs/helm/helm_inspect_values.md index f49215975..5c1c66b59 100644 --- a/docs/helm/helm_inspect_values.md +++ b/docs/helm/helm_inspect_values.md @@ -1,3 +1,20 @@ ++++ +title = "helm inspect values" +weight = "19" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-inspect-values" + +[menu.main] + url = "helm-inspect-values" + parent = "helm-commands" + ++++ + ## helm inspect values shows inspect values diff --git a/docs/helm/helm_install.md b/docs/helm/helm_install.md index f8e0885ff..e11fde60a 100644 --- a/docs/helm/helm_install.md +++ b/docs/helm/helm_install.md @@ -1,3 +1,20 @@ ++++ +title = "helm install" +weight = "20" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-install" + +[menu.main] + url = "helm-install" + parent = "helm-commands" + ++++ + ## helm install install a chart archive diff --git a/docs/helm/helm_lint.md b/docs/helm/helm_lint.md index 61e6737c4..ccf79045d 100644 --- a/docs/helm/helm_lint.md +++ b/docs/helm/helm_lint.md @@ -1,3 +1,20 @@ ++++ +title = "helm lint" +weight = "21" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-lint" + +[menu.main] + url = "helm-lint" + parent = "helm-commands" + ++++ + ## helm lint examines a chart for possible issues diff --git a/docs/helm/helm_list.md b/docs/helm/helm_list.md index a69f5ba2c..c5eb52beb 100644 --- a/docs/helm/helm_list.md +++ b/docs/helm/helm_list.md @@ -1,3 +1,20 @@ ++++ +title = "helm list" +weight = "22" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-list" + +[menu.main] + url = "helm-list" + parent = "helm-commands" + ++++ + ## helm list list releases diff --git a/docs/helm/helm_package.md b/docs/helm/helm_package.md index a88022193..529db6afe 100644 --- a/docs/helm/helm_package.md +++ b/docs/helm/helm_package.md @@ -1,3 +1,20 @@ ++++ +title = "helm package" +weight = "23" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-package" + +[menu.main] + url = "helm-package" + parent = "helm-commands" + ++++ + ## helm package package a chart directory into a chart archive diff --git a/docs/helm/helm_plugin.md b/docs/helm/helm_plugin.md index b38f3e013..3c67b85eb 100644 --- a/docs/helm/helm_plugin.md +++ b/docs/helm/helm_plugin.md @@ -1,3 +1,20 @@ ++++ +title = "helm plugin" +weight = "24" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-plugin" + +[menu.main] + url = "helm-plugin" + parent = "helm-commands" + ++++ + ## helm plugin add, list, or remove Helm plugins diff --git a/docs/helm/helm_plugin_install.md b/docs/helm/helm_plugin_install.md index 7b4f8904e..ac209b707 100644 --- a/docs/helm/helm_plugin_install.md +++ b/docs/helm/helm_plugin_install.md @@ -1,3 +1,20 @@ ++++ +title = "helm plugin install" +weight = "25" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-plugin-install" + +[menu.main] + url = "helm-plugin-install" + parent = "helm-commands" + ++++ + ## helm plugin install install one or more Helm plugins diff --git a/docs/helm/helm_plugin_list.md b/docs/helm/helm_plugin_list.md index 53f37b8d0..3e1b8b5d9 100644 --- a/docs/helm/helm_plugin_list.md +++ b/docs/helm/helm_plugin_list.md @@ -1,3 +1,20 @@ ++++ +title = "helm plugin list" +weight = "26" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-plugin-list" + +[menu.main] + url = "helm-plugin-list" + parent = "helm-commands" + ++++ + ## helm plugin list list installed Helm plugins diff --git a/docs/helm/helm_plugin_remove.md b/docs/helm/helm_plugin_remove.md index 0559f395c..8bd496181 100644 --- a/docs/helm/helm_plugin_remove.md +++ b/docs/helm/helm_plugin_remove.md @@ -1,3 +1,20 @@ ++++ +title = "helm plugin remove" +weight = "27" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-plugin-remove" + +[menu.main] + url = "helm-plugin-remove" + parent = "helm-commands" + ++++ + ## helm plugin remove remove one or more Helm plugins diff --git a/docs/helm/helm_plugin_update.md b/docs/helm/helm_plugin_update.md index c0dac090a..7cf27ba1f 100644 --- a/docs/helm/helm_plugin_update.md +++ b/docs/helm/helm_plugin_update.md @@ -1,3 +1,20 @@ ++++ +title = "helm plugin update" +weight = "28" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-plugin-update" + +[menu.main] + url = "helm-plugin-update" + parent = "helm-commands" + ++++ + ## helm plugin update update one or more Helm plugins diff --git a/docs/helm/helm_repo.md b/docs/helm/helm_repo.md index 3378a1850..d55aa8c51 100644 --- a/docs/helm/helm_repo.md +++ b/docs/helm/helm_repo.md @@ -1,3 +1,20 @@ ++++ +title = "helm repo" +weight = "29" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-repo" + +[menu.main] + url = "helm-repo" + parent = "helm-commands" + ++++ + ## helm repo add, list, remove, update, and index chart repositories diff --git a/docs/helm/helm_repo_add.md b/docs/helm/helm_repo_add.md index f7f3e8727..d8f0dc100 100644 --- a/docs/helm/helm_repo_add.md +++ b/docs/helm/helm_repo_add.md @@ -1,3 +1,20 @@ ++++ +title = "helm repo add" +weight = "30" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-repo-add" + +[menu.main] + url = "helm-repo-add" + parent = "helm-commands" + ++++ + ## helm repo add add a chart repository diff --git a/docs/helm/helm_repo_index.md b/docs/helm/helm_repo_index.md index 79c8ee608..26f389d38 100644 --- a/docs/helm/helm_repo_index.md +++ b/docs/helm/helm_repo_index.md @@ -1,3 +1,20 @@ ++++ +title = "helm repo index" +weight = "31" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-repo-index" + +[menu.main] + url = "helm-repo-index" + parent = "helm-commands" + ++++ + ## helm repo index generate an index file given a directory containing packaged charts diff --git a/docs/helm/helm_repo_list.md b/docs/helm/helm_repo_list.md index 4f8f2e1dd..1a80ad849 100644 --- a/docs/helm/helm_repo_list.md +++ b/docs/helm/helm_repo_list.md @@ -1,3 +1,20 @@ ++++ +title = "helm repo list" +weight = "32" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-repo-list" + +[menu.main] + url = "helm-repo-list" + parent = "helm-commands" + ++++ + ## helm repo list list chart repositories diff --git a/docs/helm/helm_repo_remove.md b/docs/helm/helm_repo_remove.md index 075b15fce..57ebd9b40 100644 --- a/docs/helm/helm_repo_remove.md +++ b/docs/helm/helm_repo_remove.md @@ -1,3 +1,20 @@ ++++ +title = "helm repo remove" +weight = "33" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-repo-remove" + +[menu.main] + url = "helm-repo-remove" + parent = "helm-commands" + ++++ + ## helm repo remove remove a chart repository diff --git a/docs/helm/helm_repo_update.md b/docs/helm/helm_repo_update.md index 3758f822f..dbc60c162 100644 --- a/docs/helm/helm_repo_update.md +++ b/docs/helm/helm_repo_update.md @@ -1,3 +1,20 @@ ++++ +title = "helm repo update" +weight = "34" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-repo-update" + +[menu.main] + url = "helm-repo-update" + parent = "helm-commands" + ++++ + ## helm repo update update information of available charts locally from chart repositories diff --git a/docs/helm/helm_reset.md b/docs/helm/helm_reset.md index bc3299d48..8d8591647 100644 --- a/docs/helm/helm_reset.md +++ b/docs/helm/helm_reset.md @@ -1,3 +1,20 @@ ++++ +title = "helm reset" +weight = "35" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-reset" + +[menu.main] + url = "helm-reset" + parent = "helm-commands" + ++++ + ## helm reset uninstalls Tiller from a cluster diff --git a/docs/helm/helm_rollback.md b/docs/helm/helm_rollback.md index 3a3ed1a24..b483d54aa 100644 --- a/docs/helm/helm_rollback.md +++ b/docs/helm/helm_rollback.md @@ -1,3 +1,20 @@ ++++ +title = "helm rollback" +weight = "36" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-rollback" + +[menu.main] + url = "helm-rollback" + parent = "helm-commands" + ++++ + ## helm rollback roll back a release to a previous revision diff --git a/docs/helm/helm_search.md b/docs/helm/helm_search.md index 48579c5b8..1458161e6 100644 --- a/docs/helm/helm_search.md +++ b/docs/helm/helm_search.md @@ -1,3 +1,20 @@ ++++ +title = "helm search" +weight = "37" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-search" + +[menu.main] + url = "helm-search" + parent = "helm-commands" + ++++ + ## helm search search for a keyword in charts diff --git a/docs/helm/helm_serve.md b/docs/helm/helm_serve.md index 1a317e9e4..a91e39657 100644 --- a/docs/helm/helm_serve.md +++ b/docs/helm/helm_serve.md @@ -1,3 +1,20 @@ ++++ +title = "helm serve" +weight = "38" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-serve" + +[menu.main] + url = "helm-serve" + parent = "helm-commands" + ++++ + ## helm serve start a local http web server diff --git a/docs/helm/helm_status.md b/docs/helm/helm_status.md index a737d7a64..4b6d54e67 100644 --- a/docs/helm/helm_status.md +++ b/docs/helm/helm_status.md @@ -1,3 +1,20 @@ ++++ +title = "helm status" +weight = "39" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-status" + +[menu.main] + url = "helm-status" + parent = "helm-commands" + ++++ + ## helm status displays the status of the named release diff --git a/docs/helm/helm_test.md b/docs/helm/helm_test.md index 8d7b39a59..f8ce5a7a4 100644 --- a/docs/helm/helm_test.md +++ b/docs/helm/helm_test.md @@ -1,3 +1,20 @@ ++++ +title = "helm test" +weight = "40" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-test" + +[menu.main] + url = "helm-test" + parent = "helm-commands" + ++++ + ## helm test test a release diff --git a/docs/helm/helm_upgrade.md b/docs/helm/helm_upgrade.md index 1fbefcba3..434e53bf6 100644 --- a/docs/helm/helm_upgrade.md +++ b/docs/helm/helm_upgrade.md @@ -1,3 +1,20 @@ ++++ +title = "helm upgrade" +weight = "41" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-upgrade" + +[menu.main] + url = "helm-upgrade" + parent = "helm-commands" + ++++ + ## helm upgrade upgrade a release diff --git a/docs/helm/helm_verify.md b/docs/helm/helm_verify.md index 10ddab059..4dfd1f8e1 100644 --- a/docs/helm/helm_verify.md +++ b/docs/helm/helm_verify.md @@ -1,3 +1,20 @@ ++++ +title = "helm verify" +weight = "42" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-verify" + +[menu.main] + url = "helm-verify" + parent = "helm-commands" + ++++ + ## helm verify verify that a chart at the given path has been signed and is valid diff --git a/docs/helm/helm_version.md b/docs/helm/helm_version.md index 16e2f5b92..f806b5f21 100644 --- a/docs/helm/helm_version.md +++ b/docs/helm/helm_version.md @@ -1,3 +1,20 @@ ++++ +title = "helm version" +weight = "43" + +tags = ["commands"] +section = "helm-commands" +categories = ["helm-commands"] +type = "page" + +slug = "helm-version" + +[menu.main] + url = "helm-version" + parent = "helm-commands" + ++++ + ## helm version print the client/server version information diff --git a/docs/history.md b/docs/history.md index 71e63c6b2..d59ef3fd2 100644 --- a/docs/history.md +++ b/docs/history.md @@ -1,9 +1,19 @@ -## The History of the Project ++++ +title = "History" +weight = "1" -Kubernetes Helm is the merged result of [Helm -Classic](https://github.com/helm/helm) and the Kubernetes port of GCS Deployment -Manager. The project was jointly started by Google and Deis, though it -is now part of the CNCF. Many companies now contribute regularly to Helm. +tags = ["team", "history", "about", "deis", "cncf"] +section = "history" +categories = ["history"] +type = "page" + +slug = "history" + ++++ + +# The History of the Helm Project + +Kubernetes Helm is the merged result of [Helm Classic](https://github.com/helm/helm) and the Kubernetes port of GCS Deployment Manager. The project was jointly started by Google and Deis, though it is now part of the CNCF. Many companies now contribute regularly to Helm. Differences from Helm Classic: diff --git a/docs/install.md b/docs/install.md index b935fa4f8..5a44784dd 100755 --- a/docs/install.md +++ b/docs/install.md @@ -1,3 +1,20 @@ ++++ +title = "Installing Helm" +weight = "2" + +tags = ["setup", "install", "release"] +section = "using-helm" +categories = ["using-helm"] +type = "page" + +slug = "install-helm" + +[menu.main] + url = "install-helm" + parent = "using-helm" + ++++ + # Installing Helm There are two parts to Helm: The Helm client (`helm`) and the Helm diff --git a/docs/install_faq.md b/docs/install_faq.md index 4a344c2ee..2711fdcea 100644 --- a/docs/install_faq.md +++ b/docs/install_faq.md @@ -1,3 +1,20 @@ ++++ +title = "Install FAQ" +weight = "4" + +tags = ["setup", "install", "release", "faq"] +section = "using-helm" +categories = ["using-helm"] +type = "page" + +slug = "install-helm-faq" + +[menu.main] + url = "install-helm-faq" + parent = "using-helm" + ++++ + # Installation: Frequently Asked Questions This section tracks some of the more frequently encountered issues with installing diff --git a/docs/kubernetes_distros.md b/docs/kubernetes_distros.md index bea1e8075..21745f8b5 100644 --- a/docs/kubernetes_distros.md +++ b/docs/kubernetes_distros.md @@ -1,3 +1,20 @@ ++++ +title = "Kubernetes Distribution Notes" +weight = "3" + +tags = ["setup", "install", "release", "distros", "minikube", "Ubuntu", "coreos"] +section = "using-helm" +categories = ["using-helm"] +type = "page" + +slug = "kubernetes-distribution-notes" + +[menu.main] + url = "kubernetes-distribution-notes" + parent = "using-helm" + ++++ + # Kubernetes Distribution Guide This document captures information about using Helm in specific Kubernetes diff --git a/docs/plugins.md b/docs/plugins.md index 72e78c25e..4f07c2bcf 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -1,3 +1,20 @@ ++++ +title = "Plugins" +weight = "6" + +tags = ["setup", "plugins"] +section = "using-helm" +categories = ["using-helm"] +type = "page" + +slug = "plugins" + +[menu.main] + url = "plugins" + parent = "using-helm" + ++++ + # The Helm Plugins Guide Helm 2.1.0 introduced the concept of a client-side Helm _plugin_. A plugin is a diff --git a/docs/provenance.md b/docs/provenance.md index 6a6faac36..4b8f27179 100644 --- a/docs/provenance.md +++ b/docs/provenance.md @@ -1,3 +1,20 @@ ++++ +title = "Signing Charts" +weight = "6" + +tags = ["charts", "signing", "provenance", "integrity", "PGP", "key", "keypair"] +section = "developing-charts" +categories = ["developing-charts"] +type = "page" + +slug = "signing-charts" + +[menu.main] + url = "signing-charts" + parent = "developing-charts" + ++++ + # Helm Provenance and Integrity Helm has provenance tools which help chart users verify the integrity and origin diff --git a/docs/quickstart.md b/docs/quickstart.md index dcf266867..aa0f95bf8 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -1,3 +1,20 @@ ++++ +title = "Quickstart" +weight = "1" + +tags = ["quick", "start", "setup", "install"] +section = "using-helm" +categories = ["using-helm"] +type = "page" + +slug = "quick-start" + +[menu.main] + url = "quick-start" + parent = "using-helm" + ++++ + # Quickstart Guide This guide covers how you can quickly get started using Helm. diff --git a/docs/related.md b/docs/related.md index 6e5b267bf..d53e783bc 100644 --- a/docs/related.md +++ b/docs/related.md @@ -1,3 +1,16 @@ ++++ +title = "Related Projects & Docs" +weight = "1" + +tags = ["related", "developers", "articles", "guides"] +section = "related" +categories = ["related"] +type = "page" + +slug = "related" + ++++ + # Related Projects and Documentation The Helm community has produced many extra tools, plugins, and documentation about diff --git a/docs/using_helm.md b/docs/using_helm.md index e27cd56d0..4860b59e7 100755 --- a/docs/using_helm.md +++ b/docs/using_helm.md @@ -1,3 +1,20 @@ ++++ +title = "Using Helm" +weight = "5" + +tags = ["setup", "usage", "commands"] +section = "using-helm" +categories = ["using-helm"] +type = "page" + +slug = "helm-usage" + +[menu.main] + url = "helm-usage" + parent = "using-helm" + ++++ + # Using Helm This guide explains the basics of using Helm (and Tiller) to manage From e53858eb2044e4b5388dd44617d2401b3413c377 Mon Sep 17 00:00:00 2001 From: flynnduism Date: Thu, 25 May 2017 17:30:02 -0700 Subject: [PATCH 2/3] 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 From f911002f7c1c45e4429c47a953d0ec993204e090 Mon Sep 17 00:00:00 2001 From: flynnduism Date: Tue, 6 Jun 2017 15:15:12 -0700 Subject: [PATCH 3/3] Restore the 'examples' directory I'd included the /examples section as a subset of docs, and renamed the section to chart-examples. However this breaks the CI tests, and in hindsight they are best treated as development references rather than a set of webpages, so I'll remove them from the site sidebar and restore the directory name to fix the tests. --- docs/{chart-examples => examples}/README.md | 0 docs/{chart-examples => examples}/alpine/Chart.yaml | 0 docs/{chart-examples => examples}/alpine/README.md | 0 .../{chart-examples => examples}/alpine/templates/alpine-pod.yaml | 0 docs/{chart-examples => examples}/alpine/values.yaml | 0 docs/{chart-examples => examples}/nginx/.helmignore | 0 docs/{chart-examples => examples}/nginx/Chart.yaml | 0 docs/{chart-examples => examples}/nginx/README.md | 0 docs/{chart-examples => examples}/nginx/templates/_helpers.tpl | 0 docs/{chart-examples => examples}/nginx/templates/configmap.yaml | 0 docs/{chart-examples => examples}/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 docs/{chart-examples => examples}/nginx/templates/svc.yaml | 0 docs/{chart-examples => examples}/nginx/values.yaml | 0 16 files changed, 0 insertions(+), 0 deletions(-) rename docs/{chart-examples => examples}/README.md (100%) rename docs/{chart-examples => examples}/alpine/Chart.yaml (100%) rename docs/{chart-examples => examples}/alpine/README.md (100%) rename docs/{chart-examples => examples}/alpine/templates/alpine-pod.yaml (100%) rename docs/{chart-examples => examples}/alpine/values.yaml (100%) rename docs/{chart-examples => examples}/nginx/.helmignore (100%) rename docs/{chart-examples => examples}/nginx/Chart.yaml (100%) rename docs/{chart-examples => examples}/nginx/README.md (100%) rename docs/{chart-examples => examples}/nginx/templates/_helpers.tpl (100%) rename docs/{chart-examples => examples}/nginx/templates/configmap.yaml (100%) rename docs/{chart-examples => examples}/nginx/templates/deployment.yaml (100%) rename docs/{chart-examples => examples}/nginx/templates/post-install-job.yaml (100%) rename docs/{chart-examples => examples}/nginx/templates/pre-install-secret.yaml (100%) rename docs/{chart-examples => examples}/nginx/templates/service-test.yaml (100%) rename docs/{chart-examples => examples}/nginx/templates/svc.yaml (100%) rename docs/{chart-examples => examples}/nginx/values.yaml (100%) diff --git a/docs/chart-examples/README.md b/docs/examples/README.md similarity index 100% rename from docs/chart-examples/README.md rename to docs/examples/README.md diff --git a/docs/chart-examples/alpine/Chart.yaml b/docs/examples/alpine/Chart.yaml similarity index 100% rename from docs/chart-examples/alpine/Chart.yaml rename to docs/examples/alpine/Chart.yaml diff --git a/docs/chart-examples/alpine/README.md b/docs/examples/alpine/README.md similarity index 100% rename from docs/chart-examples/alpine/README.md rename to docs/examples/alpine/README.md diff --git a/docs/chart-examples/alpine/templates/alpine-pod.yaml b/docs/examples/alpine/templates/alpine-pod.yaml similarity index 100% rename from docs/chart-examples/alpine/templates/alpine-pod.yaml rename to docs/examples/alpine/templates/alpine-pod.yaml diff --git a/docs/chart-examples/alpine/values.yaml b/docs/examples/alpine/values.yaml similarity index 100% rename from docs/chart-examples/alpine/values.yaml rename to docs/examples/alpine/values.yaml diff --git a/docs/chart-examples/nginx/.helmignore b/docs/examples/nginx/.helmignore similarity index 100% rename from docs/chart-examples/nginx/.helmignore rename to docs/examples/nginx/.helmignore diff --git a/docs/chart-examples/nginx/Chart.yaml b/docs/examples/nginx/Chart.yaml similarity index 100% rename from docs/chart-examples/nginx/Chart.yaml rename to docs/examples/nginx/Chart.yaml diff --git a/docs/chart-examples/nginx/README.md b/docs/examples/nginx/README.md similarity index 100% rename from docs/chart-examples/nginx/README.md rename to docs/examples/nginx/README.md diff --git a/docs/chart-examples/nginx/templates/_helpers.tpl b/docs/examples/nginx/templates/_helpers.tpl similarity index 100% rename from docs/chart-examples/nginx/templates/_helpers.tpl rename to docs/examples/nginx/templates/_helpers.tpl diff --git a/docs/chart-examples/nginx/templates/configmap.yaml b/docs/examples/nginx/templates/configmap.yaml similarity index 100% rename from docs/chart-examples/nginx/templates/configmap.yaml rename to docs/examples/nginx/templates/configmap.yaml diff --git a/docs/chart-examples/nginx/templates/deployment.yaml b/docs/examples/nginx/templates/deployment.yaml similarity index 100% rename from docs/chart-examples/nginx/templates/deployment.yaml rename to docs/examples/nginx/templates/deployment.yaml diff --git a/docs/chart-examples/nginx/templates/post-install-job.yaml b/docs/examples/nginx/templates/post-install-job.yaml similarity index 100% rename from docs/chart-examples/nginx/templates/post-install-job.yaml rename to docs/examples/nginx/templates/post-install-job.yaml diff --git a/docs/chart-examples/nginx/templates/pre-install-secret.yaml b/docs/examples/nginx/templates/pre-install-secret.yaml similarity index 100% rename from docs/chart-examples/nginx/templates/pre-install-secret.yaml rename to docs/examples/nginx/templates/pre-install-secret.yaml diff --git a/docs/chart-examples/nginx/templates/service-test.yaml b/docs/examples/nginx/templates/service-test.yaml similarity index 100% rename from docs/chart-examples/nginx/templates/service-test.yaml rename to docs/examples/nginx/templates/service-test.yaml diff --git a/docs/chart-examples/nginx/templates/svc.yaml b/docs/examples/nginx/templates/svc.yaml similarity index 100% rename from docs/chart-examples/nginx/templates/svc.yaml rename to docs/examples/nginx/templates/svc.yaml diff --git a/docs/chart-examples/nginx/values.yaml b/docs/examples/nginx/values.yaml similarity index 100% rename from docs/chart-examples/nginx/values.yaml rename to docs/examples/nginx/values.yaml