31 lines
1.3 KiB
Markdown
31 lines
1.3 KiB
Markdown
# Helm Template Deployment
|
|
|
|
<!-- action-docs-description source="action.yml" -->
|
|
## Description
|
|
|
|
Template a Helm chart for a deployment in a Kubernetes cluster
|
|
<!-- action-docs-description source="action.yml" -->
|
|
|
|
<!-- action-docs-inputs source="action.yml" -->
|
|
## Inputs
|
|
|
|
| name | description | required | default |
|
|
| --- | --- | --- | --- |
|
|
| `DEPLOYMENT_NAME` | <p>The Helm release name</p> | `true` | `""` |
|
|
| `DEPLOYMENT_NAMESPACE` | <p>The Kubernetes namespace (defaults to DEPLOYMENT_NAME)</p> | `false` | `""` |
|
|
| `REGISTRY` | <p>OCI registry hostname for helm dependency login</p> | `true` | `""` |
|
|
| `REGISTRY_USERNAME` | <p>Username for OCI registry login</p> | `true` | `""` |
|
|
| `REGISTRY_TOKEN` | <p>Token for OCI registry login</p> | `true` | `""` |
|
|
| `CHART_PATH` | <p>Path to the Helm chart</p> | `false` | `./helm` |
|
|
| `VALUES_FILE` | <p>The values file to use</p> | `false` | `./helm/values.yaml` |
|
|
| `IMAGE_PATH` | <p>The registry path to the image (optional)</p> | `false` | `""` |
|
|
| `IMAGE_TAG` | <p>The image tag to deploy (optional)</p> | `false` | `""` |
|
|
| `TAG_KEY` | <p>Helm --set key for the image tag (e.g. deploy.api.tag)</p> | `false` | `""` |
|
|
<!-- action-docs-inputs source="action.yml" -->
|
|
|
|
<!-- action-docs-runs source="action.yml" -->
|
|
## Runs
|
|
|
|
This action is a `composite` action.
|
|
<!-- action-docs-runs source="action.yml" -->
|