Browse Source

:book: fix typo (#2042)

Signed-off-by: bvdboom <bvdboom@users.noreply.github.com>
Co-authored-by: Bernard <bv.local>
bvdboom 3 years ago
parent
commit
13f26e6e24

+ 2 - 2
docs/api/controller-options.md

@@ -11,7 +11,7 @@ The external-secrets binary includes three components: `core controller`, `certc
 
 
 The core controller is invoked without a subcommand and can be configured with the following flags:
 The core controller is invoked without a subcommand and can be configured with the following flags:
 
 
-| Name                                          | Type     | Default                       | Descripton                                                                                                                                                         |
+| Name                                          | Type     | Default                       | Description                                                                                                                                                         |
 | --------------------------------------------- | -------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | --------------------------------------------- | -------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `--client-burst`                              | int      | uses rest client default (10) | Maximum Burst allowed to be passed to rest.Client                                                                                                                  |
 | `--client-burst`                              | int      | uses rest client default (10) | Maximum Burst allowed to be passed to rest.Client                                                                                                                  |
 | `--client-qps`                                | float32  | uses rest client default (5)  | QPS configuration to be passed to rest.Client                                                                                                                      |
 | `--client-qps`                                | float32  | uses rest client default (5)  | QPS configuration to be passed to rest.Client                                                                                                                      |
@@ -47,7 +47,7 @@ The core controller is invoked without a subcommand and can be configured with t
 
 
 ## Webhook Flags
 ## Webhook Flags
 
 
-| Name                   | Type     | Default                               | Descripton                                                                                                                                                                                                                                                                                                                                                                                                               |
+| Name                   | Type     | Default                               | Description                                                                                                                                                                                                                                                                                                                                                                                                               |
 | ---------------------- | -------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | ---------------------- | -------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `--cert-dir`           | string   | /tmp/k8s-webhook-server/serving-certs | path to check for certs                                                                                                                                                                                                                                                                                                                                                                                                  |
 | `--cert-dir`           | string   | /tmp/k8s-webhook-server/serving-certs | path to check for certs                                                                                                                                                                                                                                                                                                                                                                                                  |
 | `--check-interval`     | duration | 5m0s                                  | certificate check interval                                                                                                                                                                                                                                                                                                                                                                                               |
 | `--check-interval`     | duration | 5m0s                                  | certificate check interval                                                                                                                                                                                                                                                                                                                                                                                               |

+ 1 - 1
docs/api/spec.md

@@ -5185,7 +5185,7 @@ External Secrets meta/v1.SecretKeySelector
 <td><p>Error indicates that there is a misconfiguration.</p>
 <td><p>Error indicates that there is a misconfiguration.</p>
 </td>
 </td>
 </tr><tr><td><p>0</p></td>
 </tr><tr><td><p>0</p></td>
-<td><p>Ready indicates that the client is confgured correctly
+<td><p>Ready indicates that the client is configured correctly
 and can be used.</p>
 and can be used.</p>
 </td>
 </td>
 </tr><tr><td><p>1</p></td>
 </tr><tr><td><p>1</p></td>

+ 1 - 1
docs/contributing/process.md

@@ -58,7 +58,7 @@ make test.e2e GINKGO_LABELS='gcp&&!managed'
 
 
 #### Managed Kubernetes e2e tests
 #### Managed Kubernetes e2e tests
 
 
-There's another suite of e2e tests that integrate with managed Kuberentes offerings.
+There's another suite of e2e tests that integrate with managed Kubernetes offerings.
 They create real infrastructure at a cloud provider and deploy the controller
 They create real infrastructure at a cloud provider and deploy the controller
 into that environment.
 into that environment.
 This is necessary to test the authentication integration
 This is necessary to test the authentication integration

File diff suppressed because it is too large
+ 1 - 1
docs/examples/jenkins-kubernetes-credentials.md


+ 1 - 1
docs/guides/multi-tenancy.md

@@ -1,5 +1,5 @@
 External Secrets Operator provides different modes of operation to fulfill
 External Secrets Operator provides different modes of operation to fulfill
-ogranizational needs. This guide outlines the flexibility of ESO and should give
+organizational needs. This guide outlines the flexibility of ESO and should give
 you a first impression of how you can employ this operator in your organization.
 you a first impression of how you can employ this operator in your organization.
 
 
 For a multi-tenant deployment you should first examine your organizational
 For a multi-tenant deployment you should first examine your organizational

+ 3 - 3
docs/guides/templating.md

@@ -146,9 +146,9 @@ spec:
 ##### Functions removed/replaced
 ##### Functions removed/replaced
 
 
 - `base64encode` was renamed to `b64enc`.
 - `base64encode` was renamed to `b64enc`.
-- `base64decode` was renamed to `b64dec`. Any errors that occurr during decoding are silenced.
-- `fromJSON` was renamed to `fromJson`. Any errors that occurr during unmarshalling are silenced.
-- `toJSON` was renamed to `toJson`. Any errors that occurr during marshalling are silenced.
+- `base64decode` was renamed to `b64dec`. Any errors that occur during decoding are silenced.
+- `fromJSON` was renamed to `fromJson`. Any errors that occur during unmarshalling are silenced.
+- `toJSON` was renamed to `toJson`. Any errors that occur during marshalling are silenced.
 - `pkcs12key` and `pkcs12keyPass` encode the PKCS#8 key directly into PEM format. There is no need to call `pemPrivateKey` anymore. Also, these functions do extract all private keys from the PKCS#12 archive not just the first one.
 - `pkcs12key` and `pkcs12keyPass` encode the PKCS#8 key directly into PEM format. There is no need to call `pemPrivateKey` anymore. Also, these functions do extract all private keys from the PKCS#12 archive not just the first one.
 - `pkcs12cert` and `pkcs12certPass` encode the certs directly into PEM format. There is no need to call `pemCertificate` anymore. These functions now **extract all certificates** from the PKCS#12 archive not just the first one.
 - `pkcs12cert` and `pkcs12certPass` encode the certs directly into PEM format. There is no need to call `pemCertificate` anymore. These functions now **extract all certificates** from the PKCS#12 archive not just the first one.
 - `toString` implementation was replaced by the `sprig` implementation and should be api-compatible.
 - `toString` implementation was replaced by the `sprig` implementation and should be api-compatible.

+ 2 - 2
docs/provider/azure-key-vault.md

@@ -40,7 +40,7 @@ A service Principal client and Secret is created and the JSON keyfile is stored
 
 
 A Managed Identity should be created in Azure, and that Identity should have proper rights to the keyvault to be managed by the operator.
 A Managed Identity should be created in Azure, and that Identity should have proper rights to the keyvault to be managed by the operator.
 
 
-If there are multiple Managed Identitites for different keyvaults, the operator should have been assigned all identities via [aad-pod-identity](https://azure.github.io/aad-pod-identity/docs/), then the SecretStore configuration should include the Id of the idenetity to be used via the `identityId` field.
+If there are multiple Managed Identities for different keyvaults, the operator should have been assigned all identities via [aad-pod-identity](https://azure.github.io/aad-pod-identity/docs/), then the SecretStore configuration should include the Id of the identity to be used via the `identityId` field.
 
 
 ```yaml
 ```yaml
 {% include 'azkv-secret-store-mi.yaml' %}
 {% include 'azkv-secret-store-mi.yaml' %}
@@ -94,7 +94,7 @@ Be sure the `azurekv` provider is listed in the `Kind=SecretStore`
 ```
 ```
 **NOTE:** In case of a `ClusterSecretStore`, Be sure to provide `namespace` in `clientId` and `clientSecret`  with the namespaces where the secrets reside.
 **NOTE:** In case of a `ClusterSecretStore`, Be sure to provide `namespace` in `clientId` and `clientSecret`  with the namespaces where the secrets reside.
 
 
-Or in case of Managed Idenetity authentication:
+Or in case of Managed Identity authentication:
 
 
 ```yaml
 ```yaml
 {% include 'azkv-secret-store-mi.yaml' %}
 {% include 'azkv-secret-store-mi.yaml' %}

+ 2 - 2
docs/provider/google-secrets-manager.md

@@ -19,7 +19,7 @@ _Note: If you have installed ESO, a serviceaccount has already been created. You
 - `PROJECT_ID`: Your project ID (not your Project number nor your Project name)
 - `PROJECT_ID`: Your project ID (not your Project number nor your Project name)
 - `K8S_NAMESPACE`: For us following these steps here it will be `es`, but this will be the namespace where you deployed the external-secrets operator
 - `K8S_NAMESPACE`: For us following these steps here it will be `es`, but this will be the namespace where you deployed the external-secrets operator
 - `KSA_NAME`: external-secrets (if you are not creating a new one to attach to the deployment)
 - `KSA_NAME`: external-secrets (if you are not creating a new one to attach to the deployment)
-- `GSA_NAME`: external-secrets for simplicity, or something else if you have to follow different naming convetions for cloud resources
+- `GSA_NAME`: external-secrets for simplicity, or something else if you have to follow different naming conventions for cloud resources
 - `ROLE_NAME`: should be `roles/secretmanager.secretAccessor` - so you make the pod only be able to access secrets on Secret Manager
 - `ROLE_NAME`: should be `roles/secretmanager.secretAccessor` - so you make the pod only be able to access secrets on Secret Manager
 
 
 #### Using Service Accounts directly
 #### Using Service Accounts directly
@@ -80,7 +80,7 @@ You just need to set the `projectID`, all other fields can be omitted.
 ### GCP Service Account authentication
 ### GCP Service Account authentication
 
 
 You can use [GCP Service Account](https://cloud.google.com/iam/docs/service-accounts) to authenticate with GCP. These are static, long-lived credentials. A GCP Service Account is a JSON file that needs to be stored in a `Kind=Secret`. ESO will use that Secret to authenticate with GCP. See here how you [manage GCP Service Accounts](https://cloud.google.com/iam/docs/creating-managing-service-accounts).
 You can use [GCP Service Account](https://cloud.google.com/iam/docs/service-accounts) to authenticate with GCP. These are static, long-lived credentials. A GCP Service Account is a JSON file that needs to be stored in a `Kind=Secret`. ESO will use that Secret to authenticate with GCP. See here how you [manage GCP Service Accounts](https://cloud.google.com/iam/docs/creating-managing-service-accounts).
-After creating a GCP Service acount go to `IAM & Admin` web UI, click `ADD ANOTHER ROLE` button, add `Secret Manager Secret Accessor` role to this service account.
+After creating a GCP Service account go to `IAM & Admin` web UI, click `ADD ANOTHER ROLE` button, add `Secret Manager Secret Accessor` role to this service account.
 The `Secret Manager Secret Accessor` role is required to access secrets.
 The `Secret Manager Secret Accessor` role is required to access secrets.
 
 
 ```yaml
 ```yaml

+ 1 - 1
docs/spec.md

@@ -4935,7 +4935,7 @@ github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
 <td><p>Error indicates that there is a misconfiguration.</p>
 <td><p>Error indicates that there is a misconfiguration.</p>
 </td>
 </td>
 </tr><tr><td><p>0</p></td>
 </tr><tr><td><p>0</p></td>
-<td><p>Ready indicates that the client is confgured correctly
+<td><p>Ready indicates that the client is configured correctly
 and can be used.</p>
 and can be used.</p>
 </td>
 </td>
 </tr><tr><td><p>1</p></td>
 </tr><tr><td><p>1</p></td>