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

remove references to default registry 

The default registry concept/support was removed in v2

Signed-off-by: Jared Watts <jbw976@gmail.com>
This commit is contained in:
Jared Watts 2025-09-02 18:20:32 -07:00
parent 452c634363
commit 6c26dd43fa
No known key found for this signature in database
GPG Key ID: 0467EEAE3B6EC0D2
4 changed files with 32 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
content/master/get-started/install.md
View File

@ -87,7 +87,7 @@ crossplane-rbac-manager-86d9b5cf9f-2vc4s 1/1 Running 0 26m
Crossplane supports customizations at install time by configuring the Helm Crossplane supports customizations at install time by configuring the Helm
chart. chart.
Read [the Helm chart README](https://github.com/crossplane/crossplane/blob/v2/cluster/charts/crossplane/README.md#configuration) Read [the Helm chart README](https://github.com/crossplane/crossplane/blob/v2/cluster/charts/crossplane/README.md#configuration)
to learn what customizations are available. to learn what customizations are available.
Read [the Helm documentation](https://helm.sh/docs/) to learn how to run Helm Read [the Helm documentation](https://helm.sh/docs/) to learn how to run Helm
@ -103,25 +103,17 @@ at the table below.
{{< expand "Feature flags" >}} {{< expand "Feature flags" >}}
{{< table caption="Feature flags" >}} {{< table caption="Feature flags" >}}
| Status | Flag | Description | | Status | Flag | Description |
| --- | --- | --- | |--------|-----------------------------------------|---------------------------------------------------------------------------|
| Beta | `--enable-deployment-runtime-configs` | Enable support for DeploymentRuntimeConfigs. | | Beta | `--enable-deployment-runtime-configs` | Enable support for DeploymentRuntimeConfigs. |
| Beta | `--enable-usages` | Enable support for Usages. | | Beta | `--enable-usages` | Enable support for Usages. |
| Beta | `--enable-realtime-compositions` | Enable support for real time compositions. | | Beta | `--enable-realtime-compositions` | Enable support for real time compositions. |
| Alpha | `--enable-dependency-version-upgrades ` | Enable automatic version upgrades of dependencies when updating packages. | | Alpha | `--enable-dependency-version-upgrades ` | Enable automatic version upgrades of dependencies when updating packages. |
| Alpha | `--enable-function-response-cache` | Enable caching of composition function responses to improve performance. | | Alpha | `--enable-function-response-cache` | Enable caching of composition function responses to improve performance. |
| Alpha | `--enable-signature-verification` | Enable support for package signature verification via ImageConfig API. | | Alpha | `--enable-signature-verification` | Enable support for package signature verification via ImageConfig API. |
{{< /table >}} {{< /table >}}
{{< /expand >}} {{< /expand >}}
Set these flags either in the `values.yaml` file or at install time using the Set these flags either in the `values.yaml` file or at install time using the
`--set` flag, for example: `--set `--set` flag, for example: `--set
args='{"--enable-composition-functions","--enable-composition-webhook-schema-validation"}'`. args='{"--enable-composition-functions","--enable-composition-webhook-schema-validation"}'`.
#### Change the default package registry
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.
Change the default registry location during the Crossplane install with
`--set args='{"--registry=index.docker.io"}'`.

23
content/master/guides/upgrade-crossplane.md
View File

@ -9,7 +9,7 @@ The recommended upgrade method for an existing Crossplane install is to use
## Prerequisites ## Prerequisites
* [Helm](https://helm.sh/docs/intro/install/) version `v3.2.0` or later * [Helm](https://helm.sh/docs/intro/install/) version `v3.2.0` or later
## Add the Crossplane Helm repository ## Add the Crossplane Helm repository
Verify Helm has the Crossplane repository. Verify Helm has the Crossplane repository.
@ -27,35 +27,26 @@ helm repo update
``` ```
{{<hint "important" >}} {{<hint "important" >}}
Upgrading Crossplane without updating the Helm chart installs the last version Upgrading Crossplane without updating the Helm chart installs the last version
available in the locally cached Helm chart. available in the locally cached Helm chart.
{{< /hint >}} {{< /hint >}}
## Upgrade Crossplane ## Upgrade Crossplane
Upgrade Crossplane with `helm upgrade`, providing the Crossplane namespace. Upgrade Crossplane with `helm upgrade`, providing the Crossplane namespace.
By default, Crossplane installs into the `crossplane-system` By default, Crossplane installs into the `crossplane-system`
namespace. namespace.
```shell ```shell
helm upgrade crossplane --namespace crossplane-system crossplane-stable/crossplane helm upgrade crossplane --namespace crossplane-system crossplane-stable/crossplane
``` ```
Helm preserves any arguments or flags originally used when installing Helm preserves any arguments or flags originally used when installing
Crossplane. Crossplane.
Crossplane uses any new default behaviors unless they're changed in the `helm Crossplane uses any new default behaviors unless they're changed in the `helm
upgrade` command. upgrade` command.
For example, in v1.20.0 Crossplane changed the default image registry from Override new defaults by
`index.docker.io` to `xpkg.crossplane.io`. Upgrading Crossplane from a version [customizing the Helm chart]({{<ref "../get-started/install#customize-the-crossplane-helm-chart" >}})
before v1.20.0 updates the default package registry.
Override new defaults by
[customizing the Helm chart]({{<ref "../get-started/install#customize-the-crossplane-helm-chart" >}})
with the upgrade command. with the upgrade command.
For example, to maintain the original image registry use
```shell
helm upgrade crossplane --namespace crossplane-system crossplane-stable/crossplane --set 'args={"--registry=index.docker.io"}'
```

26
content/v2.0/get-started/install.md
View File

@ -87,7 +87,7 @@ crossplane-rbac-manager-86d9b5cf9f-2vc4s 1/1 Running 0 26m
Crossplane supports customizations at install time by configuring the Helm Crossplane supports customizations at install time by configuring the Helm
chart. chart.
Read [the Helm chart README](https://github.com/crossplane/crossplane/blob/v2/cluster/charts/crossplane/README.md#configuration) Read [the Helm chart README](https://github.com/crossplane/crossplane/blob/v2/cluster/charts/crossplane/README.md#configuration)
to learn what customizations are available. to learn what customizations are available.
Read [the Helm documentation](https://helm.sh/docs/) to learn how to run Helm Read [the Helm documentation](https://helm.sh/docs/) to learn how to run Helm
@ -103,25 +103,17 @@ at the table below.
{{< expand "Feature flags" >}} {{< expand "Feature flags" >}}
{{< table caption="Feature flags" >}} {{< table caption="Feature flags" >}}
| Status | Flag | Description | | Status | Flag | Description |
| --- | --- | --- | |--------|-----------------------------------------|---------------------------------------------------------------------------|
| Beta | `--enable-deployment-runtime-configs` | Enable support for DeploymentRuntimeConfigs. | | Beta | `--enable-deployment-runtime-configs` | Enable support for DeploymentRuntimeConfigs. |
| Beta | `--enable-usages` | Enable support for Usages. | | Beta | `--enable-usages` | Enable support for Usages. |
| Beta | `--enable-realtime-compositions` | Enable support for real time compositions. | | Beta | `--enable-realtime-compositions` | Enable support for real time compositions. |
| Alpha | `--enable-dependency-version-upgrades ` | Enable automatic version upgrades of dependencies when updating packages. | | Alpha | `--enable-dependency-version-upgrades ` | Enable automatic version upgrades of dependencies when updating packages. |
| Alpha | `--enable-function-response-cache` | Enable caching of composition function responses to improve performance. | | Alpha | `--enable-function-response-cache` | Enable caching of composition function responses to improve performance. |
| Alpha | `--enable-signature-verification` | Enable support for package signature verification via ImageConfig API. | | Alpha | `--enable-signature-verification` | Enable support for package signature verification via ImageConfig API. |
{{< /table >}} {{< /table >}}
{{< /expand >}} {{< /expand >}}
Set these flags either in the `values.yaml` file or at install time using the Set these flags either in the `values.yaml` file or at install time using the
`--set` flag, for example: `--set `--set` flag, for example: `--set
args='{"--enable-composition-functions","--enable-composition-webhook-schema-validation"}'`. args='{"--enable-composition-functions","--enable-composition-webhook-schema-validation"}'`.
#### Change the default package registry
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.
Change the default registry location during the Crossplane install with
`--set args='{"--registry=index.docker.io"}'`.

23
content/v2.0/guides/upgrade-crossplane.md
View File

@ -9,7 +9,7 @@ The recommended upgrade method for an existing Crossplane install is to use
## Prerequisites ## Prerequisites
* [Helm](https://helm.sh/docs/intro/install/) version `v3.2.0` or later * [Helm](https://helm.sh/docs/intro/install/) version `v3.2.0` or later
## Add the Crossplane Helm repository ## Add the Crossplane Helm repository
Verify Helm has the Crossplane repository. Verify Helm has the Crossplane repository.
@ -27,35 +27,26 @@ helm repo update
``` ```
{{<hint "important" >}} {{<hint "important" >}}
Upgrading Crossplane without updating the Helm chart installs the last version Upgrading Crossplane without updating the Helm chart installs the last version
available in the locally cached Helm chart. available in the locally cached Helm chart.
{{< /hint >}} {{< /hint >}}
## Upgrade Crossplane ## Upgrade Crossplane
Upgrade Crossplane with `helm upgrade`, providing the Crossplane namespace. Upgrade Crossplane with `helm upgrade`, providing the Crossplane namespace.
By default, Crossplane installs into the `crossplane-system` By default, Crossplane installs into the `crossplane-system`
namespace. namespace.
```shell ```shell
helm upgrade crossplane --namespace crossplane-system crossplane-stable/crossplane helm upgrade crossplane --namespace crossplane-system crossplane-stable/crossplane
``` ```
Helm preserves any arguments or flags originally used when installing Helm preserves any arguments or flags originally used when installing
Crossplane. Crossplane.
Crossplane uses any new default behaviors unless they're changed in the `helm Crossplane uses any new default behaviors unless they're changed in the `helm
upgrade` command. upgrade` command.
For example, in v1.20.0 Crossplane changed the default image registry from Override new defaults by
`index.docker.io` to `xpkg.crossplane.io`. Upgrading Crossplane from a version [customizing the Helm chart]({{<ref "../get-started/install#customize-the-crossplane-helm-chart" >}})
before v1.20.0 updates the default package registry.
Override new defaults by
[customizing the Helm chart]({{<ref "../get-started/install#customize-the-crossplane-helm-chart" >}})
with the upgrade command. with the upgrade command.
For example, to maintain the original image registry use
```shell
helm upgrade crossplane --namespace crossplane-system crossplane-stable/crossplane --set 'args={"--registry=index.docker.io"}'
```