Skip to content

datumctl

The Datum control plane is a collection of multiple projects developed with Kubernetes control plane technology, most of which can be installed into native Kubernetes clusters.

As a result, you will leverage common Kubernetes tooling such as kubectl to interact with Datum.

Install Tools

Section titled “Install Tools”

datumctl

Section titled “datumctl”

Install datumctl with the Homebrew package manager on macOS or Linux:

Terminal window
brew install datum-cloud/tap/datumctl

kubectl

Section titled “kubectl”

Refer to the official Kubernetes documentation for installation instructions, making sure to skip the Verify kubectl configuration section in the guide you choose.

Later in this guide, you will configure a kubeconfig file as required to interact with Datum via kubectl.

For convenience, homebrew instructions are below:

Install kubectl with the Homebrew package manager on macOS or Linux:

Terminal window
brew install kubectl

Configure Tools

Section titled “Configure Tools”

Authentication

Section titled “Authentication”
Terminal window
datumctl auth login
  1. Run the command to open a browser window and sign in with your organization’s identity provider.
  2. When Authentication successful appears, credentials are cached locally for subsequent datumctl and kubectl commands.

Add a kubeconfig context for your organization

Section titled “Add a kubeconfig context for your organization”

Obtain your organization’s resource ID with datumctl by listing organizations that your user has access to:

Terminal window
datumctl get organizations

The output is similar to:

Terminal window
DISPLAY NAME           RESOURCE ID
Personal Organization  pp4zn7tiw5be3beygm2d6mbcfe

Create a kubeconfig context to access your organization’s resources by copying the the RESOURCE ID value and executing following command, replacing RESOURCE_ID with the value:

Terminal window
datumctl auth update-kubeconfig --organization RESOURCE_ID

The output is similar to:

Terminal window
Successfully updated kubeconfig at getting-started.kubeconfig

Verify kubectl configuration

Section titled “Verify kubectl configuration”

Check that kubectl is properly configured by getting authorized user info:

Terminal window
kubectl auth whoami

The output is similar to:

Terminal window
ATTRIBUTE                                                VALUE
Username                                                 datum@example.com
Groups                                                   [system:authenticated]
Extra: authentication.datum.net/datum-organization-uid   [pp4zn7tiw5be3beygm2d6mbcfe]
Extra: authentication.kubernetes.io/credential-id        [JTI=01jgsr1m8fpb9cn0yrh05taa5v]