Skip to content

Commit

Permalink
EnvironmentConfig v1beta1 promotion related changes (#833)
Browse files Browse the repository at this point in the history
  • Loading branch information
ytsarev authored Nov 14, 2024
1 parent 6861340 commit 9a8d432
Show file tree
Hide file tree
Showing 6 changed files with 378 additions and 400 deletions.
20 changes: 10 additions & 10 deletions content/master/concepts/environment-configs.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,24 @@ TODO: Add Policies


A Crossplane EnvironmentConfig is a cluster-scoped, strongly typed,
[ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/)-like
[ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/)-like
resource used by Compositions. Compositions can use the environment to store
information from individual resources or to apply patches.

Crossplane supports multiple `EnvironmentConfigs`, each acting as a unique
data store.
data store.

When Crossplane creates a composite resource, Crossplane merges all the
When Crossplane creates a composite resource, Crossplane merges all the
EnvironmentConfigs referenced in the associated Composition and creates a unique
in-memory environment for that composite resource.

The composite resource can read and write data to their unique
The composite resource can read and write data to their unique
in-memory environment.

{{<hint "important" >}}
The in-memory environment is unique to each composite resource.
The in-memory environment is unique to each composite resource.
A composite resource can't read data in another composite resource's
environment.
environment.
{{< /hint >}}

<!-- vale Google.Headings = NO -->
Expand All @@ -41,14 +41,14 @@ An {{<hover label="env1" line="2">}}EnvironmentConfig{{</hover>}} has a single
object field,
{{<hover label="env1" line="5">}}data{{</hover>}}.

An EnvironmentConfig supports any data inside the
An EnvironmentConfig supports any data inside the
{{<hover label="env1" line="5">}}data{{</hover>}} field.

Here an example
Here an example
{{<hover label="env1" line="2">}}EnvironmentConfig{{</hover>}}.

```yaml {label="env1"}
apiVersion: apiextensions.crossplane.io/v1alpha1
apiVersion: apiextensions.crossplane.io/v1beta1
kind: EnvironmentConfig
metadata:
name: example-environment
Expand Down Expand Up @@ -497,4 +497,4 @@ The [Patch and Transform]({{<ref "../guides/function-patch-and-transform">}}) do
[function-patch-and-transform]: {{<ref "../guides/function-patch-and-transform">}}
[function-go-templating]: https://github.com/crossplane-contrib/function-go-templating
[Composition Functions]: {{<ref "./compositions">}}
[Context]: {{<ref "./compositions/#function-pipeline-context">}}
[Context]: {{<ref "./compositions/#function-pipeline-context">}}
8 changes: 4 additions & 4 deletions content/master/getting-started/install-crossplane-include.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ searchExclude: true

## Install Crossplane

Crossplane installs into an existing Kubernetes cluster.
Crossplane installs into an existing Kubernetes cluster.

{{< hint type="tip" >}}
If you don't have a Kubernetes cluster create one locally with [Kind](https://kind.sigs.k8s.io/).
Expand Down Expand Up @@ -1104,15 +1104,15 @@ crossplane-d4cd8d784-ldcgb 1/1 Running 0 54s
crossplane-rbac-manager-84769b574-6mw6f 1/1 Running 0 54s
```

Installing Crossplane creates new Kubernetes API end-points.
Installing Crossplane creates new Kubernetes API end-points.
Look at the new API end-points with `kubectl api-resources | grep crossplane`.

```shell {label="grep",copy-lines="1"}
kubectl api-resources | grep crossplane
compositeresourcedefinitions xrd,xrds apiextensions.crossplane.io/v1 false CompositeResourceDefinition
compositionrevisions comprev apiextensions.crossplane.io/v1 false CompositionRevision
compositions comp apiextensions.crossplane.io/v1 false Composition
environmentconfigs envcfg apiextensions.crossplane.io/v1alpha1 false EnvironmentConfig
environmentconfigs envcfg apiextensions.crossplane.io/v1beta1 false EnvironmentConfig
usages apiextensions.crossplane.io/v1alpha1 false Usage
configurationrevisions pkg.crossplane.io/v1 false ConfigurationRevision
configurations pkg.crossplane.io/v1 false Configuration
Expand All @@ -1124,4 +1124,4 @@ locks pkg.crossplane.io/v1beta1
providerrevisions pkg.crossplane.io/v1 false ProviderRevision
providers pkg.crossplane.io/v1 false Provider
storeconfigs secrets.crossplane.io/v1alpha1 false StoreConfig
```
```
Loading

0 comments on commit 9a8d432

Please sign in to comment.