Upgrade 1.6 Apps: jupyter-web-apps

[rohank07]

Overview

EPIC: Kubeflow Upgrade Planning

Component	Local Manifests Path	Upstream	Initial Work
jupyter-web-apps	apps/jupyter/jupyter-web-app	v1.6-rc.3

Adjustments

v1.6

• Modified jupyter-web-app-jupyter-notebook-role role
• Added APP_SECURE_COOKIES env var

v1.4

• No changes required from v1.3

v1.3

• Add additional cluster role permissions
• Change the kubeflow userid-header to kubeflow-userid
• Wholesale replacement of spawner config
• Add image pull secret and custom jupyter apis image to jupyter-web-app deployment

Kubeflow V2 Manifests

The following is the kustomize that was used in Kubeflow V2:

• https://github.com/StatCan/aaw-kubeflow-manifests/tree/master/kustomize/application/jupyter-web-app

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
patchesStrategicMerge:
- cluster-role.yaml
- deployment.yaml
- deployment_patch.yaml
resources:
- ../../../.cache/manifests/manifests-1.2-branch/stacks/azure/application/jupyter-web-app
configMapGenerator:
- files:
  - configs/spawner_ui_config.yaml
  behavior: replace
  name: jupyter-web-app-config
generatorOptions:
  disableNameSuffixHash: true

AAW Dev / Prod Live Manifests

At the moment there is no difference in state then what is overridden above.

Note: While most everything 95% would have been automated, stored as config and is using what is referenced above. I believe a few things could have been done as manual adjustments that we should make sure we are keeping. Largely any manual yaml adjustments would have been documented in high level GitHub issues or tracked in the YAML repository under the AAW group.

Kubeflow V3 Manifests

The following is the P.R. that will be merged into the main branch for Kubeflow V3:

• feat(component): Add apps component jupyter-web-app #125

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

resources:
- github.com/kubeflow/manifests/apps/jupyter/jupyter-web-app/upstream/overlays/istio?ref=v1.3.1
- configs/kubeflow-config.yaml

patchesStrategicMerge:
- cluster-role.yaml
- deployment.yaml

configMapGenerator:
- files:
  - configs/spawner_ui_config.yaml
  behavior: replace
  name: jupyter-web-app-config
  namespace: kubeflow

generatorOptions:
  disableNameSuffixHash: true

Testing

Usually a good idea to make sure all of the overrides are working is to run the following command and verify all of the yaml output for the component is what you expect and all of the overrides are taken into account.

• The jupyter-web-app cluster-role.yaml has been modified correctly
• The jupyter-web-app deployment.yaml (remove patches) has been modified correctly
• The jupyter-web-app deployment_patch.yaml (deployment) has been modified correctly
• The jupyter-web-app configs/spawner_ui_config.yaml (configmap) has been modified correctly
• The jupyter-web-app configs/kubeflow-config.yaml (configmap) has been modified correctly

task stack:aaw:preview

Note: The command above will render all of the manifests into manifests top level folder with the name aaw.yaml. A trick to keep the yaml output small is under stacks/aaw/kustomization.yaml to only have the component you wish to test referenced.