Skip to content

Commit

Permalink
Update Vale to latest (#534)
Browse files Browse the repository at this point in the history
  • Loading branch information
plumbis authored Aug 28, 2023
1 parent fd41266 commit 151ab38
Show file tree
Hide file tree
Showing 88 changed files with 1,866 additions and 453 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/vale.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:

- name: Install Vale
env:
VALE_VERSION: "2.22.0"
VALE_VERSION: "2.28.2"
run: wget https://github.com/errata-ai/vale/releases/download/v${{env.VALE_VERSION}}/vale_${{env.VALE_VERSION}}_Linux_64-bit.tar.gz && tar -xvzf vale_${{env.VALE_VERSION}}_Linux_64-bit.tar.gz

- name: Run Vale
Expand Down
6 changes: 4 additions & 2 deletions content/master/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ APIs. Crossplane can even let you
directly from Kubernetes. If it has an API, Crossplane can connect to it.

With Crossplane, platform teams can create new abstractions and custom
APIs with the full power of Kubernetes policies, namespaces, role-based access
APIs with the full power of Kubernetes policies, namespaces, role based access
controls and more. Crossplane brings all your non-Kubernetes resources under
one roof.

Expand All @@ -29,16 +29,18 @@ and use Kubernetes as the control plane for everything.

{{< hint "tip" >}}
**What's a control plane?**
<!-- vale Google.WordList = NO -->
Control planes create and manage the lifecycle of resources. Control planes
constantly _check_ that the intended resources exist, _report_ when the intended
state doesn't match reality and _act_ to make things right.

Crossplane extends the Kubernetes control plane to be a **universal control
plane** to check, report and act on any resource, anywhere.
<!-- vale Google.WordList = YES -->
{{< /hint >}}


# Get Started
# Get started
* [Install Crossplane]({{<ref "software/install">}}) in your Kubernetes cluster
* Learn more about how Crossplane works in the
[Crossplane introduction]({{<ref "getting-started/introduction" >}})
Expand Down
3 changes: 1 addition & 2 deletions content/master/concepts/claims.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,5 +204,4 @@ spec:
name: my-claim-secret
```
For more information on connection secrets read the [Connection Secrets
knowledge base article]({{<ref "/knowledge-base/guides/connection-details">}}).
For more information on connection secrets read the [Connection Secrets knowledge base article]({{<ref "/knowledge-base/guides/connection-details">}}).
19 changes: 7 additions & 12 deletions content/master/concepts/composite-resource-definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -258,8 +258,7 @@ on what your OpenAPIv3 custom API can use.
{{<hint "important" >}}
Changing or expanding the XRD schema requires restarting the [Crossplane
pod]({{<ref "./pods#crossplane-pod">}}) to take effect.
Changing or expanding the XRD schema requires restarting the [Crossplane pod]({{<ref "./pods#crossplane-pod">}}) to take effect.
{{< /hint >}}
##### Required fields
Expand Down Expand Up @@ -351,8 +350,7 @@ object,
- location
```
The Swagger "[Describing
Parameters](https://swagger.io/docs/specification/describing-parameters/)"
The Swagger "[Describing Parameters](https://swagger.io/docs/specification/describing-parameters/)"
documentation has more examples.
##### Crossplane reserved fields
Expand Down Expand Up @@ -415,8 +413,7 @@ field indicates which version of the schema Compositions use. Only one
version can be `referenceable`.

{{< hint "note" >}}
Changing which version is `referenceable:true` requires [updating the
`compositeTypeRef.apiVersion`]({{<ref "./compositions#enabling-composite-resources" >}})
Changing which version is `referenceable:true` requires [updating the `compositeTypeRef.apiVersion`]({{<ref "./compositions#enabling-composite-resources" >}})
of any Compositions referencing that XRD.
{{< /hint >}}

Expand All @@ -427,8 +424,7 @@ of any Compositions referencing that XRD.
Crossplane supports defining multiple `versions`, but the schema of each version
can't change any existing fields, also called "making a breaking change."

Breaking schema changes between versions requires the use of [conversion
webhooks](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definition-versioning/#webhook-conversion).
Breaking schema changes between versions requires the use of [conversion webhooks](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definition-versioning/#webhook-conversion).

New versions may define new optional parameters, but new required fields are
a "breaking change."
Expand Down Expand Up @@ -496,8 +492,7 @@ spec:

{{<hint "important" >}}

Changing or expanding the XRD schema requires restarting the [Crossplane
pod]({{<ref "./pods#crossplane-pod">}}) to take effect.
Changing or expanding the XRD schema requires restarting the [Crossplane pod]({{<ref "./pods#crossplane-pod">}}) to take effect.
{{< /hint >}}

### Enable Claims
Expand Down Expand Up @@ -622,8 +617,8 @@ You can't change the `connectionSecretKeys` of an XRD. You must delete and
recreate the XRD to change the `connectionSecretKeys`.
{{</hint >}}

For more information on connection secrets read the [Connection Secrets
knowledge base article]({{<ref "/knowledge-base/guides/connection-details">}}).
For more information on connection secrets read the
[Connection Secrets knowledge base article]({{<ref "/knowledge-base/guides/connection-details">}}).

### Set composite resource defaults
XRDs can set default parameters for composite resources and Claims.
Expand Down
9 changes: 3 additions & 6 deletions content/master/concepts/composite-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,7 @@ spec:
toFieldPath: metadata.annotations
```
For more information on patching resources refer to the [Patch and
Transform]({{<ref "./patch-and-transform">}}) documentation.
For more information on patching resources refer to the [Patch and Transform]({{<ref "./patch-and-transform">}}) documentation.
### Composition selection
Expand Down Expand Up @@ -282,8 +281,7 @@ to the composite resource.
A resource may only access connection secrets allowed by the XRD. By
default XRDs provide access to all connection secrets generated by managed
resources.
Read more about [managing connection
secrets]({{<ref "./composite-resource-definitions#manage-connection-secrets">}})
Read more about [managing connection secrets]({{<ref "./composite-resource-definitions#manage-connection-secrets">}})
in the XRD documentation.
{{< /hint >}}

Expand Down Expand Up @@ -335,8 +333,7 @@ spec:
Read the [External Secrets Store]({{<ref "/knowledge-base/integrations/vault-as-secret-store">}}) documentation for more information on using
external secret stores.

For more information on connection secrets read the [Connection Secrets
knowledge base article]({{<ref "/knowledge-base/guides/connection-details">}}).
For more information on connection secrets read the [Connection Secrets knowledge base article]({{<ref "/knowledge-base/guides/connection-details">}}).

### Pausing composite resources

Expand Down
15 changes: 6 additions & 9 deletions content/master/concepts/compositions.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ the external resource name.
#### Template a ProviderConfig

Compositions can define a ProviderConfig like it defines managed resources.
Generating a ProviderConfig may be useful in providing unique credentials to
Generating a ProviderConfig can provide unique credentials to
each deployment.


Expand Down Expand Up @@ -240,8 +240,7 @@ Composition, the resources defined by the
the EKS {{<hover label="xcluster" line="13">}}cluster{{</hover >}}.

{{<hint "note" >}}
This abbreviated example is from the Upbound [AWS Reference
Platform](https://github.com/upbound/platform-ref-aws).
This abbreviated example is from the Upbound [AWS Reference Platform](https://github.com/upbound/platform-ref-aws).

View the complete Compositions in the reference platform's
[package directory](https://github.com/upbound/platform-ref-aws/blob/main/package/cluster/composition.yaml).
Expand Down Expand Up @@ -446,8 +445,7 @@ Most Compositions require customizing the fields of the resources. This can
include applying unique passwords, modifying where to deploy resources,
or applying labels or annotations.

The primary method to change resources is using a resource [patch and
transform]({{<ref "./patch-and-transform" >}}). Patch and transforms allow
The primary method to change resources is using a resource [patch and transform]({{<ref "./patch-and-transform" >}}). Patch and transforms allow
matching specific input fields, modifying them and applying them to the managed
resource.

Expand Down Expand Up @@ -892,8 +890,7 @@ Read the
for more information on restricting secret keys.
{{< /hint >}}

For more information on connection secrets read the [Connection Secrets
knowledge base article]({{<ref "/knowledge-base/guides/connection-details">}}).
For more information on connection secrets read the [Connection Secrets knowledge base article]({{<ref "/knowledge-base/guides/connection-details">}}).

{{<hint "warning">}}
You can't change the
Expand Down Expand Up @@ -1007,7 +1004,7 @@ Compositions support matching resource fields by:
#### Match a string

{{<hover label="matchstring" line="11">}}MatchString{{</hover>}} considers the composed resource to be ready when the value of a
field within that resource matches a specified string.
field in that resource matches a specified string.

{{<hint "note" >}}
<!-- vale Google.WordList = NO -->
Expand Down Expand Up @@ -1042,7 +1039,7 @@ spec:
#### Match an integer

{{<hover label="matchint" line="11">}}MatchInteger{{</hover>}} considers the composed resource to be ready when the value of a
field within that resource matches a specified integer.
field in that resource matches a specified integer.

{{<hint "note" >}}
<!-- vale Google.WordList = NO -->
Expand Down
6 changes: 2 additions & 4 deletions content/master/concepts/managed-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +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 [Upbound AWS Provider](https://marketplace.upbound.io/providers/upbound/provider-aws/latest/)
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 @@ -650,8 +649,7 @@ call and receiving a response.
If a Provider restarts before creating the `succeed` or `fail` annotations the
Provider can't reconcile the manged resource.

Read Crossplane [issue
#3037](https://github.com/crossplane/crossplane/issues/3037#issuecomment-1110142427)
Read Crossplane [issue #3037](https://github.com/crossplane/crossplane/issues/3037#issuecomment-1110142427)
for more details
{{< /hint >}}

Expand Down
3 changes: 1 addition & 2 deletions content/master/concepts/pods.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,8 +276,7 @@ updates the Roles to access the specific API endpoints in a Claim.

{{< hint "note" >}}
The specific details of the namespace Roles are beyond this guide. For more
information read the [Composite Resource ClusterRole
Mechanics](https://github.com/crossplane/crossplane/blob/master/design/design-doc-rbac-manager.md#composite-resource-clusterrole-mechanics)
information read the [Composite Resource ClusterRole Mechanics](https://github.com/crossplane/crossplane/blob/master/design/design-doc-rbac-manager.md#composite-resource-clusterrole-mechanics)
section of the RBAC Manager design document.
{{< /hint >}}

Expand Down
6 changes: 2 additions & 4 deletions content/master/concepts/providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@ Kubernetes API endpoint. These endpoints are

{{< hint "note" >}}
Instructions on building your own Provider are outside of the scope of this
document. Read the Crossplane contributing [Provider Development
Guide](https://github.com/crossplane/crossplane/blob/master/contributing/guide-provider-development.md)
document. Read the Crossplane contributing [Provider Development Guide](https://github.com/crossplane/crossplane/blob/master/contributing/guide-provider-development.md)
for more information.
{{< /hint >}}

Expand Down Expand Up @@ -132,8 +131,7 @@ If you remove the Provider first, you must manually delete external resources
through your cloud provider. Managed resources must be manually deleted by
removing their finalizers.

For more information on deleting abandoned resources read the [Crossplane
troubleshooting guide]({{<ref "/knowledge-base/guides/troubleshoot#deleting-when-a-resource-hangs" >}}).
For more information on deleting abandoned resources read the [Crossplane troubleshooting guide]({{<ref "/knowledge-base/guides/troubleshoot#deleting-when-a-resource-hangs" >}}).
{{< /hint >}}

## Verify a Provider
Expand Down
5 changes: 2 additions & 3 deletions content/master/getting-started/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ defines a
[`bucket`](https://marketplace.upbound.io/providers/upbound/provider-aws/v0.25.0/resources/s3.aws.upbound.io/Bucket/v1beta1)
resource for creating and managing AWS S3 storage buckets.

Within the `bucket` CRD is a
In the `bucket` CRD is a
[`spec.forProvider.region`](https://marketplace.upbound.io/providers/upbound/provider-aws/v0.25.0/resources/s3.aws.upbound.io/Bucket/v1beta1#doc:spec-forProvider-region)
value that defines which AWS region to deploy the bucket in.

Expand Down Expand Up @@ -147,8 +147,7 @@ Depending on the size of the API server and number of managed resources, this
command may take minutes to return or may timeout.

For more information, read
[Kubernetes issue
#111880](https://github.com/kubernetes/kubernetes/issues/111880)
[Kubernetes issue #111880](https://github.com/kubernetes/kubernetes/issues/111880)
and
[Crossplane issue #3459](https://github.com/crossplane/crossplane/issues/3459).
{{< /hint >}}
Expand Down
18 changes: 9 additions & 9 deletions content/master/getting-started/provider-aws-part-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ is strongly recommended.
This guide uses the group
{{<hover label="version" line="1">}}database.example.com{{</hover>}}.

Since this is the first version of the API, this guide uses the version
Because this is the first version of the API, this guide uses the version
{{<hover label="version" line="1">}}v1alpha1{{</hover>}}.

```yaml {label="version",copy-lines="none"}
Expand All @@ -141,7 +141,7 @@ apiVersion: database.example.com/v1alpha1

### Define a kind

The API group is a logical collection of related APIs. Within a group are
The API group is a logical collection of related APIs. In a group are
individual kinds representing different resources.

For example a `database` group may have a `Relational` and `NoSQL` kinds.
Expand Down Expand Up @@ -283,11 +283,11 @@ Each entry in the template
is a full resource definitions, defining all the resource settings and metadata
like labels and annotations.

This template creates a GCP
{{<hover label="comp" line="13">}}storage{{</hover>}}
This template creates an AWS
{{<hover label="comp" line="13">}}S3{{</hover>}}
{{<hover label="comp" line="14">}}Bucket{{</hover>}} and a
{{<hover label="comp" line="33">}}Pubsub{{</hover>}}
{{<hover label="comp" line="34">}}Topic{{</hover>}}.
{{<hover label="comp" line="33">}}DynamoDB{{</hover>}}
{{<hover label="comp" line="34">}}Table{{</hover>}}.

Crossplane uses {{<hover label="comp" line="19">}}patches{{</hover>}} to apply
the user's input to the resource template.
Expand Down Expand Up @@ -319,7 +319,7 @@ spec:
name: default
patches:
- type: FromCompositeFieldPath
fromFieldPath: "spec.location"
fromFieldPath: "location"
toFieldPath: "spec.forProvider.region"
transforms:
- type: map
Expand All @@ -343,7 +343,7 @@ spec:
hashKey: S3ID
patches:
- type: FromCompositeFieldPath
fromFieldPath: "location"
fromFieldPath: "spec.location"
toFieldPath: "spec.forProvider.region"
transforms:
- type: map
Expand Down Expand Up @@ -473,7 +473,7 @@ Accessing the API `nosql` happens at the cluster scope.
Most organizations
isolate their users into namespaces.

A Crossplane _Claim_ is the custom API within a namespace.
A Crossplane _Claim_ is the custom API in a namespace.

Creating a _Claim_ is just like accessing the custom API endpoint, but with the
{{<hover label="claim" line="3">}}kind{{</hover>}}
Expand Down
Loading

0 comments on commit 151ab38

Please sign in to comment.