From 5f5bf6fa86bc2010641bfad1604c6cd3b470e2ae Mon Sep 17 00:00:00 2001 From: Pete Lumbis Date: Thu, 14 Mar 2024 12:21:53 -0400 Subject: [PATCH] Change info on installing packages offline (#733) Signed-off-by: Pete Lumbis --- content/master/concepts/packages.md | 32 +++++----------------------- content/master/concepts/providers.md | 31 +++++---------------------- content/master/release-notes/docs.md | 11 ++++++++++ content/v1.14/concepts/packages.md | 32 +++++----------------------- content/v1.14/concepts/providers.md | 31 +++++---------------------- content/v1.14/release-notes/docs.md | 11 ++++++++++ content/v1.15/concepts/packages.md | 32 +++++----------------------- content/v1.15/concepts/providers.md | 31 +++++---------------------- content/v1.15/release-notes/docs.md | 11 ++++++++++ 9 files changed, 63 insertions(+), 159 deletions(-) diff --git a/content/master/concepts/packages.md b/content/master/concepts/packages.md index e15cff6d..bfe13b02 100644 --- a/content/master/concepts/packages.md +++ b/content/master/concepts/packages.md @@ -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]({{}}). - -Provide the name of the Configuration's `.xpkg` file and set -{{}}packagePullPolicy: Never{{}}. - -For example, to install a locally stored version of -Upbound AWS reference platform set the -{{}}package{{}} to the local filename -and set the Configuration's -{{}}packagePullPolicy: Never{{}}. - -```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 diff --git a/content/master/concepts/providers.md b/content/master/concepts/providers.md index 9cab1584..77b0b544 100644 --- a/content/master/concepts/providers.md +++ b/content/master/concepts/providers.md @@ -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]({{}}). - -Provide the name of the Provider's `.xpkg` file and set -{{}}packagePullPolicy: Never{{}}. - -For example, to install a locally stored version of Provider AWS set the -{{}}package{{}} to the local filename -and set the Provider's -{{}}packagePullPolicy: Never{{}}. - -```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 diff --git a/content/master/release-notes/docs.md b/content/master/release-notes/docs.md index 6dad8793..b241d42f 100644 --- a/content/master/release-notes/docs.md +++ b/content/master/release-notes/docs.md @@ -12,6 +12,17 @@ removed: πŸ—‘οΈ moved: πŸ—ΊοΈ --> +## March 14, 2024 + +### Removed content πŸ—‘οΈ + +Removed information on installing Crossplane +[Providers]({{}}) and +[Packages]({{}}) 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 πŸ—οΈ diff --git a/content/v1.14/concepts/packages.md b/content/v1.14/concepts/packages.md index 3f0cbfb0..0e806bef 100644 --- a/content/v1.14/concepts/packages.md +++ b/content/v1.14/concepts/packages.md @@ -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]({{}}). - -Provide the name of the Configuration's `.xpkg` file and set -{{}}packagePullPolicy: Never{{}}. - -For example, to install a locally stored version of -Upbound AWS reference platform set the -{{}}package{{}} to the local filename -and set the Configuration's -{{}}packagePullPolicy: Never{{}}. - -```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 diff --git a/content/v1.14/concepts/providers.md b/content/v1.14/concepts/providers.md index 1b723ae8..3403968d 100644 --- a/content/v1.14/concepts/providers.md +++ b/content/v1.14/concepts/providers.md @@ -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]({{}}). - -Provide the name of the Provider's `.xpkg` file and set -{{}}packagePullPolicy: Never{{}}. - -For example, to install a locally stored version of Provider AWS set the -{{}}package{{}} to the local filename -and set the Provider's -{{}}packagePullPolicy: Never{{}}. - -```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 diff --git a/content/v1.14/release-notes/docs.md b/content/v1.14/release-notes/docs.md index a58b6719..7f77a876 100644 --- a/content/v1.14/release-notes/docs.md +++ b/content/v1.14/release-notes/docs.md @@ -12,6 +12,17 @@ removed: πŸ—‘οΈ moved: πŸ—ΊοΈ --> +## March 14, 2024 + +### Removed content πŸ—‘οΈ + +Removed information on installing Crossplane +[Providers]({{}}) and +[Packages]({{}}) 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 πŸŽ‰ diff --git a/content/v1.15/concepts/packages.md b/content/v1.15/concepts/packages.md index e15cff6d..bfe13b02 100644 --- a/content/v1.15/concepts/packages.md +++ b/content/v1.15/concepts/packages.md @@ -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]({{}}). - -Provide the name of the Configuration's `.xpkg` file and set -{{}}packagePullPolicy: Never{{}}. - -For example, to install a locally stored version of -Upbound AWS reference platform set the -{{}}package{{}} to the local filename -and set the Configuration's -{{}}packagePullPolicy: Never{{}}. - -```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 diff --git a/content/v1.15/concepts/providers.md b/content/v1.15/concepts/providers.md index 9cab1584..77b0b544 100644 --- a/content/v1.15/concepts/providers.md +++ b/content/v1.15/concepts/providers.md @@ -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]({{}}). - -Provide the name of the Provider's `.xpkg` file and set -{{}}packagePullPolicy: Never{{}}. - -For example, to install a locally stored version of Provider AWS set the -{{}}package{{}} to the local filename -and set the Provider's -{{}}packagePullPolicy: Never{{}}. - -```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 diff --git a/content/v1.15/release-notes/docs.md b/content/v1.15/release-notes/docs.md index 6dad8793..b241d42f 100644 --- a/content/v1.15/release-notes/docs.md +++ b/content/v1.15/release-notes/docs.md @@ -12,6 +12,17 @@ removed: πŸ—‘οΈ moved: πŸ—ΊοΈ --> +## March 14, 2024 + +### Removed content πŸ—‘οΈ + +Removed information on installing Crossplane +[Providers]({{}}) and +[Packages]({{}}) 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 πŸ—οΈ