About this documentationThis guide walks you through installing and managing your vendor’s application in your environment. Throughout these pages, “we” and “us” refer to your software vendor, and “you” and “your” refer to you, the customer. These pages cover multiple deployment environments (e.g. AWS, Kubernetes, on-prem) - your vendor may customize or limit the options shown to match the environments they support.
How It Works
The installation flow has two parts, both guided by a web-based setup wizard: Part 1 - Set up your environment. You receive a setup link from us and open it in your browser. The setup wizard walks you through choosing your deployment environment, downloading infrastructure templates, and applying them in your own cloud account or cluster. This provisions the networking, permissions, and compute resources needed to run the application. The wizard tracks your progress and advances automatically as each step completes. Part 2 - Configure your deployment. Once the controller is running in your environment, the wizard moves to configuration. You configure DNS, select services, and create any required credentials. Sensitive data stays entirely within your infrastructure - it is never sent to our systems. After both parts are complete, we deploy the application into the environment you prepared. You don’t need to do anything for the deployment step - the controller running in your environment handles it automatically. Once deployed, you can manage your appliance through your Customer Portal, a web interface where you can monitor health, review and approve operations, view deployed infrastructure, and configure release windows.What You’ll Need
- A dedicated cloud account (AWS) or Kubernetes cluster
- Terraform installed on your workstation
- The setup link we provide
- Any credentials the application requires (API keys, tokens, etc.)