Skip to content

Commit 5c5628d

Browse files
jbw976jbw976
authored
Documentation for how to install latest pre-release versions of Crossplane helm chart and CLI (#1009)
* restore crossplane install instructions for master channel Signed-off-by: Jared Watts <jbw976@gmail.com> * Add more guidance for how to install Crossplane CLI from master channel Signed-off-by: Jared Watts <jbw976@gmail.com> --------- Signed-off-by: Jared Watts <jbw976@gmail.com>
1 parent 0b9a3ca commit 5c5628d

File tree

4 files changed

+96
-6
lines changed

4 files changed

+96
-6
lines changed

‎content/master/cli/_index.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,15 @@ the `XP_CHANNEL` and `XP_VERSION` environmental variables.
5858
By default the CLI installs from the `XP_CHANNEL` named `stable` and the
5959
`XP_VERSION` of `current`, matching the most recent stable release.
6060

61-
For example, to install CLI version `v1.14.0` add `XP_VERSION=v1.14.0` to the
61+
For example, to install CLI version `v1.20.0` add `XP_VERSION=v1.20.0` to the
6262
download script curl command:
6363

64-
`curl -sL "https://raw.githubusercontent.com/crossplane/crossplane/main/install.sh" | XP_VERSION=v1.14.0 sh`
64+
```shell
65+
curl -sL "https://raw.githubusercontent.com/crossplane/crossplane/main/install.sh" | XP_VERSION=v1.20.0 sh
66+
```
67+
68+
To install the CLI from the `master` channel add `XP_CHANNEL=master`:
69+
70+
```shell
71+
curl -sL "https://raw.githubusercontent.com/crossplane/crossplane/main/install.sh" | XP_CHANNEL=master sh
72+
```

‎content/master/get-started/install.md‎

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ crossplane-rbac-manager-86d9b5cf9f-2vc4s 1/1 Running 0 26m
8787
Crossplane supports customizations at install time by configuring the Helm
8888
chart.
8989

90-
Read [the Helm chart README](https://github.com/crossplane/crossplane/blob/v2/cluster/charts/crossplane/README.md#configuration)
90+
Read [the Helm chart README](https://github.com/crossplane/crossplane/blob/main/cluster/charts/crossplane/README.md#configuration)
9191
to learn what customizations are available.
9292

9393
Read [the Helm documentation](https://helm.sh/docs/) to learn how to run Helm
@@ -118,6 +118,43 @@ Set these flags either in the `values.yaml` file or at install time using the
118118
`--set` flag, for example: `--set
119119
args='{"--enable-composition-functions","--enable-composition-webhook-schema-validation"}'`.
120120

121+
## Install pre-release Crossplane versions
122+
123+
Install pre-release versions of Crossplane from the `master` Crossplane Helm channel.
124+
125+
Versions in the `master` channel are under active development and may be unstable.
126+
127+
{{< hint "warning" >}}
128+
Don't use Crossplane `master` releases in production. Only use `stable` channel.
129+
Only use `master` for testing and development.
130+
{{< /hint >}}
131+
132+
### Add the Crossplane master Helm repository
133+
134+
Add the Crossplane repository with the `helm repo add` command.
135+
136+
```shell
137+
helm repo add crossplane-master https://charts.crossplane.io/master/
138+
```
139+
140+
Update the
141+
local Helm chart cache with `helm repo update`.
142+
```shell
143+
helm repo update
144+
```
145+
146+
### Install the Crossplane master Helm chart
147+
148+
Install the Crossplane Helm chart from the `master` channel with `helm install`. Use the
149+
`--devel` flag to install the latest pre-release version.
150+
151+
```shell
152+
helm install crossplane \
153+
--namespace crossplane-system \
154+
--create-namespace crossplane-master/crossplane \
155+
--devel
156+
```
157+
121158
## Build and install from source
122159

123160
Building Crossplane from the source code gives you complete control over the build and

‎content/v2.0/cli/_index.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,15 @@ the `XP_CHANNEL` and `XP_VERSION` environmental variables.
5858
By default the CLI installs from the `XP_CHANNEL` named `stable` and the
5959
`XP_VERSION` of `current`, matching the most recent stable release.
6060

61-
For example, to install CLI version `v1.14.0` add `XP_VERSION=v1.14.0` to the
61+
For example, to install CLI version `v1.20.0` add `XP_VERSION=v1.20.0` to the
6262
download script curl command:
6363

64-
`curl -sL "https://raw.githubusercontent.com/crossplane/crossplane/main/install.sh" | XP_VERSION=v1.14.0 sh`
64+
```shell
65+
curl -sL "https://raw.githubusercontent.com/crossplane/crossplane/main/install.sh" | XP_VERSION=v1.20.0 sh
66+
```
67+
68+
To install the CLI from the `master` channel add `XP_CHANNEL=master`:
69+
70+
```shell
71+
curl -sL "https://raw.githubusercontent.com/crossplane/crossplane/main/install.sh" | XP_CHANNEL=master sh
72+
```

‎content/v2.0/get-started/install.md‎

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ crossplane-rbac-manager-86d9b5cf9f-2vc4s 1/1 Running 0 26m
8787
Crossplane supports customizations at install time by configuring the Helm
8888
chart.
8989

90-
Read [the Helm chart README](https://github.com/crossplane/crossplane/blob/v2/cluster/charts/crossplane/README.md#configuration)
90+
Read [the Helm chart README](https://github.com/crossplane/crossplane/blob/main/cluster/charts/crossplane/README.md#configuration)
9191
to learn what customizations are available.
9292

9393
Read [the Helm documentation](https://helm.sh/docs/) to learn how to run Helm
@@ -118,6 +118,43 @@ Set these flags either in the `values.yaml` file or at install time using the
118118
`--set` flag, for example: `--set
119119
args='{"--enable-composition-functions","--enable-composition-webhook-schema-validation"}'`.
120120

121+
## Install pre-release Crossplane versions
122+
123+
Install pre-release versions of Crossplane from the `master` Crossplane Helm channel.
124+
125+
Versions in the `master` channel are under active development and may be unstable.
126+
127+
{{< hint "warning" >}}
128+
Don't use Crossplane `master` releases in production. Only use `stable` channel.
129+
Only use `master` for testing and development.
130+
{{< /hint >}}
131+
132+
### Add the Crossplane master Helm repository
133+
134+
Add the Crossplane repository with the `helm repo add` command.
135+
136+
```shell
137+
helm repo add crossplane-master https://charts.crossplane.io/master/
138+
```
139+
140+
Update the
141+
local Helm chart cache with `helm repo update`.
142+
```shell
143+
helm repo update
144+
```
145+
146+
### Install the Crossplane master Helm chart
147+
148+
Install the Crossplane Helm chart from the `master` channel with `helm install`. Use the
149+
`--devel` flag to install the latest pre-release version.
150+
151+
```shell
152+
helm install crossplane \
153+
--namespace crossplane-system \
154+
--create-namespace crossplane-master/crossplane \
155+
--devel
156+
```
157+
121158
## Build and install from source
122159

123160
Building Crossplane from the source code gives you complete control over the build and

0 commit comments

Comments
 (0)