diff --git a/README.md b/README.md index b3ba00b..67ec893 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,32 @@ +

+ + keiailab + +

+ # 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. + +

+ License: MIT + Go 1.26+ + PostgreSQL 18+ + Kubernetes 1.26+ + GHCR image + GitHub Discussions +

-[![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. diff --git a/charts/postgres-operator/Chart.yaml b/charts/postgres-operator/Chart.yaml index c25d39b..51445e1 100644 --- a/charts/postgres-operator/Chart.yaml +++ b/charts/postgres-operator/Chart.yaml @@ -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 @@ -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 diff --git a/charts/postgres-operator/README.md b/charts/postgres-operator/README.md index 21ce32b..729bd32 100644 --- a/charts/postgres-operator/README.md +++ b/charts/postgres-operator/README.md @@ -1,8 +1,21 @@ # Postgres Operator Helm Chart +

+ Keiailab Postgres Operator symbol +

+ 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+ diff --git a/docs/BRANDING.ja.md b/docs/BRANDING.ja.md index 21aa5e7..77e94ff 100644 --- a/docs/BRANDING.ja.md +++ b/docs/BRANDING.ja.md @@ -15,7 +15,7 @@ ## 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 ネイティブの自動シャーディングロードマップ。 @@ -23,11 +23,11 @@ | 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%。 @@ -79,7 +79,7 @@ GitHub README の shield.io バッジは上記 hex の使用を推奨。 ```markdown

- keiailab + keiailab

# postgres-operator @@ -87,7 +87,7 @@ GitHub README の shield.io バッジは上記 hex の使用を推奨。 > **MIT-licensed PostgreSQL Operator for Kubernetes — vanilla PG18+, license-clean, K8s-native auto-sharding roadmap**

- License + License

diff --git a/docs/BRANDING.ko.md b/docs/BRANDING.ko.md index f825894..31fc57a 100644 --- a/docs/BRANDING.ko.md +++ b/docs/BRANDING.ko.md @@ -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%. @@ -79,7 +79,7 @@ GitHub README 의 shield.io 배지는 위 hex 사용 권장. ```markdown

- keiailab + keiailab

# postgres-operator @@ -87,7 +87,7 @@ GitHub README 의 shield.io 배지는 위 hex 사용 권장. > **MIT-licensed PostgreSQL Operator for Kubernetes — vanilla PG18+, license-clean, K8s-native auto-sharding roadmap**

- License + License

diff --git a/docs/BRANDING.md b/docs/BRANDING.md index 6348431..5e59904 100644 --- a/docs/BRANDING.md +++ b/docs/BRANDING.md @@ -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. @@ -77,7 +77,7 @@ GitHub README 의 shield.io badge 는 위 hex 사용 권장. ```markdown

- keiailab + keiailab

# postgres-operator @@ -85,7 +85,7 @@ GitHub README 의 shield.io badge 는 위 hex 사용 권장. > **MIT-licensed PostgreSQL Operator for Kubernetes — vanilla PG18+, license-clean, K8s-native auto-sharding roadmap**

- License + License

diff --git a/docs/BRANDING.zh.md b/docs/BRANDING.zh.md index 1896e73..0f54290 100644 --- a/docs/BRANDING.zh.md +++ b/docs/BRANDING.zh.md @@ -15,7 +15,7 @@ ## 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 原生自动分片路线图。 @@ -23,11 +23,11 @@ | 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。始终链接到 。 +**标志放置**: README 顶部居中、width 96px。始终链接到 。 **安全间距 (Clear space)**: 标志周围最小 padding 为标志宽度的 25%。 @@ -79,7 +79,7 @@ GitHub README 的 shield.io 徽章推荐采用以上 hex。 ```markdown

- keiailab + keiailab

# postgres-operator @@ -87,7 +87,7 @@ GitHub README 的 shield.io 徽章推荐采用以上 hex。 > **MIT-licensed PostgreSQL Operator for Kubernetes — vanilla PG18+, license-clean, K8s-native auto-sharding roadmap**

- License + License

diff --git a/docs/README.ja.md b/docs/README.ja.md index 8f8bb73..702c489 100644 --- a/docs/README.ja.md +++ b/docs/README.ja.md @@ -1,5 +1,5 @@

- keiailab + keiailab

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

- License + License Go Version PostgreSQL Kubernetes diff --git a/docs/README.ko.md b/docs/README.ko.md index 371f62f..f8e654f 100644 --- a/docs/README.ko.md +++ b/docs/README.ko.md @@ -1,5 +1,5 @@

- keiailab + keiailab

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

- License + License Go Version PostgreSQL Kubernetes diff --git a/docs/README.zh.md b/docs/README.zh.md index 4815206..4535b13 100644 --- a/docs/README.zh.md +++ b/docs/README.zh.md @@ -1,5 +1,5 @@

- keiailab + keiailab

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

- License + License Go Version PostgreSQL Kubernetes diff --git a/docs/logo/base-symbol.png b/docs/logo/base-symbol.png new file mode 100644 index 0000000..6e16910 Binary files /dev/null and b/docs/logo/base-symbol.png differ diff --git a/docs/logo/dark.png b/docs/logo/dark.png new file mode 100644 index 0000000..fa493ef Binary files /dev/null and b/docs/logo/dark.png differ diff --git a/docs/logo/light.png b/docs/logo/light.png new file mode 100644 index 0000000..cb6f1f9 Binary files /dev/null and b/docs/logo/light.png differ diff --git a/docs/logo/symbol.png b/docs/logo/symbol.png new file mode 100644 index 0000000..cc7e74d Binary files /dev/null and b/docs/logo/symbol.png differ diff --git a/docs/mint.json b/docs/mint.json index 5afb00c..5e4ec1b 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -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" }