Skip to content

Commit 1e16f3f

Browse files
committed
Update docs for this implementation
1 parent e097834 commit 1e16f3f

File tree

1 file changed

+45
-0
lines changed
  • docs-v2/content/en/docs/deployers

1 file changed

+45
-0
lines changed

docs-v2/content/en/docs/deployers/helm.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -298,3 +298,48 @@ The `helm` type offers the following options:
298298
Each `release` includes the following fields:
299299

300300
{{< schema root="HelmRelease" >}}
301+
302+
## Using values files from remote Helm charts (NEW)
303+
304+
Skaffold now supports using values files that are co-located inside remote Helm charts (e.g., charts from OCI registries or remote repositories).
305+
306+
### How to use
307+
308+
In your `skaffold.yaml`, specify a values file from inside the remote chart using the special `:chart:` prefix:
309+
310+
```yaml
311+
deploy:
312+
helm:
313+
releases:
314+
- name: my-remote-release
315+
remoteChart: oci://harbor.example.com/myrepo/mychart
316+
version: 1.2.3
317+
valuesFiles:
318+
- ":chart:values-prod.yaml" # This will extract values-prod.yaml from the remote chart
319+
```
320+
321+
- The `:chart:` prefix tells Skaffold to pull the remote chart, extract the specified file, and use it as a values file override.
322+
- You can use this for any file that exists in the root of the chart archive (e.g., `values-prod.yaml`, `values-staging.yaml`, etc).
323+
- You can mix local and remote values files in the list.
324+
325+
### Example
326+
327+
Suppose your remote chart contains both `values.yaml` and `values-prod.yaml`. To use the production values:
328+
329+
```yaml
330+
deploy:
331+
helm:
332+
releases:
333+
- name: my-remote-release
334+
remoteChart: oci://harbor.example.com/myrepo/mychart
335+
version: 1.2.3
336+
valuesFiles:
337+
- ":chart:values-prod.yaml"
338+
```
339+
340+
### Limitations
341+
- The `:chart:` syntax only works for remote charts (using `remoteChart`).
342+
- The file must exist in the root of the chart archive.
343+
- Skaffold will pull the chart and extract the file to a temporary location for each deploy.
344+
345+
---

0 commit comments

Comments
 (0)