Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deployment Overrides docs change #580

Merged
merged 6 commits into from
Aug 30, 2024
Merged

Deployment Overrides docs change #580

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
85f8ef5
Deployment Overrides docs change
ashleywang1 Aug 30, 2024
bdd5cdb
changelog
ashleywang1 Aug 30, 2024
78f5943
fix codegen and test
ashleywang1 Aug 30, 2024
c6224b1
same wording for serviceOverrides
ashleywang1 Aug 30, 2024
3a7b2f0
wording fix
ashleywang1 Aug 30, 2024
ca730e8
codegen
ashleywang1 Aug 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions changelog/v0.40.6/deployment-overrides-docs-change.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
changelog:
- type: NON_USER_FACING
description: >
"Change the helm docs description for deploymentOverrides."
skipCI: "false"
2 changes: 1 addition & 1 deletion codegen/cmd_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -599,7 +599,7 @@ var _ = Describe("Cmd", func() {

painterNode := node.Content[0].Content[1]
enabledMapField := painterNode.Content[0]
Expect(enabledMapField.HeadComment).To(Equal("# Arbitrary overrides for the component's [deployment\n# template](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/deployment-v1/)."))
Expect(enabledMapField.HeadComment).To(ContainSubstring("Arbitrary overrides for the component's [deployment spec template](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/deployment-v1/), such as to set resource limits and requests. Format the overrides as YAML or JSON."))
})

It("generates from templates using a name override", func() {
Expand Down
2 changes: 1 addition & 1 deletion codegen/model/values/helm_chart_values.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ type UserValues struct {
PodSecurityContext *v1.PodSecurityContext `json:"podSecurityContext,omitempty" desc:"Pod-level security context. For more info, see the [Kubernetes documentation](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podsecuritycontext-v1-core)." omitChildren:"true"`

// Overrides which can be set by the user
DeploymentOverrides *appsv1.Deployment `json:"deploymentOverrides" desc:"Arbitrary overrides for the component's [deployment template](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/deployment-v1/)." omitChildren:"true"`
DeploymentOverrides *appsv1.Deployment `json:"deploymentOverrides" desc:"Arbitrary overrides for the component's [deployment spec template](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/deployment-v1/), such as to set resource limits and requests. Format the overrides as YAML or JSON." omitChildren:"true"`
ServiceOverrides *v1.Service `json:"serviceOverrides" desc:"Arbitrary overrides for the component's [service template](https://kubernetes.io/docs/reference/kubernetes-api/service-resources/service-v1/)." omitChildren:"true"`
}

Expand Down
2 changes: 1 addition & 1 deletion codegen/test/name_override_chart/name_override_chart_reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ weight: 2
|------|----|-----------|-------------|
|overrideName|struct|| |
|overrideName|struct|Configuration for the overrideName deployment.| |
|overrideName.deploymentOverrides|struct|Arbitrary overrides for the component's [deployment template](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/deployment-v1/).| |
|overrideName.deploymentOverrides|struct|Arbitrary overrides for the component's [deployment spec template](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/deployment-v1/), such as to set resource limits and requests. Format the overrides as YAML or JSON.| |
|overrideName.env[]|slice|Environment variables for the container. For more info, see the [Kubernetes documentation](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvarsource-v1-core).|null|
|overrideName.extraEnvs|struct|Extra environment variables for the container| |
|overrideName.floatingUserId|bool|Allow the pod to be assigned a dynamic user ID. Required for OpenShift installations.|false|
Expand Down
6 changes: 4 additions & 2 deletions codegen/test/name_override_chart/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Code generated by skv2. DO NOT EDIT.

overrideName:
# Arbitrary overrides for the component's [deployment
# template](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/deployment-v1/).
# Arbitrary overrides for the component's [deployment spec
# template](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/deployment-v1/),
# such as to set resource limits and requests. Format the overrides as YAML or
# JSON.
deploymentOverrides: null
# Environment variables for the container. For more info, see the [Kubernetes
# documentation](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#envvarsource-v1-core).
Expand Down
Loading