Skip to content

Commit ad7f75a

Browse files
authored
Merge pull request #959 from negz/plus-one
Update content/master to use v2 stable instead of preview
2 parents 704d5df + 3235c9f commit ad7f75a

File tree

10 files changed

+216
-178
lines changed

10 files changed

+216
-178
lines changed

content/master/cli/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ To download the latest version for your CPU architecture with the Crossplane
2727
install script.
2828

2929
```shell
30-
curl -sL "https://raw.githubusercontent.com/crossplane/crossplane/main/install.sh" | XP_CHANNEL=preview sh
30+
curl -sL "https://raw.githubusercontent.com/crossplane/crossplane/main/install.sh" | sh
3131
```
3232

3333
[The script](https://raw.githubusercontent.com/crossplane/crossplane/main/install.sh)

content/master/composition/composite-resource-definitions.md

Lines changed: 154 additions & 117 deletions
Large diffs are not rendered by default.

content/master/composition/composition-revisions.md

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ database configuration of an Azure MySQL Server and some firewall rules. The
1616
`Composition` contains the 'base' configuration for the MySQL server and the
1717
firewall rules that the `PlatformDB` configuration extends.
1818

19-
A `Composition` associates with multiple XRs that use it. You might
20-
define a `Composition` named `big-platform-db` that's used by ten different
21-
`PlatformDB` XRs. Often, in the interest of self-service, a different team manages the `Composition`
22-
than the actual `PlatformDB` XRs. For example
19+
A `Composition` associates with multiple XRs that use it. You might
20+
define a `Composition` named `big-platform-db` that's used by ten different
21+
`PlatformDB` XRs. Often, in the interest of self-service, a different team manages the `Composition`
22+
than the actual `PlatformDB` XRs. For example
2323
a platform team member may write and maintain the `Composition`,
2424
while individual app teams create `PlatformDB` XRs that use said
2525
`Composition`.
@@ -88,6 +88,7 @@ manually update it when you wish it to use another `CompositionRevision`.
8888
apiVersion: example.org/v1alpha1
8989
kind: PlatformDB
9090
metadata:
91+
namespace: default
9192
name: example
9293
spec:
9394
storageGB: 20
@@ -108,6 +109,7 @@ use a different `CompositionRevision`.
108109
apiVersion: example.org/v1alpha1
109110
kind: PlatformDB
110111
metadata:
112+
namespace: default
111113
name: example
112114
spec:
113115
storageGB: 20
@@ -125,9 +127,9 @@ spec:
125127
This tutorial discusses how CompositionRevisions work and how they manage Composite Resource
126128
(XR) updates. This starts with a `Composition` and `CompositeResourceDefinition` (XRD) that defines a `MyVPC`
127129
resource and continues with creating multiple XRs to observe different upgrade paths. Crossplane
128-
assigns different CompositionRevisions to composite resources each time you update the composition.
130+
assigns different CompositionRevisions to composite resources each time you update the composition.
129131

130-
### Preparation
132+
### Preparation
131133

132134
#### Deploy composition and XRD examples
133135
Apply the example Composition.
@@ -177,18 +179,18 @@ spec:
177179
plural: myvpcs
178180
versions:
179181
- name: v1alpha1
180-
served: true
181-
referenceable: true
182+
served: true
183+
referenceable: true
182184
schema:
183185
openAPIV3Schema:
184-
type: object
186+
type: object
185187
properties:
186188
spec:
187-
type: object
189+
type: object
188190
properties:
189191
id:
190-
type: string
191-
description: ID of this VPC that other objects will use to refer to it.
192+
type: string
193+
description: ID of this VPC that other objects will use to refer to it.
192194
required:
193195
- id
194196
```
@@ -228,7 +230,7 @@ spec:
228230
Expected Output:
229231
```shell
230232
myvpc.aws.example.upbound.io/vpc-auto created
231-
```
233+
```
232234

233235
#### Manual update policy
234236
Create a Composite Resource with `compositionUpdatePolicy: Manual` and `compositionRevisionRef`.
@@ -249,7 +251,7 @@ spec:
249251
Expected Output:
250252
```shell
251253
myvpc.aws.example.upbound.io/vpc-man created
252-
```
254+
```
253255

254256
#### Using a selector
255257
Create an XR with a `compositionRevisionSelector` of `channel: dev`:
@@ -269,7 +271,7 @@ spec:
269271
Expected Output:
270272
```shell
271273
myvpc.aws.example.upbound.io/vpc-dev created
272-
```
274+
```
273275

274276
Create an XR with a `compositionRevisionSelector` of `channel: staging`:
275277
```yaml
@@ -289,9 +291,9 @@ spec:
289291
Expected Output:
290292
```shell
291293
myvpc.aws.example.upbound.io/vpc-staging created
292-
```
294+
```
293295

294-
Verify the Composite Resource with the label `channel: staging` doesn't have a `REVISION`.
296+
Verify the Composite Resource with the label `channel: staging` doesn't have a `REVISION`.
295297
All other XRs have a `REVISION` matching the created Composition Revision.
296298
```shell
297299
kubectl get composite -o="custom-columns=NAME:.metadata.name,SYNCED:.status.conditions[0].status,REVISION:.spec.crossplane.compositionRevisionRef.name,POLICY:.spec.crossplane.compositionUpdatePolicy,MATCHLABEL:.spec.crossplane.compositionRevisionSelector.matchLabels"
@@ -303,15 +305,15 @@ vpc-auto True myvpcs.aws.example.upbound.io-ad265bc Automatic <none
303305
vpc-dev True myvpcs.aws.example.upbound.io-ad265bc Automatic map[channel:dev]
304306
vpc-man True myvpcs.aws.example.upbound.io-ad265bc Manual <none>
305307
vpc-staging False <none> Automatic map[channel:staging]
306-
```
308+
```
307309

308310
{{< hint "note" >}}
309311
The `vpc-staging` XR label doesn't match any existing Composition Revisions.
310312
{{< /hint >}}
311313

312314
### Create new composition revisions
313315
Crossplane creates a new CompositionRevision when you create or update a Composition. Label and annotation changes
314-
also trigger a new CompositionRevision.
316+
also trigger a new CompositionRevision.
315317

316318
#### Update the composition label
317319
Update the `Composition` label to `channel: staging`:
@@ -321,7 +323,7 @@ kubectl label composition myvpcs.aws.example.upbound.io channel=staging --overwr
321323
Expected Output:
322324
```shell
323325
composition.apiextensions.crossplane.io/myvpcs.aws.example.upbound.io labeled
324-
```
326+
```
325327

326328
Verify that Crossplane creates a new Composition revision:
327329
```shell
@@ -332,9 +334,9 @@ Expected Output:
332334
NAME REVISION CHANNEL
333335
myvpcs.aws.example.upbound.io-727b3c8 2 staging
334336
myvpcs.aws.example.upbound.io-ad265bc 1 dev
335-
```
337+
```
336338

337-
Verify that Crossplane assigns the Composite Resources `vpc-auto` and `vpc-staging` to Composite `revision:2`.
339+
Verify that Crossplane assigns the Composite Resources `vpc-auto` and `vpc-staging` to Composite `revision:2`.
338340
XRs `vpc-man` and `vpc-dev` are still assigned to the original `revision:1`:
339341

340342
```shell
@@ -347,10 +349,10 @@ vpc-auto True myvpcs.aws.example.upbound.io-727b3c8 Automatic <none
347349
vpc-dev True myvpcs.aws.example.upbound.io-ad265bc Automatic map[channel:dev]
348350
vpc-man True myvpcs.aws.example.upbound.io-ad265bc Manual <none>
349351
vpc-staging True myvpcs.aws.example.upbound.io-727b3c8 Automatic map[channel:staging]
350-
```
352+
```
351353

352354
{{< hint "note" >}}
353-
`vpc-auto` always use the latest Revision.
355+
`vpc-auto` always use the latest Revision.
354356
`vpc-staging` now matches the label applied to Revision `revision:2`.
355357
{{< /hint >}}
356358

@@ -393,7 +395,7 @@ spec:
393395
Expected Output:
394396
```shell
395397
composition.apiextensions.crossplane.io/myvpcs.aws.example.upbound.io configured
396-
```
398+
```
397399

398400
Verify that Crossplane creates a new Composition revision:
399401

@@ -406,13 +408,13 @@ NAME REVISION CHANNEL
406408
myvpcs.aws.example.upbound.io-727b3c8 2 staging
407409
myvpcs.aws.example.upbound.io-ad265bc 1 dev
408410
myvpcs.aws.example.upbound.io-f81c553 3 dev
409-
```
411+
```
410412

411413
{{< hint "note" >}}
412414
Changing the label and the spec values simultaneously is critical for deploying new changes to the `dev` channel.
413415
{{< /hint >}}
414416

415-
Verify Crossplane assigns the Composite Resources `vpc-auto` and `vpc-dev` to Composite `revision:3`.
417+
Verify Crossplane assigns the Composite Resources `vpc-auto` and `vpc-dev` to Composite `revision:3`.
416418
Crossplane assigns `vpc-staging` to `revision:2`, and still assigns `vpc-man` to the original `revision:1`:
417419

418420
```shell
@@ -425,7 +427,7 @@ vpc-auto True myvpcs.aws.example.upbound.io-f81c553 Automatic <none
425427
vpc-dev True myvpcs.aws.example.upbound.io-f81c553 Automatic map[channel:dev]
426428
vpc-man True myvpcs.aws.example.upbound.io-ad265bc Manual <none>
427429
vpc-staging True myvpcs.aws.example.upbound.io-727b3c8 Automatic map[channel:staging]
428-
```
430+
```
429431

430432

431433
{{< hint "note" >}}

content/master/get-started/get-started-with-composition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ that supports REST APIs to work with apps.
8989
This guide requires:
9090

9191
* A Kubernetes cluster with at least 2 GB of RAM
92-
* The Crossplane v2 preview [installed on the Kubernetes cluster]({{<ref "install">}})
92+
* Crossplane v2 [installed on the Kubernetes cluster]({{<ref "install">}})
9393

9494
## Create the custom resource
9595

content/master/get-started/get-started-with-managed-resources.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,16 @@ Kubernetes calls third party API resources _custom resources_.
3232
This guide requires:
3333
3434
* A Kubernetes cluster with at least 2 GB of RAM
35-
* The Crossplane v2 preview [installed on the Kubernetes cluster]({{<ref "install">}})
35+
* Crossplane v2 [installed on the Kubernetes cluster]({{<ref "install">}})
3636
* An AWS account with permissions to create an S3 storage bucket
3737
* AWS [access keys](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html#cli-configure-quickstart-creds)
3838
3939
{{<hint "note">}}
40-
Only AWS managed resources support the Crossplane v2 preview.
40+
AWS managed resources fully support Crossplane v2.
4141
4242
<!-- vale gitlab.FutureTense = NO -->
43-
Maintainers will update the managed resources for other systems including Azure,
44-
GCP, Terraform, Helm, GitHub, etc to support Crossplane v2 soon.
43+
Maintainers are actively working to update managed resources for other systems including Azure,
44+
GCP, Terraform, Helm, GitHub, etc to support Crossplane v2.
4545
<!-- vale gitlab.FutureTense = YES -->
4646
{{</hint>}}
4747
@@ -69,7 +69,7 @@ kind: Provider
6969
metadata:
7070
name: crossplane-contrib-provider-aws-s3
7171
spec:
72-
package: xpkg.crossplane.io/crossplane-contrib/provider-aws-s3:v1.24.0-crossplane-v2-preview.0
72+
package: xpkg.crossplane.io/crossplane-contrib/provider-aws-s3:v2.0.0
7373
```
7474

7575
Save this as `provider.yaml` and apply it:
@@ -83,8 +83,8 @@ Check that Crossplane installed the provider:
8383
```shell {copy-lines="1",label="getProvider"}
8484
kubectl get providers
8585
NAME INSTALLED HEALTHY PACKAGE AGE
86-
crossplane-contrib-provider-family-aws True True xpkg.crossplane.io/crossplane-contrib/provider-family-aws:v1.24.0-crossplane-v2-preview.0 27s
87-
crossplane-contrib-provider-aws-s3 True True xpkg.crossplane.io/crossplane-contrib/provider-aws-s3:v1.24.0-crossplane-v2-preview.0 31s
86+
crossplane-contrib-provider-family-aws True True xpkg.crossplane.io/crossplane-contrib/provider-family-aws:v2.0.0 27s
87+
crossplane-contrib-provider-aws-s3 True True xpkg.crossplane.io/crossplane-contrib/provider-aws-s3:v2.0.0 31s
8888
```
8989

9090
{{<hint "note">}}

content/master/get-started/install.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ Install Crossplane using the _Helm chart_.
2828

2929
<!-- vale Google.Headings = NO -->
3030
<!-- vale Microsoft.Headings = NO -->
31-
### Add the Crossplane Preview Helm repository
31+
### Add the Crossplane Helm repository
3232
<!-- vale Google.Headings = YES -->
3333
<!-- vale Microsoft.Headings = YES -->
3434

35-
Add the Crossplane preview repository with the `helm repo add` command.
35+
Add the Crossplane stable repository with the `helm repo add` command.
3636

3737
```shell
38-
helm repo add crossplane-preview https://charts.crossplane.io/preview
38+
helm repo add crossplane-stable https://charts.crossplane.io/stable
3939
```
4040

4141
Update the
@@ -46,11 +46,11 @@ helm repo update
4646

4747
<!-- vale Google.Headings = NO -->
4848
<!-- vale Microsoft.Headings = NO -->
49-
### Install the Crossplane Preview Helm chart
49+
### Install the Crossplane Helm chart
5050
<!-- vale Google.Headings = YES -->
5151
<!-- vale Microsoft.Headings = YES -->
5252

53-
Install the Crossplane Preview Helm chart with `helm install`.
53+
Install the Crossplane Helm chart with `helm install`.
5454

5555
{{< hint "tip" >}}
5656
View the changes Crossplane makes to your cluster with the
@@ -63,8 +63,7 @@ Crossplane creates and installs into the `crossplane-system` namespace.
6363
```shell
6464
helm install crossplane \
6565
--namespace crossplane-system \
66-
--create-namespace crossplane-preview/crossplane \
67-
--version v2.0.0-preview.1
66+
--create-namespace crossplane-stable/crossplane
6867
```
6968

7069
View the installed Crossplane pods with `kubectl get pods -n crossplane-system`.

content/master/guides/upgrade-crossplane.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ The recommended upgrade method for an existing Crossplane install is to use
1010
* [Helm](https://helm.sh/docs/intro/install/) version `v3.2.0` or later
1111

1212

13-
## Add the Crossplane Preview Helm repository
13+
## Add the Crossplane Helm repository
1414
Verify Helm has the Crossplane repository.
1515

1616
```shell
17-
helm repo add crossplane-preview https://charts.crossplane.io/preview
17+
helm repo add crossplane-stable https://charts.crossplane.io/stable
1818
```
1919

20-
## Update the Helm Preview repository
20+
## Update the Helm repository
2121

2222
Update the local Crossplane Helm chart with `helm repo update`.
2323

@@ -37,7 +37,7 @@ By default, Crossplane installs into the `crossplane-system`
3737
namespace.
3838

3939
```shell
40-
helm upgrade crossplane --namespace crossplane-system crossplane-preview/crossplane --devel
40+
helm upgrade crossplane --namespace crossplane-system crossplane-stable/crossplane
4141
```
4242

4343
Helm preserves any arguments or flags originally used when installing
@@ -56,5 +56,5 @@ with the upgrade command.
5656

5757
For example, to maintain the original image registry use
5858
```shell
59-
helm upgrade crossplane --namespace crossplane-system crossplane-preview/crossplane --set 'args={"--registry=index.docker.io"}'
59+
helm upgrade crossplane --namespace crossplane-system crossplane-stable/crossplane --set 'args={"--registry=index.docker.io"}'
6060
```

content/master/managed-resources/managed-resources.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ Examples of managed resources include:
2020
* Microsoft Azure PostgreSQL `Database` defined in [provider-upjet-azure](https://github.com/crossplane-contrib/provider-upjet-azure).
2121

2222
{{<hint "important">}}
23-
Only AWS managed resources support the Crossplane v2 preview.
23+
AWS managed resources fully support Crossplane v2.
2424

2525
<!-- vale gitlab.FutureTense = NO -->
26-
Maintainers will update the managed resources for other systems including Azure,
27-
GCP, Terraform, Helm, GitHub, etc to support Crossplane v2 soon.
26+
Maintainers are actively working to update managed resources for other systems including Azure,
27+
GCP, Terraform, Helm, GitHub, etc to support Crossplane v2.
2828
<!-- vale gitlab.FutureTense = YES -->
2929
{{</hint>}}
3030

@@ -419,7 +419,7 @@ For example, when creating an AWS RDS database instance with the Crossplane
419419
[community AWS provider](https://github.com/crossplane-contrib/provider-aws)
420420
generates an endpoint, password, port and username data. The Provider saves
421421
these variables in the Kubernetes secret
422-
{{<hover label="secretname" line="9" >}}rds-secret{{</hover>}}, referenced by
422+
{{<hover label="secretname" line="10" >}}rds-secret{{</hover>}}, referenced by
423423
the
424424
{{<hover label="secretname" line="9" >}}writeConnectionSecretToRef{{</hover>}}
425425
field.
@@ -428,6 +428,7 @@ field.
428428
apiVersion: database.aws.m.crossplane.io/v1beta1
429429
kind: RDSInstance
430430
metadata:
431+
namespace: default
431432
name: my-rds-instance
432433
spec:
433434
forProvider:

content/master/whats-crossplane/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -216,11 +216,11 @@ Follow [Get Started with Managed Resources]({{<ref "../get-started/get-started-w
216216
to see how managed resources work.
217217

218218
{{<hint "note">}}
219-
Only AWS managed resources support the Crossplane v2 preview.
219+
AWS managed resources fully support Crossplane v2.
220220

221221
<!-- vale gitlab.FutureTense = NO -->
222-
Maintainers will update the managed resources for other systems including Azure,
223-
GCP, Terraform, Helm, GitHub, etc to support Crossplane v2 soon.
222+
Maintainers are actively working to update managed resources for other systems including Azure,
223+
GCP, Terraform, Helm, GitHub, etc to support Crossplane v2.
224224
<!-- vale gitlab.FutureTense = YES -->
225225
{{</hint>}}
226226

content/master/whats-new/_index.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: What's New in v2?
33
weight: 4
4-
description: Learn what's new in the Crossplane v2 preview
4+
description: Learn what's new in Crossplane v2
55
---
66
**Crossplane v2 makes Crossplane more useful, more intuitive, and less
77
opinionated.**
@@ -151,12 +151,11 @@ opinionated about using composition and MRs together. Namespaces enable fine
151151
grained access control over who can create what MRs.
152152

153153
{{<hint "note">}}
154-
During the Crossplane v2 preview only namespaced AWS managed resources are
155-
available.
154+
Namespaced AWS managed resources are fully available in Crossplane v2.
156155

157156
<!-- vale gitlab.FutureTense = NO -->
158-
Maintainers will update the managed resources for other systems including Azure,
159-
GCP, Terraform, Helm, GitHub, etc to support namespaced MRs soon.
157+
Maintainers are actively working to update managed resources for other systems including Azure,
158+
GCP, Terraform, Helm, GitHub, etc to support namespaced MRs.
160159
<!-- vale gitlab.FutureTense = YES -->
161160
{{</hint>}}
162161

0 commit comments

Comments
 (0)