Note: Nutanix is actively developing the kps CLI. As a result, the software published here is release candidate (RC) quality until further notice. Use this software at your own risk and do not use it in a production environment or deployment. The latest release candidate is shown below.
The kps CLI is a command line tool that helps you manage your Karbon Platform Services resources from your terminal or shell. With minimal configuration, you can start using Karbon Platform Services functionality equal to that provided by the browser-based Karbon Platform Services Management Console from the command prompt in your favorite terminal program.
Linux and macOS You can use common shell programs such as bash and zsh. Note that autocompletion for zsh is experimental in this release.
Download the kps CLI for MacOS:
64-bit kps-1.3.0.1091-darwin_amd64.tar.gz
32-bit kps-1.3.0.1091-darwin_386.tar.gz
Optionally, from your terminal or shell, use wget.
$ wget https://kps-cli.s3-us-west-2.amazonaws.com/kps-1.3.0.1091-darwin_amd64.tar.gz
$ mkdir kps && tar zxvf kps-1.3.0.1091-darwin_amd64.tar.gz -C kps
$ sudo kps/install [*optional_path*]
Note The kps binary default installation directory is /usr/local/bin/.
To install the kps binary in a custom location, specify the custom directory or path as follows, where
my/custom/dir is the installation path:
$ sudo kps/install /my/custom/dir
Download the kps CLI for Linux:
64-bit kps-1.3.0.1091-linux_amd64.tar.gz
32-bit kps-1.3.0.1091-linux_386.tar.gz
Optionally, from your terminal or shell, use wget.
$ wget https://kps-cli.s3-us-west-2.amazonaws.com/kps-1.3.0.1091-linux_amd64.tar.gz
$ mkdir kps && tar zxvf kps-1.3.0.1091-linux_amd64.tar.gz -C kps
$ sudo kps/install [*optional_path*]
Note The kps binary default installation directory is /usr/local/bin/.
To install the kps binary in a custom location, specify the custom directory or path as follows, where
my/custom/dir is the installation path:
$ sudo kps/install /my/custom/dir
Configure the kps CLI to interact with Karbon Platform Services API, including your user role and credentials. A kps CLI user operates under a specific context. A user email address, password, and context name defines the context. The user operates according to the role assigned to their user name and email for Karbon Platform Services users.
For example, create a context named local_user_ctx_1 for an existing local user [email protected]. (A local user is a user that does not have My Nutanix portal credentials.)
Note: You can only specify an existing local user email name and password in this example. If you do not have a local user, create one according to the Creating a User topic at the Nutanix Support Portal.
kps config create-context local_user_ctx_1 --email [email protected] --password <password>
The kps CLI supports autocompletion with bash on MacOS and Linux. Using this command for zsh is experimental and not formally supported. To configure auto-completion for your favorite shell, run this command and follow the instructions.
kps completion --help
Under samples/ directory, there are samples for various Karbon Platform Services entities including Data Sources, Data Pipelines, Applications, etc. These samples can be used as a reference when creating your own Karbon Platform Services entities. Each entity has a README which explains the details of each individual attribute of that entity.