diff --git a/README.md b/README.md index d898641f..60dbcc72 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,36 @@ +

+ + keiailab + +

+ # mongodb-operator +> **Keiailab data operator family** — MongoDB replica sets and sharded clusters on Kubernetes with TLS, metrics, and declarative topology. + +

+ License: MIT + Go 1.26 + MongoDB 8.x + Kubernetes 1.26+ + GHCR image + GitHub Discussions +

+ +## Design assets + +| Asset | Path | Usage | +|---|---|---| +| Centered service symbol | [`docs/branding/symbol.png`](docs/branding/symbol.png) | GitHub README, Artifact Hub icon/screenshot | +| Repository wordmark | [`docs/branding/logo.png`](docs/branding/logo.png) | Project pages and docs cards | +| Social cover | [`docs/branding/cover.png`](docs/branding/cover.png) | Social cards and launch posts | +| Branding guide | [`docs/branding.md`](docs/branding.md) | Public visual usage rules | + A Kubernetes operator for running MongoDB on Kubernetes. It manages the lifecycle of MongoDB replica sets and sharded clusters through Custom Resources — bootstrapping the cluster, creating the admin user, wiring up TLS and metrics, and reconciling the desired topology. -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) -[![Go](https://img.shields.io/badge/Go-1.26-00ADD8?logo=go)](go.mod) -[![MongoDB](https://img.shields.io/badge/MongoDB-8.0%20|%208.2%20|%208.3-47A248?logo=mongodb)](#supported-mongodb-versions) -[![Kubernetes](https://img.shields.io/badge/Kubernetes-1.26+-326CE5?logo=kubernetes)](#requirements) - The operator does not bundle or redistribute MongoDB. It pulls the official `mongo` community images at runtime and orchestrates them; you remain responsible for complying with MongoDB's [SSPL](https://www.mongodb.com/licensing/server-side-public-license) diff --git a/charts/mongodb-operator/Chart.yaml b/charts/mongodb-operator/Chart.yaml index 699d390a..c6cdf772 100644 --- a/charts/mongodb-operator/Chart.yaml +++ b/charts/mongodb-operator/Chart.yaml @@ -27,7 +27,7 @@ maintainers: email: support@keiailab.com url: https://keiailab.com -icon: https://raw.githubusercontent.com/mongodb/mongo/master/docs/leaf.svg +icon: https://raw.githubusercontent.com/KeiaiLab/mongodb-operator/main/docs/branding/symbol.png annotations: artifacthub.io/license: MIT @@ -62,6 +62,13 @@ annotations: url: https://github.com/keiailab/mongodb-operator - name: MongoDB Documentation url: https://www.mongodb.com/docs/ + - name: Design Assets + url: https://github.com/KeiaiLab/mongodb-operator/blob/main/docs/branding.md + artifacthub.io/screenshots: | + - title: Keiailab MongoDB Operator centered service symbol + url: https://raw.githubusercontent.com/KeiaiLab/mongodb-operator/main/docs/branding/symbol.png + - title: Keiailab MongoDB Operator social cover + url: https://raw.githubusercontent.com/KeiaiLab/mongodb-operator/main/docs/branding/cover.png artifacthub.io/crds: | - kind: MongoDB version: v1alpha1 diff --git a/charts/mongodb-operator/README.md b/charts/mongodb-operator/README.md index 49bcbfde..2428cb6e 100644 --- a/charts/mongodb-operator/README.md +++ b/charts/mongodb-operator/README.md @@ -1,7 +1,20 @@ # MongoDB Operator Helm Chart +

+ Keiailab MongoDB Operator symbol +

