Catalyst Cloud API client

This is a package for installing the API clients and all necessary plugins for interacting with Catalyst Cloud.

Catalyst Cloud is an OpenStack-based public cloud based in New Zealand, with multiple regions available. We provide a range of different services for our customers, and have created this package to make it easier for customers to create a CLI environment from which they can interact with our cloud.

Note that this library is not required to interact with Catalyst Cloud APIs. The individual client libraries can be installed and used separately from this package; for more information refer to Available Commands.

Installation

The Catalyst Cloud API client supports Python 3.8 and later, and supports most systems running on Linux, macOS and Windows.

pip

The Catalyst Cloud API client can be installed directly using pip.

python -m pip install catalystcloud-client

This exposes the commands used to interact with Catalyst Cloud in the running Python environment.

Installing via pip is the recommended method for installing the package in a container image build, which can be used to, for example, create isolated command line environments or CI/CD pipelines using Catalyst Cloud.

When installing using pip it is highly recommended to install the API client into a virtual environment. This ensures that there are no conflicts with packages installed into the Python environment managed by your operating system.

pipx

For installing the Catalyst Cloud API client on a desktop machine for interactive use, an alternative installation method which may be easier is to use pipx.

pipx install catalystcloud-client --include-deps

This makes the openstack command available to run in your user environment, while installing the catalystcloud-client package into an isolated virtual environment to avoid conflicts.

Note that the --include-deps option is required to expose the commands used to interact with Catalyst Cloud so they can be executed by your user.

Once installed, run the following command to check that the installation was successful:

openstack --help

pipx also makes it easy to update the client and dependent packages using pipx upgrade.

pipx upgrade catalystcloud-client

Usage

For more information on how to interact with Catalyst Cloud from a command line environment, please refer to CLI Tools and SDKs in the Catalyst Cloud documentation.

Available Commands

Installing the Catalyst Cloud API client makes the following commands available:

• openstack - The OpenStack API client. Used for most tasks via sub-commands. Provided by the python-openstackclient package.
• swift - The Swift API client. An alternative command for interacting with the Catalyst Cloud Object Storage service using the Swift API. Provided by the python-swiftclient package.

Using the openstack command, the following services can be managed:

Service	Resource Type	Sub-command	API Client Library
Identity	Projects	openstack project	python-keystoneclient
Identity	Users	openstack user	python-keystoneclient
Identity	EC2 Credentials	openstack ec2 credentials	python-keystoneclient
Identity	Application Credentials	openstack application credential	python-keystoneclient
Compute	Instances / Servers	openstack server	python-novaclient
Compute	Keypairs	openstack keypair	python-novaclient
Networking	Networks	openstack network	python-neutronclient
Networking	Routers	openstack router	python-neutronclient
Networking	Floating IPs	openstack floating ip	python-neutronclient
Networking	Security Groups	openstack security group	python-neutronclient
Networking	VPNs	openstack vpn	python-neutronclient
Load Balancer	Load Balancers	openstack loadbalancer	python-octaviaclient
Block Storage	Volumes	openstack volume	python-cinderclient
Image	Images	openstack image	python-glanceclient
Database	Databases	openstack database	python-troveclient
Orchestration	Stacks	openstack stack	python-heatclient
Kubernetes	Clusters	openstack coe cluster	python-magnumclient
Kubernetes	Node Groups	openstack coe nodegroup	python-magnumclient
Object Storage	Containers	openstack container	python-swiftclient
Object Storage	Objects	openstack object	python-swiftclient
Object Storage	Accounts	openstack object store account	python-swiftclient
Secret Management	Secrets	openstack secret	python-barbicanclient
Telemetry	Metrics	openstack metric	gnocchiclient
Telemetry	Alarms	openstack alarm	aodhclient
Billing	Invoices	openstack rating invoice	python-distilclient
Billing	Quotations	openstack rating quotation	python-distilclient
Billing	Products	openstack rating product	python-distilclient
Administration	Project Users	openstack project user	python-adjutantclient
Administration	Project Quotas	openstack project quota	python-adjutantclient
Administration	Manageable Roles	openstack manageable roles	python-adjutantclient
Administration	Passwords	openstack password	python-adjutantclient

For more information on using these services, please refer to the Catalyst Cloud documentation.