Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Database

Generated by iac-coolify docs gen from the struct tags in internal/resource. Do not edit by hand.

This is the reference for the Database resource and its nested types. Each field below maps 1:1 to a YAML key.

Database

api_version

API schema version (must be iac-coolify/v1).

  • Required.

kind

Resource kind (must be Database).

  • Required.
  • Allowed values: Database.

metadata

Identifying metadata.

  • Required.

spec

Desired database state.

  • Required.

DatabaseMeta

name

Logical name used as the immutable key.

  • Required.

project

Logical project name (referenced by name).

  • Required.

environment

Environment name such as staging or production.

  • Required.

DatabaseSpec

description

Human-readable database description.

engine

Database engine.

  • Required.
  • Allowed values: postgresql, mysql, mariadb, mongodb, redis, keydb, dragonfly, clickhouse.

version

Engine version used as the image tag such as 16.

image

Custom Docker image overriding the default engine image.

destination

Server and network reference.

  • Required.

public

Whether the database is exposed on a public port.

public_port

Public port (required when public is true).

limits

CPU and memory limits.

password

Database password; MUST be ${env:NAME} or ${sops:path} and is shown as [REDACTED].