logo
logo
Overview
Guides
Tutorials
Reference

CloudStation Fields Reference

Quick Navigation

CategoryDescription
DeploymentNames, IDs, Git settings
ResourcesCPU, RAM, Replicas
NetworkPorts, Domains, Access
StorageVolumes, Paths
BuildCommands, Builder config
SecurityRegistry, Credentials

Field Reference Tables

Basic Configuration Fields

FieldTypeDefaultDescription
NamestringrequiredDeployment identifier
DescriptionstringoptionalPurpose description
Git BranchstringmainSource code branch
Service IDUUIDautoUnique service identifier

Resource Fields

FieldTypeRangeDescription
RAMGB0.5-64Memory allocation
CPU GHzGHz0.1-8Processing power
CPU MHzMHz100-8000Fine-grained CPU
Replicasnumber1-100Instance count

Network Configuration

FieldTypeOptionsNotes
Portnumber1-65535Application port
ProtocolenumTCP,HTTPSNetwork protocol
Public Accessbooleantrue/falseInternet exposure
Custom DomainstringoptionalCustom URL

Detailed Field Descriptions

Deployment Configuration

Job Name

  • Title: Job Name
  • Description: A unique identifier for scheduled or background tasks
  • Usage: Auto-generated, used for platform management and reference
  • Example: csi-bookingcom-main-qzkdvapzgww
  • Learn more: Job Configuration

Name

  • Title: Name
  • Description: This is the name of your deployment. It will be used to deploy your project.
  • Usage: Must be unique within your organization
  • Example: my-web-service
  • Learn more: Deployment Naming Conventions

Description

  • Title: Description
  • Description: You can add a description to your deployment.
  • Usage: Provide context about the deployment's purpose
  • Example: Production web service for customer portal

Git Branch

  • Title: Git Branch
  • Description: Changes made to this Git branch will be automatically pushed to this environment.
  • Example: main, production
  • Learn more: GitHub Auto-deploys

Resource Management

Replica

  • Title: Replica
  • Description: The number of instances that will be run for each deployment of this service.
  • Usage: Set number of service instances for scaling
  • Example: 3

RAM

  • Title: RAM (in GB)
  • Description: The amount of your deployment RAM capacity in Gigabyte.
  • Usage: Specify memory allocation
  • Example: 2

CPU

  • Title: CPU (in GHz)
  • Description: The amount of your deployment CPU capacity.
  • Usage: Define processing power
  • Example: 1.0

CPU MHz

  • Title: CPU (in MHz)
  • Description: The amount of your repo CPU capacity in MHz
  • Usage: Fine-grained CPU allocation
  • Example: 2000 (2000 MHz = 2 GHz)
  • Learn more: CPU Configuration

Execution Configuration

Execution Style

  • Title: Execution Style
  • Description: Defines how your application will be executed within the container
  • Options:
    • Standard: Normal container execution
    • Shell: Execute through shell
    • Binary: Direct binary execution
  • Learn more: Execution Styles

Service Type

  • Title: Service Type
  • Description: Specifies the type of service being deployed
  • Options:
    • Web Service
    • Worker
    • Scheduled Job
    • Database
  • Learn more: Service Types

Build & Runtime Settings

Build Command

  • Title: Build Command

  • Description: Command to override the default build process for your application.

  • Details:

  • Usage: Provide a custom command to build your application if the default build command does not meet your requirements.

  • Example:

  • For a Node.js application: npm run build
  • For a Python application: python setup.py build
  • Additional Information: This command will be executed during the build process. Ensure that all dependencies and environment variables are properly set up for the command to execute successfully.

Start Command

  • Title: Start Command
  • Description: Command that will be run to start new deployments.
  • Example: npm start
  • Learn more: Start Commands

Builder

  • Title: Builder
  • Description: Select the method for building your application container
  • Options:
    • Docker: Use Dockerfile-based builds
    • Nixpacks: Automatic build detection
    • Pack: Cloud Native Buildpacks
  • Usage: Choose based on your project's build requirements
  • Example: Select Docker when you have a custom Dockerfile
  • Learn more: Builder Options Guide

Root Directory

  • Title: Root Directory
  • Description: Directory that will be used for build and deployment steps
  • Usage: Specify the base directory for build and deployment operations
  • Type: String (path)
  • Default: / (project root)
  • Examples:
    • /: Root of repository
    • /apps/frontend: Monorepo frontend app
    • /services/api: Backend service directory
  • Best Practices:
    • Choose directories containing all necessary build files
    • Use consistent directory structure across projects
    • Consider monorepo organization if applicable
  • Additional Notes:
    • Builds skip if no changes in specified directory
    • Must include all build dependencies
    • Affects build caching and performance
  • Guidelines:
    • Organize files logically within the directory
    • Include all necessary configuration files
    • Maintain clear separation of concerns
  • Learn more: Build Configuration

