3.12

Install PrimeHub Community

Community Applicable to Community Edition

To prepare a PrimeHub-ready-Kubernetes, Please check the Prerequisites for PrimeHub first before preceding to the PrimeHub CE installation.

The document assumes there is a PrimeHub-ready-Kubernetes already. The steps below are performed against the cluster.

Prepare the environment variables

Prepare the variables before installation

KeyDescriptionExample value
PRIMEHUB_DOMAINThe domain name of PrimeHub which user can access to.example.primehub.io
PH_PASSWORDPrimeHub admin phadmin default passwordyourDefaultPassw0rd
KC_PASSWORDKeycloak admin keycloak default passwordyourDefaultPassw0rd

Clone PrimeHub Repository

git clone https://github.com/InfuseAI/primehub.git

Validate the primehub-install command is executable

./primehub/install/primehub-install

You should see the usage message like this:

USAGE:
  primehub-install create  singlenode  [options]            : Create single-node k8s environment
  primehub-install status  singlenode                       : Show the statuse of single-node k8s environment
  primehub-install destroy singlenode                       : Destroy single-node k8s environment
...

Install PrimeHub required binaries

./primehub/install/primehub-install required-bin

This will install the required commands onto ~/bin. You should append the ~/bin to your PATH variables, or use the following command to append and read from the .bashrc

echo "export PATH=$HOME/bin:$PATH" >> ~/.bashrc
source ~/.bashrc

Install PrimeHub

Prepare two terminals, one to execute the primehub install script, the other to monitor the install progress by watching the pods status.

Terminal one

Install by primehub-install create primehub and specify the version. ex. v3.6.2. Please check the latest stable version.

Check available stable versions

./primehub/install/primehub-install

Install the latest stable version by default

./primehub/install/primehub-install create primehub --primehub-ce

Or install the specific version as below

./primehub/install/primehub-install create primehub --primehub-version <version> --primehub-ce

Enter the PRIMEHUB_DOMAIN, KC_PASSWORD, PH_PASSWORD by command prompt.

The install script will start by preflight check, init config, and so on.

[Preflight Check]
[Preflight Check] Pass
[Verify] Mininal k8s resources
...
[Install] PrimeHub
[Check] primehub.yaml
[Generate] primehub.yaml
[Install] PrimeHub   
...
[Progress] wait for bootstrap job ready
...

Terminal two

Open another terminal to run the command to watch the progress.

watch 'kubectl -n hub get pods'

Or once the primehub-bootstrap is running, check the progress of bootstrapping.

kubectl logs -n hub $(kubectl get pod -n hub | grep primehub-bootstrap | cut -d' ' -f1) -f

Once to see most pods with Running STATUS except primehub-bootstrap-xxx pod in Completed STATUS and the READY indicator should be N/N.

Example watch console for the completed installation:

NAME                                                   READY   STATUS      RESTARTS   AGE
hub-758bd48876-wwwww                                   1/1     Running     0          17m
keycloak-0                                             1/1     Running     0          17m
keycloak-postgres-0                                    1/1     Running     0          17m
metacontroller-0                                       1/1     Running     0          17m
primehub-admission-xxxxxxxxxx-yyyyy                    1/1     Running     0          17m
primehub-bootstrap-xxxxx                               0/1     Completed   0          17m
primehub-console-xxxxxxxxxx-yyyyy                      1/1     Running     0          17m
primehub-controller-xxxxxxxxxx-yyyyy                   2/2     Running     0          17m
primehub-graphql-xxxxxxxxx-yyyyy                       1/1     Running     0          17m
primehub-metacontroller-webhook-xxxxxxxxxx-yyyyy       1/1     Running     0          17m
primehub-watcher-xxxxxxxxxx-yyyyy                      1/1     Running     0          17m
proxy-6bdd94cc-yyyyy                                   1/1     Running     0          17m

Then go back to Terminal one and wait until you see messages:

[Completed] Install PrimeHub

PrimeHub:   http://`$PRIMEHUB_DOMAIN` ( phadmin / `$PH_PASSWORD` )
Id Server:  http://`$PRIMEHUB_DOMAIN`/auth/admin/ ( keycloak / `$KC_PASSWORD` )

[Completed]

Enable PrimeHub Store

After the fresh installation, need to enable PrimeHub Store.

  1. Set flag by edit the env

    ~/primehub/install/primehub-install env edit

  2. Add PRIMEHUB_FEATURE_STORE flag to the last line of .env

    PRIMEHUB_FEATURE_STORE=true

  3. Update the configuration by primehub-install command

    ~/primehub/install/primehub-install upgrade primehub

Verify the Installation

Browse http://${PRIMEHUB_DOMAIN} and log in by the phadmin and the password. phadmain is a default account with admin privileges.

Hooray! PrimeHub CE has been installed and is running now.

New to PrimeHub

Initially, PrimeHub has a built-in user phadmin, a built-in group phusers, and several instance types/image which are set Global. phadmin can launch a notebook quickly by using these resources.

Now PrimeHub CE is ready, see Launch Notebook to launch your very first JupyterNotebook on PrimeHub. Also see User Guide to have the fundamental knowledge of PrimeHub.