Use datumctl to explore and manage Datum Cloud resources

[scotwells]

Overview

Our datumctl CLI now supports directly managing resources within Datum Cloud instead of requiring users to use kubectl making it easier than ever to interact with Datum Cloud on the command line!

Under the hood, our control plane is built around the Kubernetes apiserver technology to provide a reliable distributed control plane for managing infrastructure resources. Since our API feels like Kubernetes, we wanted to provide a similar experience on the command line so users don't need to learn yet another new tool.

We were able to bring the kubectl experience to Datum Cloud by using kubectl as a library within datumctl, so many of the kubectl commands people are already familiar with will behave the same on Datum Cloud.

Get up to speed with the Datum environment with these commands:

• datumctl api-resources - Show all resources available in the system
• datumctl get - Retrieve a list of resources or a single resource
• datumctl delete - Delete a resource from the platform
• datumctl describe - Show detailed information about a resource
• datumctl apply - Create or update a resource on the platform w/ conflict management support
• datumctl diff - Diff a resource on the platform to understand what could change
• datumctl explain - Show documentation for a resource and all of the fields available

Start here:

One of our personal favorites is the explain command that provides an easy way of discovering information about resources available in Datum Cloud. You can use the api-resources command to learn what resources are available and explain to learn more about a specific resource. The explain command also lets you drill into a resources field documentation by specifying the field path to the section of the resource you want more information on.

Here's an example of using the explain command to learn more about the HTTP Proxy spec.

$ datumctl explain httpproxies.spec
GROUP:      networking.datumapis.com
KIND:       HTTPProxy
VERSION:    v1alpha

FIELD: spec <Object>


DESCRIPTION:
    Spec defines the desired state of an HTTPProxy.
    
FIELDS:
  hostnames     <[]string>
    Hostnames defines a set of hostnames that should match against the HTTP
    Host header to select a HTTPProxy used to process the request.
    
    Valid values for Hostnames are determined by RFC 1123 definition of a
    hostname with 1 notable exception:
    
    1. IPs are not allowed.
    
    Hostnames must be verified before being programmed. This is accomplished
    via the use of `Domain` resources. A hostname is considered verified if any
    verified `Domain` resource exists in the same namespace where the
    `spec.domainName` of the resource either exactly matches the hostname, or
    is a suffix match of the hostname. That means that a Domain with a
    `spec.domainName` of `example.com` will match a hostname of
    `test.example.com`, `foo.test.example.com`, and exactly `example.com`, but
    not a hostname of `test-example.com`. If a `Domain` resource does not exist
    that matches a hostname, one will automatically be created when the system
    attempts to program the HTTPProxy.
    
    In addition to verifying ownership, hostnames must be unique across the
    platform. If a hostname is already programmed on another resource, a
    conflict will be encountered and communicated in the `HostnamesVerified`
    condition.
    
    Hostnames which have been programmed will be listed in the
    `status.hostnames` field. Any hostname which has not been programmed will
    be listed in the `message` field of the `HostnamesVerified` condition with
    an indication as to why it was not programmed.
    
    The system may automatically generate and associate hostnames with the
    HTTPProxy. In such cases, these will be listed in the `status.hostnames`
    field and do not require additional configuration by the user.
    
    Wildcard hostnames are not supported at this time.

  rules <[]Object> -required-
    Rules are a list of HTTP matchers, filters and actions.

Give these commands a shot and let us know what you think!

---

Download datumctl v0.7.0 straight from our GitHub release page, through homebrew, or nix!

• Want to learn more about how we implemented these using kubectl? Review the PR!
• Have feedback about what you'd like to see happen with datumctl? Comment on the roadmap with feedback!

[bmertens-datum]

@scotwells Used datumctl to create a zone, add DNS records and create a zone file. :)

[scotwells]

@bmertens-datum amazing! Any usability issues come up with it or was it pretty straight forward?