Skip to content

alloydb-create-cluster.md

Latest commit

 

History

History
60 lines (45 loc) · 2.89 KB

alloydb-create-cluster.md

File metadata and controls

60 lines (45 loc) · 2.89 KB
title alloydb-create-cluster
type docs
weight 1
description The "alloydb-create-cluster" tool creates a new AlloyDB for PostgreSQL cluster in a specified project and location.

About

The alloydb-create-cluster tool creates a new AlloyDB for PostgreSQL cluster in a specified project and location.

This tool provisions a cluster with a private IP address within the specified VPC network.

Permissions & APIs Required: Before using, ensure the following on your GCP project:

  1. The AlloyDB API is enabled.

  2. The user or service account executing the tool has one of the following IAM roles:

    • roles/alloydb.admin (the AlloyDB Admin predefined IAM role)
    • roles/owner (the Owner basic IAM role)
    • roles/editor (the Editor basic IAM role)

The tool takes the following input parameters:

Parameter Type Description Required
project string The GCP project ID where the cluster will be created. Yes
cluster string A unique identifier for the new AlloyDB cluster. Yes
password string A secure password for the initial user. Yes
location string The GCP location where the cluster will be created. Default: us-central1. If quota is exhausted then use other regions. No
network string The name of the VPC network to connect the cluster to. Default: default. No
user string The name for the initial superuser. Default: postgres. No

Compatible Sources

{{< compatible-sources >}}

Example

kind: tools
name: create_cluster
type: alloydb-create-cluster
source: alloydb-admin-source
description: Use this tool to create a new AlloyDB cluster in a given project and location.

Reference

field type required description
type string true Must be alloydb-create-cluster.
source string true The name of an alloydb-admin source.
description string false Description of the tool that is passed to the agent.