Skip to content

docs: define AISIX OSS and shared gateway terminology - #1290

Merged
kayx23 merged 9 commits into
mainfrom
docs/aisix-product-taxonomy
Oct 14, 2026
Merged

kayx23 merged 9 commits into
mainfrom
docs/aisix-product-taxonomy

Conversation

@kayx23

@kayx23 kayx23 commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • rename the open-source product to AISIX OSS in current public documentation, API descriptions, configuration comments, and architecture assets
  • distinguish AISIX OSS from AISIX Enterprise and AISIX Cloud, while documenting that all three use the same gateway runtime
  • preserve compatibility-sensitive runtime modes, environment variables, image names, routes, repository names, and example domains
  • correct the product comparison table’s API names, tenancy model, and provider-key storage behavior
  • classify roadmap items explicitly by product instead of using the former Cloud umbrella

Coordination

This is part of the cross-repository AISIX taxonomy update tracked in api7/docs#2633. The corresponding docs IA and deployment changes are integrated into api7/docs#2629.

Validation

  • cargo fmt --all --check
  • cargo test -p aisix-admin --lib (79 passed, 1 ignored)
  • cargo test -p aisix-obs --lib (341 passed, 5 ignored)
  • Admin OpenAPI generation and assertions
  • SVG XML validation
  • git diff --check
  • independent source verification

Refs api7/docs#2633

Summary by CodeRabbit

  • Documentation
    • Updated product terminology across guides, configuration references, and API descriptions to distinguish AISIX OSS, AISIX Enterprise, and AISIX Cloud.
    • Clarified product differences, including control-plane ownership, gateway traffic handling, and product-specific capabilities.
    • Updated managed-mode guidance to cover connections to AISIX Enterprise or AISIX Cloud.
    • Revised release guidance to clarify image and package publishing requirements, and updated the README and roadmap to reflect product availability and where to configure gateways connected to commercial control planes.

Copilot AI balanced review requested due to automatic review settings October 14, 2026 04:50

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@coderabbitai

coderabbitai Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 790e3c94-c101-4709-8a72-0b2ed54c7f6d
📥 Commits

Reviewing files that changed from the base of the PR and between 09e82bf and d470793.

⛔ Files ignored due to path filters: 1
  • assets/aisix-architecture.svg is excluded by !**/*.svg
📒 Files selected for processing: 6
  • .github/workflows/docker-image.yml
  • CLAUDE.md
  • Dockerfile
  • README.md
  • RELEASING.md
  • crates/aisix-server/src/main.rs
🚧 Files skipped from review as they are similar to previous changes: 4
  • crates/aisix-server/src/main.rs
  • Dockerfile
  • CLAUDE.md
  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.

📝 Walkthrough

This PR updates product terminology across documentation, configuration comments, release guidance, and API references. It describes AISIX OSS, AISIX Enterprise, and AISIX Cloud as separate products and updates descriptions of their control planes and product availability.

Changes: Product naming and availability

Layer / File(s) Summary
Product definitions and availability
README.md, CLAUDE.md, ROADMAP.md
The README and terminology guidance describe AISIX OSS, AISIX Enterprise, and AISIX Cloud. The roadmap assigns planned capabilities to products.
Managed-mode and control-plane references
Dockerfile, config.example.yaml, config.managed.yaml, crates/aisix-core/src/config.rs, docker/entrypoint.sh, crates/aisix-obs/src/metric_labels.rs, crates/aisix-core/src/models/*, crates/aisix-proxy/src/auth.rs, crates/aisix-server/src/main.rs, .github/workflows/docker-image.yml
Comments and image metadata use updated product names and control-plane descriptions. Configuration values and runtime behavior are unchanged.
Release and API references
RELEASING.md, crates/aisix-admin/src/bin/dump-openapi.rs, crates/aisix-admin/src/openapi.rs, schemas/README.md
Release guidance describes package dispatch, image manifest checks, and tag-pointer behavior. API descriptions and schema documentation use updated product and API names.

Priority: ➖ Normal

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested reviewers: jarvis9443

Merge Risk: ⚪ Minimal · up to d4707

This change updates product naming and release guidance in documentation, comments, and descriptions. It does not change runtime behavior, so merge risk is minimal.

Pre-merge checks: Passed 6
Passed Passed checks: 6 passed
Check name Status Explanation
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.
E2e Test Quality Review Passed The PR changes documentation, comments, OpenAPI descriptions, CLI text, OCI metadata, and an SVG label. It does not change business logic, data flow, error handling, concurrency, or test code. No E2E …
Security Check Passed No security issue was introduced by this documentation and terminology PR. The authoritative diff changes comments, documentation strings, product text, SVG labels, and an OCI description; it does not…
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main documentation change: defining AISIX OSS and shared gateway terminology across the project.
✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@kayx23 kayx23 changed the title docs: establish AISIX OSS product identity docs: define AISIX OSS and shared gateway terminology Oct 14, 2026
@kayx23
kayx23 merged commit cde634f into main Oct 14, 2026
16 checks passed
@kayx23
kayx23 deleted the docs/aisix-product-taxonomy branch October 14, 2026 09:11
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