Skip to content

refactor(aisix-cp): rename chart aisix-cloud → aisix-cp; default to public images#301

Merged
nic-6443 merged 2 commits into
mainfrom
chore/rename-chart-aisix-cp
Jun 23, 2026
Merged

refactor(aisix-cp): rename chart aisix-cloud → aisix-cp; default to public images#301
nic-6443 merged 2 commits into
mainfrom
chore/rename-chart-aisix-cp

Conversation

@jarvis9443

@jarvis9443 jarvis9443 commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Rename

The chart is the private / self-hosted control-plane deployment, so it shouldn't be branded "cloud". Renames it to aisix-cp to match the aisix-cp-* image names:

  • charts/aisix-cloud/charts/aisix-cp/
  • Chart.yaml name aisix-cloudaisix-cp, description "AISIX-Cloud control plane" → "AISIX control plane"
  • all template helper prefixes aisix-cloud.*aisix-cp.* (fullname, labels, secret names, DSN helpers, …)
  • regenerated README.md, updated the ct lint path in ci.yaml, and the AGENTS.md table row

Resource names become aisix-cp, aisix-cp-api, aisix-cp-dpm, aisix-cp-ui, aisix-cp-postgresql, aisix-cp-secrets.

Public images

Also default the component images to docker.io/api7 instead of ghcr.io/api7. The ghcr images are private (not publicly pullable), so a self-hosted install couldn't pull them; the Docker Hub mirror is public and is the intended source for private deployments. api.dpImage default and the NOTES snippet follow suit.

Verification

Installed the renamed chart on a kind cluster — public images pulled, all four pods (postgres/api/dpm/ui) healthy — and walked the dashboard main flow end to end (signup, organization, environment, OpenRouter provider key, model, API key), all persisted in the database.

chart-releaser will publish aisix-cp-0.1.0 to charts.api7.ai on merge. The previously published aisix-cloud-0.1.0 stays in the index (no consumers yet).

Summary by CodeRabbit

  • New Features

    • Introduced the new aisix-cp Helm chart for AISIX control plane deployment with updated documentation and service configurations.
  • Chores

    • Migrated container image repositories from GitHub Container Registry to Docker Hub for improved accessibility.
    • Updated CI/CD and documentation to reference the new chart structure.

…public images

The chart is the private/self-hosted control-plane deployment, so it
should not be branded "cloud" — rename it to aisix-cp to match the
aisix-cp-* image names. Renames the chart directory, Chart name, all
template helper prefixes (aisix-cloud.* -> aisix-cp.*), labels, secret
names, README, ct-lint path, and the AGENTS entry.

Also default the component images to docker.io/api7 instead of
ghcr.io/api7. The ghcr images are private (not publicly pullable), so a
self-hosted install could not pull them; the Docker Hub mirror is public
and is the intended source for private deployments.

Verified by installing the renamed chart on a kind cluster (public
images pulled, all four pods healthy) and walking the dashboard main
flow end to end (org, environment, provider key, model, API key).
@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c55fba87-4696-4637-8c84-97c111b2f5b3

📥 Commits

Reviewing files that changed from the base of the PR and between 40b9c46 and 5075f30.

