Deployment Instances¶

What are Deployment Instances?¶

Deployment instances are running instances of your SaaS product that have been provisioned for your customers.

Key characteristics of deployment instances:

• Tenant-specific deployments: Each instance serves specific tenant and their data
• Resource allocation: Instances have dedicated compute, storage, and networking resources
• Lifecycle management: Instances can be started, stopped, scaled, updated, and deleted
• Environment isolation: Instances are deployed within specific environments (Dev, Staging, Production)
• Plan-based configuration: Each instance is created based on a specific plan that defines its resources and capabilities

Deployment instances are the core operational units of your SaaS product - they represent the actual running services that your customers interact with.

Managing Deployment Instances¶

You can manage deployment instances through multiple interfaces:

• Customer Portal: Self-serve Customer Portal for customer to manage their deployment instances
• Operations Console UI: The Deployment Instances page provides a visual interface for monitoring and managing your customer instances
• CLI: Command-line tools allow for programmatic management and automation
• API: RESTful APIs enable integration with your own tools and workflows

Manual Operations¶

You can perform various manual operations on deployment instances through both the web interface and CLI/API:

Stopping Instances¶

You can manually stop running deployment instances when needed for maintenance, troubleshooting, or resource management. This operation gracefully shuts down the instance while preserving its configuration.

Deleting Instances¶

When instances are no longer needed, you can permanently delete them to free up resources and clean up your deployment inventory. This operation removes the instance and its associated resources.

Restarting Instances¶

Restart instances to apply updates or resolve issues. This operation provides a clean restart of the instance while maintaining its configuration and data.

Scaling Instances¶

Adjust resource allocation based on demand. This allows you to increase or decrease compute, memory, and storage resources as needed.

Updating Configurations¶

Modify instance settings without full redeployment. This enables you to change configuration parameters while keeping the instance running.

All these operations can be performed through the web interface for manual management or via CLI/API for automated workflows. These operations can be also enabled in the Customer Portal to allow your customers to perform these actions.

Changing Network Type¶

You can change the network type of a running deployment instance between public and private endpoints. This allows you to adjust network accessibility after deployment without recreating the instance.

When to change network type¶

Common scenarios for changing network type include:

• Moving to private: Transitioning from a public endpoint to a private one for improved security, compliance requirements, or when customers establish VPC peering or PrivateLink connectivity.
• Moving to public: Temporarily exposing an instance publicly for debugging, onboarding, or when private connectivity is not yet configured.

How to change network type¶

To change the network type of a deployment instance:

1. Navigate to the deployment instance in the Operations Console.
2. Select Update on the instance.
3. Change the Network Type parameter from public to private (or vice versa).
4. Confirm the operation.

The network type change runs as a workflow, so you can track its progress and troubleshoot any issues.