Docker PostgreSQL Service

Terraform module which deploys PostgreSQL service on Docker. Powered by Bitnami PostgreSQL Docker Image.

• Support standalone(one read-write instance) and replication(one read-write instance and multiple read-only instances, for read write splitting) architecture.
• Support seeding database at first-time creating.

Usage

module "example" {
  source = "..."

  infrastructure = {
    network_id = "..."
  }

  architecture = "replication"

  engine_version = "15.0"
}

Examples

• Standalone
• Replication

Contributing

Please read our contributing guide if you're interested in contributing to Walrus template.

Requirements

Name	Version
terraform	>= 1.0
docker	>= 3.0.2

Providers

Name	Version
docker	>= 3.0.2

Modules

Name	Source	Version
master	github.com/walrus-catalog/terraform-docker-containerservice	v0.2.1&depth=1
slave	github.com/walrus-catalog/terraform-docker-containerservice	v0.2.1&depth=1

Resources

Name	Type
docker_network.network	data source

Inputs

Name	Description	Type	Default	Required
architecture	Specify the deployment architecture, select from standalone or replication.	string	"standalone"	no
context	Receive contextual information. When Walrus deploys, Walrus will inject specific contextual information into this field. Examples: context: project: name: string id: string environment: name: string id: string resource: name: string id: string	map(any)	{}	no
database	Specify the database name. The database name must be 2-64 characters long and start with any lower letter, combined with number, or symbols: - _. The database name cannot be PostgreSQL forbidden keyword.	string	"mydb"	no
engine_version	Specify the deployment engine version, select from https://hub.docker.com/r/bitnami/postgresql/tags.	string	"16.0"	no
infrastructure	Specify the infrastructure information for deploying. Examples: infrastructure: network_id: string, optional domain_suffix: string, optional	object({ network_id = optional(string, "local-walrus") domain_suffix = optional(string, "cluster.local") })	{ "domain_suffix": "cluster.local", "network_id": "local-walrus" }	no
password	Specify the account password. The password must be 8-32 characters long and start with any letter, number, or symbols: ! # $ % ^ & * ( ) _ + - =. If not specified, it will use the first 16 characters of the username md5 hash value.	string	null	no
replication_readonly_replicas	Specify the number of read-only replicas under the replication deployment.	number	1	no
resources	Specify the computing resources. Examples: resources: cpu: number, optional memory: number, optional # in megabyte	object({ cpu = optional(number, 0.25) memory = optional(number, 1024) })	{ "cpu": 0.25, "memory": 1024 }	no
seeding	Specify the configuration to seed the database at first-time creating. Seeding increases the startup time waiting and also needs proper permission, like root account. Examples: seeding: type: none/url/text url: location: string text: content: string	object({ type = optional(string, "none") url = optional(object({ location = string })) text = optional(object({ content = string })) })	{}	no
username	Specify the account username. The username must be 2-16 characters long and start with lower letter, combined with number, or symbol: _. The username cannot be PostgreSQL forbidden keyword and root. See https://www.alibabacloud.com/help/en/rds/developer-reference/api-rds-2014-08-15-createaccount.	string	"rdsuser"	no

Outputs

Name	Description
address	The address, a string only has host, might be a comma separated string or a single string.
address_readonly	The readonly address, a string only has host, might be a comma separated string or a single string.
connection	The connection, a string combined host and port, might be a comma separated string or a single string.
connection_readonly	The readonly connection, a string combined host and port, might be a comma separated string or a single string.
context	The input context, a map, which is used for orchestration.
database	The name of PostgreSQL database to access.
password	The password of the account to access the database.
port	The port of the PostgreSQL service.
refer	The refer, a map, including hosts, ports and account, which is used for dependencies or collaborations.
username	The username of the account to access the database.

License

Copyright (c) 2023 Seal, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at LICENSE file for details.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.