mirror of https://github.com/crossplane/docs.git
Merge github.com:crossplane/crossplane.github.io
Signed-off-by: Pete Lumbis <pete@upbound.io>
This commit is contained in:
commit
fdf7203acb
|
@ -216,7 +216,7 @@ spec:
|
||||||
Resources:
|
Resources:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
echo "apiVersion: gcp.crossplane.io/v1alpha1
|
echo "apiVersion: gcp.secrets.crossplane.io/v1alpha1
|
||||||
kind: StoreConfig
|
kind: StoreConfig
|
||||||
metadata:
|
metadata:
|
||||||
name: vault
|
name: vault
|
||||||
|
|
|
@ -435,14 +435,14 @@ composed resource field.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Patch from the XR's spec.parameters.location field and the
|
# Patch from the XR's spec.parameters.location field and the
|
||||||
# metadata.annotations[crossplane.io/claim-name] annotation to the composed
|
# metadata.labels[crossplane.io/claim-name] label to the composed
|
||||||
# resource's spec.forProvider.administratorLogin field.
|
# resource's spec.forProvider.administratorLogin field.
|
||||||
- type: CombineFromComposite
|
- type: CombineFromComposite
|
||||||
combine:
|
combine:
|
||||||
# The patch will only be applied when all variables have non-zero values.
|
# The patch will only be applied when all variables have non-zero values.
|
||||||
variables:
|
variables:
|
||||||
- fromFieldPath: spec.parameters.location
|
- fromFieldPath: spec.parameters.location
|
||||||
- fromFieldPath: metadata.annotations[crossplane.io/claim-name]
|
- fromFieldPath: metadata.labels[crossplane.io/claim-name]
|
||||||
strategy: string
|
strategy: string
|
||||||
string:
|
string:
|
||||||
fmt: "%s-%s"
|
fmt: "%s-%s"
|
||||||
|
@ -654,9 +654,9 @@ composed resource.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Always sets the XR's 'user' connection detail to 'admin'.
|
# Always sets the XR's 'user' connection detail to 'admin'.
|
||||||
- type: FromFieldPath
|
- type: FromValue
|
||||||
name: user
|
name: user
|
||||||
fromValue: admin
|
value: admin
|
||||||
```
|
```
|
||||||
|
|
||||||
### Readiness Checks
|
### Readiness Checks
|
||||||
|
|
|
@ -182,7 +182,7 @@ annotations by third-party consumers of Crossplane packages:
|
||||||
- `meta.crossplane.io/source`: The URL at which the package's source can be
|
- `meta.crossplane.io/source`: The URL at which the package's source can be
|
||||||
found.
|
found.
|
||||||
- `meta.crossplane.io/license`: The license under which the package's source is
|
- `meta.crossplane.io/license`: The license under which the package's source is
|
||||||
released.
|
released. This should be a valid [SPDX License Identifier].
|
||||||
- `meta.crossplane.io/description`: A one sentence description of the package.
|
- `meta.crossplane.io/description`: A one sentence description of the package.
|
||||||
- `meta.crossplane.io/readme`: A longer description, documentation, etc.
|
- `meta.crossplane.io/readme`: A longer description, documentation, etc.
|
||||||
|
|
||||||
|
@ -208,3 +208,4 @@ unmodified.
|
||||||
[index]: https://github.com/opencontainers/image-spec/blob/main/image-index.md
|
[index]: https://github.com/opencontainers/image-spec/blob/main/image-index.md
|
||||||
[annotation]: https://github.com/opencontainers/image-spec/blob/main/annotations.md
|
[annotation]: https://github.com/opencontainers/image-spec/blob/main/annotations.md
|
||||||
[applying changesets]: https://github.com/opencontainers/image-spec/blob/main/layer.md#applying-changesets
|
[applying changesets]: https://github.com/opencontainers/image-spec/blob/main/layer.md#applying-changesets
|
||||||
|
[SPDX License Identifier]: https://spdx.org/licenses/
|
||||||
|
|
|
@ -406,14 +406,14 @@ composed resource field.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Patch from the XR's spec.parameters.location field and the
|
# Patch from the XR's spec.parameters.location field and the
|
||||||
# metadata.annotations[crossplane.io/claim-name] annotation to the composed
|
# metadata.labels[crossplane.io/claim-name] label to the composed
|
||||||
# resource's spec.forProvider.administratorLogin field.
|
# resource's spec.forProvider.administratorLogin field.
|
||||||
- type: CombineFromComposite
|
- type: CombineFromComposite
|
||||||
combine:
|
combine:
|
||||||
# The patch will only be applied when all variables have non-zero values.
|
# The patch will only be applied when all variables have non-zero values.
|
||||||
variables:
|
variables:
|
||||||
- fromFieldPath: spec.parameters.location
|
- fromFieldPath: spec.parameters.location
|
||||||
- fromFieldPath: metadata.annotations[crossplane.io/claim-name]
|
- fromFieldPath: metadata.labels[crossplane.io/claim-name]
|
||||||
strategy: string
|
strategy: string
|
||||||
string:
|
string:
|
||||||
fmt: "%s-%s"
|
fmt: "%s-%s"
|
||||||
|
@ -601,9 +601,9 @@ composed resource.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Always sets the XR's 'user' connection detail to 'admin'.
|
# Always sets the XR's 'user' connection detail to 'admin'.
|
||||||
- type: FromFieldPath
|
- type: FromValue
|
||||||
name: user
|
name: user
|
||||||
fromValue: admin
|
value: admin
|
||||||
```
|
```
|
||||||
|
|
||||||
### Readiness Checks
|
### Readiness Checks
|
||||||
|
|
|
@ -184,7 +184,7 @@ annotations by third-party consumers of Crossplane packages:
|
||||||
- `meta.crossplane.io/source`: The URL at which the package's source can be
|
- `meta.crossplane.io/source`: The URL at which the package's source can be
|
||||||
found.
|
found.
|
||||||
- `meta.crossplane.io/license`: The license under which the package's source is
|
- `meta.crossplane.io/license`: The license under which the package's source is
|
||||||
released.
|
released. This should be a valid [SPDX License Identifier].
|
||||||
- `meta.crossplane.io/description`: A one sentence description of the package.
|
- `meta.crossplane.io/description`: A one sentence description of the package.
|
||||||
- `meta.crossplane.io/readme`: A longer description, documentation, etc.
|
- `meta.crossplane.io/readme`: A longer description, documentation, etc.
|
||||||
|
|
||||||
|
@ -210,3 +210,4 @@ unmodified.
|
||||||
[index]: https://github.com/opencontainers/image-spec/blob/main/image-index.md
|
[index]: https://github.com/opencontainers/image-spec/blob/main/image-index.md
|
||||||
[annotation]: https://github.com/opencontainers/image-spec/blob/main/annotations.md
|
[annotation]: https://github.com/opencontainers/image-spec/blob/main/annotations.md
|
||||||
[applying changesets]: https://github.com/opencontainers/image-spec/blob/main/layer.md#applying-changesets
|
[applying changesets]: https://github.com/opencontainers/image-spec/blob/main/layer.md#applying-changesets
|
||||||
|
[SPDX License Identifier]: https://spdx.org/licenses/
|
||||||
|
|
|
@ -616,9 +616,9 @@ composed resource.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Always sets the XR's 'user' connection detail to 'admin'.
|
# Always sets the XR's 'user' connection detail to 'admin'.
|
||||||
- type: FromFieldPath
|
- type: FromValue
|
||||||
name: user
|
name: user
|
||||||
fromValue: admin
|
value: admin
|
||||||
```
|
```
|
||||||
|
|
||||||
### Readiness Checks
|
### Readiness Checks
|
||||||
|
|
|
@ -184,7 +184,7 @@ annotations by third-party consumers of Crossplane packages:
|
||||||
- `meta.crossplane.io/source`: The URL at which the package's source can be
|
- `meta.crossplane.io/source`: The URL at which the package's source can be
|
||||||
found.
|
found.
|
||||||
- `meta.crossplane.io/license`: The license under which the package's source is
|
- `meta.crossplane.io/license`: The license under which the package's source is
|
||||||
released.
|
released. This should be a valid [SPDX License Identifier].
|
||||||
- `meta.crossplane.io/description`: A one sentence description of the package.
|
- `meta.crossplane.io/description`: A one sentence description of the package.
|
||||||
- `meta.crossplane.io/readme`: A longer description, documentation, etc.
|
- `meta.crossplane.io/readme`: A longer description, documentation, etc.
|
||||||
|
|
||||||
|
@ -210,3 +210,4 @@ unmodified.
|
||||||
[index]: https://github.com/opencontainers/image-spec/blob/main/image-index.md
|
[index]: https://github.com/opencontainers/image-spec/blob/main/image-index.md
|
||||||
[annotation]: https://github.com/opencontainers/image-spec/blob/main/annotations.md
|
[annotation]: https://github.com/opencontainers/image-spec/blob/main/annotations.md
|
||||||
[applying changesets]: https://github.com/opencontainers/image-spec/blob/main/layer.md#applying-changesets
|
[applying changesets]: https://github.com/opencontainers/image-spec/blob/main/layer.md#applying-changesets
|
||||||
|
[SPDX License Identifier]: https://spdx.org/licenses/
|
||||||
|
|
|
@ -587,7 +587,7 @@ you may specify a specific package by using the `-f` flag.
|
||||||
```console
|
```console
|
||||||
# Set this to the Docker Hub username or OCI registry you wish to use.
|
# Set this to the Docker Hub username or OCI registry you wish to use.
|
||||||
REG=my-package-repo
|
REG=my-package-repo
|
||||||
kubectl crossplane push configuration ${REG}/getting-started-with-aws:v1.9.0
|
kubectl crossplane push configuration ${REG}/getting-started-with-aws:v1.9.1
|
||||||
```
|
```
|
||||||
|
|
||||||
> Note that the Crossplane CLI will not follow symbolic links for files in the
|
> Note that the Crossplane CLI will not follow symbolic links for files in the
|
||||||
|
@ -627,7 +627,7 @@ you may specify a specific package by using the `-f` flag.
|
||||||
```console
|
```console
|
||||||
# Set this to the Docker Hub username or OCI registry you wish to use.
|
# Set this to the Docker Hub username or OCI registry you wish to use.
|
||||||
REG=my-package-repo
|
REG=my-package-repo
|
||||||
kubectl crossplane push configuration ${REG}/getting-started-with-aws-with-vpc:v1.9.0
|
kubectl crossplane push configuration ${REG}/getting-started-with-aws-with-vpc:v1.9.1
|
||||||
```
|
```
|
||||||
|
|
||||||
> Note that the Crossplane CLI will not follow symbolic links for files in the
|
> Note that the Crossplane CLI will not follow symbolic links for files in the
|
||||||
|
@ -666,7 +666,7 @@ you may specify a specific package by using the `-f` flag.
|
||||||
```console
|
```console
|
||||||
# Set this to the Docker Hub username or OCI registry you wish to use.
|
# Set this to the Docker Hub username or OCI registry you wish to use.
|
||||||
REG=my-package-repo
|
REG=my-package-repo
|
||||||
kubectl crossplane push configuration ${REG}/getting-started-with-gcp:v1.9.0
|
kubectl crossplane push configuration ${REG}/getting-started-with-gcp:v1.9.1
|
||||||
```
|
```
|
||||||
|
|
||||||
> Note that the Crossplane CLI will not follow symbolic links for files in the
|
> Note that the Crossplane CLI will not follow symbolic links for files in the
|
||||||
|
@ -705,7 +705,7 @@ you may specify a specific package by using the `-f` flag.
|
||||||
```console
|
```console
|
||||||
# Set this to the Docker Hub username or OCI registry you wish to use.
|
# Set this to the Docker Hub username or OCI registry you wish to use.
|
||||||
REG=my-package-repo
|
REG=my-package-repo
|
||||||
kubectl crossplane push configuration ${REG}/getting-started-with-azure:v1.9.0
|
kubectl crossplane push configuration ${REG}/getting-started-with-azure:v1.9.1
|
||||||
```
|
```
|
||||||
|
|
||||||
> Note that the Crossplane CLI will not follow symbolic links for files in the
|
> Note that the Crossplane CLI will not follow symbolic links for files in the
|
||||||
|
|
|
@ -241,7 +241,7 @@ provider that can satisfy a `PostgreSQLInstance`. Let's get started!
|
||||||
> section.
|
> section.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
kubectl crossplane install configuration registry.upbound.io/xp/getting-started-with-aws:latest
|
kubectl crossplane install configuration registry.upbound.io/xp/getting-started-with-aws:v1.9.1
|
||||||
```
|
```
|
||||||
|
|
||||||
Wait until all packages become healthy:
|
Wait until all packages become healthy:
|
||||||
|
@ -298,7 +298,7 @@ kubectl apply -f https://raw.githubusercontent.com/crossplane/crossplane/release
|
||||||
> section.
|
> section.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
kubectl crossplane install configuration registry.upbound.io/xp/getting-started-with-aws-with-vpc:latest
|
kubectl crossplane install configuration registry.upbound.io/xp/getting-started-with-aws-with-vpc:v1.9.1
|
||||||
```
|
```
|
||||||
|
|
||||||
Wait until all packages become healthy:
|
Wait until all packages become healthy:
|
||||||
|
@ -355,7 +355,7 @@ kubectl apply -f https://raw.githubusercontent.com/crossplane/crossplane/release
|
||||||
> section.
|
> section.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
kubectl crossplane install configuration registry.upbound.io/xp/getting-started-with-gcp:latest
|
kubectl crossplane install configuration registry.upbound.io/xp/getting-started-with-gcp:v1.9.1
|
||||||
```
|
```
|
||||||
|
|
||||||
Wait until all packages become healthy:
|
Wait until all packages become healthy:
|
||||||
|
@ -428,7 +428,7 @@ spec:
|
||||||
> section.
|
> section.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
kubectl crossplane install configuration registry.upbound.io/xp/getting-started-with-azure:latest
|
kubectl crossplane install configuration registry.upbound.io/xp/getting-started-with-azure:v1.9.1
|
||||||
```
|
```
|
||||||
|
|
||||||
Wait until all packages become healthy:
|
Wait until all packages become healthy:
|
||||||
|
|
|
@ -435,14 +435,14 @@ composed resource field.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Patch from the XR's spec.parameters.location field and the
|
# Patch from the XR's spec.parameters.location field and the
|
||||||
# metadata.annotations[crossplane.io/claim-name] annotation to the composed
|
# metadata.labels[crossplane.io/claim-name] label to the composed
|
||||||
# resource's spec.forProvider.administratorLogin field.
|
# resource's spec.forProvider.administratorLogin field.
|
||||||
- type: CombineFromComposite
|
- type: CombineFromComposite
|
||||||
combine:
|
combine:
|
||||||
# The patch will only be applied when all variables have non-zero values.
|
# The patch will only be applied when all variables have non-zero values.
|
||||||
variables:
|
variables:
|
||||||
- fromFieldPath: spec.parameters.location
|
- fromFieldPath: spec.parameters.location
|
||||||
- fromFieldPath: metadata.annotations[crossplane.io/claim-name]
|
- fromFieldPath: metadata.labels[crossplane.io/claim-name]
|
||||||
strategy: string
|
strategy: string
|
||||||
string:
|
string:
|
||||||
fmt: "%s-%s"
|
fmt: "%s-%s"
|
||||||
|
@ -654,9 +654,9 @@ composed resource.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Always sets the XR's 'user' connection detail to 'admin'.
|
# Always sets the XR's 'user' connection detail to 'admin'.
|
||||||
- type: FromFieldPath
|
- type: FromValue
|
||||||
name: user
|
name: user
|
||||||
fromValue: admin
|
value: admin
|
||||||
```
|
```
|
||||||
|
|
||||||
### Readiness Checks
|
### Readiness Checks
|
||||||
|
|
|
@ -182,7 +182,7 @@ annotations by third-party consumers of Crossplane packages:
|
||||||
- `meta.crossplane.io/source`: The URL at which the package's source can be
|
- `meta.crossplane.io/source`: The URL at which the package's source can be
|
||||||
found.
|
found.
|
||||||
- `meta.crossplane.io/license`: The license under which the package's source is
|
- `meta.crossplane.io/license`: The license under which the package's source is
|
||||||
released.
|
released. This should be a valid [SPDX License Identifier].
|
||||||
- `meta.crossplane.io/description`: A one sentence description of the package.
|
- `meta.crossplane.io/description`: A one sentence description of the package.
|
||||||
- `meta.crossplane.io/readme`: A longer description, documentation, etc.
|
- `meta.crossplane.io/readme`: A longer description, documentation, etc.
|
||||||
|
|
||||||
|
@ -208,3 +208,4 @@ unmodified.
|
||||||
[index]: https://github.com/opencontainers/image-spec/blob/main/image-index.md
|
[index]: https://github.com/opencontainers/image-spec/blob/main/image-index.md
|
||||||
[annotation]: https://github.com/opencontainers/image-spec/blob/main/annotations.md
|
[annotation]: https://github.com/opencontainers/image-spec/blob/main/annotations.md
|
||||||
[applying changesets]: https://github.com/opencontainers/image-spec/blob/main/layer.md#applying-changesets
|
[applying changesets]: https://github.com/opencontainers/image-spec/blob/main/layer.md#applying-changesets
|
||||||
|
[SPDX License Identifier]: https://spdx.org/licenses/
|
||||||
|
|
Loading…
Reference in New Issue