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
29 changes: 25 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,31 @@
<p align="center">
<a href="https://keiailab.com">
<img src="docs/branding/symbol.png" alt="keiailab" width="96"/>
</a>
</p>

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

<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-00ADD8?logo=go&logoColor=white" alt="Go 1.26"/></a>
<a href="https://valkey.io/"><img src="https://img.shields.io/badge/Valkey-8%2B-6979DC?logo=redis&logoColor=white" alt="Valkey 8+"/></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/valkey-operator/pkgs/container/valkey-operator"><img src="https://img.shields.io/badge/GHCR-valkey--operator-0EA5A8?logo=github&logoColor=white" alt="GHCR image"/></a>
<a href="https://github.com/keiailab/valkey-operator/discussions"><img src="https://img.shields.io/github/discussions/keiailab/valkey-operator?label=discussions&logo=github" alt="GitHub Discussions"/></a>
</p>

[![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.

Expand Down
5 changes: 5 additions & 0 deletions charts/valkey-operator/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 11 additions & 0 deletions charts/valkey-operator/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,19 @@
# Valkey Operator Helm Chart

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

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
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 `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.

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/branding/symbol.png" alt="keiailab" width="96"/>
</p>

# valkey-operator

> **MIT-licensed Valkey Operator for Kubernetes — Standalone + Cluster + Backup/Restore, BSD-3 license-clean**

<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
Binary file added docs/branding/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/branding/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/i18n/ja/BRANDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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%。

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/branding/symbol.png" alt="keiailab" width="96"/>
</p>

# valkey-operator

> **MIT-licensed Valkey Operator for Kubernetes — Standalone + Cluster + Backup/Restore, BSD-3 license-clean**

<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/i18n/ko/BRANDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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%.

Expand Down Expand Up @@ -79,15 +79,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/branding/symbol.png" alt="keiailab" width="96"/>
</p>

# valkey-operator

> **MIT-licensed Valkey Operator for Kubernetes — Standalone + Cluster + Backup/Restore, BSD-3 license-clean**

<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/i18n/zh/BRANDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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%。

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/branding/symbol.png" alt="keiailab" width="96"/>
</p>

# valkey-operator

> **MIT-licensed Valkey Operator for Kubernetes — Standalone + Cluster + Backup/Restore, BSD-3 license-clean**

<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
Loading