From 3efb5e4c7a650b63653aeccd4d4abe5ffb82b560 Mon Sep 17 00:00:00 2001 From: Sunjay Bhatia Date: Mon, 11 Dec 2023 11:38:50 -0500 Subject: [PATCH] site: Remove leaderelection from config file params Should have been removed in #4332 Signed-off-by: Sunjay Bhatia --- site/content/docs/1.21/configuration.md | 16 ---------------- site/content/docs/1.22/configuration.md | 16 ---------------- site/content/docs/1.23/configuration.md | 16 ---------------- site/content/docs/1.24/configuration.md | 16 ---------------- site/content/docs/1.25/configuration.md | 16 ---------------- site/content/docs/1.26/configuration.md | 16 ---------------- site/content/docs/1.27/configuration.md | 16 ---------------- site/content/docs/main/configuration.md | 16 ---------------- 8 files changed, 128 deletions(-) diff --git a/site/content/docs/1.21/configuration.md b/site/content/docs/1.21/configuration.md index 9c2f7351dc2..84e2e65338b 100644 --- a/site/content/docs/1.21/configuration.md +++ b/site/content/docs/1.21/configuration.md @@ -85,7 +85,6 @@ merge_slashes path transformation behavior that strips duplicate slashes from re | incluster | boolean | `false` | This field specifies that Contour is running in a Kubernetes cluster and should use the in-cluster client access configuration. | | json-fields | string array | [fields][5] | This is the list the field names to include in the JSON [access log format][2]. This field only has effect if `accesslog-format` is `json`. | | kubeconfig | string | `$HOME/.kube/config` | Path to a Kubernetes [kubeconfig file][3] for when Contour is executed outside a cluster. | -| leaderelection | leaderelection | | The [leader election configuration](#leader-election-configuration). | | policy | PolicyConfig | | The default [policy configuration](#policy-configuration). | | tls | TLS | | The default [TLS configuration](#tls-configuration). | | timeouts | TimeoutConfig | | The [timeout configuration](#timeout-configuration). | @@ -125,21 +124,6 @@ Contour should provision TLS hosts. | name | string | `""` | This field specifies the name of the Kubernetes secret to use as the client certificate and private key when establishing TLS connections to the backend service. | | namespace | string | `""` | This field specifies the namespace of the Kubernetes secret to use as the client certificate and private key when establishing TLS connections to the backend service. | -### Leader Election Configuration - -The leader election configuration block configures how a deployment with more than one Contour pod elects a leader. -The Contour leader is responsible for updating the status field on Ingress and HTTPProxy documents. -In the vast majority of deployments, only the `configmap-name` and `configmap-namespace` fields should require any configuration. - -_Note:_ Configuring leader election via the configuration file is deprecated, please use the `contour serve` command line flags instead. - -| Field Name | Type | Default | Description | -| ------------------- | ------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| configmap-name | string | `leader-elect` | The name of the ConfigMap that Contour leader election will lease. | -| configmap-namespace | string | `projectcontour` | The namespace of the ConfigMap that Contour leader election will lease. If the `CONTOUR_NAMESPACE` environment variable is present, Contour will populate this field with its value. | -| lease-duration | [duration][4] | `15s` | The duration of the leadership lease. | -| renew-deadline | [duration][4] | `10s` | The length of time that the leader will retry refreshing leadership before giving up. | -| retry-period | [duration][4] | `2s` | The interval at which Contour will attempt to the acquire leadership lease. | ### Timeout Configuration diff --git a/site/content/docs/1.22/configuration.md b/site/content/docs/1.22/configuration.md index 9c2f7351dc2..84e2e65338b 100644 --- a/site/content/docs/1.22/configuration.md +++ b/site/content/docs/1.22/configuration.md @@ -85,7 +85,6 @@ merge_slashes path transformation behavior that strips duplicate slashes from re | incluster | boolean | `false` | This field specifies that Contour is running in a Kubernetes cluster and should use the in-cluster client access configuration. | | json-fields | string array | [fields][5] | This is the list the field names to include in the JSON [access log format][2]. This field only has effect if `accesslog-format` is `json`. | | kubeconfig | string | `$HOME/.kube/config` | Path to a Kubernetes [kubeconfig file][3] for when Contour is executed outside a cluster. | -| leaderelection | leaderelection | | The [leader election configuration](#leader-election-configuration). | | policy | PolicyConfig | | The default [policy configuration](#policy-configuration). | | tls | TLS | | The default [TLS configuration](#tls-configuration). | | timeouts | TimeoutConfig | | The [timeout configuration](#timeout-configuration). | @@ -125,21 +124,6 @@ Contour should provision TLS hosts. | name | string | `""` | This field specifies the name of the Kubernetes secret to use as the client certificate and private key when establishing TLS connections to the backend service. | | namespace | string | `""` | This field specifies the namespace of the Kubernetes secret to use as the client certificate and private key when establishing TLS connections to the backend service. | -### Leader Election Configuration - -The leader election configuration block configures how a deployment with more than one Contour pod elects a leader. -The Contour leader is responsible for updating the status field on Ingress and HTTPProxy documents. -In the vast majority of deployments, only the `configmap-name` and `configmap-namespace` fields should require any configuration. - -_Note:_ Configuring leader election via the configuration file is deprecated, please use the `contour serve` command line flags instead. - -| Field Name | Type | Default | Description | -| ------------------- | ------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| configmap-name | string | `leader-elect` | The name of the ConfigMap that Contour leader election will lease. | -| configmap-namespace | string | `projectcontour` | The namespace of the ConfigMap that Contour leader election will lease. If the `CONTOUR_NAMESPACE` environment variable is present, Contour will populate this field with its value. | -| lease-duration | [duration][4] | `15s` | The duration of the leadership lease. | -| renew-deadline | [duration][4] | `10s` | The length of time that the leader will retry refreshing leadership before giving up. | -| retry-period | [duration][4] | `2s` | The interval at which Contour will attempt to the acquire leadership lease. | ### Timeout Configuration diff --git a/site/content/docs/1.23/configuration.md b/site/content/docs/1.23/configuration.md index f2eff5c5a63..5d29b1f75c9 100644 --- a/site/content/docs/1.23/configuration.md +++ b/site/content/docs/1.23/configuration.md @@ -85,7 +85,6 @@ merge_slashes path transformation behavior that strips duplicate slashes from re | incluster | boolean | `false` | This field specifies that Contour is running in a Kubernetes cluster and should use the in-cluster client access configuration. | | json-fields | string array | [fields][5] | This is the list the field names to include in the JSON [access log format][2]. This field only has effect if `accesslog-format` is `json`. | | kubeconfig | string | `$HOME/.kube/config` | Path to a Kubernetes [kubeconfig file][3] for when Contour is executed outside a cluster. | -| leaderelection | leaderelection | | The [leader election configuration](#leader-election-configuration). | | policy | PolicyConfig | | The default [policy configuration](#policy-configuration). | | tls | TLS | | The default [TLS configuration](#tls-configuration). | | timeouts | TimeoutConfig | | The [timeout configuration](#timeout-configuration). | @@ -125,21 +124,6 @@ Contour should provision TLS hosts. | name | string | `""` | This field specifies the name of the Kubernetes secret to use as the client certificate and private key when establishing TLS connections to the backend service. | | namespace | string | `""` | This field specifies the namespace of the Kubernetes secret to use as the client certificate and private key when establishing TLS connections to the backend service. | -### Leader Election Configuration - -The leader election configuration block configures how a deployment with more than one Contour pod elects a leader. -The Contour leader is responsible for updating the status field on Ingress and HTTPProxy documents. -In the vast majority of deployments, only the `configmap-name` and `configmap-namespace` fields should require any configuration. - -_Note:_ Configuring leader election via the configuration file is deprecated, please use the `contour serve` command line flags instead. - -| Field Name | Type | Default | Description | -| ------------------- | ------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| configmap-name | string | `leader-elect` | The name of the ConfigMap that Contour leader election will lease. | -| configmap-namespace | string | `projectcontour` | The namespace of the ConfigMap that Contour leader election will lease. If the `CONTOUR_NAMESPACE` environment variable is present, Contour will populate this field with its value. | -| lease-duration | [duration][4] | `15s` | The duration of the leadership lease. | -| renew-deadline | [duration][4] | `10s` | The length of time that the leader will retry refreshing leadership before giving up. | -| retry-period | [duration][4] | `2s` | The interval at which Contour will attempt to the acquire leadership lease. | ### Timeout Configuration diff --git a/site/content/docs/1.24/configuration.md b/site/content/docs/1.24/configuration.md index 94e7e0ad17a..8f5bd90ad9a 100644 --- a/site/content/docs/1.24/configuration.md +++ b/site/content/docs/1.24/configuration.md @@ -89,7 +89,6 @@ Where Contour settings can also be specified with command-line flags, the comman | kubeconfig | string | `$HOME/.kube/config` | Path to a Kubernetes [kubeconfig file][3] for when Contour is executed outside a cluster. | | kubernetesClientQPS | float32 | | QPS allowed for the Kubernetes client. | | kubernetesClientBurst | int | | Burst allowed for the Kubernetes client. | -| leaderelection | leaderelection | | The [leader election configuration](#leader-election-configuration). | | policy | PolicyConfig | | The default [policy configuration](#policy-configuration). | | tls | TLS | | The default [TLS configuration](#tls-configuration). | | timeouts | TimeoutConfig | | The [timeout configuration](#timeout-configuration). | @@ -129,21 +128,6 @@ Contour should provision TLS hosts. | name | string | `""` | This field specifies the name of the Kubernetes secret to use as the client certificate and private key when establishing TLS connections to the backend service. | | namespace | string | `""` | This field specifies the namespace of the Kubernetes secret to use as the client certificate and private key when establishing TLS connections to the backend service. | -### Leader Election Configuration - -The leader election configuration block configures how a deployment with more than one Contour pod elects a leader. -The Contour leader is responsible for updating the status field on Ingress and HTTPProxy documents. -In the vast majority of deployments, only the `configmap-name` and `configmap-namespace` fields should require any configuration. - -_Note:_ Configuring leader election via the configuration file is deprecated, please use the `contour serve` command line flags instead. - -| Field Name | Type | Default | Description | -| ------------------- | ------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| configmap-name | string | `leader-elect` | The name of the ConfigMap that Contour leader election will lease. | -| configmap-namespace | string | `projectcontour` | The namespace of the ConfigMap that Contour leader election will lease. If the `CONTOUR_NAMESPACE` environment variable is present, Contour will populate this field with its value. | -| lease-duration | [duration][4] | `15s` | The duration of the leadership lease. | -| renew-deadline | [duration][4] | `10s` | The length of time that the leader will retry refreshing leadership before giving up. | -| retry-period | [duration][4] | `2s` | The interval at which Contour will attempt to the acquire leadership lease. | ### Timeout Configuration diff --git a/site/content/docs/1.25/configuration.md b/site/content/docs/1.25/configuration.md index 9d9014ec444..dbab39b75dc 100644 --- a/site/content/docs/1.25/configuration.md +++ b/site/content/docs/1.25/configuration.md @@ -90,7 +90,6 @@ Where Contour settings can also be specified with command-line flags, the comman | kubeconfig | string | `$HOME/.kube/config` | Path to a Kubernetes [kubeconfig file][3] for when Contour is executed outside a cluster. | | kubernetesClientQPS | float32 | | QPS allowed for the Kubernetes client. | | kubernetesClientBurst | int | | Burst allowed for the Kubernetes client. | -| leaderelection | leaderelection | | The [leader election configuration](#leader-election-configuration). | | policy | PolicyConfig | | The default [policy configuration](#policy-configuration). | | tls | TLS | | The default [TLS configuration](#tls-configuration). | | timeouts | TimeoutConfig | | The [timeout configuration](#timeout-configuration). | @@ -130,21 +129,6 @@ Contour should provision TLS hosts. | name | string | `""` | This field specifies the name of the Kubernetes secret to use as the client certificate and private key when establishing TLS connections to the backend service. | | namespace | string | `""` | This field specifies the namespace of the Kubernetes secret to use as the client certificate and private key when establishing TLS connections to the backend service. | -### Leader Election Configuration - -The leader election configuration block configures how a deployment with more than one Contour pod elects a leader. -The Contour leader is responsible for updating the status field on Ingress and HTTPProxy documents. -In the vast majority of deployments, only the `configmap-name` and `configmap-namespace` fields should require any configuration. - -_Note:_ Configuring leader election via the configuration file is deprecated, please use the `contour serve` command line flags instead. - -| Field Name | Type | Default | Description | -| ------------------- | ------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| configmap-name | string | `leader-elect` | The name of the ConfigMap that Contour leader election will lease. | -| configmap-namespace | string | `projectcontour` | The namespace of the ConfigMap that Contour leader election will lease. If the `CONTOUR_NAMESPACE` environment variable is present, Contour will populate this field with its value. | -| lease-duration | [duration][4] | `15s` | The duration of the leadership lease. | -| renew-deadline | [duration][4] | `10s` | The length of time that the leader will retry refreshing leadership before giving up. | -| retry-period | [duration][4] | `2s` | The interval at which Contour will attempt to the acquire leadership lease. | ### Timeout Configuration diff --git a/site/content/docs/1.26/configuration.md b/site/content/docs/1.26/configuration.md index dd800bc9ab2..a9c636f9aa4 100644 --- a/site/content/docs/1.26/configuration.md +++ b/site/content/docs/1.26/configuration.md @@ -91,7 +91,6 @@ Where Contour settings can also be specified with command-line flags, the comman | kubeconfig | string | `$HOME/.kube/config` | Path to a Kubernetes [kubeconfig file][3] for when Contour is executed outside a cluster. | | kubernetesClientQPS | float32 | | QPS allowed for the Kubernetes client. | | kubernetesClientBurst | int | | Burst allowed for the Kubernetes client. | -| leaderelection | leaderelection | | The [leader election configuration](#leader-election-configuration). | | policy | PolicyConfig | | The default [policy configuration](#policy-configuration). | | tls | TLS | | The default [TLS configuration](#tls-configuration). | | timeouts | TimeoutConfig | | The [timeout configuration](#timeout-configuration). | @@ -132,21 +131,6 @@ Contour should provision TLS hosts. | name | string | `""` | This field specifies the name of the Kubernetes secret to use as the client certificate and private key when establishing TLS connections to the backend service. | | namespace | string | `""` | This field specifies the namespace of the Kubernetes secret to use as the client certificate and private key when establishing TLS connections to the backend service. | -### Leader Election Configuration - -The leader election configuration block configures how a deployment with more than one Contour pod elects a leader. -The Contour leader is responsible for updating the status field on Ingress and HTTPProxy documents. -In the vast majority of deployments, only the `configmap-name` and `configmap-namespace` fields should require any configuration. - -_Note:_ Configuring leader election via the configuration file is deprecated, please use the `contour serve` command line flags instead. - -| Field Name | Type | Default | Description | -| ------------------- | ------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| configmap-name | string | `leader-elect` | The name of the ConfigMap that Contour leader election will lease. | -| configmap-namespace | string | `projectcontour` | The namespace of the ConfigMap that Contour leader election will lease. If the `CONTOUR_NAMESPACE` environment variable is present, Contour will populate this field with its value. | -| lease-duration | [duration][4] | `15s` | The duration of the leadership lease. | -| renew-deadline | [duration][4] | `10s` | The length of time that the leader will retry refreshing leadership before giving up. | -| retry-period | [duration][4] | `2s` | The interval at which Contour will attempt to the acquire leadership lease. | ### Timeout Configuration diff --git a/site/content/docs/1.27/configuration.md b/site/content/docs/1.27/configuration.md index 06eea341d61..1ce00eb4fc6 100644 --- a/site/content/docs/1.27/configuration.md +++ b/site/content/docs/1.27/configuration.md @@ -91,7 +91,6 @@ Where Contour settings can also be specified with command-line flags, the comman | kubeconfig | string | `$HOME/.kube/config` | Path to a Kubernetes [kubeconfig file][3] for when Contour is executed outside a cluster. | | kubernetesClientQPS | float32 | | QPS allowed for the Kubernetes client. | | kubernetesClientBurst | int | | Burst allowed for the Kubernetes client. | -| leaderelection | leaderelection | | The [leader election configuration](#leader-election-configuration). | | policy | PolicyConfig | | The default [policy configuration](#policy-configuration). | | tls | TLS | | The default [TLS configuration](#tls-configuration). | | timeouts | TimeoutConfig | | The [timeout configuration](#timeout-configuration). | @@ -133,21 +132,6 @@ Contour should provision TLS hosts. | name | string | `""` | This field specifies the name of the Kubernetes secret to use as the client certificate and private key when establishing TLS connections to the backend service. | | namespace | string | `""` | This field specifies the namespace of the Kubernetes secret to use as the client certificate and private key when establishing TLS connections to the backend service. | -### Leader Election Configuration - -The leader election configuration block configures how a deployment with more than one Contour pod elects a leader. -The Contour leader is responsible for updating the status field on Ingress and HTTPProxy documents. -In the vast majority of deployments, only the `configmap-name` and `configmap-namespace` fields should require any configuration. - -_Note:_ Configuring leader election via the configuration file is deprecated, please use the `contour serve` command line flags instead. - -| Field Name | Type | Default | Description | -| ------------------- | ------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| configmap-name | string | `leader-elect` | The name of the ConfigMap that Contour leader election will lease. | -| configmap-namespace | string | `projectcontour` | The namespace of the ConfigMap that Contour leader election will lease. If the `CONTOUR_NAMESPACE` environment variable is present, Contour will populate this field with its value. | -| lease-duration | [duration][4] | `15s` | The duration of the leadership lease. | -| renew-deadline | [duration][4] | `10s` | The length of time that the leader will retry refreshing leadership before giving up. | -| retry-period | [duration][4] | `2s` | The interval at which Contour will attempt to the acquire leadership lease. | ### Timeout Configuration diff --git a/site/content/docs/main/configuration.md b/site/content/docs/main/configuration.md index 06eea341d61..1ce00eb4fc6 100644 --- a/site/content/docs/main/configuration.md +++ b/site/content/docs/main/configuration.md @@ -91,7 +91,6 @@ Where Contour settings can also be specified with command-line flags, the comman | kubeconfig | string | `$HOME/.kube/config` | Path to a Kubernetes [kubeconfig file][3] for when Contour is executed outside a cluster. | | kubernetesClientQPS | float32 | | QPS allowed for the Kubernetes client. | | kubernetesClientBurst | int | | Burst allowed for the Kubernetes client. | -| leaderelection | leaderelection | | The [leader election configuration](#leader-election-configuration). | | policy | PolicyConfig | | The default [policy configuration](#policy-configuration). | | tls | TLS | | The default [TLS configuration](#tls-configuration). | | timeouts | TimeoutConfig | | The [timeout configuration](#timeout-configuration). | @@ -133,21 +132,6 @@ Contour should provision TLS hosts. | name | string | `""` | This field specifies the name of the Kubernetes secret to use as the client certificate and private key when establishing TLS connections to the backend service. | | namespace | string | `""` | This field specifies the namespace of the Kubernetes secret to use as the client certificate and private key when establishing TLS connections to the backend service. | -### Leader Election Configuration - -The leader election configuration block configures how a deployment with more than one Contour pod elects a leader. -The Contour leader is responsible for updating the status field on Ingress and HTTPProxy documents. -In the vast majority of deployments, only the `configmap-name` and `configmap-namespace` fields should require any configuration. - -_Note:_ Configuring leader election via the configuration file is deprecated, please use the `contour serve` command line flags instead. - -| Field Name | Type | Default | Description | -| ------------------- | ------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| configmap-name | string | `leader-elect` | The name of the ConfigMap that Contour leader election will lease. | -| configmap-namespace | string | `projectcontour` | The namespace of the ConfigMap that Contour leader election will lease. If the `CONTOUR_NAMESPACE` environment variable is present, Contour will populate this field with its value. | -| lease-duration | [duration][4] | `15s` | The duration of the leadership lease. | -| renew-deadline | [duration][4] | `10s` | The length of time that the leader will retry refreshing leadership before giving up. | -| retry-period | [duration][4] | `2s` | The interval at which Contour will attempt to the acquire leadership lease. | ### Timeout Configuration