Installation¶

On Kubernetes¶

For the installation on a kubernetes helm is used.

Supported versions

Requirements¶

1. Kubernetes

   No specific version a the moment known. There are no special features used at the moment, so any version, which is not EOL should work.

   Example

   For fast, easy and minimal installation a k3s as single-node installation can be used without traefik. Installation with for example:

   sudo curl -sfL https://get.k3s.io | INSTALL_K3S_EXEC="--disable traefik" sh -
   
   export KUBECONFIG=/etc/rancher/k3s/k3s.yaml
   

2. Helm

   official Installation-Guide

3. Nginx-ingress-controller (if not already exist in your kubernetes)

   run:

   kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.8.1/deploy/static/provider/baremetal/deploy.yaml
   

   and apply file with the content:

   ```¶

   apiVersion: v1 kind: Service metadata: name: ingress-nginx-controller-loadbalancer namespace: ingress-nginx spec: selector: app.kubernetes.io/component: controller app.kubernetes.io/instance: ingress-nginx app.kubernetes.io/name: ingress-nginx ports: - name: http port: 80 protocol: TCP targetPort: 80 - name: https port: 443 protocol: TCP targetPort: 443 type: LoadBalancer ```

4. Cert-Manager

   Installation:

   helm repo add jetstack https://charts.jetstack.io
   helm repo update
   kubectl create namespace cert-manager
   helm install cert-manager jetstack/cert-manager --namespace cert-manager --set installCRDs=true
   

5. Node label

   To all avaialbe nodes, where it is allowed to be deployed, the label hanami-node must be assigned

   kubectl label nodes NODE_NAME hanami-node=true
   

   Info

   At the moment OpenHanami is only a single-node application. This will change in the near future, but at the moment it doesn't make sense to label more than one node.

Installation¶

From repository

git clone https://github.com/kitsudaiki/OpenHanami.git

cd OpenHanami/deploy/k8s

helm install \
    --set docker.tag=DOCKER_IMAGE_TAG \
    --set user.id=USER_ID  \
    --set user.name=USER_NAME  \
    --set user.passphrase=PASSPHRASE  \
    --set token.data=TOKEN_KEY  \
    --set api.domain=DOMAIN_NAME  \
    openhanami \
    ./openhanami/

From pre-build

Download the helm-chart from the file-share

helm install \
    --set docker.tag=DOCKER_IMAGE_TAG \
    --set user.id=USER_ID  \
    --set user.name=USER_NAME  \
    --set user.passphrase=PASSPHRASE  \
    --set token.data=TOKEN_KEY  \
    --set api.domain=DOMAIN_NAME  \
    openhanami \
    openhanami-x.y.z.tgz

The --set-flag defining the login-information for the initial admin-user of the instance:

• USER_ID

  • required
  • Identifier for the new user. It is used for login and internal references to the user.
  • String, which MUST match the regex [a-zA-Z][a-zA-Z_0-9@]* with between 4 and 256 characters length

• USER_NAME

  • required
  • Better readable name for the user, which doesn't have to be unique in the system.
  • String, which MUST match the regex [a-zA-Z][a-zA-Z_0-9 ]* with between 4 and 256 characters length

• PASSPHRASE

  • required
  • Passphrase for the initial user
  • String, with between 8 and 4096 characters length

• TOKEN_KEY

  • required
  • Key for the JWT-Tokens
  • String

• DOMAIN_NAME

  • Domain for https-access.
  • String
  • default: local-hanami

• DOCKER_IMAGE_TAG

  • Docker-tag used from docker-hub
  • String
  • default: develop

After a successful installation the USER_ID and PASSPHRASE have to be used for login to the system.

Using¶

• check if all pods are running

  Example

  kubectl get pods
  
  NAME                      READY   STATUS    RESTARTS   AGE
  hanami-56fc87c8f5-6k77r   1/1     Running   0          14s
  

• get IP-address

  Example

  kubectl get ingress
  
  NAME                      CLASS     HOSTS          ADDRESS          PORTS     AGE
  hanami-ingress-redirect   traefik   local-hanami   192.168.178.87   80        8s
  hanami-ingress            traefik   local-hanami   192.168.178.87   80, 443   8s
  

• add domain with ip to /etc/hosts

  Example

  192.168.178.87  local-hanami
  

• use the address in your browser:

  https://DOMAIN_NAME

  Example

  https://local-hanami/
  

• login with USER_ID and PASSPHRASE

  Note

  Persistent data of hanami (checkpoints and so on) within the pod are mounted into the host directory /etc/openhanami_data, in case you want to save or delete them.