GCP Provider
Manage Google Cloud Platform resources declaratively through the Pragmatiks platform. This provider uses user-provided service account credentials (multi-tenant SaaS pattern) to create and manage GCP infrastructure.
Supported Services
| Service | Resource | Description |
|---|---|---|
| Secret Manager | gcp/secret |
Store and version sensitive data |
| GKE | gcp/gke |
Kubernetes clusters (Autopilot and Standard) |
| Cloud SQL | gcp/cloudsql/database_instance |
Managed database instances (PostgreSQL, MySQL, SQL Server) |
| Cloud SQL | gcp/cloudsql/database |
Databases within a Cloud SQL instance |
| Cloud SQL | gcp/cloudsql/user |
Database users within a Cloud SQL instance |
Prerequisites
- GCP Project with billing enabled.
- Service account with appropriate IAM roles per resource:
- Secret Manager:
roles/secretmanager.admin - GKE:
roles/container.admin - Cloud SQL:
roles/cloudsql.admin
- Secret Manager:
- GCP APIs enabled on the project:
secretmanager.googleapis.comcontainer.googleapis.comsqladmin.googleapis.comlogging.googleapis.com(for health checks and log streaming)
- Service account key exported as JSON (passed via
credentialsfield on each resource).
Installation
pragma providers install gcp
Resources
Secret (gcp/secret)
Manages secrets in GCP Secret Manager. Creates versioned secrets with automatic replication.
Config fields:
| Field | Type | Required | Mutable | Description |
|---|---|---|---|---|
project_id |
string | yes | no | GCP project ID |
secret_id |
string | yes | no | Secret identifier (unique per project) |
data |
string | yes | yes | Secret payload to store |
credentials |
object/string | yes | yes | GCP service account credentials JSON |
Outputs: resource_name, version_name, version_id (version_name and version_id are null when the secret has no enabled version)
Example:
resources:
- name: api-key
provider: gcp
type: secret
config:
project_id: my-gcp-project
secret_id: api-key
data: "sk-my-secret-value"
credentials:
$ref: gcp-credentials
Behavior:
- Create: Creates the secret and an initial version. Idempotent -- if the secret already exists, adds a new version.
- Observe: Reads the secret and its latest enabled version.
- Update: Adds a new secret version when
datadiffers from the latest enabled version. Previous versions are retained. - Delete: Deletes the secret and all its versions.
GKE Cluster (gcp/gke)
Manages GKE clusters in either Autopilot (default) or Standard mode. Includes health checks and log streaming from Cloud Logging.
Config fields:
| Field | Type | Required | Mutable | Default | Description |
|---|---|---|---|---|---|
project_id |
string | yes | no | -- | GCP project ID |
credentials |
object/string | yes | yes | -- | GCP service account credentials JSON |
location |
string | yes | no | -- | Region or zone (e.g., europe-west4) |
name |
string | yes | no | -- | Cluster name (lowercase, 1-40 chars) |
autopilot |
bool | no | no | true |
Use Autopilot mode |
network |
string | no | no | "default" |
VPC network name |
subnetwork |
string | no | no | -- | VPC subnetwork name |
release_channel |
string | no | yes | "REGULAR" |
Release channel: RAPID, REGULAR, STABLE |
initial_node_count |
int | no | no | 1 |
Nodes in default pool (Standard only) |
machine_type |
string | no | no | "e2-medium" |
Node machine type (Standard only) |
disk_size_gb |
int | no | no | 100 |
Boot disk size in GB (Standard only) |
Outputs: name, endpoint, cluster_ca_certificate, location, console_url, logs_url
Example (Autopilot):
resources:
- name: prod-cluster
provider: gcp
type: gke
config:
project_id: my-gcp-project
location: europe-west4
name: prod-cluster
autopilot: true
release_channel: STABLE
credentials:
$ref: gcp-credentials
Example (Standard):
resources:
- name: dev-cluster
provider: gcp
type: gke
config:
project_id: my-gcp-project
location: europe-west4-a
name: dev-cluster
autopilot: false
initial_node_count: 3
machine_type: e2-standard-4
disk_size_gb: 200
credentials:
$ref: gcp-credentials
Behavior:
- Create: Creates the cluster and polls until it serves, in RUNNING or DEGRADED state (up to 19 minutes). Idempotent -- if the cluster already exists, waits for it to serve.
- Observe: Reads the cluster by project, location and name.
- Update: Waits for the cluster's pending operations; when the live channel differs, moves the cluster to the configured
release_channeland waits for the update. Either way, waits for the cluster to serve, in RUNNING or DEGRADED state.credentialsis mutable too; every other field is immutable and requires delete and recreate. - Delete: Deletes the cluster and polls until fully removed.
- Health: Reports
healthy(RUNNING),degraded(DEGRADED/PROVISIONING/RECONCILING), orunhealthy(ERROR/not found). - Logs: Streams cluster logs from Cloud Logging.
Cloud SQL Database Instance (gcp/cloudsql/database_instance)
Manages Cloud SQL instances for PostgreSQL, MySQL, and SQL Server. Supports configurable tiers, high availability, backups, and network access. Includes health checks and log streaming.
Config fields:
| Field | Type | Required | Mutable | Default | Description |
|---|---|---|---|---|---|
project_id |
string | yes | no | -- | GCP project ID |
credentials |
object/string | yes | yes | -- | GCP service account credentials JSON |
region |
string | yes | no | -- | GCP region (e.g., europe-west4) |
instance_name |
string | yes | no | -- | Instance name (unique per project, 1-98 chars) |
database_version |
string | no | no | "POSTGRES_15" |
Engine version (e.g., POSTGRES_15, MYSQL_8_0) |
tier |
string | no | yes | "db-f1-micro" |
Machine tier (e.g., db-custom-1-3840) |
availability_type |
string | no | yes | "ZONAL" |
ZONAL or REGIONAL (high availability) |
backup_enabled |
bool | no | yes | true |
Enable automatic backups |
deletion_protection |
bool | no | yes | false |
Prevent accidental deletion |
authorized_networks |
list[string] | no | yes | [] |
CIDR ranges allowed to connect |
enable_public_ip |
bool | no | yes | true |
Assign a public IP address |
Outputs: connection_name, public_ip, private_ip, console_url, logs_url
Example:
resources:
- name: prod-db-instance
provider: gcp
type: cloudsql/database_instance
config:
project_id: my-gcp-project
region: europe-west4
instance_name: prod-postgres
database_version: POSTGRES_15
tier: db-custom-2-7680
availability_type: REGIONAL
backup_enabled: true
deletion_protection: true
authorized_networks:
- "10.0.0.0/8"
credentials:
$ref: gcp-credentials
Behavior:
- Create: Creates the instance and polls until RUNNABLE (up to 19 minutes). Generates a random root password. Idempotent.
- Observe: Reads the instance by project and instance name.
- Update: Patches mutable settings (tier, availability, backups, network config), waits for the patch operation, then for RUNNABLE.
- Delete: Deletes the instance. Respects
deletion_protection-- disable it first to allow deletion. - Health: Reports
healthy(RUNNABLE),degraded(PENDING_CREATE/MAINTENANCE), orunhealthy. - Logs: Streams instance logs from Cloud Logging.
Cloud SQL Database (gcp/cloudsql/database)
Creates a database within a Cloud SQL instance. Requires a dependency on a gcp/cloudsql/database_instance resource.
Config fields:
| Field | Type | Required | Mutable | Description |
|---|---|---|---|---|
instance |
Dependency | yes | no | Reference to a cloudsql/database_instance resource |
database_name |
string | yes | no | Name of the database to create |
Outputs: database_name, instance_name, host, port, url
Example:
resources:
- name: prod-db-instance
provider: gcp
type: cloudsql/database_instance
config:
project_id: my-gcp-project
region: europe-west4
instance_name: prod-postgres
credentials:
$ref: gcp-credentials
- name: app-database
provider: gcp
type: cloudsql/database
config:
instance:
$ref: prod-db-instance
database_name: myapp
Behavior:
- Create: Creates the database in the target instance and waits for the operation. Idempotent.
- Observe: Reads the database by
database_name. - Update: Returns current database state. Every field is immutable.
- Delete: Drops the database from the instance and waits for the operation.
- Outputs include a connection URL in the format
postgresql://host:port/database_name.
Cloud SQL User (gcp/cloudsql/user)
Creates a database user within a Cloud SQL instance. Requires a dependency on a gcp/cloudsql/database_instance resource.
Config fields:
| Field | Type | Required | Mutable | Description |
|---|---|---|---|---|
instance |
Dependency | yes | no | Reference to a cloudsql/database_instance resource |
username |
string | yes | no | Database username |
password |
string | yes | yes | Database password |
Outputs: username, instance_name, host
Example:
resources:
- name: prod-db-instance
provider: gcp
type: cloudsql/database_instance
config:
project_id: my-gcp-project
region: europe-west4
instance_name: prod-postgres
credentials:
$ref: gcp-credentials
- name: app-user
provider: gcp
type: cloudsql/user
config:
instance:
$ref: prod-db-instance
username: app_service
password:
$ref: db-password-secret
Behavior:
- Create: Creates the user in the target instance and waits for the operation. Idempotent.
- Observe: Reads the user by
username. - Update: Password changes are applied in place and waited on.
- Delete: Drops the user from the instance and waits for the operation.
Full Stack Example
A complete Cloud SQL setup with instance, database, user, and credentials stored in Secret Manager:
resources:
- name: db-password
provider: gcp
type: secret
config:
project_id: my-gcp-project
secret_id: db-password
data: "my-secure-password"
credentials:
$ref: gcp-credentials
- name: prod-instance
provider: gcp
type: cloudsql/database_instance
config:
project_id: my-gcp-project
region: europe-west4
instance_name: prod-postgres
database_version: POSTGRES_15
tier: db-custom-2-7680
availability_type: REGIONAL
backup_enabled: true
credentials:
$ref: gcp-credentials
- name: app-db
provider: gcp
type: cloudsql/database
config:
instance:
$ref: prod-instance
database_name: myapp
- name: app-user
provider: gcp
type: cloudsql/user
config:
instance:
$ref: prod-instance
username: app_service
password: "my-secure-password"
Credentials
All resources require a credentials field containing GCP service account credentials as either a JSON object or a JSON string. In production, use a $ref to a secret resource to inject credentials securely.
The provider uses explicit credentials (not Application Default Credentials) to support multi-tenant deployments where each user operates in their own GCP project.
Development
# Lint and type check
task gcp:check
# Format
task gcp:format
Metadata
Release files for pragmatiks-gcp-provider 7.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pragmatiks_gcp_provider-7.2.0.tar.gz | 21.4 kB | Without provenance | Details for pragmatiks_gcp_provider-7.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pragmatiks_gcp_provider-7.2.0-py3-none-any.whl | Python 3 | none | any | Details for pragmatiks_gcp_provider-7.2.0-py3-none-any.whl |
Total release size: 50.5 kB
Release files / pragmatiks_gcp_provider-7.2.0.tar.gz
| Download URL | pragmatiks_gcp_provider-7.2.0.tar.gz |
|---|---|
| Size | 21.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bb650d9ec88b28254c0c60e9aa2f2ccce784d74d8acbac7021538eb518ec5a8f
|
|
BLAKE2b-256 checksum How to use checksums |
37a0f05f78fb5709389dea03ac671d04545471441faadcf8cd0b898af30ef2db
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pragmatiks_gcp_provider-7.2.0-py3-none-any.whl
| Download URL | pragmatiks_gcp_provider-7.2.0-py3-none-any.whl |
|---|---|
| Size | 29.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
40b23eedf38fd45a61419236e48e92d2ba87c58e940b7998a88937014f69ed85
|
|
BLAKE2b-256 checksum How to use checksums |
1852f8ca5de6e9f7027708e0c3651077c7efcc7d1e771cec39a204235f67425a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Security for pragmatiks-gcp-provider 7.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.