Skip to content

Commit b699f5f

Browse files
authored
Merge branch 'crossplane:master' into master
2 parents eaaafd2 + 31e10ec commit b699f5f

File tree

155 files changed

+8057
-8082
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

155 files changed

+8057
-8082
lines changed

config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ security:
9090
# Global parameters accessible by any Page
9191
params:
9292
# The current "latest" version. Used in the version dropdown
93-
latest: "1.18"
93+
latest: "1.19"
9494
docs: true
9595
anchors:
9696
# Generate heading anchors for any heading between min and max

content/contribute/features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ without using the
195195

196196
For example,
197197
```markdown
198-
[Go to Upbound](http://upbound.io)
198+
[Go to Crossplane](http://crossplane.io)
199199
```
200200

201201
## Tables

content/master/cli/command-reference.md

Lines changed: 12 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -240,9 +240,6 @@ For example,
240240

241241
Include YAML files demonstrating how to use the package with `--examples-root`.
242242

243-
[Upbound Marketplace](https://marketplace.upbound.io/) uses files included with
244-
`--examples-root` as documentation for published packages.
245-
246243
#### Include a runtime image
247244

248245
Functions and Providers require YAML files describing their dependencies and
@@ -326,9 +323,9 @@ inside Crossplane.
326323
The `<package-kind>` is either a `configuration`, `function` or `provider`.
327324

328325
For example, to install the latest version of the
329-
[AWS S3 provider](https://marketplace.upbound.io/providers/upbound/provider-aws-s3/):
326+
[AWS S3 provider](https://github.com/crossplane-contrib/provider-upjet-aws):
330327

331-
`crossplane xpkg install provider xpkg.upbound.io/upbound/provider-aws-s3:v1`
328+
`crossplane xpkg install provider xpkg.crossplane.io/crossplane-contrib/provider-aws-s3:v1.20.1`
332329

333330
#### Flags
334331
{{< table "table table-sm table-striped">}}
@@ -380,11 +377,7 @@ in the package documentation.
380377

381378
### xpkg login
382379

383-
Use `xpkg login` to authenticate to `xpkg.upbound.io`, the
384-
[Upbound Marketplace](https://marketplace.upbound.io/) container registry.
385-
386-
[Register with the Upbound Marketplace](https://accounts.upbound.io/register)
387-
to push packages and create private repositories.
380+
Use `xpkg login` to authenticate to registries that host Crossplane packages.
388381

389382
#### Flags
390383

@@ -451,10 +444,6 @@ Using `crossplane xpkg logout` removes the `session` from the
451444

452445
Push a Crossplane package file to a package registry.
453446

454-
The Crossplane CLI pushes images to the
455-
[Upbound Marketplace](https://marketplace.upbound.io/) at `xpkg.upbound.io` by
456-
default.
457-
458447
{{< hint "note" >}}
459448
Pushing a package may require authentication with
460449
[`crossplane xpkg login`](#xpkg-login)
@@ -504,13 +493,10 @@ already installed in Crossplane.
504493

505494
`crossplane xpkg update <package-kind> <registry package name and tag> [<optional-name>]`
506495

507-
The package file must be an organization, image and tag on the `xpkg.upbound.io`
508-
registry on [Upbound Marketplace](https://marketplace.upbound.io/).
509-
510496
For example, to update to the latest version of the
511-
[AWS S3 provider](https://marketplace.upbound.io/providers/upbound/provider-aws-s3/):
497+
[AWS S3 provider](https://github.com/crossplane-contrib/provider-upjet-aws):
512498

513-
`crossplane xpkg update provider xpkg.upbound.io/upbound/provider-aws-s3:v1`
499+
`crossplane xpkg update provider xpkg.crossplane.io/crossplane-contrib/provider-aws-s3:v1.20.1`
514500

515501

516502
## beta
@@ -569,11 +555,11 @@ related pods.
569555

570556
```shell
571557
crossplane beta top
572-
TYPE NAMESPACE NAME CPU(cores) MEMORY
573-
crossplane default crossplane-f98f9ddfd-tnm46 4m 32Mi
574-
crossplane default crossplane-rbac-manager-74ff459b88-94p8p 4m 14Mi
575-
provider default provider-aws-s3-1f1a3fb08cbc-5c49d84447-sggrq 3m 108Mi
576-
provider default upbound-provider-family-aws-48b3b5ccf964-76c9686b6-bgg65 2m 89Mi
558+
TYPE NAMESPACE NAME CPU(cores) MEMORY
559+
crossplane default crossplane-f98f9ddfd-tnm46 4m 32Mi
560+
crossplane default crossplane-rbac-manager-74ff459b88-94p8p 4m 14Mi
561+
provider default provider-aws-s3-1f1a3fb08cbc-5c49d84447-sggrq 3m 108Mi
562+
provider default crossplane-contrib-provider-family-aws-48b3b5ccf964-76c9686b6-bgg65 2m 89Mi
577563
```
578564

579565
{{<hint "important" >}}
@@ -942,7 +928,7 @@ To clear the cache and download the CRD files again use the `--clean-cache` flag
942928
To validate a managed resource against a provider,
943929
first, create a provider manifest file. For example, to validate an IAM role
944930
from Provider AWS, use the
945-
[Provider AWS IAM](https://marketplace.upbound.io/providers/upbound/provider-aws-iam/v1.0.0)
931+
[Provider AWS IAM](https://github.com/crossplane-contrib/provider-upjet-aws)
946932
manifest.
947933

948934
{{<hint "tip" >}}
@@ -957,7 +943,7 @@ kind: Provider
957943
metadata:
958944
name: provider-aws-iam
959945
spec:
960-
package: xpkg.upbound.io/upbound/provider-aws-iam:v1
946+
package: xpkg.crossplane.io/crossplane-contrib/provider-aws-iam:v1.20.1
961947
```
962948

963949
Now include the XR or managed resource to validate.

content/master/concepts/compositions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ kind: Function
134134
metadata:
135135
name: function-patch-and-transform
136136
spec:
137-
package: xpkg.upbound.io/crossplane-contrib/function-patch-and-transform:v0.1.4
137+
package: xpkg.crossplane.io/crossplane-contrib/function-patch-and-transform:v0.1.4
138138
```
139139

140140
{{< hint "tip" >}}
@@ -155,7 +155,7 @@ During the install a Function reports `INSTALLED` as `True` and `HEALTHY` as
155155
```shell {copy-lines="1"}
156156
kubectl get functions
157157
NAME INSTALLED HEALTHY PACKAGE AGE
158-
function-patch-and-transform True Unknown xpkg.upbound.io/crossplane-contrib/function-patch-and-transform:v0.1.4 10s
158+
function-patch-and-transform True Unknown xpkg.crossplane.io/crossplane-contrib/function-patch-and-transform:v0.1.4 10s
159159
```
160160

161161
After the Function install completes and it's ready for use the `HEALTHY` status
@@ -545,7 +545,7 @@ kind: Function
545545
metadata:
546546
name: function-patch-and-transform
547547
spec:
548-
package: xpkg.upbound.io/crossplane-contrib/function-patch-and-transform:v0.1.4
548+
package: xpkg.crossplane.io/crossplane-contrib/function-patch-and-transform:v0.1.4
549549
```
550550
{{</expand>}}
551551

@@ -576,7 +576,7 @@ metadata:
576576
annotations:
577577
render.crossplane.io/runtime: Development
578578
spec:
579-
package: xpkg.upbound.io/crossplane-contrib/function-patch-and-transform:v0.1.4
579+
package: xpkg.crossplane.io/crossplane-contrib/function-patch-and-transform:v0.1.4
580580
```
581581

582582
{{<hint "tip">}}

content/master/concepts/connection-details.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ All the following examples use the same set of Compositions,
4949
CompositeResourceDefinitions and Claims.
5050

5151
All examples rely on
52-
[Upbound provider-aws-iam](https://marketplace.upbound.io/providers/upbound/provider-aws-iam/)
52+
[provider-aws-iam](https://github.com/crossplane-contrib/provider-upjet-aws)
5353
to create resources.
5454

5555
{{<expand "Reference Composition" >}}

content/master/concepts/managed-resources.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ external object inside the Provider an _external resource_.
1515
{{< /hint >}}
1616

1717
Examples of managed resources include:
18-
* Amazon AWS EC2 [`Instance`](https://marketplace.upbound.io/providers/upbound/provider-aws/latest/resources/ec2.aws.upbound.io/Instance/v1beta1)
19-
* Google Cloud GKE [`Cluster`](https://marketplace.upbound.io/providers/upbound/provider-gcp/latest/resources/container.gcp.upbound.io/Cluster/v1beta1)
20-
* Microsoft Azure PostgreSQL [`Database`](https://marketplace.upbound.io/providers/upbound/provider-azure/latest/resources/dbforpostgresql.azure.upbound.io/Database/v1beta1)
18+
* Amazon AWS EC2 `Instance` defined in [provider-upjet-aws](https://github.com/crossplane-contrib/provider-upjet-aws).
19+
* Google Cloud GKE `Cluster` defined in [provider-upjet-gcp](https://github.com/crossplane-contrib/provider-upjet-gcp).
20+
* Microsoft Azure PostgreSQL `Database` defined in [provider-upjet-azure](https://github.com/crossplane-contrib/provider-upjet-azure).
2121

2222
{{< hint "tip" >}}
2323

@@ -35,7 +35,7 @@ Provider also define the available settings of a managed resource.
3535
Each managed resource is a unique API endpoint with their own
3636
group, kind and version.
3737

38-
For example the [Upbound AWS Provider](https://marketplace.upbound.io/providers/upbound/provider-aws/latest/)
38+
For example the [AWS Provider](https://github.com/crossplane-contrib/provider-upjet-aws)
3939
defines the {{<hover label="gkv" line="2">}}Instance{{</hover>}} kind from the
4040
group {{<hover label="gkv" line="1">}}ec2.aws.upbound.io{{</hover>}}
4141

@@ -529,7 +529,7 @@ Crossplane stores these details in a Kubernetes Secret object specified by the
529529
`writeConnectionSecretToRef` values.
530530

531531
For example, when creating an AWS RDS database instance with the Crossplane
532-
[community AWS provider](https://marketplace.upbound.io/providers/crossplane-contrib/provider-aws/v0.40.0)
532+
[community AWS provider](https://github.com/crossplane-contrib/provider-aws)
533533
generates an endpoint, password, port and username data. The Provider saves
534534
these variables in the Kubernetes secret
535535
{{<hover label="secretname" line="9" >}}rds-secret{{</hover>}}, referenced by

content/master/concepts/packages.md

Lines changed: 56 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -34,24 +34,23 @@ the {{<hover line="6" label="install">}}spec.package{{</hover>}} value to the
3434
location of the configuration package.
3535

3636
{{< hint "important" >}}
37-
Beginning with Crossplane version 1.15.0 Crossplane uses the Upbound Marketplace
38-
Crossplane package registry at `xpkg.upbound.io` by default for downloading and
37+
Beginning with Crossplane version 1.20.0 Crossplane uses the [crossplane-contrib](https://github.com/orgs/crossplane-contrib/packages) GitHub Container Registry at `xpkg.crossplane.io` by default for downloading and
3938
installing packages.
4039

4140
Specify the full domain name with the `package` or change the default Crossplane
4241
registry with the `--registry` flag on the [Crossplane pod]({{<ref "./pods">}})
4342
{{< /hint >}}
4443

4544
For example to install the
46-
[Upbound AWS reference platform](https://marketplace.upbound.io/configurations/upbound/platform-ref-aws/v0.6.0).
45+
[Getting Started Configuration](https://github.com/crossplane-contrib/configuration-quickstart),
4746

4847
```yaml {label="install"}
4948
apiVersion: pkg.crossplane.io/v1
5049
kind: Configuration
5150
metadata:
52-
name: platform-ref-aws
51+
name: configuration-quickstart
5352
spec:
54-
package: xpkg.upbound.io/upbound/platform-ref-aws:v0.6.0
53+
package: xpkg.crossplane.io/crossplane-contrib/configuration-quickstart:v0.1.0
5554
```
5655
5756
{{<hint "tip" >}}
@@ -62,9 +61,9 @@ and repeatable installations.
6261
apiVersion: pkg.crossplane.io/v1
6362
kind: Configuration
6463
metadata:
65-
name: platform-ref-aws
64+
name: configuration-quickstart
6665
spec:
67-
package: xpkg.upbound.io/upbound/platform-ref-aws@sha256:a30ad655c7699218d9234285d838d85582f015d02f7f061f8486b28248fd7db7
66+
package: xpkg.crossplane.io/crossplane-contrib/configuration-quickstart@sha256:ef9795d146190637351a5c5848e0bab5e0c190fec7780f6c426fbffa0cb68358
6867
```
6968
{{< /hint >}}
7069
@@ -80,14 +79,14 @@ Use the
8079
{{<hover label="helm" line="5" >}}--set configuration.packages{{</hover >}}
8180
argument with `helm install`.
8281

83-
For example, to install the Upbound AWS reference platform,
82+
For example, to install the Getting Started configuration,
8483

8584
```shell {label="helm"}
8685
helm install crossplane \
8786
crossplane-stable/crossplane \
8887
--namespace crossplane-system \
8988
--create-namespace \
90-
--set configuration.packages='{xpkg.upbound.io/upbound/platform-ref-aws:v0.6.0}'
89+
--set configuration.packages='{xpkg.crossplane.io/crossplane-contrib/configuration-quickstart:v0.1.0}'
9190
```
9291

9392
### Install offline
@@ -116,8 +115,8 @@ View the configuration revisions with
116115
```shell {label="rev",copy-lines="1"}
117116
kubectl get configurationrevisions
118117
NAME HEALTHY REVISION IMAGE STATE DEP-FOUND DEP-INSTALLED AGE
119-
platform-ref-aws-1735d56cd88d True 2 xpkg.upbound.io/upbound/platform-ref-aws:v0.5.0 Active 2 2 46s
120-
platform-ref-aws-3ac761211893 True 1 xpkg.upbound.io/upbound/platform-ref-aws:v0.4.1 Inactive 5m13s
118+
platform-ref-aws-1735d56cd88d True 2 xpkg.crossplane.io/crossplane-contrib/platform-ref-aws:v0.5.0 Active 2 2 46s
119+
platform-ref-aws-3ac761211893 True 1 xpkg.crossplane.io/crossplane-contrib/platform-ref-aws:v0.4.1 Inactive 5m13s
121120
```
122121

123122
Only a single revision is active at a time. The active revision determines the
@@ -275,6 +274,47 @@ spec:
275274
# Removed for brevity
276275
```
277276

277+
#### Automatically update dependency versions
278+
279+
Crossplane can automatically upgrade a package's dependency version to the minimum
280+
valid version that satisfies all the constraints. It's an alpha feature that
281+
requires enabling with the `--enable-dependency-version-upgrades` flag.
282+
283+
In some cases, dependency version downgrade is required for proceeding with
284+
installations. Suppose configuration A, which depends on package X with the
285+
constraint`>=v0.0.0`, is installed on the control plane. In this case, the package
286+
manager installs the latest version of package X, such as `v3.0.0`. Later, you decide
287+
to install configuration B, which depends on package X with the constraint `<=v2.0.0`.
288+
Since version `v2.0.0`satisfies both conditions, package X must be downgraded to
289+
allow the installation of configuration B which is disabled by default.
290+
291+
For enabling automatic dependency version downgrades, there is a configuration
292+
option as a helm value `packageManager.enableAutomaticDependencyDowngrade=true`.
293+
Downgrading a package can cause unexpected behavior, therefore, this
294+
option is disabled by default. After enabling this option, the package manager will
295+
automatically downgrade a package's dependency version to the maximum valid version
296+
that satisfies the constraints.
297+
298+
{{<hint "note" >}}
299+
This configuration requires the `--enable-dependency-version-upgrades` flag.
300+
Please check the
301+
[configuration options]({{<ref "../software/install#customize-the-crossplane-helm-chart">}})
302+
and
303+
[feature flags]({{<ref "../software/install#feature-flags">}})
304+
are available in the
305+
[Crossplane Install]({{<ref "../software/install">}})
306+
section for more details.
307+
{{</hint >}}
308+
309+
{{<hint "important" >}}
310+
Enabling automatic dependency downgrades may have unintended consequences, such as:
311+
312+
1) CRDs missing in the downgraded version, possibly leaving orphaned MRs without
313+
controllers to reconcile them.
314+
2) Loss of data if downgraded CRD versions omit fields that were set before.
315+
3) Changes in the CRD storage version, which may prevent package version update.
316+
{{</hint >}}
317+
278318
#### Ignore Crossplane version requirements
279319

280320
A Configuration package may require a specific or minimum Crossplane version
@@ -309,7 +349,7 @@ A working configuration reports `Installed` and `Healthy` as `True`.
309349
```shell {label="verify",copy-lines="1"}
310350
kubectl get configuration
311351
NAME INSTALLED HEALTHY PACKAGE AGE
312-
platform-ref-aws True True xpkg.upbound.io/upbound/platform-ref-aws:v0.6.0 54s
352+
platform-ref-aws True True xpkg.crossplane.io/crossplane-contrib/configuration-quickstart:v0.1.0 54s
313353
```
314354

315355
### Manage dependencies
@@ -320,13 +360,13 @@ Functions, Providers or other Configurations.
320360
If Crossplane can't meet the dependencies of a Configuration the Configuration
321361
reports `HEALTHY` as `False`.
322362

323-
For example, this installation of the Upbound AWS reference platform is
363+
For example, this installation of the Getting Started Configuration is
324364
`HEALTHY: False`.
325365

326366
```shell {copy-lines="1"}
327367
kubectl get configuration
328368
NAME INSTALLED HEALTHY PACKAGE AGE
329-
platform-ref-aws True False xpkg.upbound.io/upbound/platform-ref-aws:v0.6.0 71s
369+
platform-ref-aws True False xpkg.crossplane.io/crossplane-contrib/configuration-quickstart:v0.1.0 71s
330370
```
331371

332372
To see more information on why the Configuration isn't `HEALTHY` use
@@ -340,7 +380,7 @@ Kind: ConfigurationRevision
340380
# Removed for brevity
341381
Spec:
342382
Desired State: Active
343-
Image: xpkg.upbound.io/upbound/platform-ref-aws:v0.6.0
383+
Image: xpkg.crossplane.io/crossplane-contrib/configuration-quickstart:v0.1.0
344384
Revision: 1
345385
Status:
346386
Conditions:
@@ -426,7 +466,7 @@ spec:
426466
dependsOn:
427467
- apiVersion: pkg.crossplane.io/v1
428468
kind: Provider
429-
package: xpkg.upbound.io/crossplane-contrib/provider-aws
469+
package: xpkg.crossplane.io/crossplane-contrib/provider-aws
430470
version: ">=v0.36.0"
431471
crossplane:
432472
version: ">=v1.12.1-0"

content/master/concepts/pods.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ the Helm `values.yml` file or after installation by editing the `Deployment`.
350350
The full list of
351351
[configuration options]({{<ref "../software/install#customize-the-crossplane-helm-chart">}})
352352
and
353-
[feature flags]({{<ref "../software/install#customize-the-crossplane-helm-chart">}})
353+
[feature flags]({{<ref "../software/install#feature-flags">}})
354354
are available in the
355355
[Crossplane Install]({{<ref "../software/install">}})
356356
section.

0 commit comments

Comments
 (0)