diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 5c74a3e850..89239b6d3d 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -52,10 +52,16 @@ repos: rev: v6.2.1 hooks: - id: beautysh + additional_dependencies: + # On recent Python versions beautysh fails with + # ModuleNotFoundError: No module named 'pkg_resources' + # This can be removed if https://github.com/lovesegfault/beautysh/pull/251 + # is released + - setuptools # Autoformat: markdown, yaml (but not helm templates) - - repo: https://github.com/pre-commit/mirrors-prettier - rev: v4.0.0-alpha.8 + - repo: https://github.com/rbubley/mirrors-prettier + rev: v3.6.2 hooks: - id: prettier diff --git a/RELEASE.md b/RELEASE.md index fb6053979f..9eb4439de4 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -49,7 +49,6 @@ Also the images we build are based on some image specified in the `FROM` stateme ## Pre-release iteration - Update `docs/source/changelog.md` - - [ ] Generate a list of PRs using [executablebooks/github-activity](https://github.com/executablebooks/github-activity) ```bash github-activity --output github-activity-output.md --since jupyterhub/zero-to-jupyterhub-k8s @@ -60,7 +59,6 @@ Also the images we build are based on some image specified in the `FROM` stateme - [ ] Summarize the release changes - Tag a x.y.z-beta.1 release - - [ ] Create and push a git tag ```bash git checkout main @@ -75,7 +73,6 @@ Also the images we build are based on some image specified in the `FROM` stateme ## Final release - Update `docs/source/changelog.md` - - [ ] Generate a list of merged PRs and a list of contributors and update the changelog. ```bash github-activity --output github-activity-output.md --since jupyterhub/zero-to-jupyterhub-k8s @@ -83,7 +80,6 @@ Also the images we build are based on some image specified in the `FROM` stateme - [ ] Link out to the downstream projects within the JupyterHub org to celebrate work done there as well. - Release - - [ ] Create and push a git tag. ```bash diff --git a/docs/source/administrator/optimization.md b/docs/source/administrator/optimization.md index c45f23d5dd..132cbc0c89 100644 --- a/docs/source/administrator/optimization.md +++ b/docs/source/administrator/optimization.md @@ -270,7 +270,6 @@ following: If you need help on how to do this, please refer to your cloud providers documentation. A node pool may be called a node group. - - The label: `hub.jupyter.org/node-purpose=user` **NOTE**: Cloud providers often have their own labels, separate from diff --git a/docs/source/changelog.md b/docs/source/changelog.md index ba1d0068fe..00b5cbd98a 100644 --- a/docs/source/changelog.md +++ b/docs/source/changelog.md @@ -1081,7 +1081,6 @@ and small bugfixes will increment the three version numbers. you if you don't specify them. - **Smoother helm upgrades** - - `prePuller.hook.pullOnlyOnChanges` is now available and enabled by default, which only intercepts a `helm upgrade` by pulling images if they have changed since the last upgrade. @@ -1131,7 +1130,6 @@ followed these instructions between `0.7.0-beta.1` and `0.11.1`, please see the cluster. The most common validation errors are: - - _Unrecognized config values_ For example if you have misspelled something. @@ -4148,7 +4146,6 @@ Deployer UX fixes. - No need to restart hub manually after some changes - it is automatically restarted now. You can disable an automatic restart of hub after an upgrade with the following: - 1. Finding out the current helm release's revision 2. Adding '--set revisionOverride=' to your upgrade command. diff --git a/docs/source/jupyterhub/installation.md b/docs/source/jupyterhub/installation.md index 4f3fe1f0d2..ebe6be97ef 100644 --- a/docs/source/jupyterhub/installation.md +++ b/docs/source/jupyterhub/installation.md @@ -75,7 +75,6 @@ can try with `nano config.yaml`. ``` where: - - `` refers to a [Helm release name](https://helm.sh/docs/glossary/#release), an identifier used to differentiate chart installations. You need it when you are changing or deleting the configuration of this chart installation. If your Kubernetes diff --git a/docs/source/jupyterhub/uninstall.md b/docs/source/jupyterhub/uninstall.md index 2d387e90c0..d67caef464 100644 --- a/docs/source/jupyterhub/uninstall.md +++ b/docs/source/jupyterhub/uninstall.md @@ -66,7 +66,6 @@ before doing the cloud provider specific setup. has been deleted. At a minimum, check the following under the Hamburger (left top corner) menu: - 1. Compute -> Compute Engine -> Disks 2. Compute -> Kubernetes Engine -> Clusters 3. Tools -> Container Registry -> Images diff --git a/docs/source/kubernetes/amazon/step-zero-aws-eks.md b/docs/source/kubernetes/amazon/step-zero-aws-eks.md index bcc5769221..c4aa0967cf 100644 --- a/docs/source/kubernetes/amazon/step-zero-aws-eks.md +++ b/docs/source/kubernetes/amazon/step-zero-aws-eks.md @@ -12,7 +12,6 @@ This guide uses AWS to set up a cluster. This mirrors the steps found at [Gettin Instructions for creating a role can be found [here](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html). It should have the following policies: - - AmazonEKSClusterPolicy - AmazonEKSServicePolicy - AmazonEC2ContainerRegistryReadOnly diff --git a/docs/source/kubernetes/amazon/step-zero-aws.md b/docs/source/kubernetes/amazon/step-zero-aws.md index 865e9aeba7..6546b8bdb8 100644 --- a/docs/source/kubernetes/amazon/step-zero-aws.md +++ b/docs/source/kubernetes/amazon/step-zero-aws.md @@ -17,7 +17,6 @@ template you will use to setup and shape your cluster. resources on AWS. Instructions for creating a role can be found [here](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html). The following policies are required: - - AmazonEC2FullAccess - IAMFullAccess - AmazonS3FullAccess @@ -41,7 +40,6 @@ template you will use to setup and shape your cluster. [here](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/connect-linux-inst-ssh.html). 4. Install kops and kubectl on your CI host - - Follow the instructions here: 5. Choose a cluster name: @@ -172,7 +170,6 @@ template you will use to setup and shape your cluster. You should see a list of two nodes, each beginning with `ip`. If you want to use kubectl and helm locally: - - run the following on CI host: `kops export kubecfg` - copy the contents of `~/.kube/config` to the same place on your local system @@ -189,7 +186,6 @@ template you will use to setup and shape your cluster. Instead we need to follow this guide: At this point there are a few public endpoints left open which need to be addressed - - Bastion ELB security group defaults to access from 0.0.0.0 - API ELB security group defaults to access from 0.0.0.0 diff --git a/docs/source/kubernetes/digital-ocean/step-zero-digital-ocean.md b/docs/source/kubernetes/digital-ocean/step-zero-digital-ocean.md index ae07d72b3e..b65fb77338 100644 --- a/docs/source/kubernetes/digital-ocean/step-zero-digital-ocean.md +++ b/docs/source/kubernetes/digital-ocean/step-zero-digital-ocean.md @@ -8,7 +8,6 @@ This page describes the commands required to setup a Kubernetes cluster using th If you prefer to use the Digital Ocean portal see the [Digital Ocean Get Started](https://www.digitalocean.com/products/kubernetes). 1. Prepare your Digital Ocean shell environment. - 1. **Install command-line tools locally**. You'll need at least v1.13.0. You can either follow the [installation instructions](https://github.com/digitalocean/doctl/blob/main/README.md) or use the commands below: diff --git a/docs/source/kubernetes/google/step-zero-gcp.md b/docs/source/kubernetes/google/step-zero-gcp.md index ead03588e0..29ab608ab1 100644 --- a/docs/source/kubernetes/google/step-zero-gcp.md +++ b/docs/source/kubernetes/google/step-zero-gcp.md @@ -24,7 +24,6 @@ your google cloud account. command line interfaces on your own computer's terminal. We recommend starting out by using the web based terminal. Choose one set of instructions below. - 1. **Use a web based terminal:** Start _Google Cloud Shell_ from [console.cloud.google.com](https://console.cloud.google.com) by clicking the button shown below. @@ -38,7 +37,6 @@ your google cloud account. ``` 2. **Use your own computer's terminal:** - 1. Download and install the `gcloud` command line tool at its [install page](https://cloud.google.com/sdk/docs/install). It will help you create and communicate with a Kubernetes cluster. diff --git a/docs/source/kubernetes/ibm/step-zero-ibm.md b/docs/source/kubernetes/ibm/step-zero-ibm.md index b92e35960d..a3cb19a6f6 100644 --- a/docs/source/kubernetes/ibm/step-zero-ibm.md +++ b/docs/source/kubernetes/ibm/step-zero-ibm.md @@ -28,7 +28,6 @@ Procedure: Kubernetes Service delivers powerful tools by combining Docker and Kubernetes technologies, an intuitive user experience, and built-in security and isolation to automate the deployment, operation, scaling, and monitoring of containerized apps in a cluster of computing hosts. To set up the Kubernetes cluster: - 1. Create a Kubernetes cluster from the [IBM Cloud catalog](https://cloud.ibm.com/kubernetes/catalog/create)). 2. When configuring the new cluster, select the **Cluster type** and click **Create Cluster** to provision a Kubernetes cluster. 2.1 In the case of a free cluster you will see something similar to: @@ -49,7 +48,6 @@ Procedure: 2. Configure kubectl [kubectl](https://kubernetes.io/docs/reference/kubectl/) is a CLI tool to interact with a Kubernetes cluster. In this occasion, you will use it to point forward to the created Kubernetes cluster. - 1. Use `ibmcloud login` to log in interactively into the IBM Cloud. Provide the organization (org), location and space under which the cluster is created. You can reconfirm the details by running `ibmcloud target` command. 2. When the cluster is ready, retrieve the cluster configuration by using the cluster's name: ``` diff --git a/docs/source/kubernetes/microsoft/step-zero-azure.md b/docs/source/kubernetes/microsoft/step-zero-azure.md index 027e77fdae..906ac93271 100644 --- a/docs/source/kubernetes/microsoft/step-zero-azure.md +++ b/docs/source/kubernetes/microsoft/step-zero-azure.md @@ -10,7 +10,6 @@ If you prefer to use the Azure portal see the [Azure Kubernetes Service quicksta 1. Prepare your Azure shell environment. You have two options, one is to use the Azure interactive shell, the other is to install the Azure command-line tools locally. Instructions for each are below. - - **Using the Azure interactive shell**. The [Azure Portal](https://portal.azure.com) contains an interactive shell that you can use to communicate with your Kubernetes cluster. To access this shell, go to [portal.azure.com](https://portal.azure.com) @@ -70,7 +69,6 @@ If you prefer to use the Azure portal see the [Azure Kubernetes Service quicksta ``` where: - - `--name` specifies the name of your resource group. We recommend using something that uniquely identifies this hub. For example, if you are creating a resource group for UC Berkeley's 2018 Spring Data100 Course, you may give it a @@ -137,7 +135,6 @@ If you prefer to use the Azure portal see the [Azure Kubernetes Service quicksta ``` where: - - `--resource-group` is the ResourceGroup you created - `--name` is the name you want to assign to your virtual network, for example, `hub-vnet` - `--address-prefixes` are the IP address prefixes for your virtual network @@ -208,7 +205,6 @@ If you prefer to use the Azure portal see the [Azure Kubernetes Service quicksta ``` where: - - `--name` is the name you want to use to refer to your cluster - `--resource-group` is the ResourceGroup you created - `--ssh-key-value` is the ssh public key created @@ -231,7 +227,6 @@ If you prefer to use the Azure portal see the [Azure Kubernetes Service quicksta This should take a few minutes and provide you with a working Kubernetes cluster! Optionally, prepare autoscaling, where: - - `--vm-set-type VirtualMachineScaleSets` deploys the cluster as a scale set. - `--enable-cluster-autoscaler` enables autoscaling feature for your cluster - `--min-count 3` is the minimum node count @@ -289,7 +284,6 @@ If you prefer to use the Azure portal see the [Azure Kubernetes Service quicksta ``` where: - - `--name` is the name you gave your cluster - `--resource-group` is the ResourceGroup you created @@ -327,7 +321,6 @@ RBAC is enabled by default when using the command line tools. From the left-hand menu, select "Scaling". Click the blue "Custom autoscale" button and an autogenerated form for a scale condition will appear. We will add two new rules to this condition: - - Increase the instance count by 1 when the average CPU usage over 10 minutes is greater than 70% - Decrease the instance count by 1 when the average CPU usage over 10 minutes is less than 5%