diff --git a/README.md b/README.md index c0735f6..adb667c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,31 @@ +

+ + keiailab + +

+ # valkey-operator -A Kubernetes operator for running [Valkey](https://valkey.io/) — standalone, replicated, or as a sharded cluster — with backup and restore. +> **Keiailab data operator family** — Valkey on Kubernetes with standalone, replication, cluster, backup, and restore workflows. + +

+ License: MIT + Go 1.26 + Valkey 8+ + Kubernetes 1.26+ + GHCR image + GitHub Discussions +

-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) -[![Go](https://img.shields.io/badge/Go-1.26-00ADD8?logo=go&logoColor=white)](go.mod) -[![Valkey](https://img.shields.io/badge/Valkey-8%2B-6979DC?logo=redis&logoColor=white)](https://valkey.io/) +## Design assets + +| Asset | Path | Usage | +|---|---|---| +| Centered service symbol | [`docs/branding/symbol.png`](docs/branding/symbol.png) | GitHub README, Artifact Hub icon/screenshot | +| Keiailab base symbol | [`docs/branding/base-symbol.png`](docs/branding/base-symbol.png) | Source reference for the outer rotating-arrow mark | +| Branding guide | [`docs/BRANDING.md`](docs/BRANDING.md) | Public visual usage rules | + +A Kubernetes operator for running [Valkey](https://valkey.io/) — standalone, replicated, or as a sharded cluster — with backup and restore. Built with [Kubebuilder](https://book.kubebuilder.io/). A single controller manages standalone instances, primary/replica replication, and sharded Valkey Cluster through five custom resources, and reconciles the StatefulSets, Services, ConfigMaps, Secrets, and related objects each one needs. diff --git a/charts/valkey-operator/Chart.yaml b/charts/valkey-operator/Chart.yaml index 294a6cb..a1adccb 100644 --- a/charts/valkey-operator/Chart.yaml +++ b/charts/valkey-operator/Chart.yaml @@ -46,6 +46,11 @@ annotations: url: https://github.com/keiailab/valkey-operator - name: Valkey Project url: https://valkey.io/ + - name: Design Assets + url: https://github.com/KeiaiLab/valkey-operator/blob/main/docs/BRANDING.md + artifacthub.io/screenshots: | + - title: Keiailab Valkey Operator centered service symbol + url: https://raw.githubusercontent.com/KeiaiLab/valkey-operator/main/docs/branding/symbol.png artifacthub.io/crds: | - kind: Valkey version: v1alpha1 diff --git a/charts/valkey-operator/README.md b/charts/valkey-operator/README.md index 953ad97..6ee1c81 100644 --- a/charts/valkey-operator/README.md +++ b/charts/valkey-operator/README.md @@ -1,8 +1,19 @@ # Valkey Operator Helm Chart +

+ Keiailab Valkey Operator symbol +

+ A Kubernetes Operator for deploying and managing Valkey instances and Clusters (Valkey is the BSD-licensed Redis OSS fork stewarded by the Linux Foundation). +## Design assets + +| Asset | URL | Usage | +|---|---|---| +| Centered service symbol | https://raw.githubusercontent.com/KeiaiLab/valkey-operator/main/docs/branding/symbol.png | Artifact Hub package icon and screenshot | +| Branding guide | https://github.com/KeiaiLab/valkey-operator/blob/main/docs/BRANDING.md | GitHub visual usage rules | + ## Features - **Valkey instance**: Standalone or Replication (1 primary + N replicas) with persistent storage diff --git a/docs/BRANDING.md b/docs/BRANDING.md index e7900c9..daa725e 100644 --- a/docs/BRANDING.md +++ b/docs/BRANDING.md @@ -21,11 +21,11 @@ This document is the canonical reference for `valkey-operator` branding decision | 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/branding/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

# valkey-operator @@ -85,7 +85,7 @@ GitHub README 의 shield.io badge 는 위 hex 사용 권장. > **MIT-licensed Valkey Operator for Kubernetes — Standalone + Cluster + Backup/Restore, BSD-3 license-clean**

- License + License

diff --git a/docs/branding/base-symbol.png b/docs/branding/base-symbol.png new file mode 100644 index 0000000..6e16910 Binary files /dev/null and b/docs/branding/base-symbol.png differ diff --git a/docs/branding/symbol.png b/docs/branding/symbol.png new file mode 100644 index 0000000..65facb1 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 187fe34..9009b71 100644 --- a/docs/i18n/ja/BRANDING.md +++ b/docs/i18n/ja/BRANDING.md @@ -21,11 +21,11 @@ | アセット | URL | 用途 | |---|---|---| -| Primary logo (SVG) | `https://keiailab.com/assets/logo.svg` | README header、スライド | -| Mono mark | `https://keiailab.com/assets/mark.svg` | Favicon、ソーシャルカード | -| Wordmark | `https://keiailab.com/assets/wordmark.svg` | フッター、暗い背景 | +| Current primary logo | `docs/branding/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**: README の上部中央、幅 120px。常に https://keiailab.com へリンクします。 +**Logo placement**: README の上部中央、幅 96px。常に https://keiailab.com へリンクします。 **Clear space**: ロゴ周囲の最小パディング = ロゴ幅の 25%。 @@ -77,7 +77,7 @@ GitHub README の shield.io badge には上記 hex の利用を推奨します ```markdown

- keiailab + keiailab

# valkey-operator @@ -85,7 +85,7 @@ GitHub README の shield.io badge には上記 hex の利用を推奨します > **MIT-licensed Valkey Operator for Kubernetes — Standalone + Cluster + Backup/Restore, BSD-3 license-clean**

- License + License

diff --git a/docs/i18n/ko/BRANDING.md b/docs/i18n/ko/BRANDING.md index a8227fe..20015c2 100644 --- a/docs/i18n/ko/BRANDING.md +++ b/docs/i18n/ko/BRANDING.md @@ -23,11 +23,11 @@ | 자산 | URL | 용도 | |---|---|---| -| Primary logo (SVG) | `https://keiailab.com/assets/logo.svg` | README header, 슬라이드 | -| Mono mark | `https://keiailab.com/assets/mark.svg` | Favicon, 소셜 카드 | -| Wordmark | `https://keiailab.com/assets/wordmark.svg` | Footer, 어두운 배경 | +| Current primary logo | `docs/branding/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**: README 의 상단 중앙, 너비 120px. 항상 https://keiailab.com 으로 링크. +**Logo placement**: README 의 상단 중앙, 너비 96px. 항상 https://keiailab.com 으로 링크. **Clear space**: 로고 주위 최소 여백 = 로고 너비의 25%. @@ -79,7 +79,7 @@ GitHub README 의 shield.io badge 는 위 hex 사용 권장. ```markdown

- keiailab + keiailab

# valkey-operator @@ -87,7 +87,7 @@ GitHub README 의 shield.io badge 는 위 hex 사용 권장. > **MIT-licensed Valkey Operator for Kubernetes — Standalone + Cluster + Backup/Restore, BSD-3 license-clean**

- License + License

diff --git a/docs/i18n/zh/BRANDING.md b/docs/i18n/zh/BRANDING.md index b44bc95..1e8b2a9 100644 --- a/docs/i18n/zh/BRANDING.md +++ b/docs/i18n/zh/BRANDING.md @@ -21,11 +21,11 @@ | 资源 | URL | 用途 | |---|---|---| -| Primary logo (SVG) | `https://keiailab.com/assets/logo.svg` | README header、幻灯片 | -| Mono mark | `https://keiailab.com/assets/mark.svg` | Favicon、社交卡片 | -| Wordmark | `https://keiailab.com/assets/wordmark.svg` | 页脚、深色背景 | +| Current primary logo | `docs/branding/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**: README 顶部居中,宽度 120px。始终链接到 https://keiailab.com。 +**Logo placement**: README 顶部居中,宽度 96px。始终链接到 https://keiailab.com。 **Clear space**: Logo 周围最小留白 = logo 宽度的 25%。 @@ -77,7 +77,7 @@ GitHub README 的 shield.io badge 建议使用上述 hex。 ```markdown

- keiailab + keiailab

# valkey-operator @@ -85,7 +85,7 @@ GitHub README 的 shield.io badge 建议使用上述 hex。 > **MIT-licensed Valkey Operator for Kubernetes — Standalone + Cluster + Backup/Restore, BSD-3 license-clean**

- License + License