Environment Configuration

Environment Variables

  • Title: Environment Variables
  • Description: Configuration values passed to your application at runtime
  • Usage: Define environment-specific configuration
  • Format: KEY=value pairs
  • Security: Values are encrypted at rest
  • Examples:
    • NODE_ENV=production
    • API_KEY=********
    • DATABASE_URL=postgres://...
  • Learn more: Environment Variables Guide

Networking

Public Networking

  • Title: Public Networking
  • Description: Expose this service to the public internet.
  • Usage: Toggle public access
  • Learn more: Network Configuration

Port Number

  • Title: Port
  • Description: The port number on which your application will be exposed
  • Usage: Specify the port your application listens on
  • Type: Number
  • Range: 1-65535
  • Examples:
    • 443: HTTPS web server
    • 3000: Node.js applications
    • 5432: PostgreSQL database
    • 6379: Redis server
  • Validation: Must be a valid port number
  • Additional Notes:
    • Ensure the port is available and not in use
    • Common ports may require additional permissions
    • Some ports are reserved for system use
  • Learn more: Port Configuration

Port Type

  • Title: Protocol
  • Description: The network protocol for handling traffic
  • Options:
    • TCP: Raw TCP connections
    • HTTPS: Secure web traffic
  • Usage: Select based on your application's communication needs
  • Examples:
    • TCP: Databases, message queues
    • HTTPS: Secure web services
  • Best Practices:
    • Use HTTPS for web applications
    • Use TCP for persistent connections
  • Additional Notes:
    • HTTPS requires SSL/TLS certificates
    • Some protocols may require specific configurations
    • Consider security implications when choosing protocols
  • Learn more: Protocol Types

Subdomain

  • Title: Subdomain
  • Description: Custom subdomain for accessing your application
  • Usage: Configure custom access URL
  • Example: api.myapp

Port Public

  • Title: Public
  • Description: Make port accessible from public internet
  • Type: Boolean
  • Default: false

Port Interval

  • Title: Interval
  • Description: Time between health check requests
  • Unit: Seconds
  • Default: 30

Volume Settings

Volume Size

  • Title: Volume (in GB)
  • Description: Manage your integration storage volume capacity
  • Usage: Specify persistent storage size
  • Example: 10
  • Learn more: Volume Management

Volume Settings

  • Title: Volume Settings
  • Description: Configure persistent storage options for your deployment
  • Related Fields:
    • Choose Volume Option
    • Select Volume to Attach
    • Custom Volume Name
    • Paths

Custom Volume Name

  • Title: Custom Volume Name
  • Description: Unique identifier for your persistent volume
  • Usage: Name your new volume for future reference
  • Example: app-data-vol

Paths

  • Title: Path(s)
  • Description: Filesystem paths for volume mounting
  • Usage: Specify where volumes should be mounted
  • Example: /data, /app/storage

Registry Settings

Registry Type

  • Title: Registry Type
  • Description: Select the registry where the build images will be stored in.
  • Usage: Choose between supported registry providers
  • Learn more: Container Registries

Private Registries Username

  • Title: Registry Username
  • Description: Username for authenticating with private container registry
  • Usage: Required for private registry access
  • Security: Stored securely, encrypted

Private Registries Password

  • Title: Registry Password
  • Description: Password for authenticating with private container registry
  • Usage: Required for private registry access
  • Security: Stored securely, encrypted

Registry Configuration

Registry Switch

  • Title: Set this container registry as the default
  • Description: Make this registry the default location for storing built images
  • Type: Boolean
  • Default: false

Push Registry

  • Title: Push to Registry
  • Description: Toggle to push builds to specified registry
  • Usage: Enable for custom registry usage
  • Notes: Using default registry incurs no extra cost

Pull from Registry

  • Title: Pull from Registry
  • Description: Toggle to pull builds from specified registry
  • Usage: Enable when using private registries
  • Related: Registry Username, Registry Password

Docker Configuration

Docker Image Name

  • Title: Docker Image Name
  • Description: The name of the Docker image for deployment
  • Format: [registry/]name[:tag]
  • Example: nginx:latest

Image Name

  • Title: Image Name
  • Description: Name of the container image for your application
  • Usage: Used for identifying your application image
  • Example: my-app

Tag

  • Title: Tag
  • Description: Version identifier for the container image
  • Usage: Specify image version or variant
  • Example: v1.0.0, latest

Repo Tag

  • Title: Tag
  • Description: Version identifier for repository integration
  • Usage: Specify which version to use from repository
  • Example: main, v2.1

