itzcli

README

IBM Technology Zone Command Line Interface (itz)

The itz command line interface is a scriptable command line interface that provides CLI access to IBM Technology Zone.

Introduction

Using itz, you can:

• List your existing reservations and get their status.
• Log in to your reservations by printing credentials and/or login links.
• Create new GitOps projects on your own infrastructure using your favorite templates and reference architectures in IBM Technology Zone.
• Install or provision your local projects created from IBM Technology Zone Accelerator Toolkit.
• Submit your own content for use in IBM Technology Zone.

See the QUICKSTART.

For usage documentation, see the documentation in the docs folder.

Architecture

For an architecture overview, see docs/ARCHITECTURE.md.

Installing itz

Release packages for your OS can be found at https://github.com/cloud-native-toolkit/itzcli/releases.

Getting API keys

The itz command makes calls to two different APIs to get reservation and builder solution data. To make those calls, the itz command requires API keys for authorization. The keys are available when you log into IBM Technology Zone and IBM Technology Zone Accelerator Toolkit. See the next sections for more information.

Getting the IBM Technology Zone API key

To get the API key for the listing your IBM Technology Zone reservations, follow these steps:

1. Log into IBM Technology Zone.
2. Go to your profile by clicking your picture in the upper right corner or by going to My Profile.
3. Find the API token field and click the copy icon or copy the value into your clipboard.
4. Once you have the key, put the key into a temporary file, such as /tmp/token.txt.
5. Use the itz auth login command with the --from-file option to import the token into your configuration, like this:

   ./itz auth login --from-file /tmp/token.txt --service-name reservations
   

Getting the IBM Technology Zone Accelerator Toolkit API key

To get the API key for the listing your solutions that you have created using the IBM Technology Zone Accelerator Toolkit, follow these steps:

1. Log into IBM Technology Zone Accelerator Toolkit.
2. Go to your profile by clicking your picture in the upper right corner.
3. Find the API token field and click the copy icon to copy the API key into your clipboard.
4. Once you have the key, put the key into a temporary file, such as /tmp/token.txt.
5. Use the itz auth login command with the --from-file option to import the token into your configuration, like this:

   ./itz auth login --from-file /tmp/token.txt --service-name builder