GoogleContainerTools / GoogleContainerTools/skaffold

improve docs related to using multiple profiles

Open
#8,788 0 comments 3 reactions 0 assignees View on GitHub
area/docs area/profiles priority/p2
Dominant language
Go
Stars
15.9k
Forks
1.7k
Avg merge
3d 9h
Merged PRs (30d)
10

Description

(from https://github.com/GoogleContainerTools/skaffold/issues/2535#issuecomment-1539160768)

This flags some issues that users found when following steps in the [docs](https://skaffold.dev/docs/environment/profiles/#activating-multiple-profiles-at-the-same-time),

Activating multiple profiles does work, but I think the docs [need improvement](https://github.com/GoogleContainerTools/skaffold/issues/2535#8069).

The docs should make it clearer that [patches](https://skaffold.dev/docs/environment/profiles/#override-via-patches) are needed to append to lists, such as lists of helm releases or kustomize paths. This applies to profiles that overlay on the root level, as well as when multiple profiles are activated.

In addition, there is still an issue patching-over an empty value (https://github.com/GoogleContainerTools/skaffold/issues/2741, https://github.com/GoogleContainerTools/skaffold/issues/3446, https://github.com/GoogleContainerTools/skaffold/issues/8637). I suggest calling this out in the docs.

To help troubleshoot,

skaffold diagnose will show the resulting Config.

The new skaffold render will output the resulting manifests.

Also see:

Skaffold Profile doesn't allow to patch /deploy/helm/releases/0/setValues/global/namespace #6908
https://github.com/GoogleContainerTools/skaffold/issues/8379#issuecomment-1409542926

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.