Helm Installation

Helm Installation

To install Kubepass via helm, follow these steps:

  1. Add the Kubepass Helm repository to your local Helm client:

    helm repo add kubepass https://helm.kubepass.com
  2. Update your local Helm chart repository:

    helm repo update  
  3. Create a new namespace

    kubectl create namespace kubepass
  4. Install Kubepass to your Kubernetes cluster:

    helm install kubepass kubepass/kubepass -n=kubepass  
  5. Wait for all services to become available.

    ➜  kubectl -n=kubepass get all,secrets
    
    NAME                              READY   STATUS    RESTARTS   AGE
    pod/auth-7d9fd5dcf4-zcrwb         1/1     Running   0          35d
    pod/controller-64c5cddbcc-kjv8v   1/1     Running   0          5d13h
    pod/dashboard-6dc4b547df-2bw4f    1/1     Running   0          5d13h
    pod/postgres-78f57bc795-7plb2     1/1     Running   0          37d
    
    NAME                 TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)             AGE
    service/auth         ClusterIP   10.245.22.25     <none>        8080/TCP,8443/TCP   88d
    service/controller   ClusterIP   10.245.185.4     <none>        8080/TCP,443/TCP    31d
    service/dashboard    ClusterIP   10.245.213.53    <none>        8080/TCP            11d
    service/postgres     ClusterIP   10.245.232.196   <none>        5432/TCP            88d
    
    NAME                         READY   UP-TO-DATE   AVAILABLE   AGE
    deployment.apps/auth         1/1     1            1           88d
    deployment.apps/controller   1/1     1            1           31d
    deployment.apps/dashboard    1/1     1            1           11d
    deployment.apps/postgres     1/1     1            1           88d
    
    NAME                                    DESIRED   CURRENT   READY   AGE
    replicaset.apps/auth-6d9bbcc58d         0         0         0       88d
    replicaset.apps/auth-7d9fd5dcf4         1         1         1       35d
    replicaset.apps/controller-54f946f544   0         0         0       31d
    replicaset.apps/controller-64c5cddbcc   1         1         1       11d
    replicaset.apps/controller-7c85bfb8bb   0         0         0       31d
    replicaset.apps/dashboard-686677dfbf    0         0         0       11d
    replicaset.apps/dashboard-6dc4b547df    1         1         1       11d
    replicaset.apps/postgres-78f57bc795     1         1         1       88d
    
    NAME                            TYPE                                  DATA   AGE
    secret/controller-certificate   kubernetes.io/tls                     3      27d
    secret/database                 Opaque                                6      88d
    secret/keycloak                 Opaque                                2      88d
    secret/kubepass-svc-account     kubernetes.io/service-account-token   3      31d
    secret/license                  Opaque                                1      88d
  6. You can access the Kubepass dashboard by creating an ingress or port forwarding:

    kubectl -n=kubepass port-forward svc/dashboard 8080:8080
  7. Access Kubepass via a web browser(if port forwarded):

    http://localhost:8080
  8. If you created an ingress, you can find the ingress host by running the following command:

    kubectl -n=kubepass get ingress

Helm parameters

Postgres

ParameterDefaultData typeDescription
postgres.createtrueBooleanWill create a new postgres deployment and service if set totrue
postgres.imagepostgresStringDocker registry image to use if postgres.create is true
postgres.taglatestStringImage tag to use if postgres.create is true
postgres.hostpostgresStringPostgres host
postgres.port5432StringPostgres port
postgres.usernamedb_adminStringPostgres user
postgres.passwordChanG3Me$StringPostgres password
postgres.databasekubepassStringPostgres database name

Kubepass

ParameterDefaultData typeDescription
kubepass.license_keyStringLicense key. Can be retrived from dashboard.
kubepass.root_urlStringURL where you Kubepass will be accessed. Eg. https://kubepass.example.com
kubepass.logo_urlStringURL of logo image file.

Kubepass Auth

ParameterDefaultData typeDescription
kubepass.auth.admin_usernameadminStringAdmin username
kubepass.auth.admin_passwordadminStringAdmin password