Skip to content

Commit 4dd74f6

Browse files
Remove ControllerConfig references in the troubleshooting guide (#822)
1 parent 9a8d432 commit 4dd74f6

File tree

4 files changed

+61
-33
lines changed

4 files changed

+61
-33
lines changed

content/master/concepts/providers.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -620,7 +620,7 @@ Each Provider determines their supported set of `args`.
620620
### Runtime configuration
621621

622622
{{<hint "important" >}}
623-
`DeploymentRuntimeConfigs` is a beta feature.
623+
`DeploymentRuntimeConfigs` is a beta feature.
624624

625625
It's on by default, and you can disable it by passing
626626
`--enable-deployment-runtime-configs=false` to the Crossplane deployment.
@@ -643,7 +643,6 @@ the runtime. Refer to the [design document](https://github.com/crossplane/crossp
643643
for more details.
644644
{{< /hint >}}
645645

646-
647646
As an example, to enable the external secret stores alpha feature for a `Provider`
648647
by adding the `--enable-external-secret-stores` argument to the controller,
649648
one can apply the following:

content/master/guides/troubleshoot-crossplane.md

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -80,28 +80,37 @@ kubectl -n crossplane-system logs <name-of-provider-pod>
8080

8181
All providers maintained by the Crossplane community mirror Crossplane's support
8282
of the `--debug` flag. The easiest way to set flags on a provider is to create a
83-
`ControllerConfig` and reference it from the `Provider`:
83+
`DeploymentRuntimeConfig` and reference it from the `Provider`:
8484

8585
```yaml
86-
apiVersion: pkg.crossplane.io/v1alpha1
87-
kind: ControllerConfig
86+
apiVersion: pkg.crossplane.io/v1beta1
87+
kind: DeploymentRuntimeConfig
8888
metadata:
8989
name: debug-config
9090
spec:
91-
args:
92-
- --debug
91+
deploymentTemplate:
92+
spec:
93+
selector: {}
94+
template:
95+
spec:
96+
containers:
97+
- name: package-runtime
98+
args:
99+
- --debug
93100
---
94101
apiVersion: pkg.crossplane.io/v1
95102
kind: Provider
96103
metadata:
97104
name: provider-aws
98105
spec:
99106
package: xpkg.upbound.io/crossplane-contrib/provider-aws:v0.33.0
100-
controllerConfigRef:
107+
runtimeConfigRef:
108+
apiVersion: pkg.crossplane.io/v1beta1
109+
kind: DeploymentRuntimeConfig
101110
name: debug-config
102111
```
103112
104-
> Note that a reference to a `ControllerConfig` can be added to an already
113+
> Note that a reference to a `DeploymentRuntimeConfig` can be added to an already
105114
> installed `Provider` and it will update its `Deployment` accordingly.
106115

107116
## Compositions and composite resource definition
@@ -335,29 +344,35 @@ kubectl -n crossplane-system scale --replicas=1 deployment/crossplane
335344
## Pausing Providers
336345

337346
Providers can also be paused when troubleshooting an issue or orchestrating a
338-
complex migration of resources. Creating and referencing a `ControllerConfig` is
339-
the easiest way to scale down a provider, and the `ControllerConfig` can be
347+
complex migration of resources. Creating and referencing a `DeploymentRuntimeConfig` is
348+
the easiest way to scale down a provider, and the `DeploymentRuntimeConfig` can be
340349
modified or the reference can be removed to scale it back up:
341350

342351
```yaml
343-
apiVersion: pkg.crossplane.io/v1alpha1
344-
kind: ControllerConfig
352+
apiVersion: pkg.crossplane.io/v1beta1
353+
kind: DeploymentRuntimeConfig
345354
metadata:
346355
name: scale-config
347356
spec:
348-
replicas: 0
357+
deploymentTemplate:
358+
spec:
359+
selector: {}
360+
replicas: 0
361+
template: {}
349362
---
350363
apiVersion: pkg.crossplane.io/v1
351364
kind: Provider
352365
metadata:
353366
name: provider-aws
354367
spec:
355368
package: xpkg.upbound.io/crossplane-contrib/provider-aws:v0.33.0
356-
controllerConfigRef:
369+
runtimeConfigRef:
370+
apiVersion: pkg.crossplane.io/v1beta1
371+
kind: DeploymentRuntimeConfig
357372
name: scale-config
358373
```
359374

360-
> Note that a reference to a `ControllerConfig` can be added to an already
375+
> Note that a reference to a `DeploymentRuntimeConfig` can be added to an already
361376
> installed `Provider` and it will update its `Deployment` accordingly.
362377

363378
## Deleting When a Resource Hangs

content/v1.17/concepts/providers.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ Status:
351351
Events:
352352
Type Reason Age From Message
353353
---- ------ ---- ---- -------
354-
Warning LintPackage 41s (x3 over 47s) packages/providerrevision.pkg.crossplane.io incompatible Crossplane version: package is not compatible with Crossplane version (v1.10.0)
354+
Warning LintPackage 41s (x3 over 47s) packages/providerrevision.pkg.crossplane.io incompatible Crossplane version: package isn't compatible with Crossplane version (v1.10.0)
355355
```
356356

357357
The {{<hover label="depend" line="17">}}Events{{</hover>}} show a
@@ -606,7 +606,7 @@ Each Provider determines their supported set of `args`.
606606
### Runtime configuration
607607

608608
{{<hint "important" >}}
609-
`DeploymentRuntimeConfigs` is a beta feature.
609+
`DeploymentRuntimeConfigs` is a beta feature.
610610

611611
It's on by default, and you can disable it by passing
612612
`--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
629629
for more details.
630630
{{< /hint >}}
631631

632-
633632
As an example, to enable the external secret stores alpha feature for a `Provider`
634633
by adding the `--enable-external-secret-stores` argument to the controller,
635634
one can apply the following:

content/v1.17/guides/troubleshoot-crossplane.md

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -80,28 +80,37 @@ kubectl -n crossplane-system logs <name-of-provider-pod>
8080

8181
All providers maintained by the Crossplane community mirror Crossplane's support
8282
of the `--debug` flag. The easiest way to set flags on a provider is to create a
83-
`ControllerConfig` and reference it from the `Provider`:
83+
`DeploymentRuntimeConfig` and reference it from the `Provider`:
8484

8585
```yaml
86-
apiVersion: pkg.crossplane.io/v1alpha1
87-
kind: ControllerConfig
86+
apiVersion: pkg.crossplane.io/v1beta1
87+
kind: DeploymentRuntimeConfig
8888
metadata:
8989
name: debug-config
9090
spec:
91-
args:
92-
- --debug
91+
deploymentTemplate:
92+
spec:
93+
selector: {}
94+
template:
95+
spec:
96+
containers:
97+
- name: package-runtime
98+
args:
99+
- --debug
93100
---
94101
apiVersion: pkg.crossplane.io/v1
95102
kind: Provider
96103
metadata:
97104
name: provider-aws
98105
spec:
99106
package: xpkg.upbound.io/crossplane-contrib/provider-aws:v0.33.0
100-
controllerConfigRef:
107+
runtimeConfigRef:
108+
apiVersion: pkg.crossplane.io/v1beta1
109+
kind: DeploymentRuntimeConfig
101110
name: debug-config
102111
```
103112
104-
> Note that a reference to a `ControllerConfig` can be added to an already
113+
> Note that a reference to a `DeploymentRuntimeConfig` can be added to an already
105114
> installed `Provider` and it will update its `Deployment` accordingly.
106115

107116
## Compositions and composite resource definition
@@ -335,29 +344,35 @@ kubectl -n crossplane-system scale --replicas=1 deployment/crossplane
335344
## Pausing Providers
336345

337346
Providers can also be paused when troubleshooting an issue or orchestrating a
338-
complex migration of resources. Creating and referencing a `ControllerConfig` is
339-
the easiest way to scale down a provider, and the `ControllerConfig` can be
347+
complex migration of resources. Creating and referencing a `DeploymentRuntimeConfig` is
348+
the easiest way to scale down a provider, and the `DeploymentRuntimeConfig` can be
340349
modified or the reference can be removed to scale it back up:
341350

342351
```yaml
343-
apiVersion: pkg.crossplane.io/v1alpha1
344-
kind: ControllerConfig
352+
apiVersion: pkg.crossplane.io/v1beta1
353+
kind: DeploymentRuntimeConfig
345354
metadata:
346355
name: scale-config
347356
spec:
348-
replicas: 0
357+
deploymentTemplate:
358+
spec:
359+
selector: {}
360+
replicas: 0
361+
template: {}
349362
---
350363
apiVersion: pkg.crossplane.io/v1
351364
kind: Provider
352365
metadata:
353366
name: provider-aws
354367
spec:
355368
package: xpkg.upbound.io/crossplane-contrib/provider-aws:v0.33.0
356-
controllerConfigRef:
369+
runtimeConfigRef:
370+
apiVersion: pkg.crossplane.io/v1beta1
371+
kind: DeploymentRuntimeConfig
357372
name: scale-config
358373
```
359374

360-
> Note that a reference to a `ControllerConfig` can be added to an already
375+
> Note that a reference to a `DeploymentRuntimeConfig` can be added to an already
361376
> installed `Provider` and it will update its `Deployment` accordingly.
362377

363378
## Deleting When a Resource Hangs

0 commit comments

Comments
 (0)