Skip to content

Commit 5f5bf6f

Browse files
plumbisplumbis
authored
Change info on installing packages offline (#733)
Signed-off-by: Pete Lumbis <[email protected]>
1 parent 979aedf commit 5f5bf6f

File tree

9 files changed

+66
-162
lines changed

9 files changed

+66
-162
lines changed

‎content/master/concepts/packages.md

Lines changed: 6 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -78,34 +78,12 @@ crossplane-stable/crossplane \
7878

7979
### Install offline
8080

81-
Crossplane installs packages from a local package cache. By
82-
default the Crossplane package cache is an
83-
[emptyDir volume](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir).
84-
85-
Configure Crossplane to use a
86-
[PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)
87-
to use a storage location containing the Configuration image. Read more about
88-
configuring the Crossplane Pod settings in the
89-
[Crossplane install documentation]({{<ref "../software/install#customize-the-crossplane-helm-chart">}}).
90-
91-
Provide the name of the Configuration's `.xpkg` file and set
92-
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
93-
94-
For example, to install a locally stored version of
95-
Upbound AWS reference platform set the
96-
{{<hover label="offline" line="6">}}package{{</hover>}} to the local filename
97-
and set the Configuration's
98-
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
99-
100-
```yaml {label="offline"}
101-
apiVersion: pkg.crossplane.io/v1
102-
kind: Configuration
103-
metadata:
104-
name: offline-platform-ref-aws
105-
spec:
106-
package: platform-ref-aws
107-
packagePullPolicy: Never
108-
```
81+
Installing Crossplane packages offline requires a local container registry like
82+
[Harbor](https://goharbor.io/) to host the packages. Crossplane only
83+
supports installing packages from a container registry.
84+
85+
Crossplane doesn't support installing packages directly from Kubernetes
86+
volumes.
10987

11088
### Installation options
11189

‎content/master/concepts/providers.md

Lines changed: 5 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -118,33 +118,12 @@ crossplane-stable/crossplane \
118118

119119
### Install offline
120120

121-
Crossplane installs packages from a local package cache. By
122-
default the Crossplane package cache is an
123-
[emptyDir volume](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir).
121+
Installing Crossplane Providers offline requires a local container registry like
122+
[Harbor](https://goharbor.io/) to host Provider packages. Crossplane only
123+
supports installing Provider packages from a container registry.
124124

125-
Configure Crossplane to use a
126-
[PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)
127-
to use a storage location containing the Provider image. Read more about
128-
configuring the Crossplane Pod settings in the
129-
[Crossplane install documentation]({{<ref "../software/install#customize-the-crossplane-helm-chart">}}).
130-
131-
Provide the name of the Provider's `.xpkg` file and set
132-
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
133-
134-
For example, to install a locally stored version of Provider AWS set the
135-
{{<hover label="offline" line="6">}}package{{</hover>}} to the local filename
136-
and set the Provider's
137-
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
138-
139-
```yaml {label="offline"}
140-
apiVersion: pkg.crossplane.io/v1
141-
kind: Provider
142-
metadata:
143-
name: offline-provider-aws
144-
spec:
145-
package: provider-aws
146-
packagePullPolicy: Never
147-
```
125+
Crossplane doesn't support installing Provider packages directly from Kubernetes
126+
volumes.
148127

149128
### Installation options
150129

‎content/master/release-notes/docs.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,17 @@ removed: 🗑️
1212
moved: 🗺️
1313
-->
1414

15+
## March 14, 2024
16+
17+
### Removed content 🗑️
18+
19+
Removed information on installing Crossplane
20+
[Providers]({{<ref "../concepts/providers#install-offline">}}) and
21+
[Packages]({{<ref "../concepts/packages#install-offline">}}) offline using
22+
the local package cache. Installing via the local package cache isn't intended
23+
to be user facing and the recommended offline install method is with a private
24+
registry.
25+
1526
## February 22, 2024
1627

1728
### Updated content 🏗️

‎content/v1.14/concepts/packages.md

Lines changed: 6 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -69,34 +69,12 @@ crossplane-stable/crossplane \
6969

7070
### Install offline
7171

72-
Crossplane installs packages from a local package cache. By
73-
default the Crossplane package cache is an
74-
[emptyDir volume](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir).
75-
76-
Configure Crossplane to use a
77-
[PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)
78-
to use a storage location containing the Configuration image. Read more about
79-
configuring the Crossplane Pod settings in the
80-
[Crossplane install documentation]({{<ref "../software/install#customize-the-crossplane-helm-chart">}}).
81-
82-
Provide the name of the Configuration's `.xpkg` file and set
83-
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
84-
85-
For example, to install a locally stored version of
86-
Upbound AWS reference platform set the
87-
{{<hover label="offline" line="6">}}package{{</hover>}} to the local filename
88-
and set the Configuration's
89-
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
90-
91-
```yaml {label="offline"}
92-
apiVersion: pkg.crossplane.io/v1
93-
kind: Configuration
94-
metadata:
95-
name: offline-platform-ref-aws
96-
spec:
97-
package: platform-ref-aws
98-
packagePullPolicy: Never
99-
```
72+
Installing Crossplane packages offline requires a local container registry like
73+
[Harbor](https://goharbor.io/) to host the packages. Crossplane only
74+
supports installing packages from a container registry.
75+
76+
Crossplane doesn't support installing packages directly from Kubernetes
77+
volumes.
10078

10179
### Installation options
10280

‎content/v1.14/concepts/providers.md

Lines changed: 5 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -109,33 +109,12 @@ crossplane-stable/crossplane \
109109

110110
### Install offline
111111

112-
Crossplane installs packages from a local package cache. By
113-
default the Crossplane package cache is an
114-
[emptyDir volume](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir).
112+
Installing Crossplane Providers offline requires a local container registry like
113+
[Harbor](https://goharbor.io/) to host Provider packages. Crossplane only
114+
supports installing Provider packages from a container registry.
115115

116-
Configure Crossplane to use a
117-
[PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)
118-
to use a storage location containing the Provider image. Read more about
119-
configuring the Crossplane Pod settings in the
120-
[Crossplane install documentation]({{<ref "../software/install#customize-the-crossplane-helm-chart">}}).
121-
122-
Provide the name of the Provider's `.xpkg` file and set
123-
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
124-
125-
For example, to install a locally stored version of Provider AWS set the
126-
{{<hover label="offline" line="6">}}package{{</hover>}} to the local filename
127-
and set the Provider's
128-
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
129-
130-
```yaml {label="offline"}
131-
apiVersion: pkg.crossplane.io/v1
132-
kind: Provider
133-
metadata:
134-
name: offline-provider-aws
135-
spec:
136-
package: provider-aws
137-
packagePullPolicy: Never
138-
```
116+
Crossplane doesn't support installing Provider packages directly from Kubernetes
117+
volumes.
139118

140119
### Installation options
141120

‎content/v1.14/release-notes/docs.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,17 @@ removed: 🗑️
1212
moved: 🗺️
1313
-->
1414

15+
## March 14, 2024
16+
17+
### Removed content 🗑️
18+
19+
Removed information on installing Crossplane
20+
[Providers]({{<ref "../concepts/providers#install-offline">}}) and
21+
[Packages]({{<ref "../concepts/packages#install-offline">}}) offline using
22+
the local package cache. Installing via the local package cache isn't intended
23+
to be user facing and the recommended offline install method is with a private
24+
registry.
25+
1526
## December 1, 2023
1627

1728
### New features 🎉

‎content/v1.15/concepts/packages.md

Lines changed: 6 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -78,34 +78,12 @@ crossplane-stable/crossplane \
7878

7979
### Install offline
8080

81-
Crossplane installs packages from a local package cache. By
82-
default the Crossplane package cache is an
83-
[emptyDir volume](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir).
84-
85-
Configure Crossplane to use a
86-
[PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)
87-
to use a storage location containing the Configuration image. Read more about
88-
configuring the Crossplane Pod settings in the
89-
[Crossplane install documentation]({{<ref "../software/install#customize-the-crossplane-helm-chart">}}).
90-
91-
Provide the name of the Configuration's `.xpkg` file and set
92-
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
93-
94-
For example, to install a locally stored version of
95-
Upbound AWS reference platform set the
96-
{{<hover label="offline" line="6">}}package{{</hover>}} to the local filename
97-
and set the Configuration's
98-
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
99-
100-
```yaml {label="offline"}
101-
apiVersion: pkg.crossplane.io/v1
102-
kind: Configuration
103-
metadata:
104-
name: offline-platform-ref-aws
105-
spec:
106-
package: platform-ref-aws
107-
packagePullPolicy: Never
108-
```
81+
Installing Crossplane packages offline requires a local container registry like
82+
[Harbor](https://goharbor.io/) to host the packages. Crossplane only
83+
supports installing packages from a container registry.
84+
85+
Crossplane doesn't support installing packages directly from Kubernetes
86+
volumes.
10987

11088
### Installation options
11189

‎content/v1.15/concepts/providers.md

Lines changed: 5 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -118,33 +118,12 @@ crossplane-stable/crossplane \
118118

119119
### Install offline
120120

121-
Crossplane installs packages from a local package cache. By
122-
default the Crossplane package cache is an
123-
[emptyDir volume](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir).
121+
Installing Crossplane Providers offline requires a local container registry like
122+
[Harbor](https://goharbor.io/) to host Provider packages. Crossplane only
123+
supports installing Provider packages from a container registry.
124124

125-
Configure Crossplane to use a
126-
[PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)
127-
to use a storage location containing the Provider image. Read more about
128-
configuring the Crossplane Pod settings in the
129-
[Crossplane install documentation]({{<ref "../software/install#customize-the-crossplane-helm-chart">}}).
130-
131-
Provide the name of the Provider's `.xpkg` file and set
132-
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
133-
134-
For example, to install a locally stored version of Provider AWS set the
135-
{{<hover label="offline" line="6">}}package{{</hover>}} to the local filename
136-
and set the Provider's
137-
{{<hover label="offline" line="7">}}packagePullPolicy: Never{{</hover>}}.
138-
139-
```yaml {label="offline"}
140-
apiVersion: pkg.crossplane.io/v1
141-
kind: Provider
142-
metadata:
143-
name: offline-provider-aws
144-
spec:
145-
package: provider-aws
146-
packagePullPolicy: Never
147-
```
125+
Crossplane doesn't support installing Provider packages directly from Kubernetes
126+
volumes.
148127

149128
### Installation options
150129

‎content/v1.15/release-notes/docs.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,17 @@ removed: 🗑️
1212
moved: 🗺️
1313
-->
1414

15+
## March 14, 2024
16+
17+
### Removed content 🗑️
18+
19+
Removed information on installing Crossplane
20+
[Providers]({{<ref "../concepts/providers#install-offline">}}) and
21+
[Packages]({{<ref "../concepts/packages#install-offline">}}) offline using
22+
the local package cache. Installing via the local package cache isn't intended
23+
to be user facing and the recommended offline install method is with a private
24+
registry.
25+
1526
## February 22, 2024
1627

1728
### Updated content 🏗️

0 commit comments

Comments
 (0)