Change info on installing packages offline (#733)

Signed-off-by: Pete Lumbis <pete@upbound.io>
This commit is contained in:
Pete Lumbis 2024-03-14 12:21:53 -04:00 committed by GitHub
parent 979aedfe55
commit 5f5bf6fa86
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 63 additions and 159 deletions

View File

@ -78,34 +78,12 @@ crossplane-stable/crossplane \
### Install offline
Crossplane installs packages from a local package cache. By
default the Crossplane package cache is an
[emptyDir volume](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir).
Installing Crossplane packages offline requires a local container registry like
[Harbor](https://goharbor.io/) to host the packages. Crossplane only
supports installing packages from a container registry.
Configure Crossplane to use a
[PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)
to use a storage location containing the Configuration image. Read more about
configuring the Crossplane Pod settings in the
[Crossplane install documentation]({{<ref "../software/install#customize-the-crossplane-helm-chart">}}).
Provide the name of the Configuration's `.xpkg` file and set
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
For example, to install a locally stored version of
Upbound AWS reference platform set the
{{<hover label="offline" line="6">}}package{{</hover>}} to the local filename
and set the Configuration's
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
```yaml {label="offline"}
apiVersion: pkg.crossplane.io/v1
kind: Configuration
metadata:
name: offline-platform-ref-aws
spec:
package: platform-ref-aws
packagePullPolicy: Never
```
Crossplane doesn't support installing packages directly from Kubernetes
volumes.
### Installation options

View File

@ -118,33 +118,12 @@ crossplane-stable/crossplane \
### Install offline
Crossplane installs packages from a local package cache. By
default the Crossplane package cache is an
[emptyDir volume](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir).
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.
Configure Crossplane to use a
[PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)
to use a storage location containing the Provider image. Read more about
configuring the Crossplane Pod settings in the
[Crossplane install documentation]({{<ref "../software/install#customize-the-crossplane-helm-chart">}}).
Provide the name of the Provider's `.xpkg` file and set
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
For example, to install a locally stored version of Provider AWS set the
{{<hover label="offline" line="6">}}package{{</hover>}} to the local filename
and set the Provider's
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
```yaml {label="offline"}
apiVersion: pkg.crossplane.io/v1
kind: Provider
metadata:
name: offline-provider-aws
spec:
package: provider-aws
packagePullPolicy: Never
```
Crossplane doesn't support installing Provider packages directly from Kubernetes
volumes.
### Installation options

View File

@ -12,6 +12,17 @@ removed: 🗑️
moved: 🗺️
-->
## March 14, 2024
### Removed content 🗑️
Removed information on installing Crossplane
[Providers]({{<ref "../concepts/providers#install-offline">}}) and
[Packages]({{<ref "../concepts/packages#install-offline">}}) offline using
the local package cache. Installing via the local package cache isn't intended
to be user facing and the recommended offline install method is with a private
registry.
## February 22, 2024
### Updated content 🏗️

View File

@ -69,34 +69,12 @@ crossplane-stable/crossplane \
### Install offline
Crossplane installs packages from a local package cache. By
default the Crossplane package cache is an
[emptyDir volume](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir).
Installing Crossplane packages offline requires a local container registry like
[Harbor](https://goharbor.io/) to host the packages. Crossplane only
supports installing packages from a container registry.
Configure Crossplane to use a
[PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)
to use a storage location containing the Configuration image. Read more about
configuring the Crossplane Pod settings in the
[Crossplane install documentation]({{<ref "../software/install#customize-the-crossplane-helm-chart">}}).
Provide the name of the Configuration's `.xpkg` file and set
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
For example, to install a locally stored version of
Upbound AWS reference platform set the
{{<hover label="offline" line="6">}}package{{</hover>}} to the local filename
and set the Configuration's
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
```yaml {label="offline"}
apiVersion: pkg.crossplane.io/v1
kind: Configuration
metadata:
name: offline-platform-ref-aws
spec:
package: platform-ref-aws
packagePullPolicy: Never
```
Crossplane doesn't support installing packages directly from Kubernetes
volumes.
### Installation options

View File

@ -109,33 +109,12 @@ crossplane-stable/crossplane \
### Install offline
Crossplane installs packages from a local package cache. By
default the Crossplane package cache is an
[emptyDir volume](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir).
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.
Configure Crossplane to use a
[PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)
to use a storage location containing the Provider image. Read more about
configuring the Crossplane Pod settings in the
[Crossplane install documentation]({{<ref "../software/install#customize-the-crossplane-helm-chart">}}).
Provide the name of the Provider's `.xpkg` file and set
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
For example, to install a locally stored version of Provider AWS set the
{{<hover label="offline" line="6">}}package{{</hover>}} to the local filename
and set the Provider's
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
```yaml {label="offline"}
apiVersion: pkg.crossplane.io/v1
kind: Provider
metadata:
name: offline-provider-aws
spec:
package: provider-aws
packagePullPolicy: Never
```
Crossplane doesn't support installing Provider packages directly from Kubernetes
volumes.
### Installation options

View File

@ -12,6 +12,17 @@ removed: 🗑️
moved: 🗺️
-->
## March 14, 2024
### Removed content 🗑️
Removed information on installing Crossplane
[Providers]({{<ref "../concepts/providers#install-offline">}}) and
[Packages]({{<ref "../concepts/packages#install-offline">}}) offline using
the local package cache. Installing via the local package cache isn't intended
to be user facing and the recommended offline install method is with a private
registry.
## December 1, 2023
### New features 🎉

View File

@ -78,34 +78,12 @@ crossplane-stable/crossplane \
### Install offline
Crossplane installs packages from a local package cache. By
default the Crossplane package cache is an
[emptyDir volume](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir).
Installing Crossplane packages offline requires a local container registry like
[Harbor](https://goharbor.io/) to host the packages. Crossplane only
supports installing packages from a container registry.
Configure Crossplane to use a
[PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)
to use a storage location containing the Configuration image. Read more about
configuring the Crossplane Pod settings in the
[Crossplane install documentation]({{<ref "../software/install#customize-the-crossplane-helm-chart">}}).
Provide the name of the Configuration's `.xpkg` file and set
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
For example, to install a locally stored version of
Upbound AWS reference platform set the
{{<hover label="offline" line="6">}}package{{</hover>}} to the local filename
and set the Configuration's
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
```yaml {label="offline"}
apiVersion: pkg.crossplane.io/v1
kind: Configuration
metadata:
name: offline-platform-ref-aws
spec:
package: platform-ref-aws
packagePullPolicy: Never
```
Crossplane doesn't support installing packages directly from Kubernetes
volumes.
### Installation options

View File

@ -118,33 +118,12 @@ crossplane-stable/crossplane \
### Install offline
Crossplane installs packages from a local package cache. By
default the Crossplane package cache is an
[emptyDir volume](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir).
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.
Configure Crossplane to use a
[PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)
to use a storage location containing the Provider image. Read more about
configuring the Crossplane Pod settings in the
[Crossplane install documentation]({{<ref "../software/install#customize-the-crossplane-helm-chart">}}).
Provide the name of the Provider's `.xpkg` file and set
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
For example, to install a locally stored version of Provider AWS set the
{{<hover label="offline" line="6">}}package{{</hover>}} to the local filename
and set the Provider's
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
```yaml {label="offline"}
apiVersion: pkg.crossplane.io/v1
kind: Provider
metadata:
name: offline-provider-aws
spec:
package: provider-aws
packagePullPolicy: Never
```
Crossplane doesn't support installing Provider packages directly from Kubernetes
volumes.
### Installation options

View File

@ -12,6 +12,17 @@ removed: 🗑️
moved: 🗺️
-->
## March 14, 2024
### Removed content 🗑️
Removed information on installing Crossplane
[Providers]({{<ref "../concepts/providers#install-offline">}}) and
[Packages]({{<ref "../concepts/packages#install-offline">}}) offline using
the local package cache. Installing via the local package cache isn't intended
to be user facing and the recommended offline install method is with a private
registry.
## February 22, 2024
### Updated content 🏗️