2.5

Install PrimeHub

Before installing PrimeHub, please make sure you have the PrimeHub release tarball.

tar -zxvf primehub-vx.x.x.tar.gz
cd primehub-vx.x.x

Prepare the Value File

Prepare the value file primehub-values.yaml for helm installation.

KeyDescription
PRIMEHUB_DOMAINThe domain name of keycloak. It can be the same as primehub's one.
PRIMEHUB_PASSWORDThe password for primehub admin. (The default username of admin is phadmin)
KEYCLOAK_DOMAINThe hostname of keycloak. It can be the same as primehub's one.
KEYCLOAK_PASSWORDThe master password of keycloak
STORAGE_CLASSThe storage class for persistence storage
GRAPHQL_SECRET_KEYThe graphql API secret key
HUB_AUTH_STATE_CRYPTO_KEYThe jupyterhub crypo key. Please reference the z2jh document.
HUB_PROXY_SECRET_TOKENThe jupyterhub secret. Please reference the z2jh document.

Modify the environment variables below and execute the commands to generate the value file.

PRIMEHUB_DOMAIN=1.2.3.4.nip.io
PRIMEHUB_PASSWORD=__my_password__
KEYCLOAK_DOMAIN=1.2.3.4.nip.io
KEYCLOAK_PASSWORD=__my_password__
STORAGE_CLASS=__storage_class__
GRAPHQL_SECRET_KEY=$(openssl rand -hex 32)
HUB_AUTH_STATE_CRYPTO_KEY=$(openssl rand -hex 32)
HUB_PROXY_SECRET_TOKEN=$(openssl rand -hex 32)

cat <<EOF > primehub-values.yaml
primehub:
  scheme: http
  domain: ${PRIMEHUB_DOMAIN}
  keycloak:
    scheme: http
    domain: ${KEYCLOAK_DOMAIN}
    username: keycloak
    password: ${KEYCLOAK_PASSWORD}
bootstrap:
  usernmae: phadmin  
  password: ${PRIMEHUB_PASSWORD}
graphql:
  sharedGraphqlSecret: ${GRAPHQL_SECRET_KEY}
groupvolume:
  storageClass: ${STORAGE_CLASS}
ingress:
  annotations:
    ingress.kubernetes.io/affinity: cookie
    kubernetes.io/ingress.class: nginx
  hosts:
  -  ${PRIMEHUB_DOMAIN}
jupyterhub:
  auth:
    state:
      cryptoKey: ${GRAPHQL_SECRET_KEY}
  hub:
    db:
      pvc:
        storageClassName: ${STORAGE_CLASS}
  proxy:
    secretToken: ${HUB_PROXY_SECRET_TOKEN}
  singleuser:
    storage:
      dynamic:
        storageClass: ${STORAGE_CLASS}
EOF

Install

  1. Run helm command to install keycloak

    helm upgrade \
  --install \
  --reset-values \
  --namespace hub  \
  --values primehub-values.yaml \
  primehub modules/charts/primehub

    In the first time installation, it may take a longer time to pull images. You can add --timeout 1800 to change the default timeout duration.

  2. Label the nodes which can be assigned for jupyterhub servers

    kubectl label node component=singleuser-server --all

Verify the Installation

  1. Run this command to wait for PrimeHub ready

    kubectl -n hub rollout status deploy/primehub-console

  2. Open http://${PRIMEHUB_DOMAIN} and log in by the admin username and password.

  3. Open [Jupyterhub] icon and spawn a jupyter instance.

Apply License Key

  1. Run this command to apply a license key; please contact InfuseAI for the license.

    kubectl -n hub apply -f path/to/license_key_yaml_file

You can check the license status from System Management.

Troubleshooting

  1. If there is something wrong when installing, you can check the bootstrap job log to see what's going on

    kubectl -n hub logs jobs/primehub-bootstrap
← PreviousNext →