Spelling (#3856)

* spelling: adopt

Signed-off-by: Josh Soref <[email protected]>

* spelling: case-sensitive

Signed-off-by: Josh Soref <[email protected]>

* spelling: certificates

Signed-off-by: Josh Soref <[email protected]>

* spelling: controller

Signed-off-by: Josh Soref <[email protected]>

* spelling: current

Signed-off-by: Josh Soref <[email protected]>

* spelling: directory

Signed-off-by: Josh Soref <[email protected]>

* spelling: disconnected

Signed-off-by: Josh Soref <[email protected]>

* spelling: github

Signed-off-by: Josh Soref <[email protected]>

* spelling: identifier

Signed-off-by: Josh Soref <[email protected]>

* spelling: independently

Signed-off-by: Josh Soref <[email protected]>

* spelling: iterations

Signed-off-by: Josh Soref <[email protected]>

* spelling: jqlang

Signed-off-by: Josh Soref <[email protected]>

* spelling: mismatch

Signed-off-by: Josh Soref <[email protected]>

* spelling: nonexistent

Signed-off-by: Josh Soref <[email protected]>

* spelling: occurred

Signed-off-by: Josh Soref <[email protected]>

* spelling: particularly

Signed-off-by: Josh Soref <[email protected]>

* spelling: password

Signed-off-by: Josh Soref <[email protected]>

* spelling: preexisting

Signed-off-by: Josh Soref <[email protected]>

* spelling: remaining

Signed-off-by: Josh Soref <[email protected]>

* spelling: requeuing

Signed-off-by: Josh Soref <[email protected]>

* spelling: than

Signed-off-by: Josh Soref <[email protected]>

* spelling: the

Signed-off-by: Josh Soref <[email protected]>

* spelling: todo

Signed-off-by: Josh Soref <[email protected]>

* spelling: utilized

Signed-off-by: Josh Soref <[email protected]>

* spelling: version

Signed-off-by: Josh Soref <[email protected]>

---------

Signed-off-by: Josh Soref <[email protected]>

Author: jsoref

CONTRIBUTING.md

@@ -86,7 +86,7 @@ possible as to what the changes are. Good things to include:
 understand.
 ```
 
-If you wish to tag a Github issue or another project management tracker, please
+If you wish to tag a GitHub issue or another project management tracker, please
 do so at the bottom of the commit message, and make it clearly labeled like so:
 
 ```

config/crd/bases/postgres-operator.crunchydata.com_postgresclusters.yaml

@@ -2695,7 +2695,7 @@ spec:
                               - bucket
                               type: object
                             name:
-                              description: The name of the the repository
+                              description: The name of the repository
                               pattern: ^repo[1-4]
                               type: string
                             s3:
@@ -4438,10 +4438,10 @@ spec:
                 properties:
                   pgbackrest:
                     description: 'Defines a pgBackRest cloud-based data source that
-                      can be used to pre-populate the the PostgreSQL data directory
-                      for a new PostgreSQL cluster using a pgBackRest restore. The
-                      PGBackRest field is incompatible with the PostgresCluster field:
-                      only one data source can be used for pre-populating a new PostgreSQL
+                      can be used to pre-populate the PostgreSQL data directory for
+                      a new PostgreSQL cluster using a pgBackRest restore. The PGBackRest
+                      field is incompatible with the PostgresCluster field: only one
+                      data source can be used for pre-populating a new PostgreSQL
                       cluster'
                     properties:
                       affinity:
@@ -5615,7 +5615,7 @@ spec:
                             - bucket
                             type: object
                           name:
-                            description: The name of the the repository
+                            description: The name of the repository
                             pattern: ^repo[1-4]
                             type: string
                           s3:
@@ -15323,7 +15323,7 @@ spec:
                           type: boolean
                         repoOptionsHash:
                           description: A hash of the required fields in the spec for
-                            defining an Azure, GCS or S3 repository, Utilizd to detect
+                            defining an Azure, GCS or S3 repository, Utilized to detect
                             changes to these fields and then execute pgBackRest stanza-create
                             commands accordingly.
                           type: string

installers/olm/Makefile

@@ -66,7 +66,7 @@ tools: ## Download tools needed to build bundles
 tools: tools/$(SYSTEM)/jq
 tools/$(SYSTEM)/jq:
 	install -d '$(dir $@)'
-	curl -fSL -o '$@' "https://github.com/stedolan/jq/releases/download/jq-1.6/jq-$$(SYSTEM='$(SYSTEM)'; \
+	curl -fSL -o '$@' "https://github.com/jqlang/jq/releases/download/jq-1.6/jq-$$(SYSTEM='$(SYSTEM)'; \
 		case "$$SYSTEM" in \
 			(linux-*) echo "$${SYSTEM/-amd/}";; (darwin-*) echo "$${SYSTEM/darwin/osx}";; (*) echo '$(SYSTEM)';; \
 		esac)"

