Install Self-Deployed runtime
Use Self-deployed runtime approach when the Cloud SQL Postgresql database can't be accessed directly from Atlan Cloud. This service runs within your network perimeter and establishes secure outbound connections to Atlan, enabling metadata extraction without exposing your database to the Internet. For more details on connection architecture and security considerations, see How Atlan connects to Cloud SQL Postgresql.
Prerequisites
Before you begin, make sure you have:
- Understanding of Self-Deployed Runtime architecture and deployment options
- Configured network security. For detailed network configuration steps, see Configure network security.
System requirements
Cloud SQL Postgresql App deployment requires specific hardware and operating system specifications to reliably connect to your Cloud SQL Postgresql database and extract metadata.
- Hardware:
- Instance type: t2.xlarge or equivalent
- vCPUs: 4 minimum
- RAM: 16 GB minimum
- Disk space: 80 GB available
- Supported Architectures:
Atlan provides full multi-architecture support so the Apps runs seamlessly across modern environments.
- amd64 (x86_64)
- Standard Intel/AMD 64-bit processors
- Works on most servers, cloud VMs, and developer machines
- arm64 (AArch64)
- Optimised for AWS Graviton, Apple Silicon (M1/M2/M3), and ARM servers
- Great performance-per-watt and lower cloud cost
- amd64 (x86_64)
Deploy runtime
Choose the deployment platform and perform corresponding steps
- Kubernetes
- Docker Compose
-
Note the below placeholder values to deploy Cloud SQL Postgresql app:
- Helm chart name -
{app-helm-chart}→cloudsql-postgres-app - Required only in case of using a Private Image Repository:
- Image name -
{app-image-name}→atlan-cloudsql-postgres-app - Image tag -
{app-image-tag}→latest
- Image name -
- Helm chart name -
-
Follow the Kubernetes deployment guide, substituting Cloud SQL Postgresql values provided in the step 1.
-
Note the below placeholder values to deploy Cloud SQL Postgresql app:
- Helm chart name -
{app-package-name}→cloudsql-postgres-app - Required only in case of using a Private Image Repository:
- Image name -
{app-image-name}→atlan-cloudsql-postgres-app - Image tag -
{app-image-tag}→latest
- Image name -
- Helm chart name -
-
Follow the Docker Compose deployment guide, substituting Cloud SQL Postgresql values provided in the step 1.
Next steps
- Crawl Cloud SQL Postgres: Configure and run Cloud SQL Postgres metadata extraction using Agent mode