Skip to content

Commit 51135b0

Browse files
mjtrangoniFxKu
andauthored
docs: Fix issues found by codespell (#2896)
Signed-off-by: Mario Trangoni <[email protected]> Co-authored-by: Felix Kunde <[email protected]>
1 parent ccb52c0 commit 51135b0

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

docs/administrator.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -384,7 +384,7 @@ exceptions:
384384
The interval of days can be set with `password_rotation_interval` (default
385385
`90` = 90 days, minimum 1). On each rotation the user name and password values
386386
are replaced in the K8s secret. They belong to a newly created user named after
387-
the original role plus rotation date in YYMMDD format. All priviliges are
387+
the original role plus rotation date in YYMMDD format. All privileges are
388388
inherited meaning that migration scripts should still grant and revoke rights
389389
against the original role. The timestamp of the next rotation (in RFC 3339
390390
format, UTC timezone) is written to the secret as well. Note, if the rotation
@@ -564,7 +564,7 @@ manifest affinity.
564564
```
565565

566566
If `node_readiness_label_merge` is set to `"OR"` (default) the readiness label
567-
affinty will be appended with its own expressions block:
567+
affinity will be appended with its own expressions block:
568568

569569
```yaml
570570
affinity:
@@ -1140,7 +1140,7 @@ metadata:
11401140
iam.gke.io/gcp-service-account: <GCP_SERVICE_ACCOUNT_NAME>@<GCP_PROJECT_ID>.iam.gserviceaccount.com
11411141
```
11421142
1143-
2. Specify the new custom service account in your [operator paramaters](./reference/operator_parameters.md)
1143+
2. Specify the new custom service account in your [operator parameters](./reference/operator_parameters.md)
11441144
11451145
If using manual deployment or kustomize, this is done by setting
11461146
`pod_service_account_name` in your configuration file specified in the

docs/reference/cluster_manifest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ These parameters are grouped directly under the `spec` key in the manifest.
247247
[kubernetes volumeSource](https://godoc.org/k8s.io/api/core/v1#VolumeSource).
248248
It allows you to mount existing PersistentVolumeClaims, ConfigMaps and Secrets inside the StatefulSet.
249249
Also an `emptyDir` volume can be shared between initContainer and statefulSet.
250-
Additionaly, you can provide a `SubPath` for volume mount (a file in a configMap source volume, for example).
250+
Additionally, you can provide a `SubPath` for volume mount (a file in a configMap source volume, for example).
251251
Set `isSubPathExpr` to true if you want to include [API environment variables](https://kubernetes.io/docs/concepts/storage/volumes/#using-subpath-expanded-environment).
252252
You can also specify in which container the additional Volumes will be mounted with the `targetContainers` array option.
253253
If `targetContainers` is empty, additional volumes will be mounted only in the `postgres` container.
@@ -257,7 +257,7 @@ These parameters are grouped directly under the `spec` key in the manifest.
257257
## Prepared Databases
258258

259259
The operator can create databases with default owner, reader and writer roles
260-
without the need to specifiy them under `users` or `databases` sections. Those
260+
without the need to specify them under `users` or `databases` sections. Those
261261
parameters are grouped under the `preparedDatabases` top-level key. For more
262262
information, see [user docs](../user.md#prepared-databases-with-roles-and-default-privileges).
263263

docs/reference/operator_parameters.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ under the `users` key.
209209
For all `LOGIN` roles that are not database owners the operator can rotate
210210
credentials in the corresponding K8s secrets by replacing the username and
211211
password. This means, new users will be added on each rotation inheriting
212-
all priviliges from the original roles. The rotation date (in YYMMDD format)
212+
all privileges from the original roles. The rotation date (in YYMMDD format)
213213
is appended to the names of the new user. The timestamp of the next rotation
214214
is written to the secret. The default is `false`.
215215

@@ -552,7 +552,7 @@ configuration they are grouped under the `kubernetes` key.
552552
pods with `InitialDelaySeconds: 6`, `PeriodSeconds: 10`, `TimeoutSeconds: 5`,
553553
`SuccessThreshold: 1` and `FailureThreshold: 3`. When enabling readiness
554554
probes it is recommended to switch the `pod_management_policy` to `parallel`
555-
to avoid unneccesary waiting times in case of multiple instances failing.
555+
to avoid unnecessary waiting times in case of multiple instances failing.
556556
The default is `false`.
557557

558558
* **storage_resize_mode**
@@ -701,7 +701,7 @@ In the CRD-based configuration they are grouped under the `load_balancer` key.
701701
replaced by the cluster name, `{namespace}` is replaced with the namespace
702702
and `{hostedzone}` is replaced with the hosted zone (the value of the
703703
`db_hosted_zone` parameter). The `{team}` placeholder can still be used,
704-
although it is not recommened because the team of a cluster can change.
704+
although it is not recommended because the team of a cluster can change.
705705
If the cluster name starts with the `teamId` it will also be part of the
706706
DNS, aynway. No other placeholders are allowed!
707707

@@ -720,7 +720,7 @@ In the CRD-based configuration they are grouped under the `load_balancer` key.
720720
is replaced by the cluster name, `{namespace}` is replaced with the
721721
namespace and `{hostedzone}` is replaced with the hosted zone (the value of
722722
the `db_hosted_zone` parameter). The `{team}` placeholder can still be used,
723-
although it is not recommened because the team of a cluster can change.
723+
although it is not recommended because the team of a cluster can change.
724724
If the cluster name starts with the `teamId` it will also be part of the
725725
DNS, aynway. No other placeholders are allowed!
726726

docs/user.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -900,7 +900,7 @@ the PostgreSQL version between source and target cluster has to be the same.
900900

901901
To start a cluster as standby, add the following `standby` section in the YAML
902902
file. You can stream changes from archived WAL files (AWS S3 or Google Cloud
903-
Storage) or from a remote primary. Only one option can be specfied in the
903+
Storage) or from a remote primary. Only one option can be specified in the
904904
manifest:
905905

906906
```yaml
@@ -911,7 +911,7 @@ spec:
911911

912912
For GCS, you have to define STANDBY_GOOGLE_APPLICATION_CREDENTIALS as a
913913
[custom pod environment variable](administrator.md#custom-pod-environment-variables).
914-
It is not set from the config to allow for overridding.
914+
It is not set from the config to allow for overriding.
915915

916916
```yaml
917917
spec:
@@ -1282,7 +1282,7 @@ minutes if the certificates have changed and reloads postgres accordingly.
12821282
### TLS certificates for connection pooler
12831283

12841284
By default, the pgBouncer image generates its own TLS certificate like Spilo.
1285-
When the `tls` section is specfied in the manifest it will be used for the
1285+
When the `tls` section is specified in the manifest it will be used for the
12861286
connection pooler pod(s) as well. The security context options are hard coded
12871287
to `runAsUser: 100` and `runAsGroup: 101`. The `fsGroup` will be the same
12881288
like for Spilo.

0 commit comments

Comments
 (0)