On this page

    Administering Dremio on EKS

    This topic discusses administration activities such as pod scaling, configuration changes, basic administrative tasks (backup, restore, clean, and so on), and Dremio upgrading.

    Monitoring Logs

    Logs are written to the container’s console (stdout). These logs can be monitored using the kubectl command. All the logs (server.log, server.out, server.gc and access.log) are written to the console simultaneously. You can view the logs using the kubectl logs or kubectl logs -f command.

    kubectl logs <container-name>
    kubectl logs -f <container-name>
    

    Scaling Up/Down

    When you scale up or down the number of Dremio’s pods (master-coordinator, executors, or slave-coordinators), you are changing the number of Dremio pods. All scaling values remain in affect until another helm upgrade command is run.

    note:

    Performance: If you scale down the number of pods (either temporarily or permanently), already created reflections may need to be re-created during the next refresh. This could result in a delay for up-to-date data reflections.

    1. Obtain the name of the helm chart release with the helm list command. For example:
      helm list
      NAME             	REVISION	UPDATED                 	STATUS  	CHART       	NAMESPACE
      plundering-alpaca	1       	Wed Jul 18 09:36:14 2018	DEPLOYED	dremio-0.0.5	default
      
    2. Run the helm upgrade --wait <chart release name> . --set <dremio pod=value> command.

    For example, Dremio executor pods could be scaled up/down with the following commands where plundering-alpaca is the chart release name and the pod count is 5:

    helm upgrade --wait plundering-alpaca . --set executor.count=5
    

    Resetting to Defaults

    Once you scale up/down a Dremio pod, if helm upgrade is run again (either for scaling, changing your configuration, or upgrading) the configuration resets to the defaults specified in the values.yaml file.

    All scaling values remain in affect until another helm upgrade command is run. When a subsequent helm upgrade command is run, values are reset to the default in the value.yaml file. For example, if you scale up the slave-coordinators to 3 and then scale up the executors to 5, the slave-coordinator is reset to 0 (default) after the executor is scaled up/down to 5.

    note:

    Scale to zero: If you scale all of the Dremio pods down to zero (0), you are effectively shutting down the Dremio cluster.

    To permanently change your default values, update the values.yaml file. See Changing your Configuration for more information.

    Changing your Configuration

    If you need to update your configuration, this can be done after installation by re-editing the configuration files and then upgrading using the helm upgrade <chart release name> . command. The upgrade process pushes out your changes to all of the pods in your Kubernetes cluster and restarts the pods.

    For example, if you want to permanently increase the number of Dremio executor pods to five (5):

    1. Edit the values.yaml file and change the number of executor pods via executor.count. In this example, executor.count is 5 and the other executor defaults remain unchanged.
      executor:
        memory: 16384
        cpu: 4
        count: 5
        volumeSize: 20Gi
      
    2. Run the helm upgrade --wait <chart release name> . command. In this example, plundering-alpaca is the chart release name:
      helm upgrade --wait plundering-alpaca .
      

    note:

    Tip: If it takes longer than a couple of minutes to complete, check the status of the pods via kubectl get pods. If the pods are pending scheduling due to limited memory or cpu, either re-adjust the values in the values.yaml file or add more resources to your Kubernetes cluster.

    Dremio Admin Commands

    The following are the Dremio administration command that can be run on the Dremio+Kubernetes cluster. All commands except for the Dremio backup command required that Dremio be shutdown/offline.

    CommandOffline/OnlineNotes
    backuponline/opt/dremio/bin/dremio-admin backup
    See Backup Dremio for more information.
    cleanoffline/opt/dremio/bin/dremio-admin clean
    See Metadata Cleanup for more information.
    restoreoffline/opt/dremio/bin/dremio-admin restore
    See Restore Dremio for more information.
    set-passwordoffline/opt/dremio/bin/dremio-admin set-password
    See Reset Password for more information.

    Backup

    The backup command is run when Dremio is online. It is run on the master-coordinator pod from a bash shell.

    To run the backup command:

    1. Connect to the master-coordinator pod using the exec command.
      kubectl exec -it dremio-master-0 -- bash
    2. Run the command from the bash shell. See Backup Dremio for more information.
       /opt/dremio/bin/dremio-admin backup \
        -u <DREMIO_ADMIN_USER> \
        -p <DREMIO_ADMIN_PASS> \
        -d <BACKUP_PATH>
      
    3. Store the backup files in some persistent volume or copy the files out of the local pod.

    Clean, Restore, and Set-Password

    The following Dremio commands are offline commands, that is, Dremio must not be running.

    • clean
    • restore
    • set-password

    note:

    To temporarily shut down Dremio, scale down the master-coordinator to zero (0).

    These offline commands are run by creating a Dremio Admin pod with the Dremio image and mounting the master-coordinator pod’s persistent volume.

    To run offline dremio-admin commands:

    1. Create a Dremio Admin pod to run the dremio-admin commands. Use the following command to create a Dremio Admin pod:
      helm install --wait dremio --set DremioAdmin=true
    2. Run the dremio-admin commands from the bash shell on the Dremio Admin pod. See Advanced Administration for more information on each command.
      The following commands connect you to the pod and allow you to perform the offline command:
      kubectl exec -it dremio-admin -- bash
      bin/dremio-admin <offline command>
    3. Delete the pod.
      kubectl delete pod dremio-admin

    After performing the offline command, you can restart your Dremio cluster.