Deploy Private Docker Image

  • Title: Deploy private Docker image
  • Description: Configure deployment using a private Docker image
  • Usage: Enable when using images from private registries
  • Related:
    • Registry Username
    • Registry Password
    • Registry Type
  • Learn more: Private Registry Guide

Image ID

  • Title: Image ID
  • Description: Unique identifier for the container image
  • Format: SHA256 hash
  • Example: sha256:a4d8...
  • Usage: Reference specific image versions

Build Context

Build Context

  • Title: Build Context
  • Description: Directory used for build and deployment steps
  • Usage: Specify the directory containing build files
  • Example: ./src
  • Notes: Affects build performance and caching

Cloud Provider Settings

Cloud Provider

  • Title: Cloud Provider
  • Description: Select your cloud provider for this deployment
  • Usage: Choose cloud infrastructure provider

Region Selection

  • Title: Region Selection
  • Description: Select your region choice for this deployment.
  • Usage: Choose deployment location

Health Checks

Health Check Path

  • Title: Path
  • Description: Endpoint to be called before a deploy completes to ensure the new deployment is live.
  • Example: /health
  • Learn more: Health Check Configuration

Health Check Timeout

  • Title: Timeout
  • Description: Number of seconds we will wait for the health check to complete.
  • Example: 30

Health Check Configuration

Health Check Port

  • Title: HC Port
  • Description: Port used for health check requests
  • Type: Number
  • Range: 1-65535
  • Example: 8080
  • Notes: Must be accessible within container

Lifecycle Management

Restart Attempts

  • Title: Restart Attempts
  • Description: The number of times to attempt restarting the service if it fails
  • Usage: Specify maximum restart attempts for failed services
  • Type: Number
  • Default: 3
  • Example: Set to 3 to attempt three restarts before giving up
  • Best Practices:
    • Use lower values for development environments
    • Set higher values for critical production services
    • Consider logging/monitoring alongside restarts
  • Additional Notes:
    • Prevents infinite restart loops
    • Helps conserve resources
    • Useful for debugging issues

Automatic Build

  • Title: Automatic Build
  • Description: Enable or disable automatic builds on code changes.
  • Usage: Configure CI/CD automation

Keep Running

  • Title: Keep Running
  • Description: Activate to keep the application running continuously.
  • Usage: Control application lifecycle

GPU Resources

GPU

  • Title: GPU
  • Description: GPU capacity allocation for deployment
  • Usage: Specify GPU resource requirements
  • Example: 1

GPU Model

  • Title: GPU Model
  • Description: Specific GPU model selection
  • Options: Available GPU models in your region
  • Usage: Select appropriate GPU for workload

Service Configuration

Service ID

  • Title: Service ID
  • Description: Unique identifier for your service deployment
  • Format: Auto-generated UUID
  • Usage: Reference for API calls and logging

Source Repo

  • Title: Source Repo
  • Description: Git repository containing application source code
  • Format: owner/repo
  • Example: organization/project-name

Additional Settings

Credit To Purchase

  • Title: Credit to purchase
  • Description: Amount of credits to add to account
  • Usage: Specify credit purchase amount
  • Unit: Credits

Deployment Controls

Don't Deploy

  • Title: Enable Deployment
  • Description: Toggle to control deployment execution
  • Usage: Control whether builds are deployed
  • Options:
    • On: Deploy after build
    • Off: Store build without deploying
  • Learn more: Deployment Control

Scheduling

Schedule Settings

  • Title: Scheduled Program
  • Description: Configure recurring application schedules
  • Usage: Set up automated execution schedules
  • Format: Cron expression
  • Example: 0 0 * * * (daily at midnight)

Custom Domain Configuration

Custom Domain

  • Title: Custom Domain
  • Description: Access your application with custom domains
  • Usage: Configure custom domain routing
  • Example: api.yourdomain.com
  • Notes: Requires DNS configuration

Field Validation

Many fields include built-in validation to ensure proper values:

  • Name fields: Allow alphanumeric characters, hyphens, and dots
  • Resource allocations: Must be within allowed ranges
  • Ports: Must be valid port numbers (0-65535)

Best Practices

  1. Naming Conventions

    • Use lowercase letters
    • Separate words with hyphens
    • Be descriptive but concise

  2. Resource Allocation

    • Start with recommended defaults
    • Monitor usage before scaling
    • Consider cost implications

  3. Security

    • Use private networking when possible
    • Implement health checks
    • Configure proper restart policies

Related Resources

For more detailed information about specific fields, visit the documentation links provided in the UI.

Additional Resources

Prev
Variables
Next
Volumes
Edit this file on GitHub