CLI Commands and Usage

Commands

  • sdk login

    Accepts --api-key and --insecure. Login will need to be completed using the browser via an OAuth2 flow. Insecure flag is used to configure the login request to use HTTP over HTTPS. The API Key flag is used to provide an API key as credentials. When API key is used as credentials, the global profile flag must also be used to tell the CLI which profile the API key is going to be associated with.

  • sdk list-profiles

    Lists the profiles previously configured with sdk login. Also shows which profile is the active profile.

  • sdk use-profile <PROFILE_NAME>

    Sets the active profile. First argument must be a string matching the name of a previously configured profile.

  • sdk remove-profile <PROFILE_NAME>

    Removes the profile from the current list of configured profiles, and deletes the credentials.

  • sdk configure-docker

    Configures the docker daemon to use the SDKs credential helper with the indicated docker registry. This allows for authentication to the DTaaS docker registry using the credentials of the active profile. Accepts the options --server and --port.

  • sdk show

    Displays the information about the current DTaaS project.

  • sdk types

    Displays a list of the prototype types supported by the current version of the SDK.

  • sdk package

    Packages the current project into a tarball for upload to DTaaS. Accepts the options --pre-built, --no-cache, --output and exist-ok. The pre-built option indicates to not build the docker images for the prototypes and instead use the already built versions. This is required if there is no dockerfile defined in the manifest for any of the prototypes. The no-cache option forces the SDK to build the docker images without the use of the docker image cache. Output takes as a value a file name with path to write the resulting tarball to. If not set, the default output is default.tar in the current directory. The exist-ok option indicates that it’s okay to replace an existing file when writing the tarball.

  • sdk upload

    Uploads the current project to DTaaS. Accepts the options --pre-built, --no-cache and --path. The path option accepts as a value a path to a tarball produced by sdk package to upload. Omitting the path will result in a new tarball being uploaded as if sdk package were called. See sdk package for details about what the pre-built and no-cache options do.

  • sdk teardown

    Removes all prototypes defined in the current project from the connected DTaaS deployment. This involves deleting all servables instantiated using said prototype and stopping all instances of those servables.

  • sdk replace

    Performs an sdk teardown followed by an sdk upload. Accepts the same options as sdk upload.

  • sdk list <TYPE>

    Lists all artifacts of a given servable type. Accepts the option --json which prints the output as a JSON string.

  • sdk describe <ARTIFACT_ID>

    Describes the artifact with the given artifact ID. Accepts the option --json which prints the output as a JSON string.

  • sdk logs <ARTIFACT_ID>

    Retrieves the pod logs for the instance with the supplied artifact ID. Accepts the -f flag to continuously stream the logs.

  • sdk create-key <KEY_NAME>

    Creates an API key for later use as credentials in another CLI session. This API key will not be retrievable after being issued, so don’t lose it.

  • sdk list-keys

    Lists all the known API keys of the active profile. Only lists the names of the keys, not the keys themselves.

  • sdk remove-key <KEY_NAME>

    Removes and revokes the indicated key. That key will no longer be valid for any session. Any profiles using that API key will be invalidated.

  • sdk version

    Displays the version of the SDK currently being used.

Global Options

  • -h, --help

    Display the help information

  • --dir <PATH>

    Selects the path to the project to interact with. Defaults to the current directory.

  • simon-domain <DOMAIN>

    Specifies the domain to assume DTaaS is available at.

  • simon-auth <TOKEN>

    Sets a token to use for authenticating with DTaaS.

  • profile <PROFILE>

    Sets which profile name to use when executing a command.

  • --verbose

    Enables debug level logging of SDK commands.