Director OnPrem is the on-premise version of Director Online(Director OnPrem has the same features as that of Director Online). Enterprise users who are bound by network restriction policies might encounter problems while connecting their Kubernetes cluster to Director Online. In such cases, users can download Director Onprem and deploy it at their end.
1. Kubernetes 1.12.0 or above.
2. Allocating 4 vCPU and 15GB RAM for Director OnPrem components is recommended.
3. Pod CIDR should be one of these values:
4. Helm should be installed.
- Helm needs to be installed on the master node.
- The document has information for both Helm 2 as well as Helm 3. However, the recommended version is Helm 3.
Installing Director OnPrem:
To get started with Director OnPrem follow the below steps:
Register and Download Director OnPrem:
If you are an existing user, login to MayaData user portal with your credentials, else SignUp to MayaData.
To know the detailed steps on Sign Up Click Here.
Once you are logged in, you will be redirected to the User Portal dashboard, now Click on Download OnPrem button on the dashboard under Director section (encircled in the image).
You will receive an email from MayaData Inc containing docker repository credentials. Keep a note of these credentials provided in the email as these will be needed in the later steps of installation.
Install Director OnPrem
All the steps mentioned below are written assuming that Director needs to be deployed on "director" namespace.
Installation of Director needs the below mentioned preparatory steps:
To create "director" namespace, execute: Next, you need to create a docker secret using the credentials you received earlier.
1. Creation of a secret
kubectl create ns director
kubectl create secret docker-registry directoronprem-registry-secret --docker-server=registry.mayadata.io --docker-username=<username> --docker-password=<password> -n director
2. Exposing the Node IP, where Director is to be installed.
If you are behind a NAT or external load balancer want to be able to access the Director OnPrem UI from outside your internal network, then you need to expose the node IP that you used in the values.yaml by adding a network rule to route traffic to the Director service.
3. Create a StorageClass
You can use any storageClass, however ensure the name is set to standard. To know the steps for creation of OpenEBS cStor storageClass click here.
4. Install Director OnPrem
To add the director repo to your local machine, execute:
helm repo add directoronprem https://github.com/mayadata-io/director-charts/raw/master/package-artifacts/
helm repo update
Next, to install Director OnPrem execute the below-mentioned command replacing Node_IP with the exposed Node IP, where Director needs to be deployed.
For helm version 3, execute:
helm install dop directoronprem/directoronprem --set server.url=<Node_IP> -n director
For helm version 2, execute:
helm install directoronprem/directoronprem --name dop --set server.url=<Node_IP> --namespace director
To view the installed version, execute:
helm ls -n director
To create "director" namespace, execute:
Next, you need to create a docker secret using the credentials you received earlier.
Verify Director OnPrem pods using the following command.
kubectl get pods -n director
NAME READY STATUS RESTARTS AGE alertmanager-57b4ddcf68-lw4gx 0/1 Init:2/3 0 2m17s alertstore-6f66b4475f-gjjjf 0/1 Init:2/3 0 2m16s alertstore-tablemanager-5c48fcd87b-6gf9b 0/1 PodInitializing 0 2m16s cassandra-0 1/1 Running 0 2m15s chat-server-69584fcb64-9562s 1/1 Running 0 2m16s cloud-agent-7d79d6f4c8-p8bxf 1/1 Running 0 2m16s configs-78849595c5-6ptnl 1/1 Running 0 2m16s configs-db-57bf44bbfd-f7rg5 1/1 Running 0 2m16s consul-c6ffdf59b-vpxnd 1/1 Running 0 2m15s distributor-68587d6c48-4k8lj 0/1 Init:2/3 0 2m16s dop-nginx-ingress-controller-v8frh 1/1 Running 0 2m17s dop-nginx-ingress-default-backend-cf9c64c-2dch8 1/1 Running 0 2m16s dop-nginx-ingress-default-backend-cf9c64c-rlrbt 1/1 Running 0 2m16s elastalert-6bf984b7b6-th2l5 0/1 Init:1/2 0 2m14s ingester-74f85f9bcc-wb79m 0/1 Init:2/4 0 2m16s maya-grafana-6dd4dd577d-jpl6t 0/2 ContainerCreating 0 2m16s maya-io-6764b8775c-9rkh9 0/1 Init:1/8 0 2m16s maya-ui-74b57777b-ft7gr 1/1 Running 0 2m16s memcached-78844679fc-b6j4w 1/1 Running 0 2m16s mysql-0 0/2 Init:1/2 0 2m16s od-elasticsearch-logging-0 0/1 PodInitializing 0 2m15s od-kibana-logging-6f88fdd6fb-fxlrb 1/1 Running 0 2m15s querier-668b78b688-cbd9x 0/1 Init:2/4 0 2m15s ruler-679bd4777b-ml85w 0/1 Init:2/6 0 2m14s table-manager-767dfd9b94-mn6sh 0/1 PodInitializing 0 2m16s
The pods may take some time to come to running state, based on the underlying storage. In case the pod(s) do not come up or you face any other problem, refer to the troubleshooting section. If the problem still persists feel free to contact our support team.
Once all the pods are up and running you can access OnPrem portal from a browser using the Worker Node IP provided in Step 2, in the format
NOTE:By default username is set as "Administrator" and password as "password".