⛔ Files ignored due to path filters (1)
  • charts/aisix-cp/Chart.lock is excluded by !**/*.lock
📒 Files selected for processing (20)
  • .github/workflows/ci.yaml
  • AGENTS.md
  • charts/aisix-cloud/templates/api-service.yaml
  • charts/aisix-cloud/templates/ui-service.yaml
  • charts/aisix-cp/.helmignore
  • charts/aisix-cp/Chart.yaml
  • charts/aisix-cp/README.md
  • charts/aisix-cp/charts/postgresql-12.12.10.tgz
  • charts/aisix-cp/templates/NOTES.txt
  • charts/aisix-cp/templates/_helpers.tpl
  • charts/aisix-cp/templates/api-deployment.yaml
  • charts/aisix-cp/templates/api-service.yaml
  • charts/aisix-cp/templates/dpm-deployment.yaml
  • charts/aisix-cp/templates/dpm-service.yaml
  • charts/aisix-cp/templates/external-db-secret.yaml
  • charts/aisix-cp/templates/secret.yaml
  • charts/aisix-cp/templates/serviceaccount.yaml
  • charts/aisix-cp/templates/ui-deployment.yaml
  • charts/aisix-cp/templates/ui-service.yaml
  • charts/aisix-cp/values.yaml
💤 Files with no reviewable changes (2)
  • charts/aisix-cloud/templates/ui-service.yaml
  • charts/aisix-cloud/templates/api-service.yaml

📝 Walkthrough

Walkthrough

The aisix-cloud Helm chart is renamed to aisix-cp. All template helpers, deployment/service/secret/serviceaccount templates, chart metadata, values, CI lint target, and documentation are updated to use aisix-cp naming. Image registries for all components are changed from ghcr.io/api7 to docker.io/api7. New api-service.yaml and ui-service.yaml templates are added to charts/aisix-cp.

Changes

aisix-cloud → aisix-cp Helm Chart Rename

Layer / File(s) Summary
Chart metadata, CI lint target, and docs
charts/aisix-cp/Chart.yaml, .github/workflows/ci.yaml, AGENTS.md
Chart name and description updated to aisix-cp; CI ct lint target changed from charts/aisix-cloud to charts/aisix-cp; AGENTS.md chart table entry updated.
Helper template namespace migration
charts/aisix-cp/templates/_helpers.tpl
All Helm helper definitions renamed from aisix-cloud.* to aisix-cp.*, covering naming, labels, PostgreSQL connection helpers, secret name helpers, service account, image pull secrets, and the pgWaitInitContainer init container.
Secret and ServiceAccount template migration
charts/aisix-cp/templates/secret.yaml, charts/aisix-cp/templates/external-db-secret.yaml, charts/aisix-cp/templates/serviceaccount.yaml
metadata.name and metadata.labels updated to use aisix-cp.* helper includes; no structural or logic changes.
Deployment templates migration (api, dpm, ui)
charts/aisix-cp/templates/api-deployment.yaml, charts/aisix-cp/templates/dpm-deployment.yaml, charts/aisix-cp/templates/ui-deployment.yaml
All three deployments updated to use aisix-cp.* helpers for naming, labels, pod spec wiring, and secret env var refs. Default DP image registry changed from ghcr.io/api7/aisix to docker.io/api7/aisix in api-deployment.
Service templates: migration and new api/ui services
charts/aisix-cp/templates/dpm-service.yaml, charts/aisix-cp/templates/api-service.yaml, charts/aisix-cp/templates/ui-service.yaml
dpm-service updated to aisix-cp.* helpers; new api-service.yaml and ui-service.yaml templates added, replacing the deleted charts/aisix-cloud equivalents.
Values, README, and NOTES: registry and naming updates
charts/aisix-cp/values.yaml, charts/aisix-cp/README.md, charts/aisix-cp/templates/NOTES.txt
Image repositories for api, dpm, and ui switched from ghcr.io/api7 to docker.io/api7; postgresql password comment updated to recommend openssl rand -hex 24; README and NOTES.txt updated for aisix-cp naming and docker.io registries.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • api7/api7-helm-chart#298: Directly scaffolded the original aisix-cloud chart structure (including api-service.yaml, ui-service.yaml, and _helpers.tpl with aisix-cloud.* helpers) that this PR renames and migrates to aisix-cp.

Suggested reviewers

  • nic-6443
🚥 Pre-merge checks | ✅ 5 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
E2e Test Quality Review ❓ Inconclusive Custom check "E2E Test Quality Review" is inapplicable: PR contains zero test code. This is a Helm chart rename/registry update PR (aisix-cloud→aisix-cp), not a test implementation PR. Check expect... Check is not applicable to this PR type. Review should focus on Helm chart correctness, template consistency, and configuration validation instead of E2E test quality criteria.
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the two main changes: renaming the Helm chart from aisix-cloud to aisix-cp and switching default image registries from private to public.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Security Check ✅ Passed Security review of Helm chart rename PR (aisix-cloud→aisix-cp) found no vulnerabilities. All secrets are properly stored in Kubernetes Secrets (base64-encoded), database passwords use secretKeyRef...

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/rename-chart-aisix-cp

Comment @coderabbitai help to get the list of available commands.

@nic-6443 nic-6443 merged commit 0581107 into main Jun 23, 2026
3 checks passed
@nic-6443 nic-6443 deleted the chore/rename-chart-aisix-cp branch June 23, 2026 12:09
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.

2 participants