installers/olm/README.md

@@ -55,7 +55,7 @@ Marketplace: https://github.com/redhat-openshift-ecosystem/redhat-marketplace-op
 
 We hit various issues with 5.1.0 where the 'replaces' name, set in the clusterserviceversion.yaml, didn't match the
 expected names found for all indexes. Previously, we set the 'com.redhat.openshift.versions' annotation to "v4.6-v4.9".
-The goal for this setting was to limit the upper bound of supported versions for a particulary PGO release.
+The goal for this setting was to limit the upper bound of supported versions for a particularly PGO release.
 The problem with this was, at the time of the 5.1.0 release, OCP 4.10 had been just been released. This meant that the
 5.0.5 bundle did not exist in the OCP 4.10 index. The solution presented by Red Hat was to use the 'skips' clause for
 the 5.1.0 release to remedy the immediate problem, but then go back to using an unbounded setting for subsequent

internal/bridge/client_test.go

@@ -304,7 +304,7 @@ func TestClientDoWithRetry(t *testing.T) {
 		assert.Assert(t, requests[1].Header.Get("Idempotency-Key") != prior,
 			"expected a new idempotency key")
 
-		// Requests are delayed according the the server's response.
+		// Requests are delayed according the server's response.
 		// TODO: Mock the clock for faster tests.
 		assert.Assert(t, times[0].Add(time.Second).Before(times[1]),
 			"expected the second request over 1sec after the first")

internal/bridge/crunchybridgecluster/crunchybridgecluster_controller.go

@@ -317,7 +317,7 @@ func (r *CrunchyBridgeClusterReconciler) Reconcile(ctx context.Context, req ctrl
 
 		// TODO(crunchybridgecluster) If the CreateCluster response was interrupted, we won't have the ID
 		// so we can get by name
-		// BUT if we do that, there's a chance for the K8s object to grab a pre-existing Bridge cluster
+		// BUT if we do that, there's a chance for the K8s object to grab a preexisting Bridge cluster
 		// which means there's a chance to delete a Bridge cluster through K8s actions
 		// even though that cluster didn't originate from K8s.
 

internal/config/config.go

@@ -65,7 +65,7 @@ func RegistrationRequiredBy(cluster *v1beta1.PostgresCluster) string {
 // Red Hat Marketplace requires operators to use environment variables be used
 // for any image other than the operator itself. Those variables must start with
 // "RELATED_IMAGE_" so that OSBS can transform their tag values into digests
-// for a "disconncted" OLM CSV.
+// for a "disconnected" OLM CSV.
 
 // - https://redhat-connect.gitbook.io/certified-operator-guide/troubleshooting-and-resources/offline-enabled-operators
 // - https://osbs.readthedocs.io/en/latest/users.html#pullspec-locations

internal/controller/pgupgrade/jobs.go

@@ -69,7 +69,7 @@ func upgradeCommand(upgrade *v1beta1.PGUpgrade, fetchKeyCommand string) []string
 		`echo "postgres:x:${gid%% *}:") > "${NSS_WRAPPER_GROUP}"`,
 
 		// Create a copy of the system user definitions, but remove the "postgres"
-		// user or any user with the currrent UID. Replace them with our own that
+		// user or any user with the current UID. Replace them with our own that
 		// has the current UID and GID.
 		`uid=$(id -u); NSS_WRAPPER_PASSWD=$(mktemp)`,
 		`(sed "/^postgres:x:/ d; /^[^:]*:x:${uid}:/ d" /etc/passwd`,
@@ -80,7 +80,7 @@ func upgradeCommand(upgrade *v1beta1.PGUpgrade, fetchKeyCommand string) []string
 		`export LD_PRELOAD='libnss_wrapper.so' NSS_WRAPPER_GROUP NSS_WRAPPER_PASSWD`,
 
 		// Below is the pg_upgrade script used to upgrade a PostgresCluster from
-		// one major verson to another. Additional information concerning the
+		// one major version to another. Additional information concerning the
 		// steps used and command flag specifics can be found in the documentation:
 		// - https://www.postgresql.org/docs/current/pgupgrade.html
 

internal/controller/postgrescluster/controller_ref_manager_test.go

@@ -67,7 +67,7 @@ func TestManageControllerRefs(t *testing.T) {
 	t.Run("adopt Object", func(t *testing.T) {
 
 		obj := objBase.DeepCopy()
-		obj.Name = "adpot"
+		obj.Name = "adopt"
 		obj.Labels = map[string]string{naming.LabelCluster: clusterName}
 
 		if err := r.Client.Create(ctx, obj); err != nil {
@@ -155,7 +155,7 @@ func TestManageControllerRefs(t *testing.T) {
 
 		obj := objBase.DeepCopy()
 		obj.Name = "ignore-no-postgrescluster"
-		obj.Labels = map[string]string{naming.LabelCluster: "noexist"}
+		obj.Labels = map[string]string{naming.LabelCluster: "nonexistent"}
 
 		if err := r.Client.Create(ctx, obj); err != nil {
 			t.Error(err)

internal/controller/postgrescluster/helpers_test.go

@@ -210,14 +210,14 @@ func testCluster() *v1beta1.PostgresCluster {
 
 // setupManager creates the runtime manager used during controller testing
 func setupManager(t *testing.T, cfg *rest.Config,
-	contollerSetup func(mgr manager.Manager)) (context.Context, context.CancelFunc) {
+	controllerSetup func(mgr manager.Manager)) (context.Context, context.CancelFunc) {
 
 	mgr, err := runtime.CreateRuntimeManager("", cfg, true)
 	if err != nil {
 		t.Fatal(err)
 	}
 
-	contollerSetup(mgr)
+	controllerSetup(mgr)
 
 	ctx, cancel := context.WithCancel(context.Background())
 	go func() {

internal/controller/postgrescluster/instance.md

@@ -69,7 +69,7 @@ instance name or set to blank ("")
 ### Logic Map
 
 With this, the grid below shows the expected replica count value, depending on
-the the values. Below, the letters represent the following:
+the values. Below, the letters represent the following:
 
 M = StartupInstance matches the instance name
 

internal/controller/postgrescluster/pgbackrest.go

@@ -2190,7 +2190,7 @@ func (r *Reconciler) reconcileManualBackup(ctx context.Context,
 	//
 	// TODO (andrewlecuyer): Since reconciliation doesn't currently occur when a leader is elected,
 	// the operator may not get another chance to create the backup if a writable instance is not
-	// detected, and it then returns without requeing.  To ensure this doesn't occur and that the
+	// detected, and it then returns without requeuing.  To ensure this doesn't occur and that the
 	// operator always has a chance to reconcile when an instance becomes writable, we should watch
 	// Pods in the cluster for leader election events, and trigger reconciles accordingly.
 	if !clusterWritable || manualAnnotation == "" ||
@@ -2384,7 +2384,7 @@ func (r *Reconciler) reconcileReplicaCreateBackup(ctx context.Context,
 	//
 	// TODO (andrewlecuyer): Since reconciliation doesn't currently occur when a leader is elected,
 	// the operator may not get another chance to create the backup if a writable instance is not
-	// detected, and it then returns without requeing.  To ensure this doesn't occur and that the
+	// detected, and it then returns without requeuing.  To ensure this doesn't occur and that the
 	// operator always has a chance to reconcile when an instance becomes writable, we should watch
 	// Pods in the cluster for leader election events, and trigger reconciles accordingly.
 	if !clusterWritable || replicaCreateRepoStatus == nil || replicaCreateRepoStatus.ReplicaCreateBackupComplete {
@@ -2624,7 +2624,7 @@ func (r *Reconciler) reconcileStanzaCreate(ctx context.Context,
 	//
 	// TODO (andrewlecuyer): Since reconciliation doesn't currently occur when a leader is elected,
 	// the operator may not get another chance to create the stanza if a writable instance is not
-	// detected, and it then returns without requeing.  To ensure this doesn't occur and that the
+	// detected, and it then returns without requeuing.  To ensure this doesn't occur and that the
 	// operator always has a chance to reconcile when an instance becomes writable, we should watch
 	// Pods in the cluster for leader election events, and trigger reconciles accordingly.
 	if !clusterWritable || stanzasCreated {

internal/controller/postgrescluster/pgbackrest_test.go

@@ -729,9 +729,9 @@ func TestReconcileStanzaCreate(t *testing.T) {
 		Message:            "pgBackRest dedicated repository host is ready",
 	})
 
-	configHashMistmatch, err := r.reconcileStanzaCreate(ctx, postgresCluster, instances, "abcde12345")
+	configHashMismatch, err := r.reconcileStanzaCreate(ctx, postgresCluster, instances, "abcde12345")
 	assert.NilError(t, err)
-	assert.Assert(t, !configHashMistmatch)
+	assert.Assert(t, !configHashMismatch)
 
 	events := &corev1.EventList{}
 	err = wait.Poll(time.Second/2, Scale(time.Second*2), func() (bool, error) {
@@ -773,7 +773,7 @@ func TestReconcileStanzaCreate(t *testing.T) {
 		SystemIdentifier: "6952526174828511264",
 	}
 
-	configHashMismatch, err := r.reconcileStanzaCreate(ctx, postgresCluster, instances, "abcde12345")
+	configHashMismatch, err = r.reconcileStanzaCreate(ctx, postgresCluster, instances, "abcde12345")
 	assert.Error(t, err, "fake stanza create failed: ")
 	assert.Assert(t, !configHashMismatch)
 

internal/controller/postgrescluster/pgmonitor.go

@@ -54,7 +54,7 @@ func (r *Reconciler) reconcilePGMonitor(ctx context.Context,
 // Status.Monitoring.ExporterConfiguration is used to determine when the
 // pgMonitor postgres_exporter configuration should be added/changed to
 // limit how often PodExec is used
-// - TODO jmckulk: kube perms comment?
+// - TODO (jmckulk): kube perms comment?
 func (r *Reconciler) reconcilePGMonitorExporter(ctx context.Context,
 	cluster *v1beta1.PostgresCluster, instances *observedInstances,
 	monitoringSecret *corev1.Secret) error {
@@ -251,7 +251,7 @@ func addPGMonitorToInstancePodSpec(
 
 // addPGMonitorExporterToInstancePodSpec performs the necessary setup to
 // add pgMonitor exporter resources to a PodTemplateSpec
-// TODO jmckulk: refactor to pass around monitoring secret; Without the secret
+// TODO (jmckulk): refactor to pass around monitoring secret; Without the secret
 // the exporter container cannot be created; Testing relies on ensuring the
 // monitoring secret is available
 func addPGMonitorExporterToInstancePodSpec(

internal/controller/postgrescluster/pgmonitor_test.go

@@ -604,7 +604,7 @@ func TestReconcilePGMonitorExporterStatus(t *testing.T) {
 		exporterEnabled: true,
 		podExecCalled:   false,
 		// Status was generated manually for this test case
-		// TODO jmckulk: add code to generate status
+		// TODO (jmckulk): add code to generate status
 		status:                      v1beta1.MonitoringStatus{ExporterConfiguration: "7cdb484b6c"},
 		statusChangedAfterReconcile: false,
 	}} {
@@ -695,7 +695,7 @@ func TestReconcilePGMonitorExporterStatus(t *testing.T) {
 // is correct. If exporter is enabled, the return shouldn't be nil. If the exporter is disabled, the
 // return should be nil.
 func TestReconcileMonitoringSecret(t *testing.T) {
-	// TODO jmckulk: debug test with existing cluster
+	// TODO (jmckulk): debug test with existing cluster
 	// Seems to be an issue when running with other tests
 	if strings.EqualFold(os.Getenv("USE_EXISTING_CLUSTER"), "true") {
 		t.Skip("Test failing with existing cluster")

internal/controller/postgrescluster/util.go

@@ -301,7 +301,7 @@ func safeHash32(content func(w io.Writer) error) (string, error) {
 // updateReconcileResult creates a new Result based on the new and existing results provided to it.
 // This includes setting "Requeue" to true in the Result if set to true in the new Result but not
 // in the existing Result, while also updating RequeueAfter if the RequeueAfter value for the new
-// result is less the the RequeueAfter value for the existing Result.
+// result is less than the RequeueAfter value for the existing Result.
 func updateReconcileResult(currResult, newResult reconcile.Result) reconcile.Result {
 
 	if newResult.Requeue {

internal/naming/annotations.go

@@ -46,7 +46,7 @@ const (
 	PGBackRestCurrentConfig = annotationPrefix + "pgbackrest-config"
 
 	// PGBackRestRestore is the annotation that is added to a PostgresCluster to initiate an in-place
-	// restore.  The value of the annotation will be a unique identfier for a restore Job (e.g. a
+	// restore.  The value of the annotation will be a unique identifier for a restore Job (e.g. a
 	// timestamp), which will be stored in the PostgresCluster status to properly track completion
 	// of the Job.
 	PGBackRestRestore = annotationPrefix + "pgbackrest-restore"

internal/patroni/reconcile_test.go

@@ -132,7 +132,7 @@ func TestInstancePod(t *testing.T) {
 	cluster.Spec.ImagePullPolicy = corev1.PullAlways
 	clusterConfigMap := new(corev1.ConfigMap)
 	clusterPodService := new(corev1.Service)
-	instanceCertficates := new(corev1.Secret)
+	instanceCertificates := new(corev1.Secret)
 	instanceConfigMap := new(corev1.ConfigMap)
 	instanceSpec := new(v1beta1.PostgresInstanceSetSpec)
 	patroniLeaderService := new(corev1.Service)
@@ -142,7 +142,7 @@ func TestInstancePod(t *testing.T) {
 	call := func() error {
 		return InstancePod(context.Background(),
 			cluster, clusterConfigMap, clusterPodService, patroniLeaderService,
-			instanceSpec, instanceCertficates, instanceConfigMap, template)
+			instanceSpec, instanceCertificates, instanceConfigMap, template)
 	}
 
 	assert.NilError(t, call())

internal/pgbackrest/config.go

@@ -492,7 +492,7 @@ func serverConfig(cluster *v1beta1.PostgresCluster) iniSectionSet {
 	//
 	// NOTE(cbandy): The unspecified IPv6 address, which ends up being the IPv6
 	// wildcard address, did not work in all environments. In some cases, the
-	// the "server-ping" command would not connect.
+	// "server-ping" command would not connect.
 	// - https://tools.ietf.org/html/rfc3493#section-3.8
 	//
 	// TODO(cbandy): When pgBackRest provides a way to bind to all addresses,

internal/pki/pki_test.go

@@ -479,7 +479,7 @@ func basicOpenSSLVerify(t *testing.T, openssl string, root, leaf Certificate) {
 	// - https://mail.python.org/pipermail/cryptography-dev/2016-August/000676.html
 
 	// TODO(cbandy): When we generate intermediate certificates, verify them
-	// idependently then bundle them with the root to verify the leaf.
+	// independently then bundle them with the root to verify the leaf.
 
 	verify(t, "-CAfile", rootFile, leafFile)
 	verify(t, "-CAfile", rootFile, "-purpose", "sslclient", leafFile)
@@ -525,7 +525,7 @@ func strictOpenSSLVerify(t *testing.T, openssl string, root, leaf Certificate) {
 	assert.NilError(t, os.WriteFile(leafFile, leafBytes, 0o600))
 
 	// TODO(cbandy): When we generate intermediate certificates, verify them
-	// idependently then pass them via "-untrusted" to verify the leaf.
+	// independently then pass them via "-untrusted" to verify the leaf.
 
 	verify(t, "-trusted", rootFile, leafFile)
 	verify(t, "-trusted", rootFile, "-purpose", "sslclient", leafFile)

internal/postgres/password/scram.go

@@ -37,7 +37,7 @@ import (
 //
 // where:
 // DIGEST = SCRAM-SHA-256 (only value for now in PostgreSQL)
-// ITERATIONS = the number of iteratiosn to use for PBKDF2
+// ITERATIONS = the number of iterations to use for PBKDF2
 // SALT = the salt used as part of the PBKDF2, stored in base64
 // STORED_KEY = the hash of the client key, stored in base64
 // SERVER_KEY = the hash of the server key
@@ -179,7 +179,7 @@ func (s *SCRAMPassword) saslPrep() string {
 
 	// perform SASLprep on the password. if the SASLprep fails or returns an
 	// empty string, return the original password
-	// Otherwise return the clean pasword
+	// Otherwise return the clean password
 	cleanedPassword, err := stringprep.SASLprep.Prepare(s.password)
 	if cleanedPassword == "" || err != nil {
 		return s.password

internal/util/util.go

@@ -26,7 +26,7 @@ import (
 // be used as part of an SQL statement.
 //
 // Any double quotes in name will be escaped.  The quoted identifier will be
-// case sensitive when used in a query.  If the input string contains a zero
+// case-sensitive when used in a query.  If the input string contains a zero
 // byte, the result will be truncated immediately before it.
 //
 // Implementation borrowed from lib/pq: https://github.com/lib/pq which is

pkg/apis/postgres-operator.crunchydata.com/v1beta1/pgbackrest_types.go

@@ -311,7 +311,7 @@ type PGBackRestRepo struct {
 	// will be applicable once implemented:
 	// https://github.com/kubernetes/enhancements/tree/master/keps/sig-api-machinery/1027-api-unions
 
-	// The name of the the repository
+	// The name of the repository
 	// +kubebuilder:validation:Required
 	// +kubebuilder:validation:Pattern=^repo[1-4]
 	Name string `json:"name"`
@@ -414,7 +414,7 @@ type RepoStatus struct {
 	ReplicaCreateBackupComplete bool `json:"replicaCreateBackupComplete,omitempty"`
 
 	// A hash of the required fields in the spec for defining an Azure, GCS or S3 repository,
-	// Utilizd to detect changes to these fields and then execute pgBackRest stanza-create
+	// Utilized to detect changes to these fields and then execute pgBackRest stanza-create
 	// commands accordingly.
 	// +optional
 	RepoOptionsHash string `json:"repoOptionsHash,omitempty"`

pkg/apis/postgres-operator.crunchydata.com/v1beta1/postgrescluster_types.go

@@ -184,7 +184,7 @@ type PostgresClusterSpec struct {
 // DataSource defines data sources for a new PostgresCluster.
 type DataSource struct {
 	// Defines a pgBackRest cloud-based data source that can be used to pre-populate the
-	// the PostgreSQL data directory for a new PostgreSQL cluster using a pgBackRest restore.
+	// PostgreSQL data directory for a new PostgreSQL cluster using a pgBackRest restore.
 	// The PGBackRest field is incompatible with the PostgresCluster field: only one
 	// data source can be used for pre-populating a new PostgreSQL cluster
 	// +optional
@@ -221,7 +221,7 @@ type DataSourceVolumes struct {
 	PGBackRestVolume *DataSourceVolume `json:"pgBackRestVolume,omitempty"`
 }
 
-// DataSourceVolume defines the PVC name and data diretory path for an existing cluster volume.
+// DataSourceVolume defines the PVC name and data directory path for an existing cluster volume.
 type DataSourceVolume struct {
 	// The existing PVC name.
 	PVCName string `json:"pvcName"`