Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 26 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,32 @@
<p align="center">
<a href="https://keiailab.com">
<img src="docs/logo/symbol.png" alt="keiailab" width="96"/>
</a>
</p>

# postgres-operator

A Kubernetes operator for running vanilla PostgreSQL 18+, written in Go with Kubebuilder. It manages the full lifecycle of a PostgreSQL cluster — provisioning, high availability, backups, connection pooling, and declarative databases/roles — through plain Kubernetes resources.
> **Keiailab data operator family** — vanilla PostgreSQL 18+ on Kubernetes with HA, backup, pooling, and declarative database workflows.

<p align="center">
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-0EA5A8.svg" alt="License: MIT"/></a>
<a href="go.mod"><img src="https://img.shields.io/badge/Go-1.26%2B-00ADD8?logo=go&logoColor=white" alt="Go 1.26+"/></a>
<a href="https://www.postgresql.org/"><img src="https://img.shields.io/badge/PostgreSQL-18%2B-336791?logo=postgresql&logoColor=white" alt="PostgreSQL 18+"/></a>
<a href="https://kubernetes.io/"><img src="https://img.shields.io/badge/Kubernetes-1.26%2B-326CE5?logo=kubernetes&logoColor=white" alt="Kubernetes 1.26+"/></a>
<a href="https://github.com/keiailab/postgres-operator/pkgs/container/postgres-operator"><img src="https://img.shields.io/badge/GHCR-postgres--operator-0EA5A8?logo=github&logoColor=white" alt="GHCR image"/></a>
<a href="https://github.com/keiailab/postgres-operator/discussions"><img src="https://img.shields.io/github/discussions/keiailab/postgres-operator?label=discussions&logo=github" alt="GitHub Discussions"/></a>
</p>

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
[![Go](https://img.shields.io/badge/Go-1.26%2B-00ADD8?logo=go)](go.mod)
[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-18%2B-336791?logo=postgresql)](https://www.postgresql.org/)
[![Kubernetes](https://img.shields.io/badge/Kubernetes-1.26%2B-326CE5?logo=kubernetes)](https://kubernetes.io/)
## Design assets

| Asset | Path | Usage |
|---|---|---|
| Centered service symbol | [`docs/logo/symbol.png`](docs/logo/symbol.png) | GitHub README, Artifact Hub icon/screenshot |
| Light wordmark | [`docs/logo/light.png`](docs/logo/light.png) | Light backgrounds and docs cards |
| Dark wordmark | [`docs/logo/dark.png`](docs/logo/dark.png) | Dark backgrounds and social cards |
| Branding guide | [`docs/BRANDING.md`](docs/BRANDING.md) | Public visual usage rules |

A Kubernetes operator for running vanilla PostgreSQL 18+, written in Go with Kubebuilder. It manages the full lifecycle of a PostgreSQL cluster — provisioning, high availability, backups, connection pooling, and declarative databases/roles — through plain Kubernetes resources.

The operator runs **unmodified upstream PostgreSQL** — no forked engine, no embedded fork of another operator. Your applications keep using standard PostgreSQL extensions, types, and the libpq/JDBC/asyncpg drivers they already use.

Expand Down
8 changes: 8 additions & 0 deletions charts/postgres-operator/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ maintainers:
- name: keiailab
email: support@keiailab.com
url: https://github.com/keiailab
icon: https://raw.githubusercontent.com/KeiaiLab/postgres-operator/main/docs/logo/symbol.png
annotations:
# 본 chart의 beta 신호. Helm hub/artifacthub에 beta 라벨로 표시되도록.
artifacthub.io/alternativeName: keiailab-postgres-operator
Expand All @@ -52,6 +53,13 @@ annotations:
url: https://github.com/keiailab/postgres-operator
- name: Release Process
url: https://github.com/keiailab/postgres-operator/blob/main/docs/releases/release-process.md
- name: Design Assets
url: https://github.com/KeiaiLab/postgres-operator/blob/main/docs/BRANDING.md
artifacthub.io/screenshots: |
- title: Keiailab Postgres Operator centered service symbol
url: https://raw.githubusercontent.com/KeiaiLab/postgres-operator/main/docs/logo/symbol.png
- title: Keiailab Postgres Operator light wordmark
url: https://raw.githubusercontent.com/KeiaiLab/postgres-operator/main/docs/logo/light.png
artifacthub.io/crds: |
- kind: PostgresCluster
version: v1alpha1
Expand Down
13 changes: 13 additions & 0 deletions charts/postgres-operator/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
# Postgres Operator Helm Chart

<p align="center">
<img src="https://raw.githubusercontent.com/KeiaiLab/postgres-operator/main/docs/logo/symbol.png" alt="Keiailab Postgres Operator symbol" width="96"/>
</p>

The `postgres-operator` chart deploys the operator manager, RBAC,
CRDs, and NetworkPolicies for `keiailab/postgres-operator`.

## Design assets

| Asset | URL | Usage |
|---|---|---|
| Centered service symbol | https://raw.githubusercontent.com/KeiaiLab/postgres-operator/main/docs/logo/symbol.png | Artifact Hub package icon and screenshot |
| Light wordmark | https://raw.githubusercontent.com/KeiaiLab/postgres-operator/main/docs/logo/light.png | Light backgrounds and docs cards |
| Dark wordmark | https://raw.githubusercontent.com/KeiaiLab/postgres-operator/main/docs/logo/dark.png | Dark backgrounds and social cards |
| Branding guide | https://github.com/KeiaiLab/postgres-operator/blob/main/docs/BRANDING.md | GitHub visual usage rules |

## Prerequisites

- Kubernetes 1.26+
Expand Down
14 changes: 7 additions & 7 deletions docs/BRANDING.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,19 @@

## 1. Identity

**組織**: [keiailab](https://keiailab.com) — Kubernetes ネイティブのデータプラットフォーム (Apache-2.0、license-clean、vanilla upstream 互換)。
**組織**: [keiailab](https://keiailab.com) — Kubernetes ネイティブのデータプラットフォーム (MIT-licensed, license-clean、vanilla upstream 互換)。

**プロジェクト**: `postgres-operator` — Kubernetes 向け MIT-licensed PostgreSQL Operator — vanilla PG18+、license-clean、K8s ネイティブの自動シャーディングロードマップ。

## 2. ロゴ & ビジュアルアセット

| Asset | URL | 用途 |
|---|---|---|
| Primary logo (SVG) | `https://keiailab.com/assets/logo.svg` | README ヘッダー、スライド |
| Mono mark | `https://keiailab.com/assets/mark.svg` | favicon、SNS カード |
| Wordmark | `https://keiailab.com/assets/wordmark.svg` | Footer、暗背景 |
| Current primary logo | `docs/logo/symbol.png` | README header, slides |
| Current favicon | `https://keiailab.com/favicon.ico` | Favicon, social cards |
| Planned SVG kit | `https://keiailab.com/assets/{logo,mark,wordmark}.svg` | Future replacement after URLs return 200 |

**ロゴ配置**: README 上部中央、width 120px。常に https://keiailab.com にリンクします。
**ロゴ配置**: README 上部中央、width 96px。常に https://keiailab.com にリンクします。

**Clear space**: ロゴ周りの最小 padding はロゴ幅の 25%。

Expand Down Expand Up @@ -79,15 +79,15 @@ GitHub README の shield.io バッジは上記 hex の使用を推奨。

```markdown
<p align="center">
<img src="https://keiailab.com/assets/logo.svg" alt="keiailab" width="120"/>
<img src="docs/logo/symbol.png" alt="keiailab" width="96"/>
</p>

# postgres-operator

> **MIT-licensed PostgreSQL Operator for Kubernetes — vanilla PG18+, license-clean, K8s-native auto-sharding roadmap**

<p align="center">
<a href="LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="License"/></a>
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-0EA5A8.svg" alt="License"/></a>
<!-- 既存の shield.io バッジを維持 + 整合 -->
</p>

Expand Down
12 changes: 6 additions & 6 deletions docs/BRANDING.ko.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@

| Asset | URL | 용도 |
|---|---|---|
| Primary logo (SVG) | `https://keiailab.com/assets/logo.svg` | README 헤더, 슬라이드 |
| Mono mark | `https://keiailab.com/assets/mark.svg` | 파비콘, 소셜 카드 |
| Wordmark | `https://keiailab.com/assets/wordmark.svg` | Footer, dark 배경 |
| Current primary logo | `docs/logo/symbol.png` | README header, slides |
| Current favicon | `https://keiailab.com/favicon.ico` | Favicon, social cards |
| Planned SVG kit | `https://keiailab.com/assets/{logo,mark,wordmark}.svg` | Future replacement after URLs return 200 |

**로고 배치**: README 상단 중앙, width 120px. 항상 https://keiailab.com 으로 링크.
**로고 배치**: README 상단 중앙, width 96px. 항상 https://keiailab.com 으로 링크.

**Clear space**: 로고 둘레 최소 padding = 로고 너비의 25%.

Expand Down Expand Up @@ -79,15 +79,15 @@ GitHub README 의 shield.io 배지는 위 hex 사용 권장.

```markdown
<p align="center">
<img src="https://keiailab.com/assets/logo.svg" alt="keiailab" width="120"/>
<img src="docs/logo/symbol.png" alt="keiailab" width="96"/>
</p>

# postgres-operator

> **MIT-licensed PostgreSQL Operator for Kubernetes — vanilla PG18+, license-clean, K8s-native auto-sharding roadmap**

<p align="center">
<a href="LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="License"/></a>
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-0EA5A8.svg" alt="License"/></a>
<!-- 기존 shield.io badges 유지 + 정합 -->
</p>

Expand Down
12 changes: 6 additions & 6 deletions docs/BRANDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ This document is the canonical reference for `postgres-operator` branding decisi

| Asset | URL | Usage |
|---|---|---|
| Primary logo (SVG) | `https://keiailab.com/assets/logo.svg` | README header, slides |
| Mono mark | `https://keiailab.com/assets/mark.svg` | Favicon, social cards |
| Wordmark | `https://keiailab.com/assets/wordmark.svg` | Footer, dark backgrounds |
| Current primary logo | `docs/logo/symbol.png` | README header, slides |
| Current favicon | `https://keiailab.com/favicon.ico` | Favicon, social cards |
| Planned SVG kit | `https://keiailab.com/assets/{logo,mark,wordmark}.svg` | Future replacement after URLs return 200 |

**Logo placement**: Top-center of README, width 120px. Always link to https://keiailab.com.
**Logo placement**: Top-center of README, width 96px. Always link to https://keiailab.com.

**Clear space**: Minimum padding around logo = 25% of logo width.

Expand Down Expand Up @@ -77,15 +77,15 @@ GitHub README 의 shield.io badge 는 위 hex 사용 권장.

```markdown
<p align="center">
<img src="https://keiailab.com/assets/logo.svg" alt="keiailab" width="120"/>
<img src="docs/logo/symbol.png" alt="keiailab" width="96"/>
</p>

# postgres-operator

> **MIT-licensed PostgreSQL Operator for Kubernetes — vanilla PG18+, license-clean, K8s-native auto-sharding roadmap**

<p align="center">
<a href="LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="License"/></a>
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-0EA5A8.svg" alt="License"/></a>
<!-- 기존 shield.io badges 유지 + 정합 -->
</p>

Expand Down
14 changes: 7 additions & 7 deletions docs/BRANDING.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,19 @@

## 1. Identity

**组织**: [keiailab](https://keiailab.com) —— Kubernetes 原生数据平台 (Apache-2.0、license-clean、与 vanilla upstream 兼容)。
**组织**: [keiailab](https://keiailab.com) —— Kubernetes 原生数据平台 (MIT-licensed, license-clean、与 vanilla upstream 兼容)。

**项目**: `postgres-operator` —— Kubernetes 上的 MIT-licensed PostgreSQL Operator —— vanilla PG18+、license-clean、K8s 原生自动分片路线图。

## 2. 标志与视觉资产

| Asset | URL | 用途 |
|---|---|---|
| Primary logo (SVG) | `https://keiailab.com/assets/logo.svg` | README 标题、幻灯片 |
| Mono mark | `https://keiailab.com/assets/mark.svg` | favicon、社交卡片 |
| Wordmark | `https://keiailab.com/assets/wordmark.svg` | Footer、暗色背景 |
| Current primary logo | `docs/logo/symbol.png` | README header, slides |
| Current favicon | `https://keiailab.com/favicon.ico` | Favicon, social cards |
| Planned SVG kit | `https://keiailab.com/assets/{logo,mark,wordmark}.svg` | Future replacement after URLs return 200 |

**标志放置**: README 顶部居中、width 120px。始终链接到 <https://keiailab.com>。
**标志放置**: README 顶部居中、width 96px。始终链接到 <https://keiailab.com>。

**安全间距 (Clear space)**: 标志周围最小 padding 为标志宽度的 25%。

Expand Down Expand Up @@ -79,15 +79,15 @@ GitHub README 的 shield.io 徽章推荐采用以上 hex。

```markdown
<p align="center">
<img src="https://keiailab.com/assets/logo.svg" alt="keiailab" width="120"/>
<img src="docs/logo/symbol.png" alt="keiailab" width="96"/>
</p>

# postgres-operator

> **MIT-licensed PostgreSQL Operator for Kubernetes — vanilla PG18+, license-clean, K8s-native auto-sharding roadmap**

<p align="center">
<a href="LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="License"/></a>
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-0EA5A8.svg" alt="License"/></a>
<!-- 保留并对齐现有 shield.io 徽章 -->
</p>

Expand Down
4 changes: 2 additions & 2 deletions docs/README.ja.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="https://keiailab.com/assets/logo.svg" alt="keiailab" width="120"/>
<img src="logo/symbol.png" alt="keiailab" width="96"/>
</p>

# postgres-operator (日本語)
Expand All @@ -9,7 +9,7 @@
> English README: [README.md](../README.md) — canonical / 正本

<p align="center">
<a href="../LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="License"/></a>
<a href="../LICENSE"><img src="https://img.shields.io/badge/License-MIT-0EA5A8.svg" alt="License"/></a>
<a href="https://golang.org/"><img src="https://img.shields.io/badge/Go-1.26+-00ADD8?logo=go" alt="Go Version"/></a>
<a href="https://www.postgresql.org/"><img src="https://img.shields.io/badge/PostgreSQL-18%2B-336791?logo=postgresql" alt="PostgreSQL"/></a>
<a href="https://kubernetes.io/"><img src="https://img.shields.io/badge/Kubernetes-1.26+-326CE5?logo=kubernetes" alt="Kubernetes"/></a>
Expand Down
4 changes: 2 additions & 2 deletions docs/README.ko.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="https://keiailab.com/assets/logo.svg" alt="keiailab" width="120"/>
<img src="logo/symbol.png" alt="keiailab" width="96"/>
</p>

# postgres-operator (한국어)
Expand All @@ -9,7 +9,7 @@
> English README: [README.md](../README.md) — canonical / 정본

<p align="center">
<a href="../LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="License"/></a>
<a href="../LICENSE"><img src="https://img.shields.io/badge/License-MIT-0EA5A8.svg" alt="License"/></a>
<a href="https://golang.org/"><img src="https://img.shields.io/badge/Go-1.26+-00ADD8?logo=go" alt="Go Version"/></a>
<a href="https://www.postgresql.org/"><img src="https://img.shields.io/badge/PostgreSQL-18%2B-336791?logo=postgresql" alt="PostgreSQL"/></a>
<a href="https://kubernetes.io/"><img src="https://img.shields.io/badge/Kubernetes-1.26+-326CE5?logo=kubernetes" alt="Kubernetes"/></a>
Expand Down
4 changes: 2 additions & 2 deletions docs/README.zh.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="https://keiailab.com/assets/logo.svg" alt="keiailab" width="120"/>
<img src="logo/symbol.png" alt="keiailab" width="96"/>
</p>

# postgres-operator (简体中文)
Expand All @@ -9,7 +9,7 @@
> English README: [README.md](../README.md) — canonical / 正本

<p align="center">
<a href="../LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="License"/></a>
<a href="../LICENSE"><img src="https://img.shields.io/badge/License-MIT-0EA5A8.svg" alt="License"/></a>
<a href="https://golang.org/"><img src="https://img.shields.io/badge/Go-1.26+-00ADD8?logo=go" alt="Go Version"/></a>
<a href="https://www.postgresql.org/"><img src="https://img.shields.io/badge/PostgreSQL-18%2B-336791?logo=postgresql" alt="PostgreSQL"/></a>
<a href="https://kubernetes.io/"><img src="https://img.shields.io/badge/Kubernetes-1.26+-326CE5?logo=kubernetes" alt="Kubernetes"/></a>
Expand Down
Binary file added docs/logo/base-symbol.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/logo/dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/logo/light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/logo/symbol.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 6 additions & 6 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
"$schema": "https://mintlify.com/schema.json",
"name": "keiailab/postgres-operator",
"logo": {
"light": "/logo/light.svg",
"dark": "/logo/dark.svg"
"light": "/logo/light.png",
"dark": "/logo/dark.png"
},
"favicon": "/favicon.svg",
"favicon": "/logo/symbol.png",
"colors": {
"primary": "#2563eb",
"light": "#60a5fa",
"dark": "#1e40af"
"primary": "#0EA5A8",
"light": "#38BDF8",
"dark": "#0F172A"
},
"topbarLinks": [
{ "name": "GitHub", "url": "https://github.com/keiailab/postgres-operator" }
Expand Down