このページは機械翻訳されています。英語の原文を読む。

Component

core/datastore/postgres

A PostgreSQL relational database. Provider-agnostic: the same component is implemented by Compose Recipes (local development), Helm Recipes (Kubernetes), Terraform Recipes (AWS RDS, Google Cloud SQL, Azure), and CloudFormation Recipes, and by a reference Recipe that provisions nothing and only wires a consumer to a server that already exists. Reach for the synthesis Recipe on a cluster that runs no PostgreSQL control plane: it needs no controller installed and no chart repository, so it builds with nothing fetched. Reach for the controller-driven Recipe, which emits a CloudNativePG Cluster custom resource, where that control plane is already in place and the cluster should own failover, rolling upgrades and the database's credentials. Reach for the reference Recipe where the server already exists outside the deployment and nothing is to be provisioned. On AWS RDS through Terraform, reach for terraform/postgres-rds-terraform-aws-modules, which vendors the terraform-aws-modules project's published RDS module, where the pull may fetch it from its git repository, and for terraform/postgres-rds, which authors its own body, where nothing may be fetched or read replicas are needed. On Google Cloud SQL, reach for terraform/postgres-cloud-sql, where the database runs in a Google Cloud project whose VPC network has private services access to Cloud SQL. On Azure, reach for terraform/postgres-flexible-server, a flexible server in a delegated subnet of the operator's virtual network. Backup is the core/backup attachment: the managed Recipes set the service's automated backups from it, 7 days with none attached; on Kubernetes the backup product the Manifest binds realizes it; Compose halts on one.

来歴

公式このカタログが公式の公開者として認めている署名 ID によって署名されています。
コンテンツダイジェスト
sha256:e6d60d3c6be10826891493b0d073f3f75b84929f44b92db2bc6356adc57b5828
公開日
2026-11-10T10:11:07Z
署名 ID
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

署名

  • 公式application/vnd.dev.sigstore.bundle.v0.3+json

    https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

    sha256:20a03ea1db4c1fc0ff91c24e088ecd48ae033c1f9c4c419f9f62871c377d05e1

このバージョンの参照

oci://hub.aggrega.ai/component/core/datastore/postgres:1.0.0

開発者パラメーター

開発者が Aggregate で設定する値です。

名前型デフォルト必須説明
databasestringappdbいいえLogical database name created on startup (POSTGRES_DB).
userstringappuserいいえBootstrap superuser role created on startup (POSTGRES_USER), owner of the initial database. For an additional non-superuser application role, see app_user.
app_userstringappいいえName of an optional non-superuser application login role. The role is created only when an application-user credential is attached to the app_user_password slot (helm target only); the bootstrap superuser is named by `user`. Attaching that credential and setting this to an empty string asks for a role it has not named, and the build halts rather than emitting an unnamed role.
encodingstring—いいえDatabase encoding passed to initdb (e.g. UTF8). Omit to use the image default. terraform/postgres-cloud-sql accepts UTF8 alone, the one encoding Cloud SQL creates a database with, and halts on any other. terraform/postgres-flexible-server creates the database with it as its charset.
localestring—いいえDatabase locale passed to initdb (e.g. en_US.utf8). Omit to use the image default. terraform/postgres-cloud-sql accepts en_US.UTF8 alone, the one collation Cloud SQL creates a database with, and halts on any other. terraform/postgres-flexible-server creates the database with it as its collation.
init_scriptsobject—いいえSQL or shell scripts executed on first database initialization from /docker-entrypoint-initdb.d. Each key is a filename, each value is the file content. Scripts run once, when the data directory is empty, in alphabetical key order. The controller-driven realization runs each entry as SQL in the application database instead, in the same key order, so content that is not SQL belongs on a synthesized realization.
custom_configstring—いいえRaw server configuration block (postgresql.conf format). Applied verbatim as the server's configuration file; unspecified settings keep their built-in defaults. The controller-driven realization takes server configuration as named settings rather than as a file and halts the build when this is set, naming the key it offers instead.

運用担当者によるサイジング

運用担当者が環境ごとに調整するインフラストラクチャのサイジングです。

名前型デフォルト必須説明
portinteger (min 1024, max 65535)5432いいえServer listen port. Most operators should omit this and let the Recipe assign the default (5432). The controller-driven realization runs the server on 5432 and cannot move it, and Cloud SQL and Azure Database for PostgreSQL flexible server serve PostgreSQL on 5432 alone, so those realizations halt the build on any other value rather than handing a consumer a port the server does not answer on.
engine_versionstring16いいえPostgreSQL major version (the postgres image tag).
computeobject—いいえ—
storageobject—いいえ—
haobject—いいえ—
overridesobject (open)—いいえProvider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.
control_plane_presentbooleanfalseいいえOperator affirmation that the CloudNativePG control plane is installed in the target cluster. The controller-driven realization halts the build unless this is set true, so a Cluster custom resource is never emitted as an orphan into a cluster that cannot reconcile it. Every other realization ignores this flag.
credentialsstring (generated | supplied)generatedいいえWho owns the database's credentials on the controller-driven realization. `generated` — the controller creates the Secret holding the owning role's password and owns it, which is what it does when nothing is supplied; the developer's `database` and `user` values are still honored, and no password reaches the rendered artifact. `supplied` — the controller reads that role's credentials from an existing Secret named in `credentials_secret` and generates none. Every other realization halts the build on `supplied`: the synthesized ones take the database password from the `password` credential slot and the application role's from `app_user_password`, the reference one owns no credential, on the RDS ones RDS owns the password, and on terraform/postgres-cloud-sql and terraform/postgres-flexible-server the `password` slot carries it.
credentials_secretstringいいえName of the existing Secret the controller-driven realization reads the database owner's credentials from when `credentials` is `supplied`. The Secret lives in the same namespace as the database, is of type `kubernetes.io/basic-auth`, and carries a `username` entry that must match `values.user` alongside a `password` entry holding that role's password. Leave it empty when `credentials` is `generated`; a controller-driven build halts if `supplied` is selected without it. Every other realization reads no Secret by this name and halts the build when it is set.

