zero-to-jupyterhub-k8s icon indicating copy to clipboard operation
zero-to-jupyterhub-k8s copied to clipboard

Update docs to reflect Azure 2022 process

Open Sieboldianus opened this issue 3 years ago • 6 comments
trafficstars

I recently went through the Kubernetes on Microsoft Azure Kubernetes Service (AKS) and Kubernetes on Microsoft Azure Kubernetes Service (AKS) with Autoscaling docs.

There were some minor inconsistencies with the current Azure process that I have updated.

Sieboldianus avatar Aug 02 '22 07:08 Sieboldianus

Thanks for submitting your first pull request! You are awesome! :hugs:
If you haven't done so already, check out Jupyter's Code of Conduct. Also, please make sure you followed the pull request template, as this will help us review your contribution more quickly. welcome You can meet the other Jovyans by joining our Discourse forum. There is also a intro thread there where you can stop by and say Hi! :wave:
Welcome to the Jupyter community! :tada:

welcome[bot] avatar Aug 02 '22 07:08 welcome[bot]

There's a broken link outside of the scope of this PR that is responsible for failed checks:

(administrator/upgrading/upgrade-1-to-2: line  114) broken    
https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/2.0.0/images/hub/Dockerfile - 
404 Client Error: Not Found for url: 

Sieboldianus avatar Aug 02 '22 07:08 Sieboldianus

@Sieboldianus wieeee thank you for helping out with this! I'm very positive on combining both the separate documents into one as that added significant complexity with regards to maintaining this documentation.

I'll try find time to review this tonight, but a key review point in my mind will be: was something of relevance lost when we removed one of the versions of the azure setup that should be retained in the one we keep?

consideRatio avatar Aug 02 '22 12:08 consideRatio

I can check again in detail, but it mostly looked duplicate, except for the preview-feature part (which isn't necessary anymore).

I'll also want to look into the part again for activating autoscale for an existing cluster, just to make sure it works as written.

Thank you for reviewing this. Thanks for the great docs!

Sieboldianus avatar Aug 02 '22 13:08 Sieboldianus

@consideRatio: I went through the docs again and compared the autoscaler to the standard docs and merged all.

  • In the autoscaling docs, the paragraph At this stage, you may wish to think about customising your deployment. The [Hub23 Deployment Guide](https://alan-turing-institute.github.io/hub23-deploy/) contains instructions for deploying a Kubernetes cluster to Azure with [autoscaling and multiple nodepools](https://alan-turing-institute.github.io/hub23-deploy/deploy-k8s/az-aks-create.html). These instructions can be combined so that all nodepools can autoscale. was missing, but I guess this was just a result of diversion due to the duplicate handling. I left the paragraph as is.
  • Replaced az ad sp show --id http://<SERVICE-PRINCIPAL-NAME> --query appId with az ad app list --filter "displayname eq '<SERVICE-PRINCIPAL-NAME>'"- According to azure-cli issue #19179, --id http// has ben deprecated and only appId should be used.
  • In the autoscaling docs, --enable-vmss now became --vm-set-type VirtualMachineScaleSets, see: #927
  • I incorporated the part on adjusting autoscaler rules in the azure frontend to the standard docs:
    • Removed the part on "register for Microsoft Insights", since this is not necessary anymore
    • Updated the screenshots (I think it is also ok to stick with the old ones, the changes are minor, but I still created new ones)
  • Verified all commands

I think it makes sense merging both docs, since the differences between autoscaling and not autoscaling for a cluster are minimal, but I am new to the project and not the best to decide.

Sieboldianus avatar Aug 03 '22 07:08 Sieboldianus

While I was at it, I also updated Installing JupyterHub: Getting the public IP of the Proxy (https://github.com/jupyterhub/zero-to-jupyterhub-k8s/pull/2823/commits/7ff31fd5dfe5cf8065bdd71015e4395a8e44764d).

kubectl outputs the recommended command, after installation of the helm chart:

> Release "<helm-release-name>" does not exist. Installing it now.
> NAME: <helm-release-name>
> LAST DEPLOYED: Wed Aug  3 10:01:48 2022
> NAMESPACE: <k8s-namespace>
> STATUS: deployed
> REVISION: 1
> TEST SUITE: None
> NOTES:
> Thank you for installing JupyterHub!
> 
> Your release is named "<helm-release-name>" and installed into the namespace "<k8s-namespace>".
> 
> You can check whether the hub and proxy are ready by running:
> 
>  kubectl --namespace=<k8s-namespace> get pod
> 
> and watching for both those pods to be in status 'Running'.
> 
> You can find the public (load-balancer) IP of JupyterHub by running:
> 
>   kubectl -n <k8s-namespace> get svc proxy-public -o jsonpath='{.status.loadBalancer.ingress[].ip}'
> 
> It might take a few minutes for it to appear!
> 
> To get full information about the JupyterHub proxy service run:
> 
>   kubectl --namespace=<k8s-namespace> get svc proxy-public
> 
> If you have questions, please:
> 
>   1. Read the guide at https://z2jh.jupyter.org
>   2. Ask for help or chat to us on https://discourse.jupyter.org/
>   3. If you find a bug please report it at https://github.com/jupyterhub/zero-to-jupyterhub-k8s/issues

This does not really fit in here. Happy to submit a different PR for this commit.

Sieboldianus avatar Aug 03 '22 08:08 Sieboldianus

Congrats on your first merged pull request in this project! :tada: congrats Thank you for contributing, we are very proud of you! :heart:

welcome[bot] avatar Aug 16 '22 10:08 welcome[bot]