github.com/lrills/helm@v2.8.1+incompatible/docs/examples/nginx/README.md (about)

     1  # nginx: An advanced example chart
     2  
     3  This Helm chart provides examples of some of Helm's more powerful
     4  features.
     5  
     6  **This is not a production-grade chart. It is an example.**
     7  
     8  The chart installs a simple nginx server according to the following
     9  pattern:
    10  
    11  - A `ConfigMap` is used to store the files the server will serve.
    12    ([templates/configmap.yaml](templates/configmap.yaml))
    13  - A `Deployment` is used to create a Replica Set of nginx pods.
    14    ([templates/deployment.yaml](templates/deployment.yaml))
    15  - A `Service` is used to create a gateway to the pods running in the
    16    replica set ([templates/service.yaml](templates/service.yaml))
    17  
    18  The [values.yaml](values.yaml) exposes a few of the configuration options in the
    19  charts, though there are some that are not exposed there (like
    20  `.image`).
    21  
    22  The [templates/_helpers.tpl](templates/_helpers.tpl) file contains helper templates. The leading
    23  underscore (`_`) on the filename is semantic. It tells the template renderer
    24  that this file does not contain a manifest. That file declares some
    25  templates that are used elsewhere in the chart.
    26  
    27  Helpers (usually called "partials" in template languages) are an
    28  advanced way for developers to structure their templates for optimal
    29  reuse.
    30  
    31  You can deploy this chart with `helm install docs/examples/nginx`. Or
    32  you can see how this chart would render with `helm install --dry-run
    33  --debug docs/examples/nginx`.