出力コントラクト

このコンポーネントが uses トポロジを通じて利用側に公開する値です。

名前型デフォルト必須説明
hoststring—はいAddress a client opens its database connection to. Which address that is follows the realization the Manifest selected — a Service's DNS name in-cluster, a pointer string a provisioning tool resolves for a managed instance, or the address of a server that already exists — so a consumer reads this rather than deriving one. A managed realization publishes the DNS name the Release sets in infra.overrides.host instead of its pointer, so a consumer on another target receives an address it can resolve.
portinteger—はいTCP port the server accepts connections on. It follows the port an operator set, so a consumer reads it rather than assuming 5432.
userstring—いいえName of the login role a consumer authenticates as. The matching password arrives through the credential attached to the component, never through this contract.
databasestring—いいえName of the logical database created at startup. A consumer names it in its connection string to land in the right database rather than the server's default.
protocolstring—いいえWire protocol the published address speaks — `postgres`, which is what a consumer selects a driver for.
metrics_pod_selectorstring—いいえKubernetes label selector matching every instance pod that serves the database's metrics, for a scraper that discovers those pods directly. Set by the controller-driven realization, beside `metrics_pod_port` and `metrics_path`; empty on every other realization, which serves no metrics.
metrics_pod_portstring—いいえName of the container port on those pods that carries the metrics, `metrics`. Set and empty together with `metrics_pod_selector`.
metrics_pathstring—いいえPath the metrics are served at on that port, `/metrics`. Set and empty together with `metrics_pod_selector`.

uses ソケット

このコンポーネントが接続に用いる依存関係ソケットです。ソケットを介して配線される各接続のターゲットは、そのソケットのラベルセレクターを満たす必要があり、各接続はソケットが宣言するスロットにアタッチメントを持つことができます。必須スロットは、Aggregate または Release がそのソケットを介して配線する各接続が満たす必要があります。

uses ソケットは宣言されていません。

アタッチメントスロット

Feature がこのコンポーネントにアタッチされる、名前付きのバインディングポイントです。スロットのセレクターはどの Feature がそのスロットを埋められるかを制約し、その inject リストは Feature のマテリアルをどのように配信できるかを示します。必須スロットは、インスタンス上のアタッチメント、またはその上位のスコープでのアタッチメントによって、すべてのインスタンスでバインドされている必要があります。また、機密スロットは秘密のマテリアルを扱うものとして宣言されます。Feature は、どのスロットも宣言していない名前でアタッチすることもできます。

スロットセレクター必須注入機密説明
passwordfeature.aggrega.ai/kind=secretいいえenvはいOptional database password credential. When attached, supplies POSTGRES_PASSWORD via the credential subsystem. Unattached, compose/postgres and helm/postgres set POSTGRES_PASSWORD to the development literal `apppass`, which this catalog publishes, so every Release that leaves the slot unattached shares that password. The controller-driven realization owns the database's credentials through infra.credentials and halts the build when this slot is filled. On the RDS Recipes RDS generates the master password and keeps it in AWS Secrets Manager, so the slot stays empty or takes core/generated-secret there, and any other credential halts the build. terraform/postgres-cloud-sql takes core/random-password here as the password of the user values.user names, and with nothing attached the module it sources draws one; it halts on any other credential. terraform/postgres-flexible-server requires core/random-password here as the administrator's password, and halts with nothing attached or on any other credential, since neither the service nor its module draws one.
app_user_passwordfeature.aggrega.ai/kind=secretいいえenvはいOptional application-user password credential. When attached, the synthesized helm Recipe creates a non-superuser login role (named by values.app_user) with this password; unattached, no application role is created. The controller-driven realization owns the database's credentials through infra.credentials and halts the build when this slot is filled, and so do the managed Recipes, which create only the one user values.user names.

自己注入の許可リスト

env

関係

他の公開エンティティとの間の型付きエッジです。公開されたターゲットがない参照は、リンクではなく切れたエッジとして表示されます。

使用先

このエンティティはカタログ内の何も使用していません。

使用元

Component の概念リファレンス →

Aggrega カタログ — コンポーネント、機能、レシピ、およびそれらをレンダリングするプラグインのオープンなインデックスです。

共有の Aggrega デザインシステムで構築されています。

プライバシー