remove controllerconfig references in troubleshooting

Signed-off-by: Steven Borrelli <[email protected]>
crossplane · Oct 10, 2024 · 88c18ab · 88c18ab
1 parent 33fe2ef
commit 88c18ab
Show file tree

Hide file tree

Showing 4 changed files with 61 additions and 33 deletions.
diff --git 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
 
 {{<hint "important" >}}
-`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
@@ -80,28 +80,37 @@ kubectl -n crossplane-system logs <name-of-provider-pod>
 
 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
 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,29 +344,35 @@ 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
 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
@@ -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 {{<hover label="depend" line="17">}}Events{{</hover>}} show a 
@@ -606,7 +606,7 @@ Each Provider determines their supported set of `args`.
 ### Runtime configuration
 
 {{<hint "important" >}}
-`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
@@ -80,28 +80,37 @@ kubectl -n crossplane-system logs <name-of-provider-pod>
 
 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
 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,29 +344,35 @@ 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
 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