Merge pull request #3098 from yarikoptic/enh-codespell

Add codespell config (within pyproject.toml), action and fix the typos it finds (and fixes)

.github/workflows/deploy-hubs.yaml

@@ -44,7 +44,7 @@ on:
 # https://github.blog/changelog/2021-04-19-github-actions-limit-workflow-run-or-job-concurrency/
 concurrency: deploy
 
-# This environment variable triggers the deployer to colourise print statments in the
+# This environment variable triggers the deployer to colourise print statements in the
 # GitHug Actions logs for easy reading
 env:
   TERM: xterm
@@ -85,7 +85,7 @@ jobs:
         uses: actions/cache@v3
         with:
           path: ~/.cache/pip
-          # key determines if we define or re-use an existing cache or not. Our
+          # key determines if we define or reuse an existing cache or not. Our
           # key ensure we cache within a workflow run and its attempts, but not
           # between workflow runs.
           key: "${{ github.run_id }}"

.github/workflows/ensure-uptime-checks.yaml

@@ -19,7 +19,7 @@ on:
 # https://github.blog/changelog/2021-04-19-github-actions-limit-workflow-run-or-job-concurrency/
 concurrency: uptime-checks
 
-# This environment variable triggers the deployer to colourise print statments in the
+# This environment variable triggers the deployer to colourise print statements in the
 # GitHub Actions logs for easy reading
 env:
   TERM: xterm

.pre-commit-config.yaml

@@ -59,6 +59,14 @@ repos:
         # Add files here if they contain the word 'secret' but should not be encrypted
         exclude: secrets\.md|helm-charts/support/templates/prometheus-ingres-auth/secret\.yaml|helm-charts/basehub/templates/dex/secret\.yaml|helm-charts/basehub/templates/static/secret\.yaml|config/clusters/templates/common/support\.secret\.values\.yaml|helm-charts/basehub/templates/ingress-auth/secret\.yaml
 
+  # Prevent known typos from being committed
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.5
+    hooks:
+      - id: codespell
+        additional_dependencies:
+          - tomli
+
 # pre-commit.ci config reference: https://pre-commit.ci/#configuration
 ci:
   autoupdate_schedule: monthly

README.md

@@ -1,6 +1,6 @@
 # Infrastructure for deployments
 