+ A Kubernetes Operator for deploying and managing MongoDB ReplicaSets and Sharded Clusters. +## Design assets + +| Asset | URL | Usage | +|---|---|---| +| Centered service symbol | https://raw.githubusercontent.com/KeiaiLab/mongodb-operator/main/docs/branding/symbol.png | Artifact Hub package icon and screenshot | +| Repository wordmark | https://raw.githubusercontent.com/KeiaiLab/mongodb-operator/main/docs/branding/logo.png | Project pages and docs cards | +| Social cover | https://raw.githubusercontent.com/KeiaiLab/mongodb-operator/main/docs/branding/cover.png | Social cards and launch posts | +| Branding guide | https://github.com/KeiaiLab/mongodb-operator/blob/main/docs/branding.md | GitHub visual usage rules | + ## Features - **MongoDB ReplicaSet**: Deploy highly available 3+ member replica sets diff --git a/docs/branding.md b/docs/branding.md index 63d5f09f..6244d12d 100644 --- a/docs/branding.md +++ b/docs/branding.md @@ -28,14 +28,15 @@ This document is the canonical reference for `mongodb-operator` branding decisio | Asset | URL | Usage | |---|---|---| -| Primary logo (current) | `https://github.com/keiailab.png` | README header (all repos), slides | -| Primary logo (SVG, planned) | `https://keiailab.com/assets/logo.svg` *(not yet published)* | future replacement for GitHub avatar | -| Mono mark (planned) | `https://keiailab.com/assets/mark.svg` *(not yet published)* | Favicon, social cards | +| Primary logo (current) | `docs/branding/symbol.png` | README header (all repos), slides | +| Repository wordmark | `docs/branding/logo.png` | Project pages | +| Social cover | `docs/branding/cover.png` | Social cards and launch posts | +| Current favicon | `https://keiailab.com/favicon.ico` | Favicon, social cards | | Wordmark (planned) | `https://keiailab.com/assets/wordmark.svg` *(not yet published)* | Footer, dark backgrounds | -**Logo placement**: Top-center of README, width 120px. Always link to https://github.com/keiailab. +**Logo placement**: Top-center of README, width 96px. Always link to https://keiailab.com. -**Migration note (2026-05-21)**: until `keiailab.com/assets/*.svg` is published, all repos in the family use the GitHub avatar (`https://github.com/keiailab.png`) as canonical primary logo. The SVG row is reserved for the future migration. +**Symbol note (2026-06-11)**: the primary symbol keeps the Keiailab rotating-arrow mark and replaces only the removed center sphere with the service icon. **Clear space**: Minimum padding around logo = 25% of logo width. @@ -87,7 +88,7 @@ GitHub README 의 shield.io badge 는 위 hex 사용 권장. ```markdown

- keiailab + keiailab

# mongodb-operator @@ -95,7 +96,7 @@ GitHub README 의 shield.io badge 는 위 hex 사용 권장. > **MIT MongoDB Operator for Kubernetes — ReplicaSet + Sharded Cluster + Backup, vanilla MongoDB 7.0+**

- License + License

diff --git a/docs/branding/base-symbol.png b/docs/branding/base-symbol.png new file mode 100644 index 00000000..6e169101 Binary files /dev/null and b/docs/branding/base-symbol.png differ diff --git a/docs/branding/cover.png b/docs/branding/cover.png index 730376d4..5523ed63 100644 Binary files a/docs/branding/cover.png and b/docs/branding/cover.png differ diff --git a/docs/branding/logo.png b/docs/branding/logo.png index b5e162c2..c6e7b22b 100644 Binary files a/docs/branding/logo.png and b/docs/branding/logo.png differ diff --git a/docs/branding/logo.svg b/docs/branding/logo.svg index 91c7df93..2c453f9e 100644 --- a/docs/branding/logo.svg +++ b/docs/branding/logo.svg @@ -1,20 +1,8 @@ - - MongoDB Operator - - - - - - - - - - - - - MongoDB - Operator - + + Keiailab MongoDB Operator + Original Keiailab symbol with MongoDB Operator wordmark. + + + Keiailab + MongoDB Operator diff --git a/docs/branding/symbol.png b/docs/branding/symbol.png new file mode 100644 index 00000000..70598640 Binary files /dev/null and b/docs/branding/symbol.png differ diff --git a/docs/i18n/ja/branding.md b/docs/i18n/ja/branding.md index a4d98220..a1a7b346 100644 --- a/docs/i18n/ja/branding.md +++ b/docs/i18n/ja/branding.md @@ -28,14 +28,15 @@ | アセット | URL | 用途 | |---|---|---| -| Primary logo (現行) | `https://github.com/keiailab.png` | README header (全リポ)、スライド | -| Primary logo (SVG、予定) | `https://keiailab.com/assets/logo.svg` *(未公開)* | GitHub avatar の今後の代替 | -| Mono mark (予定) | `https://keiailab.com/assets/mark.svg` *(未公開)* | Favicon、ソーシャルカード | +| Primary logo (現行) | `docs/branding/symbol.png` | README header (全リポ)、スライド | +| Repository wordmark | `docs/branding/logo.png` | Project pages | +| Social cover | `docs/branding/cover.png` | Social cards and launch posts | +| Current favicon | `https://keiailab.com/favicon.ico` | Favicon, social cards | | Wordmark (予定) | `https://keiailab.com/assets/wordmark.svg` *(未公開)* | フッター、暗い背景 | -**Logo placement**: README の上部中央、幅 120px。常に https://github.com/keiailab へリンクします。 +**Logo placement**: README の上部中央、幅 96px。常に https://keiailab.com へリンクします。 -**Migration note (2026-05-21)**: `keiailab.com/assets/*.svg` が公開されるまで、family の全リポは GitHub avatar (`https://github.com/keiailab.png`) を canonical primary logo として使用します。SVG 行は今後のマイグレーション用に予約。 +**Symbol note (2026-06-11)**: primary symbol keeps the Keiailab rotating-arrow mark and places the service icon at the removed center sphere position. **Clear space**: ロゴ周囲の最小パディング = ロゴ幅の 25%。 @@ -87,7 +88,7 @@ GitHub README の shield.io badge には上記 hex の利用を推奨します ```markdown

