Catalyst Cloud documentation¶

Kia ora and a warm welcome to Catalyst Cloud!

Contents:

Getting started
- Introduction to the Cloud platform
- What services are on Catalyst Cloud?
- How can I interact with my project?
- The shared responsibility model
- Additional info and terminology
Launching your first instance
- Overview
- Using the web dashboard
- Using programmatic methods
- Windows instance using the web interface
Best practices
- Everyday considerations
- High availability
- Security
- Compute
- Network
- Block storage
- Object storage
CLI Tools and SDKs
- Linux or Mac OS CLI
- Windows CLI
- Software development kits (SDKs)
- Application programming interfaces (APIs)
Alarm
- Overview
- FAQ
- Tutorials
Audit Logs
- Audit Log creation and access
Backups
- Creating a backup
- Automating backup tasks with cron
Billing
- Billing API
- Credit card payment
- Separate billing
- FAQ
Block storage
- Volume Tiers
- Creating and using volumes
- Volumes using LVM
- Mounting a volume using a UUID
- Transferring a volume to another project
- Using Snapshots
- FAQ
- Best practices
Compute
- Quickstart
- Instance Types
- Launching an instance
- Using the Dashboard Console with a linux instance
- Resizing an instance
- Stopping an instance
- Cloning Instances
- GPU Support in Virtual Servers
- Using server affinity for HA
- FAQ
- Best practices
Dashboard
- Using the dashboard
- FAQ
Databases
- Database creation and access
- Managing your databases
- Working with backups
- Creating replicas
- Tuning your database
- Available database versions and extensions
Identity and Access Management
- Access control
- Multi factor authentication
- Application Credentials
- Best Practices for roles
- Additional management methods
Images
- Types of images
- Importing existing virtual machines
- Converting images
- Uploading images to Catalyst Cloud
- Launching an instance from a custom image
- Sharing images between projects
- Downloading from the cloud
- FAQ
Kubernetes
- Quick Start
- Clusters
- User Access
- Load Balancers
- Ingress
- Auto Scaling
- Cluster Upgrade
- Storage
- Application Credentials
- GPU Acceleration
- Versions
- Appendix
- Glossary
- Usage Tutorials
- Providing Feedback
Load balancer
- Overview
- Layer 4 load balancing
- Layer 7 load balancing
- Health monitor
- Connection draining
- Access control
- TLS Termination
Metrics
- Getting Started
- Overview
- Resource/Metric Reference
- FAQ
- Tutorials
Network
- Public networks
- DNS servers
- Adding a network
- Deleting a network
- Security groups
- Virtual private networks
- Creating a shared network
- FAQ
- Best practices
Object Storage
- Using Containers
- Advanced features
- Managing access
- Replication Policy
- Software Configuration
- FAQ
- Best practices
Orchestration
- Using heat via the command line tools
- HOT format
- Auto healing
- Auto-scaling
- FAQ
Tutorials
- Compute
- Container
- Image
- Kubernetes
- Metrics
- Network
- Orchestration
- Block Storage
- Other Tutorials
Release notes
- 24 October 2025
- 1 October 2025
- 14 July 2025
- 16 June 2025
- 09 May 2025
- 7 April 2025
- 05 February 2025
- 20 December 2024
- 24 September 2024
- 16 September 2024
- 26 August 2024
- 15 July 2024
- 27 May 2024
- 18 April 2024
- 18 March 2024
- 19 February 2024
- 23 February 2023
- 28 September 2022
- 29 August 2022
- 15 August 2022
- 21 February 2022
- 12 October 2021
- 30 August 2021
- 02 June 2021
- 04 May 2021
- 17 March 2021
- 11 February 2021
- 18 January 2021
- 30 November 2020
- 10 September 2020
- 1 July 2020
- 25 May 2020
- 9 April 2020
- 31 March 2020
- 24 March 2020
- 27 August 2019
- 25 July 2018
Contributing to the documentation
- Style guide
- Submitting a patch
- Git hooks

External resources¶

The Catalyst Cloud documentation is intended as a supplement to the documentation maintained by the OpenStack Foundation. It is meant to clarify details about Catalyst Cloud that may not be applicable OpenStack in general. The OpenStack Foundation documents can be found at https://docs.openstack.org/.

You can find more information about Catalyst Cloud, including prices and terms and conditions at https://catalystcloud.nz/.

You can sign up to Catalyst Cloud at https://catalystcloud.nz/signup/.

Catalyst Cloud documentation¶

External resources¶

Indices and tables¶