From 2acde581e62ba00479288ce05a12e15a6375fb72 Mon Sep 17 00:00:00 2001 From: Steven Borrelli Date: Thu, 10 Oct 2024 11:04:32 +0200 Subject: [PATCH] remove controllerconfig references in troubleshooting Signed-off-by: Steven Borrelli --- content/master/concepts/providers.md | 3 +- .../master/guides/troubleshoot-crossplane.md | 43 +++++++++++++------ content/v1.17/concepts/providers.md | 5 +-- .../v1.17/guides/troubleshoot-crossplane.md | 43 +++++++++++++------ 4 files changed, 61 insertions(+), 33 deletions(-) diff --git a/content/master/concepts/providers.md b/content/master/concepts/providers.md index f2fc5d62..105b5ed2 100644 --- a/content/master/concepts/providers.md +++ b/content/master/concepts/providers.md @@ -606,7 +606,7 @@ Each Provider determines their supported set of `args`. ### Runtime configuration {{}} -`DeploymentRuntimeConfigs` is a beta feature. +`DeploymentRuntimeConfigs` is a beta feature. It's on by default, and you can disable it by passing `--enable-deployment-runtime-configs=false` to the Crossplane deployment. @@ -629,7 +629,6 @@ the runtime. Refer to the [design document](https://github.com/crossplane/crossp for more details. {{< /hint >}} - As an example, to enable the external secret stores alpha feature for a `Provider` by adding the `--enable-external-secret-stores` argument to the controller, one can apply the following: diff --git a/content/master/guides/troubleshoot-crossplane.md b/content/master/guides/troubleshoot-crossplane.md index 164c01c9..78cadf39 100644 --- a/content/master/guides/troubleshoot-crossplane.md +++ b/content/master/guides/troubleshoot-crossplane.md @@ -80,16 +80,23 @@ kubectl -n crossplane-system logs All providers maintained by the Crossplane community mirror Crossplane's support of the `--debug` flag. The easiest way to set flags on a provider is to create a -`ControllerConfig` and reference it from the `Provider`: +`DeploymentRuntimeConfig` and reference it from the `Provider`: ```yaml -apiVersion: pkg.crossplane.io/v1alpha1 -kind: ControllerConfig +apiVersion: pkg.crossplane.io/v1beta1 +kind: DeploymentRuntimeConfig metadata: name: debug-config spec: - args: - - --debug + deploymentTemplate: + spec: + selector: {} + template: + spec: + containers: + - name: package-runtime + args: + - --debug --- apiVersion: pkg.crossplane.io/v1 kind: Provider @@ -97,11 +104,13 @@ metadata: name: provider-aws spec: package: xpkg.upbound.io/crossplane-contrib/provider-aws:v0.33.0 - controllerConfigRef: + runtimeConfigRef: + apiVersion: pkg.crossplane.io/v1beta1 + kind: DeploymentRuntimeConfig name: debug-config ``` -> Note that a reference to a `ControllerConfig` can be added to an already +> Note that a reference to a `DeploymentRuntimeConfig` can be added to an already > installed `Provider` and it will update its `Deployment` accordingly. ## Compositions and composite resource definition @@ -335,17 +344,21 @@ kubectl -n crossplane-system scale --replicas=1 deployment/crossplane ## Pausing Providers Providers can also be paused when troubleshooting an issue or orchestrating a -complex migration of resources. Creating and referencing a `ControllerConfig` is -the easiest way to scale down a provider, and the `ControllerConfig` can be +complex migration of resources. Creating and referencing a `DeploymentRuntimeConfig` is +the easiest way to scale down a provider, and the `DeploymentRuntimeConfig` can be modified or the reference can be removed to scale it back up: ```yaml -apiVersion: pkg.crossplane.io/v1alpha1 -kind: ControllerConfig +apiVersion: pkg.crossplane.io/v1beta1 +kind: DeploymentRuntimeConfig metadata: name: scale-config spec: - replicas: 0 + deploymentTemplate: + spec: + selector: {} + replicas: 0 + template: {} --- apiVersion: pkg.crossplane.io/v1 kind: Provider @@ -353,11 +366,13 @@ metadata: name: provider-aws spec: package: xpkg.upbound.io/crossplane-contrib/provider-aws:v0.33.0 - controllerConfigRef: + runtimeConfigRef: + apiVersion: pkg.crossplane.io/v1beta1 + kind: DeploymentRuntimeConfig name: scale-config ``` -> Note that a reference to a `ControllerConfig` can be added to an already +> Note that a reference to a `DeploymentRuntimeConfig` can be added to an already > installed `Provider` and it will update its `Deployment` accordingly. ## Deleting When a Resource Hangs diff --git a/content/v1.17/concepts/providers.md b/content/v1.17/concepts/providers.md index b426e490..105b5ed2 100644 --- a/content/v1.17/concepts/providers.md +++ b/content/v1.17/concepts/providers.md @@ -351,7 +351,7 @@ Status: Events: Type Reason Age From Message ---- ------ ---- ---- ------- - Warning LintPackage 41s (x3 over 47s) packages/providerrevision.pkg.crossplane.io incompatible Crossplane version: package is not compatible with Crossplane version (v1.10.0) + Warning LintPackage 41s (x3 over 47s) packages/providerrevision.pkg.crossplane.io incompatible Crossplane version: package isn't compatible with Crossplane version (v1.10.0) ``` The {{}}Events{{}} show a @@ -606,7 +606,7 @@ Each Provider determines their supported set of `args`. ### Runtime configuration {{}} -`DeploymentRuntimeConfigs` is a beta feature. +`DeploymentRuntimeConfigs` is a beta feature. It's on by default, and you can disable it by passing `--enable-deployment-runtime-configs=false` to the Crossplane deployment. @@ -629,7 +629,6 @@ the runtime. Refer to the [design document](https://github.com/crossplane/crossp for more details. {{< /hint >}} - As an example, to enable the external secret stores alpha feature for a `Provider` by adding the `--enable-external-secret-stores` argument to the controller, one can apply the following: diff --git a/content/v1.17/guides/troubleshoot-crossplane.md b/content/v1.17/guides/troubleshoot-crossplane.md index 164c01c9..78cadf39 100644 --- a/content/v1.17/guides/troubleshoot-crossplane.md +++ b/content/v1.17/guides/troubleshoot-crossplane.md @@ -80,16 +80,23 @@ kubectl -n crossplane-system logs All providers maintained by the Crossplane community mirror Crossplane's support of the `--debug` flag. The easiest way to set flags on a provider is to create a -`ControllerConfig` and reference it from the `Provider`: +`DeploymentRuntimeConfig` and reference it from the `Provider`: ```yaml -apiVersion: pkg.crossplane.io/v1alpha1 -kind: ControllerConfig +apiVersion: pkg.crossplane.io/v1beta1 +kind: DeploymentRuntimeConfig metadata: name: debug-config spec: - args: - - --debug + deploymentTemplate: + spec: + selector: {} + template: + spec: + containers: + - name: package-runtime + args: + - --debug --- apiVersion: pkg.crossplane.io/v1 kind: Provider @@ -97,11 +104,13 @@ metadata: name: provider-aws spec: package: xpkg.upbound.io/crossplane-contrib/provider-aws:v0.33.0 - controllerConfigRef: + runtimeConfigRef: + apiVersion: pkg.crossplane.io/v1beta1 + kind: DeploymentRuntimeConfig name: debug-config ``` -> Note that a reference to a `ControllerConfig` can be added to an already +> Note that a reference to a `DeploymentRuntimeConfig` can be added to an already > installed `Provider` and it will update its `Deployment` accordingly. ## Compositions and composite resource definition @@ -335,17 +344,21 @@ kubectl -n crossplane-system scale --replicas=1 deployment/crossplane ## Pausing Providers Providers can also be paused when troubleshooting an issue or orchestrating a -complex migration of resources. Creating and referencing a `ControllerConfig` is -the easiest way to scale down a provider, and the `ControllerConfig` can be +complex migration of resources. Creating and referencing a `DeploymentRuntimeConfig` is +the easiest way to scale down a provider, and the `DeploymentRuntimeConfig` can be modified or the reference can be removed to scale it back up: ```yaml -apiVersion: pkg.crossplane.io/v1alpha1 -kind: ControllerConfig +apiVersion: pkg.crossplane.io/v1beta1 +kind: DeploymentRuntimeConfig metadata: name: scale-config spec: - replicas: 0 + deploymentTemplate: + spec: + selector: {} + replicas: 0 + template: {} --- apiVersion: pkg.crossplane.io/v1 kind: Provider @@ -353,11 +366,13 @@ metadata: name: provider-aws spec: package: xpkg.upbound.io/crossplane-contrib/provider-aws:v0.33.0 - controllerConfigRef: + runtimeConfigRef: + apiVersion: pkg.crossplane.io/v1beta1 + kind: DeploymentRuntimeConfig name: scale-config ``` -> Note that a reference to a `ControllerConfig` can be added to an already +> Note that a reference to a `DeploymentRuntimeConfig` can be added to an already > installed `Provider` and it will update its `Deployment` accordingly. ## Deleting When a Resource Hangs