- keiailab + keiailab

# mongodb-operator @@ -95,7 +96,7 @@ GitHub README の shield.io badge には上記 hex の利用を推奨します > **MIT MongoDB Operator for Kubernetes — ReplicaSet + Sharded Cluster + Backup, vanilla MongoDB 7.0+**

- License + License

diff --git a/docs/i18n/ja/readme.md b/docs/i18n/ja/readme.md index cd268e51..843c21b5 100644 --- a/docs/i18n/ja/readme.md +++ b/docs/i18n/ja/readme.md @@ -1,5 +1,5 @@

- keiailab + keiailab

# mongodb-operator @@ -7,7 +7,7 @@ > **Kubernetes 向け MIT MongoDB Operator — ReplicaSet + Sharded Cluster + バックアップ、vanilla MongoDB 7.0+**

- License + License Go Version MongoDB Kubernetes diff --git a/docs/i18n/ko/branding.md b/docs/i18n/ko/branding.md index 46942513..a33d5c2c 100644 --- a/docs/i18n/ko/branding.md +++ b/docs/i18n/ko/branding.md @@ -30,14 +30,15 @@ | 자산 | URL | 용도 | |---|---|---| -| Primary logo (현재) | `https://github.com/keiailab.png` | README header (전 리포), 슬라이드 | -| Primary logo (SVG, 예정) | `https://keiailab.com/assets/logo.svg` *(아직 미공개)* | GitHub avatar 의 향후 대체 | -| Mono mark (예정) | `https://keiailab.com/assets/mark.svg` *(아직 미공개)* | Favicon, 소셜 카드 | +| Primary logo (현재) | `docs/branding/symbol.png` | README header (전 리포), 슬라이드 | +| Repository wordmark | `docs/branding/logo.png` | Project page | +| Social cover | `docs/branding/cover.png` | Social cards 및 launch posts | +| Current favicon | `https://keiailab.com/favicon.ico` | Favicon, social cards | | Wordmark (예정) | `https://keiailab.com/assets/wordmark.svg` *(아직 미공개)* | Footer, 어두운 배경 | -**Logo placement**: README 의 상단 중앙, 너비 120px. 항상 https://github.com/keiailab 으로 링크. +**Logo placement**: README 의 상단 중앙, 너비 96px. 항상 https://keiailab.com 으로 링크. -**Migration note (2026-05-21)**: `keiailab.com/assets/*.svg` 가 게시되기 전까지, family 전 리포는 GitHub avatar (`https://github.com/keiailab.png`) 를 canonical primary logo 로 사용. SVG 행은 향후 마이그레이션용 예약. +**Symbol note (2026-06-11)**: primary symbol 은 Keiailab rotating-arrow mark 를 유지하고, 제거된 중앙 구 위치에만 service icon 을 둔다. **Clear space**: 로고 주위 최소 여백 = 로고 너비의 25%. @@ -89,7 +90,7 @@ GitHub README 의 shield.io badge 는 위 hex 사용 권장. ```markdown