-This repository contains deployment infrastucture and documentation for a federation of JupyterHubs that 2i2c manages for various communities.
+This repository contains deployment infrastructure and documentation for a federation of JupyterHubs that 2i2c manages for various communities.
 
 See [the infrastructure documentation](https://infrastructure.2i2c.org) for more information.
 

config/clusters/2i2c-aws-us/go-bgc.values.yaml

@@ -59,7 +59,7 @@ jupyterhub:
       #       https://github.com/2i2c-org/infrastructure/issues/2121.
       #
       #       - Memory requests are different from the description, based on:
-      #         whats found to remain allocate in k8s, subtracting 1GiB
+      #         what's found to remain allocate in k8s, subtracting 1GiB
       #         overhead for misc system pods, and transitioning from GB in
       #         description to GiB in mem_guarantee
       #         https://cloud.google.com/kubernetes-engine/docs/concepts/plan-node-sizes.

config/clusters/2i2c-aws-us/itcoocean.values.yaml

@@ -86,7 +86,7 @@ jupyterhub:
       #       https://github.com/2i2c-org/infrastructure/issues/2121.
       #
       #       - Memory requests are different from the description, based on:
-      #         whats found to remain allocate in k8s, subtracting 1GiB
+      #         what's found to remain allocate in k8s, subtracting 1GiB
       #         overhead for misc system pods, and transitioning from GB in
       #         description to GiB in mem_guarantee
       #         https://cloud.google.com/kubernetes-engine/docs/concepts/plan-node-sizes.

config/clusters/2i2c-aws-us/ncar-cisl.values.yaml

@@ -41,8 +41,8 @@ basehub:
             - read:org
         Authenticator:
           admin_users:
-            - kcote-ncar # Ken Cote, Initial adminstrator
-            - NicholasCote # Nicholas Cote, Initial adminstrator
+            - kcote-ncar # Ken Cote, Initial administrator
+            - NicholasCote # Nicholas Cote, Initial administrator
             - nwehrheim # Nick Wehrheim, Community representative
     singleuser:
       image:
@@ -60,7 +60,7 @@ basehub:
         #       https://github.com/2i2c-org/infrastructure/issues/2121.
         #
         #       - Memory requests are different from the description, based on:
-        #         whats found to remain allocate in k8s, subtracting 1GiB
+        #         what's found to remain allocate in k8s, subtracting 1GiB
         #         overhead for misc system pods, and transitioning from GB in
         #         description to GiB in mem_guarantee.
         #       - CPU requests are lower than the description, with a factor of

config/clusters/catalystproject-africa/must.values.yaml

@@ -57,7 +57,7 @@ jupyterhub:
       #       https://github.com/2i2c-org/infrastructure/issues/2121.
       #
       #       - Memory requests are different from the description, based on:
-      #         whats found to remain allocate in k8s, subtracting 1GiB
+      #         what's found to remain allocate in k8s, subtracting 1GiB
       #         overhead for misc system pods, and transitioning from GB in
       #         description to GiB in mem_guarantee.
       #       - CPU requests are lower than the description, with a factor of

config/clusters/catalystproject-africa/nm-aist.values.yaml

@@ -56,7 +56,7 @@ jupyterhub:
       #       https://github.com/2i2c-org/infrastructure/issues/2121.
       #
       #       - Memory requests are different from the description, based on:
-      #         whats found to remain allocate in k8s, subtracting 1GiB
+      #         what's found to remain allocate in k8s, subtracting 1GiB
       #         overhead for misc system pods, and transitioning from GB in
       #         description to GiB in mem_guarantee.
       #       - CPU requests are lower than the description, with a factor of

config/clusters/catalystproject-africa/staging.values.yaml

@@ -53,7 +53,7 @@ jupyterhub:
       #       https://github.com/2i2c-org/infrastructure/issues/2121.
       #
       #       - Memory requests are different from the description, based on:
-      #         whats found to remain allocate in k8s, subtracting 1GiB
+      #         what's found to remain allocate in k8s, subtracting 1GiB
       #         overhead for misc system pods, and transitioning from GB in
       #         description to GiB in mem_guarantee.
       #       - CPU requests are lower than the description, with a factor of

config/clusters/catalystproject-latam/common.values.yaml

@@ -27,7 +27,7 @@ jupyterhub:
       #       https://github.com/2i2c-org/infrastructure/issues/2121.
       #
       #       - Memory requests are different from the description, based on:
-      #         whats found to remain allocate in k8s, subtracting 1GiB
+      #         what's found to remain allocate in k8s, subtracting 1GiB
       #         overhead for misc system pods, and transitioning from GB in
       #         description to GiB in mem_guarantee
       #         https://cloud.google.com/kubernetes-engine/docs/concepts/plan-node-sizes.

config/clusters/leap/common.values.yaml

@@ -90,7 +90,7 @@ basehub:
         #       https://github.com/2i2c-org/infrastructure/issues/2121.
         #
         #       - Memory requests are different from the description, based on:
-        #         whats found to remain allocate in k8s, subtracting 1GiB
+        #         what's found to remain allocate in k8s, subtracting 1GiB
         #         overhead for misc system pods, and transitioning from GB in
         #         description to GiB in mem_guarantee.
         #       - CPU requests are lower than the description, with a factor of

config/clusters/linked-earth/common.values.yaml

@@ -55,7 +55,7 @@ basehub:
         #       https://github.com/2i2c-org/infrastructure/issues/2121.
         #
         #       - Memory requests are different from the description, based on:
-        #         whats found to remain allocate in k8s, subtracting 1GiB
+        #         what's found to remain allocate in k8s, subtracting 1GiB
         #         overhead for misc system pods, and transitioning from GB in
         #         description to GiB in mem_guarantee.
         #       - CPU requests are lower than the description, with a factor of

config/clusters/nasa-cryo/common.values.yaml

@@ -107,7 +107,7 @@ basehub:
         #       https://github.com/2i2c-org/infrastructure/issues/2121.
         #
         #       - Memory requests are different from the description, based on:
-        #         whats found to remain allocate in k8s, subtracting 1GiB
+        #         what's found to remain allocate in k8s, subtracting 1GiB
         #         overhead for misc system pods, and transitioning from GB in
         #         description to GiB in mem_guarantee.
         #       - CPU requests are lower than the description, with a factor of

config/clusters/qcl/common.values.yaml

@@ -61,7 +61,7 @@ jupyterhub:
       #       https://github.com/2i2c-org/infrastructure/issues/2121.
       #
       #       - Memory requests are different from the description, based on:
-      #         whats found to remain allocate in k8s, subtracting 1GiB
+      #         what's found to remain allocate in k8s, subtracting 1GiB
       #         overhead for misc system pods, and transitioning from GB in
       #         description to GiB in mem_guarantee
       #         https://cloud.google.com/kubernetes-engine/docs/concepts/plan-node-sizes.

config/clusters/smithsonian/common.values.yaml

@@ -67,7 +67,7 @@ basehub:
         #       https://github.com/2i2c-org/infrastructure/issues/2121.
         #
         #       - Memory requests are different from the description, based on:
-        #         whats found to remain allocate in k8s, subtracting 1GiB
+        #         what's found to remain allocate in k8s, subtracting 1GiB
         #         overhead for misc system pods, and transitioning from GB in
         #         description to GiB in mem_guarantee.
         #       - CPU requests are lower than the description, with a factor of

deployer/README.md

@@ -383,7 +383,7 @@ Once you run this command, run `export DOCKER_HOST=tcp://localhost:23760` in ano
 docker daemon.
 
 #### `exec shell`
-This exec sub-command can be used to aquire a shell in various places of the infrastructure.
+This exec sub-command can be used to acquire a shell in various places of the infrastructure.
 
 ##### `exec shell hub`
 

deployer/commands/exec/infra_components.py

@@ -210,8 +210,8 @@ def ask_for_dirname_again():
     """
     Function that asks the user to provide the name of the source and dest directories using typer prompts.
 
-    Returns the name of the source and dest directories as a touple if they were provided by the user
-    or the None, None touple.
+    Returns the name of the source and dest directories as a tuple if they were provided by the user
+    or the None, None tuple.
     """
     print_colour("Asking for the dirs again...", "yellow")
     continue_with_dir_names_confirmation = typer.confirm(

deployer/commands/generate/billing/importers.py

@@ -251,7 +251,7 @@ def get_shared_cluster_hub_costs(cluster, start_month, end_month):
     # Rename project to use hub names
     totals["project"] = totals["hub"]
     totals.drop("hub", axis=1)
-    # Calcluate cost from utilization
+    # Calculate cost from utilization
     # Needs to account for uptime checks and 2i2c paid for stuff
     totals["cost"] = totals["utilization"].multiply(
         totals["total_with_credits"].astype(float), axis=0

deployer/commands/generate/dedicated_cluster/common.py

@@ -92,7 +92,7 @@ def generate_support_files(cluster_config_directory, vars):
         - `config/<cluster_name>/support.values.yaml`
         - `config/<cluster_name>/enc-support.secret.values.yaml`
     """
-    # Generate the suppport values file `support.values.yaml`
+    # Generate the support values file `support.values.yaml`
     print_colour("Generating the support values file...", "yellow")
     with open(
         REPO_ROOT_PATH / "config/clusters/templates/common/support.values.yaml"

deployer/commands/grafana/tokens.py

@@ -122,7 +122,7 @@ def get_deployer_token(sa_endpoint, sa_id, headers):
     )
     if not response.ok:
         print(
-            f"An error occured when retrieving the tokens the service account with id {sa_id}.\n"
+            f"An error occurred when retrieving the tokens the service account with id {sa_id}.\n"
             f"Error was {response.text}."
         )
         response.raise_for_status()
@@ -144,7 +144,7 @@ def create_deployer_token(sa_endpoint, sa_id, headers):
 
     if not response.ok:
         print(
-            "An error occured when creating the token for the deployer service account.\n"
+            "An error occurred when creating the token for the deployer service account.\n"
             f"Error was {response.text}."
         )
         response.raise_for_status()

deployer/commands/validate/cluster.schema.yaml

@@ -235,7 +235,7 @@ properties:
                 type: string
                 description: |
                   Status code expected from hitting the health checkpoint for
-                  this hub. Defaults to 200, can be overriden in case we have
+                  this hub. Defaults to 200, can be overridden in case we have
                   basic auth setup for the entire hub
           domain:
             type: string

docs/contributing/code-review.md

@@ -44,7 +44,7 @@ or can wait for review.  That said, sometimes the only way to
 understand the impact of a change is to merge and see how things go,
 so use your best judgment!
 
-Here is a list of things you can clearly, unambigously self merge without
+Here is a list of things you can clearly, unambiguously self merge without
 any approval.
 
 1. Updating admin users for a hub
@@ -119,7 +119,7 @@ To deploy changes to the authentication workflow, follow these steps:
    - cluster: `utoronto`, hub: `staging` (Azure AD)
    - cluster: `2i2c`, hub: `staging` (CILogon)
 1. **Login into the staging hubs**. Try logging in into the hubs where you deployed your changes.
-1. **Start a server**. Afer you've logged into the hub, make sure everything works as expected by spinning up a server.
+1. **Start a server**. After you've logged into the hub, make sure everything works as expected by spinning up a server.
 1. **Post the status of the manual steps above**. In your PR's top comment, post the hubs where you've deployed the changes and whether or not they are functioning properly.
 1. **Wait for review and approval**. Leave the PR open for other team members to review and approve.
 

docs/helper-programs/generate-general-info-table-about-hubs.py

@@ -2,7 +2,7 @@
 
 This is used in two places:
 
-- docs/_static/hub-table.json is published with the docs and meant for re-use in other parts of 2i2c
+- docs/_static/hub-table.json is published with the docs and meant for reuse in other parts of 2i2c
 - docs/tmp/hub-table.csv is read by reference/hubs.md to create a list of hubs
 """
 import pandas as pd
@@ -81,7 +81,7 @@ def build_hub_list_entry(
 def build_hub_statistics_df(df):
     # Write some quick statistics for display
     # Calculate total number of community hubs by removing staging and demo hubs
-    # Remove `staging` hubs to count the total number of communites we serve
+    # Remove `staging` hubs to count the total number of communities we serve
     filter_out = ["staging", "demo"]
     community_hubs = df.loc[
         df["name"].map(lambda a: all(ii not in a.lower() for ii in filter_out))
@@ -167,7 +167,7 @@ def main():
     write_to_json_and_csv_files(df, "hub-table")
     write_to_json_and_csv_files(community_hubs_by_cluster, "hub-stats")
 
-    print("Finished updating list of hubs and statics tables...")
+    print("Finished updating list of hubs and statistics tables...")
 
 
 if __name__ == "__main__":

docs/helper-programs/generate-hub-features-table.py

@@ -2,7 +2,7 @@
 
 This is used in two places:
 
-- docs/_static/hub-options-table.json is published with the docs and meant for re-use in other parts of 2i2c
+- docs/_static/hub-options-table.json is published with the docs and meant for reuse in other parts of 2i2c
 - docs/tmp/hub-options-table.csv is read by reference/options.md to create a list of hubs
 """
 import hcl2
@@ -171,7 +171,7 @@ def build_options_list_entry(hub, hub_count, values_files_features, terraform_fe
         "user buckets (scratch/persistent)": terraform_features.get(
             hub["name"], {}
         ).get("user_buckets", False),
-        "requestor pays for buckets storage": terraform_features.get(
+        "requester pays for buckets storage": terraform_features.get(
             hub["name"], {}
         ).get("requestor_pays", False),
         "authenticator": values_files_features["authenticator"],

docs/howto/features/anonymized-usernames.md

@@ -40,7 +40,7 @@ useful privacy guarantees to be worth it. Those are:
 2. We live in a world where user data leaks are a fact of life, and you can buy
    tons of user identifiers for pretty cheap. This may also happen to *us*, and
    we may unintentionally leak data too! So users should still be hard to 
-   de-anonymize when the attacker has in their posession the following:
+   de-anonymize when the attacker has in their possession the following:
 
    1. List of user identifiers (emails, usernames, numeric user ids,
       etc) from *other data breaches*.

docs/howto/features/cloud-access.md

@@ -136,6 +136,6 @@ This AWS IAM Role is managed via terraform.
     If the hub is a `daskhub`, nest the config under a `basehub` key
     ```
 
-7. Get this change deployed, and users should now be able to use the requestor pays feature!
+7. Get this change deployed, and users should now be able to use the requester pays feature!
    Currently running users might have to restart their pods for the change to take effect.
 

docs/howto/manage-domains/redirects.md

@@ -16,5 +16,5 @@ redirects:
 ```
 
 You can add any number of such redirects. They will all be `302 Temporary`
-redirects, in case we want to re-use the old domain for something else in
+redirects, in case we want to reuse the old domain for something else in
 the future.

docs/howto/troubleshoot/cilogon-user-accounts.md

@@ -1,15 +1,15 @@
 # CILogon: switch Identity Providers or user accounts
 
 By default, logging in with a particular user account will persist your credentials in future sessions.
-This means that you'll automatically re-use the same institutional and user account when you access the hub's home page.
+This means that you'll automatically reuse the same institutional and user account when you access the hub's home page.
 
 ## Switch Identity Providers
 
 1. **Logout of the Hub** using the logout button or by going to `https://{hub-name}/hub/logout`.
-2. **Clear browser cookies** (optional). If the user asked CILogon to re-use the same Identity Provider connection when they logged in, they'll need to [clear browser cookies](https://www.lifewire.com/how-to-delete-cookies-2617981) for <https://cilogon.org>.
+2. **Clear browser cookies** (optional). If the user asked CILogon to reuse the same Identity Provider connection when they logged in, they'll need to [clear browser cookies](https://www.lifewire.com/how-to-delete-cookies-2617981) for <https://cilogon.org>.
 
    ```{figure} ../../images/cilogon-remember-this-selection.png
-   The dialog box that allows you to re-use the same Identity Provider.
+   The dialog box that allows you to reuse the same Identity Provider.
    ```
 
    Firefox example:
@@ -40,6 +40,6 @@ If you see a 403 error page, this means that the account you were using to login
 ```{figure} ../../images/403-forbidden.png
 ```
 
-If you think this is an error, and the account should have been allowed, then contact the hub adminstrator/s.
+If you think this is an error, and the account should have been allowed, then contact the hub administrator/s.
 
 If you used the wrong user account, you can log in using another account by following the steps in [](troubleshoot:cilogon:switch-user-accounts).

docs/howto/troubleshoot/logs/cloud-logs.md

@@ -25,7 +25,7 @@ logs are kept for 30 days, and are searchable.
    as time sliders. However, for most of our logs, the 'log levels' (error, warning, etc)
    are not parsed correctly, and hence are useless.
 
-4. Google provies a [query library](https://cloud.google.com/logging/docs/view/query-library) set of [sample queries](https://cloudlogging.app.goo.gl/Ad7B8hjFHpj6X7rT8) that you can access via the Library tab in Logs Explorer.
+4. Google provides a [query library](https://cloud.google.com/logging/docs/view/query-library) set of [sample queries](https://cloudlogging.app.goo.gl/Ad7B8hjFHpj6X7rT8) that you can access via the Library tab in Logs Explorer.
 
 
 ### Common queries

docs/howto/troubleshoot/logs/kubectl-logs.md

@@ -139,7 +139,7 @@ The following commands require passing the namespace where a specific pod is run
     ```
 
 ### Kubernetes pod logs
-You can access any pod's logs by using the `kubectl logs` commands. Bellow are some of the most common debugging commands.
+You can access any pod's logs by using the `kubectl logs` commands. Below are some of the most common debugging commands.
 
 ```{tip}
 1. The `--follow` flag