From 38c9d4e248ab03d4c682844357dc9f40944aff07 Mon Sep 17 00:00:00 2001 From: Marco Kilchhofer Date: Fri, 19 May 2023 12:25:23 +0200 Subject: [PATCH] docs: Apply changes from code review Signed-off-by: Marco Kilchhofer --- charts/argo-workflows/README.md | 6 +++--- charts/argo-workflows/README.md.gotmpl | 2 ++ charts/argo-workflows/values.yaml | 8 +++++--- 3 files changed, 10 insertions(+), 6 deletions(-) diff --git a/charts/argo-workflows/README.md b/charts/argo-workflows/README.md index 3e38c89e..b5612a16 100644 --- a/charts/argo-workflows/README.md +++ b/charts/argo-workflows/README.md @@ -102,6 +102,7 @@ Fields to note: | Key | Type | Default | Description | |-----|------|---------|-------------| | apiVersionOverrides.autoscaling | string | `""` | String to override apiVersion of autoscaling rendered by this helm chart | +| apiVersionOverrides.cloudgoogle | string | `""` | String to override apiVersion of GKE resources rendered by this helm chart | | crds.annotations | object | `{}` | Annotations to be added to all CRDs | | crds.install | bool | `true` | Install and upgrade CRDs | | crds.keep | bool | `true` | Keep CRDs on chart uninstall | @@ -240,13 +241,10 @@ Fields to note: | Key | Type | Default | Description | |-----|------|---------|-------------| -| server.GKEbackendConfig | object | `{"enabled":false,"spec":{}}` | Create a Google Backendconfig for use with the GKE Ingress Controller | | server.GKEbackendConfig.enabled | bool | `false` | Enable BackendConfig custom resource for Google Kubernetes Engine | | server.GKEbackendConfig.spec | object | `{}` | [BackendConfigSpec] | -| server.GKEfrontendConfig | object | `{"enabled":false,"spec":{}}` | Create a Google FrontendConfig Custom Resource, for use with the GKE Ingress Controller | | server.GKEfrontendConfig.enabled | bool | `false` | Enable FrontConfig custom resource for Google Kubernetes Engine | | server.GKEfrontendConfig.spec | object | `{}` | [FrontendConfigSpec] | -| server.GKEmanagedCertificate | object | `{"domains":["argoworkflows.example.com"],"enabled":false}` | Create a Google Managed Certificate for use with the GKE Ingress Controller | | server.GKEmanagedCertificate.domains | list | `["argoworkflows.example.com"]` | Domains for the Google Managed Certificate | | server.GKEmanagedCertificate.enabled | bool | `false` | Enable ManagedCertificate custom resource for Google Kubernetes Engine. | | server.affinity | object | `{}` | Assign custom [affinity] rules | @@ -342,6 +340,8 @@ Fields to note: 1. moved the field previously known as `telemetryServicePort` inside the `telemetryConfig` as `telemetryConfig.servicePort` - same for `metricsConfig` [affinity]: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ +[BackendConfigSpec]: https://cloud.google.com/kubernetes-engine/docs/concepts/backendconfig#backendconfigspec_v1beta1_cloudgooglecom +[FrontendConfigSpec]: https://cloud.google.com/kubernetes-engine/docs/how-to/ingress-features#configuring_ingress_features_through_frontendconfig_parameters [links]: https://argoproj.github.io/argo-workflows/links/ [Node selector]: https://kubernetes.io/docs/user-guide/node-selection/ [Pod Disruption Budget]: https://kubernetes.io/docs/tasks/run-application/configure-pdb/ diff --git a/charts/argo-workflows/README.md.gotmpl b/charts/argo-workflows/README.md.gotmpl index 398a8788..ab8554f5 100644 --- a/charts/argo-workflows/README.md.gotmpl +++ b/charts/argo-workflows/README.md.gotmpl @@ -188,6 +188,8 @@ Fields to note: 1. moved the field previously known as `telemetryServicePort` inside the `telemetryConfig` as `telemetryConfig.servicePort` - same for `metricsConfig` [affinity]: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ +[BackendConfigSpec]: https://cloud.google.com/kubernetes-engine/docs/concepts/backendconfig#backendconfigspec_v1beta1_cloudgooglecom +[FrontendConfigSpec]: https://cloud.google.com/kubernetes-engine/docs/how-to/ingress-features#configuring_ingress_features_through_frontendconfig_parameters [links]: https://argoproj.github.io/argo-workflows/links/ [Node selector]: https://kubernetes.io/docs/user-guide/node-selection/ [Pod Disruption Budget]: https://kubernetes.io/docs/tasks/run-application/configure-pdb/ diff --git a/charts/argo-workflows/values.yaml b/charts/argo-workflows/values.yaml index bf5f11eb..b65fd4f8 100644 --- a/charts/argo-workflows/values.yaml +++ b/charts/argo-workflows/values.yaml @@ -33,6 +33,8 @@ kubeVersionOverride: "" apiVersionOverrides: # -- String to override apiVersion of autoscaling rendered by this helm chart autoscaling: "" # autoscaling/v2 + # -- String to override apiVersion of GKE resources rendered by this helm chart + cloudgoogle: "" # cloud.google.com/v1 # -- Restrict Argo to operate only in a single namespace (the namespace of the # Helm release) by apply Roles and RoleBindings instead of the Cluster @@ -576,7 +578,7 @@ server: # hosts: # - argoworkflows.example.com - # -- Create a Google Backendconfig for use with the GKE Ingress Controller + ## Create a Google Backendconfig for use with the GKE Ingress Controller ## https://cloud.google.com/kubernetes-engine/docs/how-to/ingress-configuration#configuring_ingress_features_through_backendconfig_parameters GKEbackendConfig: # -- Enable BackendConfig custom resource for Google Kubernetes Engine @@ -589,7 +591,7 @@ server: # oauthclientCredentials: # secretName: argoworkflows-secret - # -- Create a Google Managed Certificate for use with the GKE Ingress Controller + ## Create a Google Managed Certificate for use with the GKE Ingress Controller ## https://cloud.google.com/kubernetes-engine/docs/how-to/managed-certs GKEmanagedCertificate: # -- Enable ManagedCertificate custom resource for Google Kubernetes Engine. @@ -598,7 +600,7 @@ server: domains: - argoworkflows.example.com - # -- Create a Google FrontendConfig Custom Resource, for use with the GKE Ingress Controller + ## Create a Google FrontendConfig Custom Resource, for use with the GKE Ingress Controller ## https://cloud.google.com/kubernetes-engine/docs/how-to/ingress-features#configuring_ingress_features_through_frontendconfig_parameters GKEfrontendConfig: # -- Enable FrontConfig custom resource for Google Kubernetes Engine