- keiailab + keiailab

# mongodb-operator @@ -97,7 +98,7 @@ GitHub README 의 shield.io badge 는 위 hex 사용 권장. > **MIT MongoDB Operator for Kubernetes — ReplicaSet + Sharded Cluster + Backup, vanilla MongoDB 7.0+**

- License + License

diff --git a/docs/i18n/ko/readme.md b/docs/i18n/ko/readme.md index 6eb56ca7..035d5155 100644 --- a/docs/i18n/ko/readme.md +++ b/docs/i18n/ko/readme.md @@ -1,5 +1,5 @@

- keiailab + keiailab

# mongodb-operator (한국어) @@ -9,7 +9,7 @@ > **MIT MongoDB Operator for Kubernetes — ReplicaSet + Sharded Cluster + Backup, vanilla MongoDB 7.0+**

- 라이선스 + 라이선스 Go 버전 MongoDB Kubernetes diff --git a/docs/i18n/zh/branding.md b/docs/i18n/zh/branding.md index 06955b6d..afa97ea0 100644 --- a/docs/i18n/zh/branding.md +++ b/docs/i18n/zh/branding.md @@ -28,14 +28,15 @@ | 资源 | URL | 用途 | |---|---|---| -| Primary logo (当前) | `https://github.com/keiailab.png` | README header (全部仓库)、幻灯片 | -| Primary logo (SVG, 计划) | `https://keiailab.com/assets/logo.svg` *(尚未发布)* | GitHub avatar 的未来替代 | -| Mono mark (计划) | `https://keiailab.com/assets/mark.svg` *(尚未发布)* | Favicon、社交卡片 | +| Primary logo (当前) | `docs/branding/symbol.png` | README header (全部仓库)、幻灯片 | +| Repository wordmark | `docs/branding/logo.png` | Project pages | +| Social cover | `docs/branding/cover.png` | Social cards and launch posts | +| Current favicon | `https://keiailab.com/favicon.ico` | Favicon, social cards | | Wordmark (计划) | `https://keiailab.com/assets/wordmark.svg` *(尚未发布)* | 页脚、深色背景 | -**Logo placement**: README 顶部居中,宽度 120px。始终链接到 https://github.com/keiailab。 +**Logo placement**: README 顶部居中,宽度 96px。始终链接到 https://keiailab.com。 -**Migration note (2026-05-21)**: 在 `keiailab.com/assets/*.svg` 发布之前,family 全部仓库均使用 GitHub avatar (`https://github.com/keiailab.png`) 作为 canonical primary logo。SVG 行为未来迁移预留。 +**Symbol note (2026-06-11)**: primary symbol keeps the Keiailab rotating-arrow mark and places the service icon at the removed center sphere position. **Clear space**: Logo 周围最小留白 = logo 宽度的 25%。 @@ -87,7 +88,7 @@ GitHub README 的 shield.io badge 建议使用上述 hex。 ```markdown

- keiailab + keiailab

# mongodb-operator @@ -95,7 +96,7 @@ GitHub README 的 shield.io badge 建议使用上述 hex。 > **MIT MongoDB Operator for Kubernetes — ReplicaSet + Sharded Cluster + Backup, vanilla MongoDB 7.0+**

- License + License

diff --git a/docs/i18n/zh/readme.md b/docs/i18n/zh/readme.md index 29ec3799..2979b034 100644 --- a/docs/i18n/zh/readme.md +++ b/docs/i18n/zh/readme.md @@ -1,5 +1,5 @@

- keiailab + keiailab

# mongodb-operator @@ -7,7 +7,7 @@ > **Kubernetes 的 MIT MongoDB Operator — ReplicaSet + Sharded Cluster + 备份,原生 MongoDB 7.0+**

- License + License Go Version MongoDB Kubernetes