DSH resource management API command line tool

NOTE
This tool is still under development and will most likely contain many bugs. If you encounter any of these bugs (and you will), you can report them to unibox@kpn.com. Please include the exact command, the erroneous output and an explanation of the expected output. You can also send requests for new features to this e-mail address.

This project provides a tool to call functions on the DSH resource management API from the command line of your workstation. The following DSH resources can be listed, queried, searched, created and deleted.

Meaning of the dots:

Local installation and run

The DSH Api Command Line Tool (dsh) can be installed on your local machine (assuming you have the rust tool chain installed), by executing the following command.

> cargo install dsh
...

Environment variables

In order to run dsh, either make sure that the environment variables described below are properly set. These values can also be set via the settings file or be provided as command line arguments.

Settings file

Run

When installation completed without any errors and the environment variables are set, you should be able to start the tool from the command line.

> dsh
DSH resource management api command line interface.

Usage: dsh [OPTIONS] [SUBJECT/COMMAND]

Subjects/commands:
  api          List and call DSH resource management api.
  app          Show, manage and list apps deployed from the DSH app catalog.
  application  Show, manage and list applications deployed on the DSH.
  bucket       Show, manage and list DSH buckets.
  certificate  Show, manage and list DSH certificates.
  env          Find values used in configurations.
  image        Show image usage.
  manifest     Show App Catalog manifests.
  metric       Show metric exports.
  platform     Show, list and open platform resources.
  proxy        Show, manage and list DSH Kafka proxies.
  secret       Show, manage and list DSH secrets.
  topic        Show, manage and list DSH topics.
  vhost        Show vhost usage.
  volume       Show, manage and list DSH volumes.
  setting      Show, manage and list dsh settings.
  target       Show, manage and list dsh target configurations.
  help         Print this message or the help of the given subcommand(s)

Options:
  -p, --platform <PLATFORM>                 Provide target platform. [possible values: np-aws-lz-dsh, poc-aws-dsh,
                                            prod-aws-dsh, prod-aws-lz-dsh, prod-aws-lz-laas, prod-azure-dsh]
  -t, --tenant <TENANT>                     Provide target tenant.
  -g, --guid <GUID>                         Provide target group and user id.
      --password-file <FILE>                Provide password file name.
  -o, --output-format <FORMAT>              Set output format. [possible values: csv, json, json-compact, plain, quiet,
                                            table, table-no-border, toml, toml-compact, yaml]
  -v, --verbosity <VERBOSITY>               Set verbosity level. [possible values: off, low, medium, high]
      --dry-run                             Execute in dry-run mode.
      --force                               Force changes without confirmation.
      --matching-style <STYLE>              Set styling for matches. [possible values: normal, bold, dim, italic,
                                            underlined, reverse]
      --no-color                            No color.
  -q, --quiet                               Run in quiet mode.
      --show-execution-time                 Show execution time.
      --terminal-width <WIDTH>              Set terminal width.
      --generate-autocomplete-file <SHELL>  Generate autocomplete file [possible values: bash, elvish, fish, powershell,
                                            zsh]
  -h, --help                                Print help (see more with '--help')
  -V, --version                             Print version

For most commands adding an 's' as a postfix will yield the same result as using the 'list' subcommand, e.g. using 'dsh
apps' will be the same as using 'dsh app list'.

You can have a more comprehensive explanation by using the --help command line option. Commands also have their own help text.

> dsh --help
> dsh secret --help
> dsh secret list --help

Development

Dependencies

The dsh tool has a strong dependency on the dsh_api library, that provides the client for the DSH resource management API. This library is continuously being worked on, and is published to crates.io. Hence, at this time dsh depends on the crates.io version of the library.

# Cargo.toml
dsh_api = "0.3.1"

When developing simultaneously on dsh and dsh_api consider changing the library dependency to your local copy.

# Cargo.toml
dsh_api = { path = "../dsh-api/dsh-api" }

Coding guidelines

Before pushing code to github, make sure that you adhere to the code formatting defined in rustfmt.toml and that you have run the clippy linter. The following commands should return without any remarks:

> cargo +nightly fmt --check

> cargo clippy

Consider configuring your IDE to automatically apply the formatting rules when saving a file.