V1.14 release (#596)

Co-authored-by: Philippe Scorsolini <[email protected]> Co-authored-by: Nic Cope <[email protected]> Co-authored-by: Hasan Turken <[email protected]>
crossplane · Nov 1, 2023 · 5dcc5b8 · 5dcc5b8
1 parent c819ac2
commit 5dcc5b8
Show file tree

Hide file tree

Showing 68 changed files with 11,937 additions and 10,892 deletions.
diff --git a/.github/workflows/link-checker.yml b/.github/workflows/link-checker.yml
@@ -19,7 +19,7 @@ jobs:
       - name: Setup Hugo
         uses: peaceiris/actions-hugo@v2
         with:
-          hugo-version: '0.109.0'
+          hugo-version: '0.119.0'
           extended: true
 
       - name: Build

diff --git a/.github/workflows/weekly-link-checker.yml b/.github/workflows/weekly-link-checker.yml
@@ -18,7 +18,7 @@ jobs:
       - name: Setup Hugo
         uses: peaceiris/actions-hugo@v2
         with:
-          hugo-version: '0.109.0'
+          hugo-version: '0.119.0'
           extended: true
 
       - name: Build

diff --git a/config.yaml b/config.yaml
@@ -51,7 +51,7 @@ security:
       - ^REVIEW_ID
 
 params:
-  latest: "1.13"
+  latest: "1.14"
   upboundLink: "https://www.upbound.io/"
   slackLink: "https://slack.crossplane.io/"
   githubLink: "https://github.com/crossplane/crossplane"

diff --git a/content/contribute/features.md b/content/contribute/features.md
@@ -123,9 +123,9 @@ Hugo to fail.
 
 ## Images
 All images are in `/content/media`.  
-Crossplane supports standard [Markdown image
-syntax](https://www.markdownguide.org/basic-syntax/#images-1) but using the
-`img` shortcode is strongly recommended.
+Crossplane supports standard 
+[Markdown image syntax](https://www.markdownguide.org/basic-syntax/#images-1) 
+but using the `img` shortcode is strongly recommended.
 
 Images using the shortcode are automatically converted to `webp` image format,
 compressed and use responsive image sizing. 
@@ -157,8 +157,9 @@ Which generates this responsive image (change your browser size to see it change
 {{<img src="/media/banner.png" alt="Crossplane Popsicle Truck" size="small" >}}
 
 ## Links
-Crossplane docs support standard [Markdown
-links](https://www.markdownguide.org/basic-syntax/#links) but Crossplane prefers link shortcodes
+Crossplane docs support standard 
+[Markdown links](https://www.markdownguide.org/basic-syntax/#links) 
+but Crossplane prefers link shortcodes
 for links between docs pages. Using shortcodes prevents incorrect link creation
 and notifies which links to change after moving a page.
 
@@ -187,8 +188,9 @@ If the `ref` value points to a page that doesn't exist, Hugo fails to start.
 
 ### Linking to external sites
 Minimize linking to external sites. When linking to any page outside of
-`crossplane.io` use standard [markdown link
-syntax](https://www.markdownguide.org/basic-syntax/#links) without using the
+`crossplane.io` use standard 
+[markdown link syntax](https://www.markdownguide.org/basic-syntax/#links) 
+without using the
 `ref` shortcode.
 
 For example, 

diff --git a/content/master/concepts/compositions.md b/content/master/concepts/compositions.md
@@ -1322,8 +1322,8 @@ Composition.
 
 ## Composition validation
 
-When creating a Composition Crossplane automatically validates specific
-parameters in the Composition.
+When creating a Composition, Crossplane automatically validates its integrity,
+checking that the Composition is well formed, for example:
 
 If using `mode: Resources`:
 
@@ -1344,47 +1344,78 @@ If using `mode: Pipeline` (Composition Functions):
 * The `pipeline` field isn't empty.
 * No duplicate step names.
 
-### Resource schema validation
-<!-- vale write-good.TooWordy = NO -->
-Optionally, Crossplane can also validate the schema of the resources defined
-inside a Composition. This verifies that the resource `apiVersion` and `kinds`
-are valid. 
-<!-- vale write-good.TooWordy = YES -->
+### Composition schema aware validation
+
+Crossplane also performs schema aware
+validation of Compositions. Schema validation checks that `patches`, 
+`readinessChecks` and `connectionDetails` are valid according to the resource 
+schemas. For example, checking that the source and destination fields of a patch 
+are valid according to the source and destination resource schema.
+
+{{<hint "note" >}}
+Composition schema aware validation is a beta feature. Crossplane enables
+beta features by default. 
+
+Disable schema aware validation by setting the
+`--enable-composition-webhook-schema-validation=false` flag on the Crossplane
+pod.  
 
-Enable "schema validation" with the
-`--enable-composition-webhook-schema-validation` flag on the Crossplane pod.
 The [Crossplane Pods]({{<ref "./pods#edit-the-deployment">}}) page has
 more information on enabling Crossplane flags.
+{{< /hint >}}
+
+#### Schema aware validation modes
+
+Crossplane always rejects Compositions in case of integrity errors.
+
+Set the schema aware validation mode to configure how Crossplane handles both
+missing resource schemas and schema aware validation errors.
 
 {{<hint "note" >}}
-<!-- vale write-good.TooWordy = NO -->
-Schema validation only checks the `apiVersion` and `kind` are valid. Schema
-validation doesn't validate the fields of a specific resource.
-<!-- vale write-good.TooWordy = YES -->
+If a resource schema is missing, Crossplane skips schema aware validation
+but still returns an error for integrity errors and a warning or an error
+for the missing schemas.
 {{< /hint >}}
 
-The default validations are still checked with schema validation enabled. 
-#### Validation modes
+The following modes are available:
 
-Schema validation supports two modes:
-* `loose` (default) - Sends an warning for each schema error and installs the 
-  Composition if the default validations pass. 
-* `strict` - Send an error for every schema validation error and rejects the
-  Composition. 
+{{< table "table table-sm table-striped" >}}
+| Mode     | Missing Schema | Schema Aware Error | Integrity Error |
+| -------- | -------------- |--------------------|-----------------|
+| `warn`   | Warning        | Warning            | Error           |
+| `loose`  | Warning        | Error              | Error           |
+| `strict` | Error          | Error              | Error           |
+{{< /table >}}
 
 Change the validation mode for a Composition with the
-{{<hover label="mode" line="5">}}crossplane.io/composition-validation-mode{{</hover>}} 
-annotation. 
+{{<hover label="mode" line="5">}}crossplane.io/composition-schema-aware-validation-mode{{</hover>}} 
+annotation.
+
+If not specified, the default mode is `warn`.
 
-For example, to enable `strict` mode checking:
+For example, to enable `loose` mode checking set the annotation value to 
+{{<hover label="mode" line="5">}}loose{{</hover>}}.
 
 ```yaml {copy-lines="none",label="mode"}
 apiVersion: apiextensions.crossplane.io/v1
 kind: Composition
 metadata:
   annotations:
-    crossplane.io/composition-validation-mode: strict
+    crossplane.io/composition-schema-aware-validation-mode: loose
   # Removed for brevity
 spec:
   # Removed for brevity
 ```
+
+{{<hint "important" >}}
+Validation modes also apply to Compositions defined by Configuration packages.
+
+Depending on the mode configured in the Composition, schema aware validation
+issues may result in warnings or the rejection of the Composition.
+
+View the Crossplane logs for validation warnings.
+
+Crossplane sets a Configuration as unhealthy if there are validation errors.
+View the Configuration details with `kubectl describe configuration` to see the
+specific errors.
+{{< /hint >}}
diff --git a/content/master/concepts/environment-configs.md b/content/master/concepts/environment-configs.md
@@ -1,6 +1,6 @@
 ---
 title: Environment Configurations
-weight: 90
+weight: 75
 state: alpha
 alphaVersion: "1.11"
 description: "Environment Configurations or EnvironmentConfigs are an in-memory datastore used in patching Compositions"

diff --git a/content/master/concepts/managed-resources.md b/content/master/concepts/managed-resources.md
@@ -308,8 +308,9 @@ spec:
 ### managementPolicies
 <!-- vale on --> 
 
-{{<hint "important" >}}
-The managed resource `managementPolicies` option is an alpha feature.
+{{<hint "note" >}}
+The managed resource `managementPolicies` option is a beta feature. Crossplane enables
+beta features by default. 
 
 The Provider determines support for management policies.  
 Refer to the Provider's documentation to see if the Provider supports

diff --git a/content/master/concepts/providers.md b/content/master/concepts/providers.md
@@ -600,7 +600,7 @@ a future release.
 <!-- vale gitlab.FutureTense = YES -->
 
 [`DeploymentRuntimeConfig`]({{<ref "#runtime-configuration" >}}) is the
-replacement for Controller configuration and is available in v1.14.
+replacement for Controller configuration and is available in v1.14+.
 {{< /hint >}}
 
 Applying a Crossplane `ControllerConfig` to a Provider changes the settings of

diff --git a/content/master/concepts/usages.md b/content/master/concepts/usages.md
@@ -189,7 +189,7 @@ spec:
           baz: qux
 ```
 
-## Usage in a composition
+## Usage in a Composition
 
 A typical use case for Usages is to define a deletion ordering between the
 resources in a Composition. The Usages support

diff --git a/content/master/software/install.md b/content/master/software/install.md
@@ -245,10 +245,10 @@ at the table below.
 {{< table caption="Feature flags" >}}
 | Status | Flag | Description |
 | --- | --- | --- |
-| Beta | `--enable-composition-revisions` |Enable support for CompositionRevisions. |
-| Beta | `--enable-deployment-runtime-configs` |Enable support for Deployment Runtime Configurations. |
+| Beta | `--enable-composition-revisions` |Enable support for CompositionRevisions |
+| Beta | `--enable-composition-webhook-schema-validation` | Enable Composition validation using schemas. |
+| Beta | `--enable-deployment-runtime-configs` |Enable support for Deployment Runtime Configs. |
 | Alpha | `--enable-composition-functions` | Enable support for Composition Functions. |
-| Alpha | `--enable-composition-webhook-schema-validation` | Enable Composition validation using schemas. |
 | Alpha | `--enable-environment-configs` | Enable support for EnvironmentConfigs. |
 | Alpha | `--enable-external-secret-stores` | Enable support for External Secret Stores. |
 | Alpha | `--enable-usages` | Enable support for Usages. |