Skip to content

Commit

Permalink
Merge pull request #880 from cwilhit/provider-docs-update
Browse files Browse the repository at this point in the history 
Update docs to point to providers sourced from xpkg.crossplane.io. Remove terminology related to Upbound Marketplace
  • Loading branch information
@jbw976
jbw976 authored Feb 25, 2025
2 parents 992b618 + e470506 commit 5e9d91f
Show file tree
Hide file tree
Showing 99 changed files with 566 additions and 729 deletions.
2 changes: 1 addition & 1 deletion content/contribute/features.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ without using the

For example,
```markdown
[Go to Upbound](http://upbound.io)
[Go to Crossplane](http://crossplane.io)
```

## Tables
Expand Down
38 changes: 12 additions & 26 deletions content/master/cli/command-reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -240,9 +240,6 @@ For example,

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

[Upbound Marketplace](https://marketplace.upbound.io/) uses files included with
`--examples-root` as documentation for published packages.

#### Include a runtime image

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

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

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

#### Flags
{{< table "table table-sm table-striped">}}
Expand Down Expand Up @@ -380,11 +377,7 @@ in the package documentation.

### xpkg login

Use `xpkg login` to authenticate to `xpkg.upbound.io`, the
[Upbound Marketplace](https://marketplace.upbound.io/) container registry.

[Register with the Upbound Marketplace](https://accounts.upbound.io/register)
to push packages and create private repositories.
Use `xpkg login` to authenticate to registries that host Crossplane packages.

#### Flags

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

Push a Crossplane package file to a package registry.

The Crossplane CLI pushes images to the
[Upbound Marketplace](https://marketplace.upbound.io/) at `xpkg.upbound.io` by
default.

{{< hint "note" >}}
Pushing a package may require authentication with
[`crossplane xpkg login`](#xpkg-login)
Expand Down Expand Up @@ -504,13 +493,10 @@ already installed in Crossplane.

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

The package file must be an organization, image and tag on the `xpkg.upbound.io`
registry on [Upbound Marketplace](https://marketplace.upbound.io/).

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

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


## beta
Expand Down Expand Up @@ -569,11 +555,11 @@ related pods.

```shell
crossplane beta top
TYPE NAMESPACE NAME CPU(cores) MEMORY
crossplane default crossplane-f98f9ddfd-tnm46 4m 32Mi
crossplane default crossplane-rbac-manager-74ff459b88-94p8p 4m 14Mi
provider default provider-aws-s3-1f1a3fb08cbc-5c49d84447-sggrq 3m 108Mi
provider default upbound-provider-family-aws-48b3b5ccf964-76c9686b6-bgg65 2m 89Mi
TYPE NAMESPACE NAME CPU(cores) MEMORY
crossplane default crossplane-f98f9ddfd-tnm46 4m 32Mi
crossplane default crossplane-rbac-manager-74ff459b88-94p8p 4m 14Mi
provider default provider-aws-s3-1f1a3fb08cbc-5c49d84447-sggrq 3m 108Mi
provider default crossplane-contrib-provider-family-aws-48b3b5ccf964-76c9686b6-bgg65 2m 89Mi
```

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

{{<hint "tip" >}}
Expand All @@ -957,7 +943,7 @@ kind: Provider
metadata:
name: provider-aws-iam
spec:
package: xpkg.upbound.io/upbound/provider-aws-iam:v1
package: xpkg.crossplane.io/crossplane-contrib/provider-aws-iam:v1.20.1
```

Now include the XR or managed resource to validate.
Expand Down
8 changes: 4 additions & 4 deletions content/master/concepts/compositions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ kind: Function
metadata:
name: function-patch-and-transform
spec:
package: xpkg.upbound.io/crossplane-contrib/function-patch-and-transform:v0.1.4
package: xpkg.crossplane.io/crossplane-contrib/function-patch-and-transform:v0.1.4
```

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

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

Expand Down Expand Up @@ -576,7 +576,7 @@ metadata:
annotations:
render.crossplane.io/runtime: Development
spec:
package: xpkg.upbound.io/crossplane-contrib/function-patch-and-transform:v0.1.4
package: xpkg.crossplane.io/crossplane-contrib/function-patch-and-transform:v0.1.4
```

{{<hint "tip">}}
Expand Down
2 changes: 1 addition & 1 deletion content/master/concepts/connection-details.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ All the following examples use the same set of Compositions,
CompositeResourceDefinitions and Claims.

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

{{<expand "Reference Composition" >}}
Expand Down
10 changes: 5 additions & 5 deletions content/master/concepts/managed-resources.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ external object inside the Provider an _external resource_.
{{< /hint >}}

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

{{< hint "tip" >}}

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

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

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

For example, when creating an AWS RDS database instance with the Crossplane
[community AWS provider](https://marketplace.upbound.io/providers/crossplane-contrib/provider-aws/v0.40.0)
[community AWS provider](https://github.com/crossplane-contrib/provider-aws)
generates an endpoint, password, port and username data. The Provider saves
these variables in the Kubernetes secret
{{<hover label="secretname" line="9" >}}rds-secret{{</hover>}}, referenced by
Expand Down
31 changes: 15 additions & 16 deletions content/master/concepts/packages.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,24 +34,23 @@ the {{<hover line="6" label="install">}}spec.package{{</hover>}} value to the
location of the configuration package.

{{< hint "important" >}}
Beginning with Crossplane version 1.15.0 Crossplane uses the Upbound Marketplace
Crossplane package registry at `xpkg.upbound.io` by default for downloading and
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
installing packages.

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

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

```yaml {label="install"}
apiVersion: pkg.crossplane.io/v1
kind: Configuration
metadata:
name: platform-ref-aws
name: configuration-quickstart
spec:
package: xpkg.upbound.io/upbound/platform-ref-aws:v0.6.0
package: xpkg.crossplane.io/crossplane-contrib/configuration-quickstart:v0.1.0
```
{{<hint "tip" >}}
Expand All @@ -62,9 +61,9 @@ and repeatable installations.
apiVersion: pkg.crossplane.io/v1
kind: Configuration
metadata:
name: platform-ref-aws
name: configuration-quickstart
spec:
package: xpkg.upbound.io/upbound/platform-ref-aws@sha256:a30ad655c7699218d9234285d838d85582f015d02f7f061f8486b28248fd7db7
package: xpkg.crossplane.io/crossplane-contrib/configuration-quickstart@sha256:ef9795d146190637351a5c5848e0bab5e0c190fec7780f6c426fbffa0cb68358
```
{{< /hint >}}
Expand All @@ -80,14 +79,14 @@ Use the
{{<hover label="helm" line="5" >}}--set configuration.packages{{</hover >}}
argument with `helm install`.

For example, to install the Upbound AWS reference platform,
For example, to install the Getting Started configuration,

```shell {label="helm"}
helm install crossplane \
crossplane-stable/crossplane \
--namespace crossplane-system \
--create-namespace \
--set configuration.packages='{xpkg.upbound.io/upbound/platform-ref-aws:v0.6.0}'
--set configuration.packages='{xpkg.crossplane.io/crossplane-contrib/configuration-quickstart:v0.1.0}'
```

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

Only a single revision is active at a time. The active revision determines the
Expand Down Expand Up @@ -350,7 +349,7 @@ A working configuration reports `Installed` and `Healthy` as `True`.
```shell {label="verify",copy-lines="1"}
kubectl get configuration
NAME INSTALLED HEALTHY PACKAGE AGE
platform-ref-aws True True xpkg.upbound.io/upbound/platform-ref-aws:v0.6.0 54s
platform-ref-aws True True xpkg.crossplane.io/crossplane-contrib/configuration-quickstart:v0.1.0 54s
```

### Manage dependencies
Expand All @@ -361,13 +360,13 @@ Functions, Providers or other Configurations.
If Crossplane can't meet the dependencies of a Configuration the Configuration
reports `HEALTHY` as `False`.

For example, this installation of the Upbound AWS reference platform is
For example, this installation of the Getting Started Configuration is
`HEALTHY: False`.

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

To see more information on why the Configuration isn't `HEALTHY` use
Expand All @@ -381,7 +380,7 @@ Kind: ConfigurationRevision
# Removed for brevity
Spec:
Desired State: Active
Image: xpkg.upbound.io/upbound/platform-ref-aws:v0.6.0
Image: xpkg.crossplane.io/crossplane-contrib/configuration-quickstart:v0.1.0
Revision: 1
Status:
Conditions:
Expand Down Expand Up @@ -467,7 +466,7 @@ spec:
dependsOn:
- apiVersion: pkg.crossplane.io/v1
kind: Provider
package: xpkg.upbound.io/crossplane-contrib/provider-aws
package: xpkg.crossplane.io/crossplane-contrib/provider-aws
version: ">=v0.36.0"
crossplane:
version: ">=v1.12.1-0"
Expand Down
29 changes: 14 additions & 15 deletions content/master/concepts/providers.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,7 @@ Install a Provider with a Crossplane
location of the provider package.

{{< hint "important" >}}
Beginning with Crossplane version 1.15.0 Crossplane uses the Upbound Marketplace
Crossplane package registry at `xpkg.upbound.io` by default for downloading and
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
installing packages.

Specify the full domain name with the `package` or change the default Crossplane
Expand All @@ -65,7 +64,7 @@ kind: Provider
metadata:
name: provider-aws
spec:
package: xpkg.upbound.io/crossplane-contrib/provider-aws:v0.39.0
package: xpkg.crossplane.io/crossplane-contrib/provider-aws:v0.39.0
```
By default, the Provider pod installs in the same namespace as Crossplane
Expand Down Expand Up @@ -113,7 +112,7 @@ helm install crossplane \
crossplane-stable/crossplane \
--namespace crossplane-system \
--create-namespace \
--set provider.packages='{xpkg.upbound.io/crossplane-contrib/provider-aws:v0.39.0}'
--set provider.packages='{xpkg.crossplane.io/crossplane-contrib/provider-aws:v0.39.0}'
```

### Install offline
Expand All @@ -140,7 +139,7 @@ kind: Provider
metadata:
name: provider-aws
spec:
package: xpkg.upbound.io/crossplane-contrib/provider-aws@sha256:ee6bece46dbb54cc3f0233961f5baac317fa4e4a81b41198bdc72fc472d113d0
package: xpkg.crossplane.io/crossplane-contrib/provider-aws@sha256:ee6bece46dbb54cc3f0233961f5baac317fa4e4a81b41198bdc72fc472d113d0
```
{{< /hint >}}

Expand Down Expand Up @@ -374,13 +373,13 @@ Configurations or other Providers.
If Crossplane can't meet the dependencies of a Provider package the Provider
reports `HEALTHY` as `False`.

For example, this installation of the Upbound AWS reference platform is
For example, this installation of the Getting Started Configuration is
`HEALTHY: False`.

```shell {copy-lines="1"}
kubectl get providers
NAME INSTALLED HEALTHY PACKAGE AGE
provider-aws-s3 True False xpkg.upbound.io/upbound/provider-aws-s3:v1.0.0 12s
provider-aws-s3 True False xpkg.crossplane.io/crossplane-contrib/provider-aws-s3:v1.20.1 12s
```

To see more information on why the Provider isn't `HEALTHY` use
Expand All @@ -393,7 +392,7 @@ API Version: pkg.crossplane.io/v1
Kind: ProviderRevision
Spec:
Desired State: Active
Image: xpkg.upbound.io/upbound/provider-aws-s3:v1.0.0
Image: xpkg.crossplane.io/crossplane-contrib/provider-aws-s3:v1.20.1
Revision: 1
Status:
Conditions:
Expand Down Expand Up @@ -431,10 +430,10 @@ View the `ProviderRevisions` with
```shell {label="getPR",copy-lines="1"}
kubectl get providerrevisions
NAME HEALTHY REVISION IMAGE STATE DEP-FOUND DEP-INSTALLED AGE
provider-aws-s3-dbc7f981d81f True 1 xpkg.upbound.io/upbound/provider-aws-s3:v1.0.0 Active 1 1 10d
provider-nop-552a394a8acc True 2 xpkg.upbound.io/crossplane-contrib/provider-nop:v0.3.0 Active 11d
provider-nop-7e62d2a1a709 True 1 xpkg.upbound.io/crossplane-contrib/provider-nop:v0.2.0 Inactive 13d
upbound-provider-family-aws-710d8cfe9f53 True 1 xpkg.upbound.io/upbound/provider-family-aws:v1.0.0 Active 10d
provider-aws-s3-dbc7f981d81f True 1 xpkg.crossplane.io/crossplane-contrib/provider-aws-s3:v1.20.1 Active 1 1 10d
provider-nop-552a394a8acc True 2 xpkg.crossplane.io/crossplane-contrib/provider-nop:v0.3.0 Active 11d
provider-nop-7e62d2a1a709 True 1 xpkg.crossplane.io/crossplane-contrib/provider-nop:v0.2.0 Inactive 13d
crossplane-contrib-provider-family-aws-710d8cfe9f53 True 1 xpkg.crossplane.io/crossplane-contrib/provider-family-aws:v1.20.1 Active 10d
```

By default Crossplane keeps a single
Expand Down Expand Up @@ -477,7 +476,7 @@ During the install a Provider report `INSTALLED` as `True` and `HEALTHY` as
```shell {copy-lines="1"}
kubectl get providers
NAME INSTALLED HEALTHY PACKAGE AGE
crossplane-contrib-provider-aws True Unknown xpkg.upbound.io/crossplane-contrib/provider-aws:v0.39.0 63s
crossplane-contrib-provider-aws True Unknown xpkg.crossplane.io/crossplane-contrib/provider-aws:v0.39.0 63s
```

After the Provider install completes and it's ready for use the `HEALTHY` status
Expand All @@ -486,7 +485,7 @@ reports `True`.
```shell {copy-lines="1"}
kubectl get providers
NAME INSTALLED HEALTHY PACKAGE AGE
crossplane-contrib-provider-aws True True xpkg.upbound.io/crossplane-contrib/provider-aws:v0.39.0 88s
crossplane-contrib-provider-aws True True xpkg.crossplane.io/crossplane-contrib/provider-aws:v0.39.0 88s
```

{{<hint "important" >}}
Expand Down Expand Up @@ -694,7 +693,7 @@ kind: Provider
metadata:
name: provider-gcp-iam
spec:
package: xpkg.upbound.io/upbound/provider-gcp-iam:v1
package: xpkg.crossplane.io/crossplane-contrib/provider-gcp-iam:v1.20.1
runtimeConfigRef:
name: enable-ess
---
Expand Down
Loading

0 comments on commit 5e9d91f

Please sign in to comment.