Skip to content

docs(integration): Cortex, Flux, Vitess guides + Cloud Native category - #160

Merged
majinghe merged 3 commits into
rustfs:mainfrom
majinghe:docs/cortex-flux-vitess-batch
Sep 23, 2026
Merged

majinghe merged 3 commits into
rustfs:mainfrom
majinghe:docs/cortex-flux-vitess-batch

Conversation

@majinghe

Copy link
Copy Markdown
Collaborator

Summary

  • Add three new RustFS integration guides in all five locales (en/zh/de/fr/ja), each verified end-to-end against RustFS v2.3.1:
    • developer/integration/cloud-native/cortex.md — Cortex v1.21.1 single-binary with TSDB blocks, ruler, and alertmanager storage on a RustFS bucket (bucket_name + bucket_lookup_type: path); verified via Prometheus remote write, ruler API, query read-back, and block objects (chunks/index/meta.json) in the bucket.
    • developer/integration/cloud-native/flux.md — Flux CD v2.9.5 Bucket source (generic provider, path-style, plain HTTP) pulling Kubernetes manifests from RustFS on k3s; verified by a Kustomization applying a ConfigMap sourced from the bucket.
    • developer/integration/big-data/vitess.md — Vitess S3 backup storage (--backup-storage-implementation s3 + --s3-backup-* flags) uploading a vtctldclient Backup to RustFS; verified via 155 uploaded objects, MANIFEST presence, and GetBackups read-back.
  • New developer/integration/cloud-native/ category (index + meta.json, all locales; ja title "クラウドネイティブ").
  • Update integration and big-data category indexes and meta.json navigation in all locales.
  • Screenshots: zh-locale console shots in zh docs, English shots in en/de/fr/ja.

Notes

Six of the nine requested products were evaluated as not integrable and skipped, per the skip rule:

  • CubeFS / Rook / TiKV: storage systems or orchestrators that expose storage themselves (local-disk backed) and have no mode to consume an external S3-compatible backend.
  • Prometheus: TSDB is local-disk only; S3 block shipping requires Thanos/Cortex/Mimir — Thanos is already documented in the observability category.
  • Artifact Hub: stores all data in PostgreSQL plus local volumes; no S3 backend option.
  • Argo CD: application sources support Git/Helm/OCI/Directory only; Flux's Bucket source covers the S3-driven GitOps flow (documented here).

Documented real pitfalls: Cortex field names (bucket_name, bucket_lookup_type — no force_path_style) and small block_ranges_period for fast block shipping; Flux requires lowercase accesskey/secretkey secret keys and a pod-reachable endpoint; Vitess refuses backups when connection params bypass my.cnf loading, needs --service-map grpc-vtctl,grpc-vtctld, cell registration before tablet start, and dash-style flags on Vitess 20+.

Validation

  • node .agents/skills/localize-rustfs-docs/scripts/audit-locales.mjs --locales zh,de,fr,ja — only expected findings (de/fr/ja English-copy notices consistent with 392 existing ones; no violations on new integration files)
  • npm run docs:check — OK (7/7 checks, 800 pages)
  • npm run build — OK (3215 files generated)
  • All three integrations verified on a live RustFS v2.3.1 instance before writing docs.

majinghe and others added 2 commits September 22, 2026 10:23
…w AI category

- New guides (en/zh/de/fr/ja): big-data/lakefs, big-data/hudi, ai/ray, backup/velero, backup/kopia
- New AI category under developer/integration (index + meta, all locales)
- Update integration/backup/big-data category indexes and meta.json navigation
- Add verified screenshots (zh shots in zh docs, EN shots in other locales)
…ategory

- New guides (en/zh/de/fr/ja): cloud-native/cortex, cloud-native/flux, big-data/vitess
- New Cloud Native category under developer/integration (index + meta, all locales)
- Update integration/big-data category indexes and meta.json navigation in all locales
- Add verified screenshots (zh shots in zh docs, EN shots in other locales)
@vercel

vercel Bot commented Sep 23, 2026

Copy link
Copy Markdown

@majinghe is attempting to deploy a commit to the overtrue's projects Team on Vercel.

A member of the Team first needs to authorize it.

@majinghe
majinghe merged commit 3b5a44e into rustfs:main Sep 23, 2026
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant