Skip to content

Commit

Permalink
docs: Update doc values
Browse files Browse the repository at this point in the history
  • Loading branch information
colinjfw committed Sep 7, 2019
1 parent 13efedc commit 002b667
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions charts/app/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
app
===
A Helm chart for Kubernetes
application
===========
Kubernetes application service

Current chart version is `0.0.2`

Expand All @@ -13,26 +13,29 @@ Current chart version is `0.0.2`
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| affinity | object | `{}` | Kubernetes affinity resource. |
| appName | string | `""` | |
| env | string | `nil` | Environment variables for the application. |
| fullnameOverride | string | `""` | |
| app.name | string | `"nginx"` | Application name: Can be consistent between tracks. (required) |
| app.version | string | `"v1"` | Application version: Unique tag for this release. (required) |
| env | list | `[]` | Environment variables for the application. |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"nginx"` | |
| image.tag | string | `"latest"` | |
| imagePullSecrets | list | `[]` | |
| image.repository | string | `"nginx"` | Docker image repository. |
| image.tag | string | `"latest"` | Docker image tag. |
| imagePullSecrets | list | `[]` | Defines secrets to use for pulling docker images. |
| ingress.annotations | object | `{}` | Configures annotations for the ingress. |
| ingress.enabled | bool | `false` | Enable ingress resource. |
| ingress.hosts[0].host | string | `"chart-example.local"` | Host name for routing traffic. |
| ingress.hosts[0].paths | list | `["/"]` | Array of routable paths. |
| ingress.tls | list | `[]` | Kubernetes ingress tls resource. |
| livenessProbe | object | `{"httpGet":{"path":"/","port":"http"}}` | Customize the livenessProbe. |
| migrate.command | string | `"rails db:migrate"` | Command to run on the migrate pod. |
| migrate.enabled | bool | `false` | Run a pod before the application is released to migrate. |
| nodeSelector | object | `{}` | Kubernetes node selectors for Deployment resources. |
| readinessProbe | object | `{"httpGet":{"path":"/","port":"http"}}` | Customize the readiness probe. |
| replicaCount | int | `1` | Replica count for deployments. |
| resources | object | `{}` | Kubernetes resources for Deployment resources. |
| secrets | list | `[]` | Creates a secret for the application. All variables passed in env. |
| secret | string | `nil` | If defined will pull all secrets from this resource using envFrom. |
| service.enabled | bool | `true` | Enable service resource. |
| service.internalPort | int | `80` | Deployment internal port. |
| service.port | int | `80` | Kubernetes service port. |
| service.type | string | `"ClusterIP"` | Kubernetes service type. |
| tolerations | list | `[]` | Kubernetes tolerations for Deployment resources. |
| workers | list | `[]` | Deploy background jobs with the same config as the main app. |

0 comments on commit 002b667

Please sign in to comment.