Configuration
This guide covers all configuration options available when creating and managing PostgreSQL clusters on Orbit. Understanding these settings helps you optimize your database's performance, resource usage, and availability to match your specific requirements.
General Settings
Display Label: The human-readable name shown throughout the Viduli console interface. This can be updated at any time to reflect changes in your database's purpose or project context.
Resource Name: A unique identifier for your PostgreSQL cluster within the project. Once created, this name cannot be changed as it's used internally for resource management and networking. Choose a descriptive name that clearly identifies your database's function.
Database Configuration
Engine: The database engine type, which is PostgreSQL for this resource. This setting is read-only and cannot be modified after cluster creation.
Version: The PostgreSQL engine version deployed for your cluster. This setting is read-only and is determined during cluster creation based on the latest available stable version.
Compute Resources
All compute resources are dedicated allocations, ensuring consistent performance and predictable resource availability for your database operations.
CPU Allocation: The amount of CPU resources allocated to your database cluster. CPU can be allocated in fractional units called millicpu, where 1000 millicpu equals 1 full vCPU core. Higher CPU allocations provide better performance for compute-intensive queries and concurrent operations.
Memory Allocation: The amount of RAM allocated to your database cluster. Memory is specified in megabytes with allocations ranging from the minimum required based on your CPU selection up to the maximum supported limit. Adequate memory allocation is crucial for database performance, caching, and handling concurrent connections.
Disk Storage: The amount of disk space (in GB) allocated for your database storage. This includes space for your data, indexes, transaction logs, and temporary files. Storage can be configured from the minimum required size up to the platform maximum, and can be expanded later if needed.
Resource Optimization: Database performance is highly dependent on proper resource allocation. Consider your workload characteristics - analytical queries benefit from more CPU and memory, while transactional workloads may require faster storage and balanced resources.
Scaling Configuration
Deployment Region: The geographic region where your PostgreSQL cluster is deployed. This setting is read-only after cluster creation and affects latency for your applications and data residency requirements.
Replication Type: The replication configuration for your database cluster. This setting is read-only and determines how data is replicated across instances for high availability and read scaling.
Replicas: Define the total number of database instances in your cluster. At least one replica is required as the primary instance. Additional replicas are created as read replicas, which can serve read-only queries to distribute load and improve performance for read-heavy workloads.
Read Replica Benefits: Additional read replicas improve query performance by distributing read traffic across multiple instances while maintaining data consistency. Consider your read-to-write ratio when determining the optimal number of replicas.
Backup Configuration
Retention Period: The number of days that automated backups are retained. This setting determines how far back in time you can perform point-in-time recovery operations. Backup retention is configured automatically to 7 days during the beta period and cannot be modified directly.