diff --git a/chart/stable/podinfo/README.md b/chart/stable/podinfo/README.md new file mode 100644 index 0000000..3759836 --- /dev/null +++ b/chart/stable/podinfo/README.md @@ -0,0 +1,75 @@ +# Podinfo + +Podinfo is a tiny web application made with Go +that showcases best practices of running microservices in Kubernetes. + +## Installing the Chart + +To install the chart with the release name `my-release`: + +```console +$ helm install stable/podinfo --name my-release +``` + +The command deploys podinfo on the Kubernetes cluster in the default namespace. +The [configuration](#configuration) section lists the parameters that can be configured during installation. + +## Uninstalling the Chart + +To uninstall/delete the `my-release` deployment: + +```console +$ helm delete --purge my-release +``` + +The command removes all the Kubernetes components associated with the chart and deletes the release. + +## Configuration + +The following tables lists the configurable parameters of the podinfo chart and their default values. + +Parameter | Description | Default +--- | --- | --- +`affinity` | node/pod affinities | None +`hpa.enabled` | Enables HPA | `false` +`hpa.cpu` | Target CPU usage per pod | None +`hpa.memory` | Target memory usage per pod | None +`hpa.maxReplicas` | Maximum pod replicas | `10` +`ingress.hosts` | Ingress accepted hostnames | None +`ingress.tls` | Ingress TLS configuration | None: +`image.pullPolicy` | Image pull policy | `IfNotPresent` +`image.repository` | Image repository | `stefanprodan/podinfo` +`image.tag` | Image tag | `0.0.1` +`ingress.enabled` | Enables Ingress | `false` +`ingress.annotations` | Ingress annotations | None +`ingress.hosts` | Ingress accepted hostnames | None +`ingress.tls` | Ingress TLS configuration | None +`nodeSelector` | node labels for pod assignment | `{}` +`podAnnotations` | annotations to add to each pod | `{}` +`replicaCount` | desired number of pods | `1` +`resources.requests/cpu` | pod CPU request | `1m` +`resources.requests/memory` | pod memory request | `16Mi` +`resources.limits/cpu` | pod CPU limit | None +`resources.limits/memory` | pod memory limit | None +`service.externalPort` | external port for the service | `9898` +`service.internalPort` | internal port for the service | `9898` +`service.nodePort` | node port for the service | `31198` +`service.type` | type of service | `ClusterIP` +`tolerations` | List of node taints to tolerate | `[]` + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, + +```console +$ helm install stable/podinfo --name my-release \ + --set=image.tag=0.0.2,service.type=NodePort +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, + +```console +$ helm install stable/podinfo --name my-release -f values.yaml +``` + +> **Tip**: You can use the default [values.yaml](values.yaml) +``` +