From 18683f21c47e910c9ab5cd0fd306d0cbdd9bfb32 Mon Sep 17 00:00:00 2001 From: Jared Watts Date: Wed, 14 May 2025 17:02:05 +0100 Subject: [PATCH] Update explanation of --enable-dependency-version-downgrades flag Signed-off-by: Jared Watts --- content/master/concepts/packages.md | 194 +++++++++++++-------------- content/master/concepts/providers.md | 134 +++++++++--------- 2 files changed, 164 insertions(+), 164 deletions(-) diff --git a/content/master/concepts/packages.md b/content/master/concepts/packages.md index 79ea6528..498996b7 100644 --- a/content/master/concepts/packages.md +++ b/content/master/concepts/packages.md @@ -5,44 +5,44 @@ altTitle: "Crossplane Packages" weight: 200 --- -A _Configuration_ package is an +A _Configuration_ package is an [OCI container image](https://opencontainers.org/) containing a collection of -[Compositions]({{}}), +[Compositions]({{}}), [Composite Resource Definitions]({{}}) -and any required [Providers]({{}}) or +and any required [Providers]({{}}) or [Functions]({{}}). -Configuration packages make your Crossplane configuration fully portable. +Configuration packages make your Crossplane configuration fully portable. {{}} -Crossplane [Providers]({{}}) and -[Functions]({{}}) are also Crossplane packages. +Crossplane [Providers]({{}}) and +[Functions]({{}}) are also Crossplane packages. -This document describes how to install and manage configuration packages. +This document describes how to install and manage configuration packages. -Refer to the -[Provider]({{}}) and +Refer to the +[Provider]({{}}) and [Composition Functions]({{}}) chapters for -details on their usage of packages. +details on their usage of packages. {{< /hint >}} ## Install a Configuration -Install a Configuration with a Crossplane -{{}}Configuration{{}} object by setting +Install a Configuration with a Crossplane +{{}}Configuration{{}} object by setting the {{}}spec.package{{}} value to the location of the configuration package. {{< hint "important" >}} Beginning with Crossplane version 1.20.0 Crossplane uses the [crossplane-contrib](https://github.com/orgs/crossplane-contrib/packages) GitHub Container Registry at `xpkg.crossplane.io` by default for downloading and -installing packages. +installing packages. Specify the full domain name with the `package` or change the default Crossplane registry with the `--registry` flag on the [Crossplane pod]({{}}) {{< /hint >}} -For example to install the -[Getting Started Configuration](https://github.com/crossplane-contrib/configuration-quickstart), +For example to install the +[Getting Started Configuration](https://github.com/crossplane-contrib/configuration-quickstart), ```yaml {label="install"} apiVersion: pkg.crossplane.io/v1 @@ -68,7 +68,7 @@ spec: {{< /hint >}} Crossplane installs the Compositions, Composite Resource Definitions and -Providers listed in the Configuration. +Providers listed in the Configuration. ### Install with Helm @@ -93,7 +93,7 @@ crossplane-stable/crossplane \ Installing Crossplane packages offline requires a local container registry, such as [Harbor](https://goharbor.io/) to host the packages. Crossplane only -supports installing packages from a container registry. +supports installing packages from a container registry. Crossplane doesn't support installing packages directly from Kubernetes volumes. @@ -101,15 +101,15 @@ volumes. ### Installation options Configurations support multiple options to change configuration package related -settings. +settings. #### Configuration revisions When installing a newer version of an existing Configuration Crossplane creates -a new configuration revision. +a new configuration revision. -View the configuration revisions with +View the configuration revisions with {{}}kubectl get configurationrevisions{{}}. ```shell {label="rev",copy-lines="1"} @@ -120,20 +120,20 @@ platform-ref-aws-3ac761211893 True 1 xpkg.crossplane.io/crosspla ``` Only a single revision is active at a time. The active revision determines the -available resources, including Compositions and Composite Resource Definitions. +available resources, including Compositions and Composite Resource Definitions. By default Crossplane keeps only a single _Inactive_ revision. -Change the number of revisions Crossplane maintains with a Configuration package -{{}}revisionHistoryLimit{{}}. +Change the number of revisions Crossplane maintains with a Configuration package +{{}}revisionHistoryLimit{{}}. The {{}}revisionHistoryLimit{{}} -field is an integer. -The default value is `1`. -Disable storing revisions by setting +field is an integer. +The default value is `1`. +Disable storing revisions by setting {{}}revisionHistoryLimit{{}} to `0`. -For example, to change the default setting and store 10 revisions use +For example, to change the default setting and store 10 revisions use {{}}revisionHistoryLimit: 10{{}}. ```yaml {label="revHistory"} @@ -152,26 +152,26 @@ Use a {{}}packagePullPolicy{{}} to define when Crossplane should download the Configuration package to the local Crossplane package cache. -The `packagePullPolicy` options are: +The `packagePullPolicy` options are: * `IfNotPresent` - (**default**) Only download the package if it isn't in the cache. * `Always` - Check for new packages every minute and download any matching package that isn't in the cache. * `Never` - Never download the package. Packages are only installed from the - local package cache. + local package cache. {{}} -The Crossplane +The Crossplane {{}}packagePullPolicy{{}} works -like the Kubernetes container image -[image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy). +like the Kubernetes container image +[image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy). Crossplane supports the use of tags and package digest hashes like -Kubernetes images. +Kubernetes images. {{< /hint >}} -For example, to `Always` download a given Configuration package use the +For example, to `Always` download a given Configuration package use the {{}}packagePullPolicy: Always{{}} -configuration. +configuration. ```yaml {label="pullpolicy",copy-lines="6"} apiVersion: pkg.crossplane.io/v1 @@ -186,20 +186,20 @@ spec: #### Revision activation policy The `Active` package revision -is the package controller actively reconciling resources. +is the package controller actively reconciling resources. -By default Crossplane sets the most recently installed package revision as +By default Crossplane sets the most recently installed package revision as `Active`. Control the Configuration upgrade behavior with a {{}}revisionActivationPolicy{{}}. -The {{}}revisionActivationPolicy{{}} +The {{}}revisionActivationPolicy{{}} options are: * `Automatic` - (**default**) Automatically activate the last installed configuration. -* `Manual` - Don't automatically activate a configuration. +* `Manual` - Don't automatically activate a configuration. -For example, to change the upgrade behavior to require manual upgrades, set +For example, to change the upgrade behavior to require manual upgrades, set {{}}revisionActivationPolicy: Manual{{}}. ```yaml {label="revision"} @@ -215,14 +215,14 @@ spec: #### Install a Configuration from a private registry -Like Kubernetes uses `imagePullSecrets` to -[install images from private registries](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/), -Crossplane uses `packagePullSecrets` to install Configuration packages from a -private registry. +Like Kubernetes uses `imagePullSecrets` to +[install images from private registries](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/), +Crossplane uses `packagePullSecrets` to install Configuration packages from a +private registry. Use {{}}packagePullSecrets{{}} to provide a -Kubernetes secret to use for authentication when downloading a Configuration -package. +Kubernetes secret to use for authentication when downloading a Configuration +package. {{}} The Kubernetes secret must be in the same namespace as Crossplane. @@ -232,7 +232,7 @@ The {{}}packagePullSecrets{{}} is a list of secrets. For example, to use the secret named -{{}}example-secret{{}} configure a +{{}}example-secret{{}} configure a {{}}packagePullSecrets{{}}. ```yaml {label="pps"} @@ -241,7 +241,7 @@ kind: Configuration metadata: name: platform-ref-aws spec: - packagePullSecrets: + packagePullSecrets: - name: example-secret # Removed for brevity ``` @@ -249,19 +249,19 @@ spec: #### Ignore dependencies By default Crossplane installs any [dependencies](#manage-dependencies) listed -in a Configuration package. +in a Configuration package. -Crossplane can ignore a Configuration package's dependencies with +Crossplane can ignore a Configuration package's dependencies with {{}}skipDependencyResolution{{}}. {{< hint "warning" >}} -Most Configurations include dependencies for the required Providers. +Most Configurations include dependencies for the required Providers. -If a Configuration ignores dependencies, the required Providers must be +If a Configuration ignores dependencies, the required Providers must be manually installed. {{< /hint >}} -For example, to disable dependency resolution configure +For example, to disable dependency resolution configure {{}}skipDependencyResolution: true{{}}. ```yaml {label="pkgDep"} @@ -285,15 +285,15 @@ installations. Suppose configuration A, which depends on package X with the constraint`>=v0.0.0`, is installed on the control plane. In this case, the package manager installs the latest version of package X, such as `v3.0.0`. Later, you decide to install configuration B, which depends on package X with the constraint `<=v2.0.0`. -Since version `v2.0.0`satisfies both conditions, package X must be downgraded to +Since version `v2.0.0` satisfies both conditions, package X must be downgraded to allow the installation of configuration B which is disabled by default. -For enabling automatic dependency version downgrades, there is a configuration -option as a helm value `packageManager.enableAutomaticDependencyDowngrade=true`. -Downgrading a package can cause unexpected behavior, therefore, this -option is disabled by default. After enabling this option, the package manager will -automatically downgrade a package's dependency version to the maximum valid version -that satisfies the constraints. +Automatic dependency version downgrades is also an alpha feature that can be +enabled with the `--enable-dependency-version-downgrades` flag. Downgrading a +package can cause unexpected behavior, therefore, this option is disabled by +default. After enabling this option, the package manager will automatically +downgrade a package's dependency version to the maximum valid version that +satisfies the constraints. {{}} This configuration requires the `--enable-dependency-version-upgrades` flag. @@ -309,7 +309,7 @@ section for more details. {{}} Enabling automatic dependency downgrades may have unintended consequences, such as: -1) CRDs missing in the downgraded version, possibly leaving orphaned MRs without +1) CRDs missing in the downgraded version, possibly leaving orphaned MRs without controllers to reconcile them. 2) Loss of data if downgraded CRD versions omit fields that were set before. 3) Changes in the CRD storage version, which may prevent package version update. @@ -317,15 +317,15 @@ controllers to reconcile them. #### Ignore Crossplane version requirements -A Configuration package may require a specific or minimum Crossplane version -before installing. By default, Crossplane doesn't install a Configuration if -the Crossplane version doesn't meet the required version. +A Configuration package may require a specific or minimum Crossplane version +before installing. By default, Crossplane doesn't install a Configuration if +the Crossplane version doesn't meet the required version. -Crossplane can ignore the required version with +Crossplane can ignore the required version with {{}}ignoreCrossplaneConstraints{{}}. For example, to install a Configuration package into an unsupported Crossplane -version, configure +version, configure {{}}ignoreCrossplaneConstraints: true{{}}. ```yaml {label="xpVer"} @@ -341,7 +341,7 @@ spec: ### Verify a Configuration -Verify a Configuration with +Verify a Configuration with {{}}kubectl get configuration{{}}. A working configuration reports `Installed` and `Healthy` as `True`. @@ -355,10 +355,10 @@ platform-ref-aws True True xpkg.crossplane.io/crossplane-contrib/c ### Manage dependencies Configuration packages may include dependencies on other packages including -Functions, Providers or other Configurations. +Functions, Providers or other Configurations. If Crossplane can't meet the dependencies of a Configuration the Configuration -reports `HEALTHY` as `False`. +reports `HEALTHY` as `False`. For example, this installation of the Getting Started Configuration is `HEALTHY: False`. @@ -369,7 +369,7 @@ NAME INSTALLED HEALTHY PACKAGE platform-ref-aws True False xpkg.crossplane.io/crossplane-contrib/configuration-quickstart:v0.1.0 71s ``` -To see more information on why the Configuration isn't `HEALTHY` use +To see more information on why the Configuration isn't `HEALTHY` use {{}}kubectl describe configurationrevisions{{}}. ```yaml {copy-lines="1",label="depend"} @@ -396,64 +396,64 @@ Events: Warning LintPackage 29s (x2 over 29s) packages/configurationrevision.pkg.crossplane.io incompatible Crossplane version: package isn't compatible with Crossplane version (v1.12.0) ``` -The {{}}Events{{}} show a +The {{}}Events{{}} show a {{}}Warning{{}} with a message that the -current version of Crossplane doesn't meet the Configuration package +current version of Crossplane doesn't meet the Configuration package requirements. ## Create a Configuration -Crossplane Configuration packages are +Crossplane Configuration packages are [OCI container images](https://opencontainers.org/) containing one or more YAML -files. +files. {{}} Configuration packages are fully OCI compliant. Any tool that builds OCI images -can build Configuration packages. +can build Configuration packages. It's strongly recommended to use the Crossplane command-line tool to -provide error checking and formatting to Crossplane package builds. +provide error checking and formatting to Crossplane package builds. -Read the -[Crossplane package specification](https://github.com/crossplane/crossplane/blob/main/contributing/specifications/xpkg.md) +Read the +[Crossplane package specification](https://github.com/crossplane/crossplane/blob/main/contributing/specifications/xpkg.md) for package requirements when building packages with third-party tools. {{}} A Configuration package requires a `crossplane.yaml` file and may include -Composition and CompositeResourceDefinition files. +Composition and CompositeResourceDefinition files. ### The crossplane.yaml file To build a Configuration package using the Crossplane CLI, create a file -named -{{}}crossplane.yaml{{}}. -The +named +{{}}crossplane.yaml{{}}. +The {{}}crossplane.yaml{{}} -file defines the requirements and name of the +file defines the requirements and name of the Configuration. {{}} The Crossplane CLI only supports a file named `crossplane.yaml`. {{< /hint >}} -Configuration package uses the +Configuration package uses the {{}}meta.pkg.crossplane.io{{}} Crossplane API group. -Specify any other Configurations, Functions or Providers in the -{{}}dependsOn{{}} list. -Optionally, you can require a specific or minimum package version with the +Specify any other Configurations, Functions or Providers in the +{{}}dependsOn{{}} list. +Optionally, you can require a specific or minimum package version with the {{}}version{{}} option. You can also define a specific or minimum version of Crossplane for this -Configuration with the -{{}}crossplane.version{{}} option. +Configuration with the +{{}}crossplane.version{{}} option. {{}} -Defining the {{}}crossplane{{}} object -or required versions is optional. +Defining the {{}}crossplane{{}} object +or required versions is optional. {{< /hint >}} ```yaml {label="cfgMeta",copy-lines="all"} @@ -474,8 +474,8 @@ spec: ### Build the package -Create the package using the -[Crossplane CLI]({{}}) command +Create the package using the +[Crossplane CLI]({{}}) command `crossplane xpkg build --package-root=`. Where the `` is the directory containing the `crossplane.yaml` file @@ -485,19 +485,19 @@ The CLI recursively searches for `.yml` or `.yaml` files in the directory to include in the package. {{}} -You must ignore any other YAML files with `--ignore=`. +You must ignore any other YAML files with `--ignore=`. For example, `crossplane xpkg build --package-root=test-directory --ignore=".tmp/*"`. -Including YAML files that aren't Compositions or CompositeResourceDefinitions, +Including YAML files that aren't Compositions or CompositeResourceDefinitions, including Claims isn't supported. {{}} -By default, Crossplane creates a `.xpkg` file of the Configuration name and +By default, Crossplane creates a `.xpkg` file of the Configuration name and a SHA-256 hash of the package contents. For example, a {{}}Configuration{{}} -named {{}}test-configuration{{}}. +named {{}}test-configuration{{}}. The Crossplane CLI builds a package named `test-configuration-e8c244f6bf21.xpkg`. diff --git a/content/master/concepts/providers.md b/content/master/concepts/providers.md index 0ef3da74..0c7f668e 100644 --- a/content/master/concepts/providers.md +++ b/content/master/concepts/providers.md @@ -24,7 +24,7 @@ Examples of providers include: Providers define every external resource they can create in Kubernetes as a -Kubernetes API endpoint. +Kubernetes API endpoint. These endpoints are [_Managed Resources_]({{}}). @@ -32,10 +32,10 @@ These endpoints are ## Install a Provider -Installing a provider creates new Kubernetes resources representing the -Provider's APIs. Installing a provider also creates a Provider pod that's -responsible for reconciling the Provider's APIs into the Kubernetes cluster. -Providers constantly watch the state of the desired managed resources and create +Installing a provider creates new Kubernetes resources representing the +Provider's APIs. Installing a provider also creates a Provider pod that's +responsible for reconciling the Provider's APIs into the Kubernetes cluster. +Providers constantly watch the state of the desired managed resources and create any external resources that are missing. Install a Provider with a Crossplane @@ -45,7 +45,7 @@ location of the provider package. {{< hint "important" >}} Beginning with Crossplane version 1.20.0 Crossplane uses the [crossplane-contrib](https://github.com/orgs/crossplane-contrib/packages) GitHub Container Registry at `xpkg.crossplane.io` by default for downloading and -installing packages. +installing packages. Specify the full domain name with the `package` or change the default Crossplane registry with the `--registry` flag on the [Crossplane pod]({{}}) @@ -67,19 +67,19 @@ By default, the Provider pod installs in the same namespace as Crossplane (`crossplane-system`). {{}} -Providers are part of the -{{}}pkg.crossplane.io{{}} group. +Providers are part of the +{{}}pkg.crossplane.io{{}} group. The {{}}meta.pkg.crossplane.io{{}} -group is for creating Provider packages. +group is for creating Provider packages. Instructions on building Providers are outside of the scope of this -document. -Read the Crossplane contributing +document. +Read the Crossplane contributing [Provider Development Guide](https://github.com/crossplane/crossplane/blob/main/contributing/guide-provider-development.md) for more information. -For information on the specification of Provider packages read the +For information on the specification of Provider packages read the [Crossplane Provider Package specification](https://github.com/crossplane/crossplane/blob/main/contributing/specifications/xpkg.md#provider-package-requirements). ```yaml {label="meta-pkg"} @@ -113,9 +113,9 @@ crossplane-stable/crossplane \ ### Install offline -Installing Crossplane Providers offline requires a local container registry like +Installing Crossplane Providers offline requires a local container registry like [Harbor](https://goharbor.io/) to host Provider packages. Crossplane only -supports installing Provider packages from a container registry. +supports installing Provider packages from a container registry. Crossplane doesn't support installing Provider packages directly from Kubernetes volumes. @@ -123,11 +123,11 @@ volumes. ### Installation options Providers support multiple configuration options to change installation related -settings. +settings. {{}} Crossplane supports installations with image digests instead of tags to get deterministic -and repeatable installations. +and repeatable installations. ```yaml {label="digest"} apiVersion: pkg.crossplane.io/v1 @@ -145,26 +145,26 @@ Use a {{}}packagePullPolicy{{}} to define when Crossplane should download the Provider package to the local Crossplane package cache. -The `packagePullPolicy` options are: +The `packagePullPolicy` options are: * `IfNotPresent` - (**default**) Only download the package if it isn't in the cache. * `Always` - Check for new packages every minute and download any matching package that isn't in the cache. * `Never` - Never download the package. Packages are only installed from the - local package cache. + local package cache. {{}} -The Crossplane +The Crossplane {{}}packagePullPolicy{{}} works -like the Kubernetes container image -[image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy). +like the Kubernetes container image +[image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy). Crossplane supports the use of tags and package digest hashes like -Kubernetes images. +Kubernetes images. {{< /hint >}} -For example, to `Always` download a given Provider package use the +For example, to `Always` download a given Provider package use the {{}}packagePullPolicy: Always{{}} -configuration. +configuration. ```yaml {label="pullpolicy",copy-lines="6"} apiVersion: pkg.crossplane.io/v1 @@ -179,20 +179,20 @@ spec: #### Revision activation policy The `Active` package revision -is the package controller actively reconciling resources. +is the package controller actively reconciling resources. -By default Crossplane sets the most recently installed package revision as +By default Crossplane sets the most recently installed package revision as `Active`. Control the Provider upgrade behavior with a {{}}revisionActivationPolicy{{}}. -The {{}}revisionActivationPolicy{{}} +The {{}}revisionActivationPolicy{{}} options are: * `Automatic` - (**default**) Automatically activate the last installed Provider. * `Manual` - Don't automatically activate a Provider. -For example, to change the upgrade behavior to require manual upgrades, set +For example, to change the upgrade behavior to require manual upgrades, set {{}}revisionActivationPolicy: Manual{{}}. ```yaml {label="revision"} @@ -207,26 +207,26 @@ spec: #### Package revision history limit -When Crossplane installs a different version of the same Provider package -Crossplane creates a new _revision_. +When Crossplane installs a different version of the same Provider package +Crossplane creates a new _revision_. -By default Crossplane maintains one _Inactive_ revision. +By default Crossplane maintains one _Inactive_ revision. {{}} Read the [Provider upgrade](#upgrade-a-provider) section for more information on the use of package revisions. {{< /hint >}} -Change the number of revisions Crossplane maintains with a Provider Package -{{}}revisionHistoryLimit{{}}. +Change the number of revisions Crossplane maintains with a Provider Package +{{}}revisionHistoryLimit{{}}. The {{}}revisionHistoryLimit{{}} -field is an integer. -The default value is `1`. -Disable storing revisions by setting +field is an integer. +The default value is `1`. +Disable storing revisions by setting {{}}revisionHistoryLimit{{}} to `0`. -For example, to change the default setting and store 10 revisions use +For example, to change the default setting and store 10 revisions use {{}}revisionHistoryLimit: 10{{}}. ```yaml {label="revHistoryLimit"} @@ -241,13 +241,13 @@ spec: #### Install a provider from a private registry -Like Kubernetes uses `imagePullSecrets` to -[install images from private registries](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/), +Like Kubernetes uses `imagePullSecrets` to +[install images from private registries](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/), Crossplane uses `packagePullSecrets` to install Provider packages from a private -registry. +registry. Use {{}}packagePullSecrets{{}} to provide a -Kubernetes secret to use for authentication when downloading a Provider package. +Kubernetes secret to use for authentication when downloading a Provider package. {{}} The Kubernetes secret must be in the same namespace as Crossplane. @@ -257,7 +257,7 @@ The {{}}packagePullSecrets{{}} is a list of secrets. For example, to use the secret named -{{}}example-secret{{}} configure a +{{}}example-secret{{}} configure a {{}}packagePullSecrets{{}}. ```yaml {label="pps"} @@ -266,25 +266,25 @@ kind: Provider metadata: name: provider-aws spec: - packagePullSecrets: + packagePullSecrets: - name: example-secret # Removed for brevity ``` {{}} Configured `packagePullSecrets` aren't passed to any Provider package -dependencies. +dependencies. {{< /hint >}} #### Ignore dependencies By default Crossplane installs any [dependencies](#manage-dependencies) listed -in a Provider package. +in a Provider package. -Crossplane can ignore a Provider package's dependencies with +Crossplane can ignore a Provider package's dependencies with {{}}skipDependencyResolution{{}}. -For example, to disable dependency resolution configure +For example, to disable dependency resolution configure {{}}skipDependencyResolution: true{{}}. ```yaml {label="pkgDep"} @@ -308,15 +308,15 @@ installations. Suppose configuration A, which depends on package X with the constraint`>=v0.0.0`, is installed on the control plane. In this case, the package manager installs the latest version of package X, such as `v3.0.0`. Later, you decide to install configuration B, which depends on package X with the constraint `<=v2.0.0`. -Since version `v2.0.0`satisfies both conditions, package X must be downgraded to +Since version `v2.0.0` satisfies both conditions, package X must be downgraded to allow the installation of configuration B which is disabled by default. -For enabling automatic dependency version downgrades, there is a configuration -option as a helm value `packageManager.enableAutomaticDependencyDowngrade=true`. -Downgrading a package can cause unexpected behavior, therefore, this -option is disabled by default. After enabling this option, the package manager will -automatically downgrade a package's dependency version to the maximum valid version -that satisfies the constraints. +Automatic dependency version downgrades is also an alpha feature that can be +enabled with the `--enable-dependency-version-downgrades` flag. Downgrading a +package can cause unexpected behavior, therefore, this option is disabled by +default. After enabling this option, the package manager will automatically +downgrade a package's dependency version to the maximum valid version that +satisfies the constraints. {{}} This configuration requires the `--enable-dependency-version-upgrades` flag. @@ -342,13 +342,13 @@ controllers to reconcile them. A Provider package may require a specific or minimum Crossplane version before installing. By default, Crossplane doesn't install a Provider if the Crossplane -version doesn't meet the required version. +version doesn't meet the required version. -Crossplane can ignore the required version with +Crossplane can ignore the required version with {{}}ignoreCrossplaneConstraints{{}}. For example, to install a Provider package into an unsupported Crossplane -version, configure +version, configure {{}}ignoreCrossplaneConstraints: true{{}}. ```yaml {label="xpVer"} @@ -364,10 +364,10 @@ spec: ### Manage dependencies Providers packages may include dependencies on other packages including -Configurations or other Providers. +Configurations or other Providers. If Crossplane can't meet the dependencies of a Provider package the Provider -reports `HEALTHY` as `False`. +reports `HEALTHY` as `False`. For example, this installation of the Getting Started Configuration is `HEALTHY: False`. @@ -404,9 +404,9 @@ Events: 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 +The {{}}Events{{}} show a {{}}Warning{{}} with a message that the -current version of Crossplane doesn't meet the Configuration package +current version of Crossplane doesn't meet the Configuration package requirements. ## Upgrade a Provider @@ -420,7 +420,7 @@ Crossplane installs the new image and creates a new `ProviderRevision`. The `ProviderRevision` allows Crossplane to store deprecated Provider CRDs without removing them until you decide. -View the `ProviderRevisions` with +View the `ProviderRevisions` with {{}}kubectl get providerrevisions{{}} ```shell {label="getPR",copy-lines="1"} @@ -436,14 +436,14 @@ By default Crossplane keeps a single {{}}Inactive{{}} Provider. Read the [revision history limit](#package-revision-history-limit) section to -change the default value. +change the default value. -Only a single revision of a Provider is +Only a single revision of a Provider is {{}}Active{{}} at a time. ## Remove a Provider -Remove a Provider by deleting the Provider object with +Remove a Provider by deleting the Provider object with `kubectl delete provider`. {{< hint "warning" >}} @@ -495,7 +495,7 @@ The Crossplane community has more ### Provider conditions -Crossplane uses a standard set of `Conditions` for Providers. +Crossplane uses a standard set of `Conditions` for Providers. View the conditions of a provider under their `Status` with `kubectl describe provider`. @@ -622,7 +622,7 @@ Providers have two different types of configurations: an external provider. For example, cloud provider authentication. {{}} -Apply `ControllerConfig` objects to Providers. +Apply `ControllerConfig` objects to Providers. Apply `ProviderConfig` objects to managed resources. {{< /hint >}}