crossplane
/
docs
mirror of https://github.com/crossplane/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #854 from jbw976/882-to-v1.18 

docs: port removal of ControllerConfig refs in troubleshooting guide to v1.18
This commit is contained in:
Jared Watts 2025-01-16 08:22:49 -08:00 committed by GitHub
parent be737b4ed3 29d47606da
commit a65aa24ff4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 29 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
content/v1.18/guides/troubleshoot-crossplane.md
View File

@ -80,14 +80,21 @@ kubectl -n crossplane-system logs <name-of-provider-pod>
All providers maintained by the Crossplane community mirror Crossplane's support 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 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 ```yaml
apiVersion: pkg.crossplane.io/v1alpha1 apiVersion: pkg.crossplane.io/v1beta1
kind: ControllerConfig kind: DeploymentRuntimeConfig
metadata: metadata:
name: debug-config name: debug-config
spec: spec:
deploymentTemplate:
spec:
selector: {}
template:
spec:
containers:
- name: package-runtime
args: args:
- --debug - --debug
--- ---
@ -97,11 +104,13 @@ metadata:
name: provider-aws name: provider-aws
spec: spec:
package: xpkg.upbound.io/crossplane-contrib/provider-aws:v0.33.0 package: xpkg.upbound.io/crossplane-contrib/provider-aws:v0.33.0
controllerConfigRef: runtimeConfigRef:
apiVersion: pkg.crossplane.io/v1beta1
kind: DeploymentRuntimeConfig
name: debug-config 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. > installed `Provider` and it will update its `Deployment` accordingly.
## Compositions and composite resource definition ## Compositions and composite resource definition
@ -335,17 +344,21 @@ kubectl -n crossplane-system scale --replicas=1 deployment/crossplane
## Pausing Providers ## Pausing Providers
Providers can also be paused when troubleshooting an issue or orchestrating a Providers can also be paused when troubleshooting an issue or orchestrating a
complex migration of resources. Creating and referencing a `ControllerConfig` is complex migration of resources. Creating and referencing a `DeploymentRuntimeConfig` is
the easiest way to scale down a provider, and the `ControllerConfig` can be 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: modified or the reference can be removed to scale it back up:
```yaml ```yaml
apiVersion: pkg.crossplane.io/v1alpha1 apiVersion: pkg.crossplane.io/v1beta1
kind: ControllerConfig kind: DeploymentRuntimeConfig
metadata: metadata:
name: scale-config name: scale-config
spec: spec:
deploymentTemplate:
spec:
selector: {}
replicas: 0 replicas: 0
template: {}
--- ---
apiVersion: pkg.crossplane.io/v1 apiVersion: pkg.crossplane.io/v1
kind: Provider kind: Provider
@ -353,11 +366,13 @@ metadata:
name: provider-aws name: provider-aws
spec: spec:
package: xpkg.upbound.io/crossplane-contrib/provider-aws:v0.33.0 package: xpkg.upbound.io/crossplane-contrib/provider-aws:v0.33.0
controllerConfigRef: runtimeConfigRef:
apiVersion: pkg.crossplane.io/v1beta1
kind: DeploymentRuntimeConfig
name: scale-config 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. > installed `Provider` and it will update its `Deployment` accordingly.
## Deleting When a Resource Hangs ## Deleting When a Resource Hangs