History

Adam Reese 0c6b6d1c62 fix(*): correct file permissions on source files		8 years ago
..
templates	fix(helm): add trimSuffix to helper functions	8 years ago
.helmignore	docs(examples): add nginx example chart	9 years ago
Chart.yaml	fix(*): correct file permissions on source files	8 years ago
README.md	fix(example/nginx): add links, clarify a few things	9 years ago
values.yaml	feat(tiller): support hooks for install	9 years ago

README.md

nginx: An advanced example chart

This Helm chart provides examples of some of Helm's more powerful features.

This is not a production-grade chart. It is an example.

The chart installs a simple nginx server according to the following pattern:

A ConfigMap is used to store the files the server will serve. (templates/configmap.yaml)
A Deployment is used to create a Replica Set of nginx pods. (templates/deployment.yaml)
A Service is used to create a gateway to the pods running in the replica set (templates/svc.yaml)

The values.yaml exposes a few of the configuration options in the charts, though there are some that are not exposed there (like .image).

The templates/_helpers.tpl file contains helper templates. The leading underscore (_) on the filename is semantic. It tells the template renderer that this file does not contain a manifest. That file declares some templates that are used elsewhere in the chart.

Helpers (usually called "partials" in template languages) are an advanced way for developers to structure their templates for optimal reuse.

You can deploy this chart with helm install docs/examples/nginx. Or you can see how this chart would render with helm install --dry-run --debug docs/examples/nginx.