docs(kgo): prepare v1.4.x (#8083)

* docs(kgo): prepare v1.4.x * chore(kgo): revert the changelog for 1.4.0 so that it doesn't show before the release --------- Co-authored-by: Jakub Warczarek <[email protected]> Co-authored-by: Patryk Małek <[email protected]>
Kong · Oct 29, 2024 · 26f62b1 · 26f62b1
1 parent a642cb4
commit 26f62b1
Show file tree

Hide file tree

Showing 7 changed files with 3,524 additions and 22 deletions.
diff --git a/.github/styles/kong/dictionary.txt b/.github/styles/kong/dictionary.txt
@@ -242,6 +242,8 @@ favicon
 filepath
 filetype
 filetypes
+finalizer
+finalizers
 firewalled
 flamegraph
 full_name
@@ -470,6 +472,7 @@ remediation
 remediations
 repo
 requery
+Requeue
 Resty
 retryOn
 reusability
@@ -482,8 +485,8 @@ routable
 ruleset
 runloop
 runtime
-runtime_groups
 runtimes
+runtime_groups
 SAML
 sandboxed
 sandboxing
@@ -504,8 +507,8 @@ sni
 snis
 Splunk
 ssl
-ssl_cert_key
 ssl_certificate
+ssl_cert_key
 sso
 Stap
 stapxx

diff --git a/app/_data/docs_nav_kgo_1.3.x.yml b/app/_data/docs_nav_kgo_1.3.x.yml
@@ -120,6 +120,9 @@ items:
           - text: DataPlane
             url: /reference/custom-resources/#dataplane
             generate: false
+      - text: Configuration Options
+        url: /reference/cli-arguments/
+        src: reference/cli-arguments/1.3.x
       - text: License
         url: /reference/license
       - text: Version Compatibility

diff --git a/app/_data/docs_nav_kgo_1.4.x.yml b/app/_data/docs_nav_kgo_1.4.x.yml
@@ -0,0 +1,132 @@
+product: gateway-operator
+release: 1.4.x
+generate: true
+assume_generated: true
+items:
+  - title: Introduction
+    icon: /assets/images/icons/documentation/icn-flag.svg
+    items:
+      - text: Overview
+        url: /gateway-operator/1.4.x/
+        absolute_url: true
+      - text: Deployment Topologies
+        items:
+          - text: Hybrid Mode
+            url: /topologies/hybrid/
+          - text: DB-less Mode
+            url: /topologies/dbless/
+      - text: Key Concepts
+        items:
+          - text: Gateway API
+            url: /concepts/gateway-api
+          - text: Gateway Configuration
+            url: /concepts/gateway-configuration
+          - text: Managed Gateways
+            url: /concepts/managed-gateways
+      - text: Changelog
+        url: /gateway-operator/changelog
+        absolute_url: true
+      - text: Version Support Policy
+        url: /support
+      - text: FAQ
+        url: /faq
+  - title: Get Started
+    icon: /assets/images/icons/documentation/icn-learning.svg
+    items:
+      - text: Konnect
+        items:
+          - text: Install Gateway Operator
+            url: /get-started/konnect/install/
+          - text: Deploy a Data Plane
+            url: /get-started/konnect/deploy-data-plane/
+          - text: Create a Route
+            url: /get-started/konnect/create-route/
+      - text: Kong Ingress Controller
+        items:
+          - text: Install Gateway Operator
+            url: /get-started/kic/install/
+          - text: Create a Gateway
+            url: /get-started/kic/create-gateway/
+          - text: Create a Route
+            url: /get-started/kic/create-route/
+  - title: Production Deployment
+    icon: /assets/images/icons/icn-server.svg
+    items:
+      - text: Overview
+        url: /production/
+      - text: Install
+        url: /install/
+      - text: Enterprise License
+        url: /license/
+      - text: Monitoring
+        items:
+          - text: Metrics
+            url: /production/monitoring/metrics/
+          - text: Status fields
+            items:
+              - text: Overview
+                url: /production/monitoring/status/overview/
+              - text: DataPlane
+                url: /production/monitoring/status/dataplane/
+              - text: ControlPlane
+                url: /production/monitoring/status/controlplane/
+              - text: Gateway
+                url: /production/monitoring/status/gateway/
+      - text: Upgrade Gateway Operator
+        url: /production/upgrade/gateway-operator/
+  - title: Guides
+    icon: /assets/images/icons/documentation/icn-solution-guide.svg
+    items:
+      - text: AI Gateway
+        url: /guides/ai-gateway/
+      - text: Customization
+        items:
+          - text: Set data plane image
+            url: /customization/data-plane-image/
+          - text: Deploying Sidecars
+            url: /customization/sidecars/
+          - text: Customizing PodTemplateSpec
+            url: /customization/pod-template-spec/
+      - text: Autoscaling Kong Gateway
+        url: /guides/autoscaling-kong/
+      - text: Autoscaling Workloads
+        items:
+          - text: Overview
+            url: /guides/autoscaling-workloads/overview/
+          - text: Prometheus
+            url: /guides/autoscaling-workloads/prometheus/
+          - text: Datadog
+            url: /guides/autoscaling-workloads/datadog/
+      - text: Upgrading Data Planes
+        items:
+          - text: Rolling Deployment
+            url: /guides/upgrade/data-plane/rolling/
+          - text: Blue / Green Deployment
+            url: /guides/upgrade/data-plane/blue-green/
+  - title: Reference
+    icon: /assets/images/icons/icn-magnifying-glass.svg
+    items:
+      - text: Custom Resources
+        items:
+          - text: Overview
+            url: /reference/custom-resources/
+            src: reference/custom-resources/1.4.x
+          - text: GatewayConfiguration
+            url: /reference/custom-resources/#gatewayconfiguration
+            generate: false
+          - text: ControlPlane
+            url: /reference/custom-resources/#controlplane
+            generate: false
+          - text: DataPlane
+            url: /reference/custom-resources/#dataplane
+            generate: false
+          - text: KongPluginInstallation
+            url: /reference/custom-resources/#kongplugininstallation
+            generate: false
+      - text: Configuration Options
+        url: /reference/cli-arguments/
+        src: reference/cli-arguments/1.4.x
+      - text: License
+        url: /reference/license
+      - text: Version Compatibility
+        url: /reference/version-compatibility
diff --git a/app/_data/kong_versions.yml b/app/_data/kong_versions.yml
@@ -307,6 +307,12 @@
   releaseDate: "2024-06-24"
   endOfLifeDate: "2025-06-24"
   latest: true
+- edition: gateway-operator
+  version: 1.4.0
+  release: 1.4.x
+  releaseDate: "2024-10-28"
+  endOfLifeDate: "2025-10-28"
+  label: unreleased
 - edition: mesh
   version: 1.2.6
   release: 1.2.x

diff --git a/app/_src/gateway-operator/reference/cli-arguments/1.4.x.md b/app/_src/gateway-operator/reference/cli-arguments/1.4.x.md
@@ -0,0 +1,61 @@
+---
+title: CLI Arguments
+---
+
+Learn about the various settings and configurations of the controller can be tweaked
+using CLI flags.
+
+## Environment variables
+
+Each flag defined in the table below can also be configured using
+an environment variable. The name of the environment variable is `GATEWAY_OPERATOR_`
+string followed by the name of flag in uppercase.
+
+For example, `--enable-gateway-controller` can be configured using the following
+environment variable:
+
+```
+GATEWAY_OPERATOR_ENABLE_GATEWAY_CONTROLLER=false
+```
+
+It is recommended that all the configuration is done through environment variables
+and not CLI flags.
+
+<!-- vale off -->
+
+<!-- This document is generated by KGO's 'generate.cli-arguments-docs' make target, DO NOT EDIT -->
+
+## Flags
+
+| Flag | Type | Description | Default |
+| ---- | ---- | ----------- | ------- |
+| `--anonymous-reports` | `bool` | Send anonymized usage data to help improve Kong. | `true` |
+| `--apiserver-host` | `string` | The Kubernetes API server URL. If not set, the operator will use cluster config discovery. | `""` |
+| `--cluster-ca-secret` | `string` | Name of the Secret containing the cluster CA certificate. | `kong-operator-ca` |
+| `--cluster-ca-secret-namespace` | `string` | Name of the namespace for Secret containing the cluster CA certificate. | `""` |
+| `--controller-name` | `string` | Controller name to use if other than the default, only needed for multi-tenancy. | `""` |
+| `--enable-controller-aigateway` | `bool` | Enable the AIGateway controller. (Experimental). | `false` |
+| `--enable-controller-controlplane` | `bool` | Enable the ControlPlane controller. | `true` |
+| `--enable-controller-controlplaneextensions` | `bool` | Enable the ControlPlane extensions controller. _Only supported by the Enterprise version of the Gateway Operator._ | `true` |
+| `--enable-controller-dataplane` | `bool` | Enable the DataPlane controller. | `true` |
+| `--enable-controller-dataplane-bluegreen` | `bool` | Enable the DataPlane BlueGreen controller. Mutually exclusive with DataPlane controller. | `true` |
+| `--enable-controller-gateway` | `bool` | Enable the Gateway controller. | `true` |
+| `--enable-controller-konglicense` | `bool` | Enable the Kong License controller. _Only supported by the Enterprise version of the Gateway Operator._ | `true` |
+| `--enable-controller-kongplugininstallation` | `bool` | Enable the KongPluginInstallation controller. | `false` |
+| `--enable-controller-konnect` | `bool` | Enable the Konnect controllers. | `false` |
+| `--enable-validating-webhook` | `bool` | Enable the validating webhook. | `true` |
+| `--health-probe-bind-address` | `string` | The address the probe endpoint binds to. | `:8081` |
+| `--konnect-sync-period` | `string` | Sync period for Konnect entities. After a successful reconciliation of Konnect entities the controller will wait this duration before enforcing configuration on Konnect once again. | `1m0s` |
+| `--kubeconfig` | `string` | Path to the kubeconfig file. | `""` |
+| `--metrics-bind-address` | `string` | The address the metric endpoint binds to. | `:8080` |
+| `--no-leader-election` | `bool` | Disable leader election for controller manager. Disabling this will not ensure there is only one active controller manager. | `false` |
+| `--version` | `bool` | Print version information. | `false` |
+| `--webhook-certificate-config-base-image` | `string` | The base image for the certgen Jobs. | `registry.k8s.io/ingress-nginx/kube-webhook-certgen:v1.3.0` |
+| `--webhook-certificate-config-shell-image` | `string` | The shell image for the certgen Jobs. | `busybox` |
+| `--zap-devel` | `bool` | Development Mode defaults(encoder=consoleEncoder,logLevel=Debug,stackTraceLevel=Warn). Production Mode defaults(encoder=jsonEncoder,logLevel=Info,stackTraceLevel=Error). | `false` |
+| `--zap-encoder` | `string` | Zap log encoding (one of 'json' or 'console'). | `""` |
+| `--zap-log-level` | `string` | Zap Level to configure the verbosity of logging. Can be one of 'debug', 'info', 'error', or any integer value > 0 which corresponds to custom debug levels of increasing verbosity. | `""` |
+| `--zap-stacktrace-level` | `string` | Zap Level at and above which stacktraces are captured (one of 'info', 'error', 'panic'). | `""` |
+| `--zap-time-encoding` | `string` | Zap time encoding (one of 'epoch', 'millis', 'nano', 'iso8601', 'rfc3339' or 'rfc3339nano'). Defaults to 'epoch'. | `""` |
+
+<!-- vale on -->