From 2c104044828e80caf3c72a373b08e031907e5b85 Mon Sep 17 00:00:00 2001 From: Kalaiselvim <117940852+Kalaiselvi84@users.noreply.github.com> Date: Thu, 2 May 2024 03:09:38 +0000 Subject: [PATCH] Helm Param Update: Default to agones.controller if agones.extensions is Missing (#3773) Helm Parameter Migration to agones.extensions --- install/helm/agones/templates/extensions.yaml | 20 ++--- .../docs/Installation/Install Agones/helm.md | 81 ++++++++++++++++++- 2 files changed, 91 insertions(+), 10 deletions(-) diff --git a/install/helm/agones/templates/extensions.yaml b/install/helm/agones/templates/extensions.yaml index 275564cdbd..597dd180fe 100644 --- a/install/helm/agones/templates/extensions.yaml +++ b/install/helm/agones/templates/extensions.yaml @@ -28,9 +28,10 @@ metadata: chart: {{ template "agones.chart" . }} release: {{ .Release.Name }} heritage: {{ .Release.Service }} -{{- if .Values.agones.controller.allocationApiService.annotations }} +{{- $annotations := default .Values.agones.controller.allocationApiService.annotations .Values.agones.extensions.allocationApiService.annotations }} +{{- if $annotations }} annotations: -{{- toYaml .Values.agones.controller.allocationApiService.annotations | nindent 4 }} +{{- toYaml $annotations | nindent 4 }} {{- end }} spec: group: allocation.agones.dev @@ -39,7 +40,7 @@ spec: service: name: agones-controller-service namespace: {{ .Release.Namespace }} -{{- if not .Values.agones.controller.allocationApiService.disableCaBundle }} +{{- if not (default .Values.agones.controller.allocationApiService.disableCaBundle .Values.agones.extensions.allocationApiService.disableCaBundle) }} {{- if .Values.agones.controller.generateTLS }} caBundle: {{ b64enc $ca.Cert }} {{- else }} @@ -54,7 +55,7 @@ apiVersion: admissionregistration.k8s.io/v1 kind: ValidatingWebhookConfiguration metadata: name: agones-validation-webhook -{{- if .Values.agones.controller.validatingWebhook.annotations }} +{{- if (default .Values.agones.controller.validatingWebhook.annotations .Values.agones.extensions.validatingWebhook.annotations) }} annotations: {{- toYaml .Values.agones.controller.validatingWebhook.annotations | nindent 4 }} {{- end }} @@ -75,7 +76,7 @@ webhooks: name: agones-controller-service namespace: {{ .Release.Namespace }} path: /validate -{{- if not .Values.agones.controller.validatingWebhook.disableCaBundle }} +{{- if not (default .Values.agones.controller.validatingWebhook.disableCaBundle .Values.agones.extensions.validatingWebhook.disableCaBundle) }} {{- if .Values.agones.controller.generateTLS }} caBundle: {{ b64enc $ca.Cert }} {{- else }} @@ -117,9 +118,10 @@ apiVersion: admissionregistration.k8s.io/v1 kind: MutatingWebhookConfiguration metadata: name: agones-mutation-webhook -{{- if .Values.agones.controller.mutatingWebhook.annotations }} +{{- $annotations := default .Values.agones.controller.mutatingWebhook.annotations .Values.agones.extensions.mutatingWebhook.annotations }} +{{- if $annotations }} annotations: -{{- toYaml .Values.agones.controller.mutatingWebhook.annotations | nindent 4 }} +{{- toYaml $annotations | nindent 4 }} {{- end }} labels: component: controller @@ -138,7 +140,7 @@ webhooks: name: agones-controller-service namespace: {{ .Release.Namespace }} path: /mutate -{{- if not .Values.agones.controller.mutatingWebhook.disableCaBundle }} +{{- if not (default .Values.agones.controller.mutatingWebhook.disableCaBundle .Values.agones.extensions.mutatingWebhook.disableCaBundle) }} {{- if .Values.agones.controller.generateTLS }} caBundle: {{ b64enc $ca.Cert }} {{- else }} @@ -165,7 +167,7 @@ webhooks: - CREATE - UPDATE {{- end }} -{{- if not .Values.agones.controller.disableSecret }} +{{- if not (default .Values.agones.controller.disableSecret .Values.agones.extensions.disableSecret) }} --- apiVersion: v1 kind: Secret diff --git a/site/content/en/docs/Installation/Install Agones/helm.md b/site/content/en/docs/Installation/Install Agones/helm.md index 21b7444302..b17295d60c 100644 --- a/site/content/en/docs/Installation/Install Agones/helm.md +++ b/site/content/en/docs/Installation/Install Agones/helm.md @@ -148,7 +148,7 @@ The following tables lists the configurable parameters of the Agones chart and t | `agones.image.extensions.pullPolicy` | Image pull policy for extensions | `IfNotPresent` | - +{{% feature expiryVersion="1.41.0" %}} ### Agones Controller | Parameter | Description | Default | @@ -185,6 +185,45 @@ The following tables lists the configurable parameters of the Agones chart and t | `agones.controller.mutatingWebhook.disableCaBundle` | Disable ca-bundle so it can be injected by cert-manager | `false` | | `agones.controller.allocationBatchWaitTime` | Wait time between each allocation batch when performing allocations in controller mode | `500ms` | | `agones.controller.topologySpreadConstraints` | Ensures better resource utilization and high availability by evenly distributing Pods in the agones-system namespace | `{}` | +{{% /feature %}} +{{% feature publishVersion="1.41.0" %}} +### Agones Controller + +| Parameter | Description | Default | +|----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| `agones.controller.replicas` | The number of replicas to run in the `agones-controller` deployment. | `2` | +| `agones.controller.pdb.minAvailable` | Description of the number of pods from that set that must still be available after the eviction, even in the absence of the evicted pod. Can be either an absolute number or a percentage. Mutually Exclusive with `maxUnavailable` | `1` | +| `agones.controller.pdb.maxUnavailable` | Description of the number of pods from that set that can be unavailable after the eviction. It can be either an absolute number or a percentage Mutually Exclusive with `minAvailable` | \`\` | +| `agones.controller.http.port` | Port to use for liveness probe service and metrics | `8080` | +| `agones.controller.healthCheck.initialDelaySeconds` | Initial delay before performing the first probe (in seconds) | `3` | +| `agones.controller.healthCheck.periodSeconds` | Seconds between every liveness probe (in seconds) | `3` | +| `agones.controller.healthCheck.failureThreshold` | Number of times before giving up (in seconds) | `3` | +| `agones.controller.healthCheck.timeoutSeconds` | Number of seconds after which the probe times out (in seconds) | `1` | +| `agones.controller.resources` | Controller [resource requests/limit][resources] | `{}` | +| `agones.controller.generateTLS` | Set to true to generate TLS certificates or false to provide your own certificates | `true` | +| `agones.controller.tlsCert` | Custom TLS certificate provided as a string | \`\` | +| `agones.controller.tlsKey` | Custom TLS private key provided as a string | \`\` | +| `agones.controller.nodeSelector` | Controller [node labels][nodeSelector] for pod assignment | `{}` | +| `agones.controller.tolerations` | Controller [toleration][toleration] labels for pod assignment | `[]` | +| `agones.controller.affinity` | Controller [affinity][affinity] settings for pod assignment | `{}` | +| `agones.controller.annotations` | [Annotations][annotations] added to the Agones controller pods | `{}` | +| `agones.controller.numWorkers` | Number of workers to spin per resource type | `100` | +| `agones.controller.apiServerQPS` | Maximum sustained queries per second that controller should be making against API Server | `400` | +| `agones.controller.apiServerQPSBurst` | Maximum burst queries per second that controller should be making against API Server | `500` | +| `agones.controller.logLevel` | Agones Controller Log level. Log only entries with that severity and above | `info` | +| `agones.controller.persistentLogs` | Store Agones controller logs in a temporary volume attached to a container for debugging | `true` | +| `agones.controller.persistentLogsSizeLimitMB` | Maximum total size of all Agones container logs in MB | `10000` | +| `agones.controller.disableSecret` | **Deprecated**. Use `agones.extensions.disableSecret` instead. Disables the creation of any allocator secrets. If true, you MUST provide the `{agones.releaseName}-cert` secrets before installation. | `false` | +| `agones.controller.customCertSecretPath` | Remap cert-manager path to server.crt and server.key | `{}` | +| `agones.controller.allocationApiService.annotations` | **Deprecated**. Use `agones.extensions.allocationApiService.annotations` instead. [Annotations][annotations] added to the Agones apiregistration | `{}` | +| `agones.controller.allocationApiService.disableCaBundle` | **Deprecated**. Use `agones.extensions.allocationApiService.disableCaBundle` instead. Disable ca-bundle so it can be injected by cert-manager. | `false` | +| `agones.controller.validatingWebhook.annotations` | **Deprecated**. Use `agones.extensions.validatingWebhook.annotations` instead. [Annotations][annotations] added to the Agones validating webhook | `{}` | +| `agones.controller.validatingWebhook.disableCaBundle` | **Deprecated**. Use `agones.extensions.validatingWebhook.disableCaBundle` instead. Disable ca-bundle so it can be injected by cert-manager | `false` | +| `agones.controller.mutatingWebhook.annotations` | **Deprecated**. Use `agones.extensions.mutatingWebhook.annotations` instead. [Annotations][annotations] added to the Agones mutating webhook | `{}` | +| `agones.controller.mutatingWebhook.disableCaBundle` | **Deprecated**. Use `agones.extensions.mutatingWebhook.disableCaBundle` instead. Disable ca-bundle so it can be injected by cert-manager | `false` | +| `agones.controller.allocationBatchWaitTime` | Wait time between each allocation batch when performing allocations in controller mode | `500ms` | +| `agones.controller.topologySpreadConstraints` | Ensures better resource utilization and high availability by evenly distributing Pods in the agones-system namespace | `{}` | +{{% /feature %}} ### Ping Service @@ -282,6 +321,7 @@ The following tables lists the configurable parameters of the Agones chart and t | `agones.allocator.topologySpreadConstraints` | Ensures better resource utilization and high availability by evenly distributing Pods in the agones-system namespace | `{}` | +{{% feature expiryVersion="1.41.0" %}} ### Extensions | Parameter | Description | Default | @@ -318,6 +358,45 @@ The following tables lists the configurable parameters of the Agones chart and t | `agones.extensions.pdb.maxUnavailable` | Description of the number of pods from that set that can be unavailable after the eviction. It can be either an absolute number or a percentage Mutually Exclusive with `minAvailable` | \`\` | | `agones.extensions.replicas` | The number of replicas to run in the deployment | `2` | | `agones.extensions.topologySpreadConstraints` | Ensures better resource utilization and high availability by evenly distributing Pods in the agones-system namespace | `{}` | +{{% /feature %}} +{{% feature publishVersion="1.41.0" %}} +### Extensions + +| Parameter | Description | Default | +|----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| `agones.extensions.http.port` | Port to use for liveness probe service and metrics | `8080` | +| `agones.extensions.healthCheck.initialDelaySeconds` | Initial delay before performing the first probe (in seconds) | `3` | +| `agones.extensions.healthCheck.periodSeconds` | Seconds between every liveness probe (in seconds) | `3` | +| `agones.extensions.healthCheck.failureThreshold` | Number of times before giving up (in seconds) | `3` | +| `agones.extensions.healthCheck.timeoutSeconds` | Number of seconds after which the probe times out (in seconds) | `1` | +| `agones.extensions.resources` | Extensions [resource requests/limit][resources] | `{}` | +| `agones.extensions.generateTLS` | Set to true to generate TLS certificates or false to provide your own certificates | `true` | +| `agones.extensions.tlsCert` | Custom TLS certificate provided as a string | \`\` | +| `agones.extensions.tlsKey` | Custom TLS private key provided as a string | \`\` | +| `agones.extensions.nodeSelector` | Extensions [node labels][nodeSelector] for pod assignment | `{}` | +| `agones.extensions.tolerations` | Extensions [toleration][toleration] labels for pod assignment | `[]` | +| `agones.extensions.affinity` | Extensions [affinity][affinity] settings for pod assignment | `{}` | +| `agones.extensions.annotations` | [Annotations][annotations] added to the Agones extensions pods | `{}` | +| `agones.extensions.numWorkers` | Number of workers to spin per resource type | `100` | +| `agones.extensions.apiServerQPS` | Maximum sustained queries per second that extensions should be making against API Server | `400` | +| `agones.extensions.apiServerQPSBurst` | Maximum burst queries per second that extensions should be making against API Server | `500` | +| `agones.extensions.logLevel` | Agones Extensions Log level. Log only entries with that severity and above | `info` | +| `agones.extensions.persistentLogs` | Store Agones extensions logs in a temporary volume attached to a container for debugging | `true` | +| `agones.extensions.persistentLogsSizeLimitMB` | Maximum total size of all Agones container logs in MB | `10000` | +| `agones.extensions.disableSecret` | Disables the creation of any allocator secrets. You MUST provide the `{agones.releaseName}-cert` secrets before installation if this is set to `true`. | `false` | +| `agones.extensions.customCertSecretPath` | Remap cert-manager path to server.crt and server.key | `{}` | +| `agones.extensions.allocationApiService.annotations` | [Annotations][annotations] added to the Agones API registration. | `{}` | +| `agones.extensions.allocationApiService.disableCaBundle` | Disable ca-bundle so it can be injected by cert-manager. | `false` | +| `agones.extensions.validatingWebhook.annotations` | [Annotations][annotations] added to the Agones validating webhook. | `{}` | +| `agones.extensions.validatingWebhook.disableCaBundle` | Disable ca-bundle so it can be injected by cert-manager. | `false` | +| `agones.extensions.mutatingWebhook.annotations` | [Annotations][annotations] added to the Agones mutating webhook. | `{}` | +| `agones.extensions.mutatingWebhook.disableCaBundle` | Disable ca-bundle so it can be injected by cert-manager. | `false` | +| `agones.extensions.allocationBatchWaitTime` | Wait time between each allocation batch when performing allocations in controller mode | `500ms` | +| `agones.extensions.pdb.minAvailable` | Description of the number of pods from that set that must still be available after the eviction, even in the absence of the evicted pod. Can be either an absolute number or a percentage. Mutually Exclusive with maxUnavailable | `1` | +| `agones.extensions.pdb.maxUnavailable` | Description of the number of pods from that set that can be unavailable after the eviction. It can be either an absolute number or a percentage. Mutually Exclusive with `minAvailable` | \`\` | +| `agones.extensions.replicas` | The number of replicas to run in the deployment | `2` | +| `agones.extensions.topologySpreadConstraints` | Ensures better resource utilization and high availability by evenly distributing Pods in the agones-system namespace | `{}` | +{{% /feature %}} ### GameServers