Skip to content

docs(deploy): document CTK v2 feature switches in README - #896

Merged
janzak-dev merged 3 commits into
mainfrom
docs/ctk-v2-feature-switches
Sep 17, 2026
Merged

janzak-dev merged 3 commits into
mainfrom
docs/ctk-v2-feature-switches

Conversation

@janzak-dev

Copy link
Copy Markdown
Collaborator

Summary

Document optional feature switch variables in the Cluster Toolkit v2 deployment README.

Motivation & Context

Cluster Toolkit v2 supports multiple modular deployment feature switches (dashboard_service_deployment_enabled, rod_deployment_enabled, enable_metrics). Clarifying these options in deploy/ctk_v2/README.md helps operators configure only the required microservices during provisioning.

Key Changes

  • Document dashboard_service_deployment_enabled flag (provisions Dashboard Service microservice for custom chart/dashboard visualizations).
  • Document rod_deployment_enabled flag (provisions Resource Optimization & Diagnostics Data Provider).
  • Refine description of enable_metrics to clarify microservices provisioned (Ingestion Gateway and Ingestion Services).

Assumptions

None — requirements were fully specified.

Verification & Testing

  • Commands Executed:
    • python3 ./tools/analyze_diff_size.py --base-ref origin/main... (0 code lines, passed)
    • ./.githooks/pre-commit (all linters passed)
  • Coverage & Test Status: Documentation-only change, pre-commit formatting and linters verified.

Related Issues / Bugs

N/A

TAG=agy
CONV=acf882de-1561-404c-ba2e-ae0940451165

Document `dashboard_service_deployment_enabled` and `rod_deployment_enabled` feature switch flags in Cluster Toolkit v2 README, and clarify microservices provisioned under `enable_metrics`.

TAG=agy

CONV=acf882de-1561-404c-ba2e-ae0940451165

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request updates the deploy/ctk_v2/README.md file to include new feature switches for the Dashboard Service and the Resource Optimization & Diagnostics (ROD) Data Provider, while also updating the description for the enable_metrics flag. The reviewer identified a potential discrepancy in the documentation regarding 'Ingestion Services' and requested clarification to ensure it accurately reflects the existing Helm values.

Comment thread deploy/ctk_v2/README.md Resolved
…CTK v2 README

Update `enable_metrics` description in deploy/ctk_v2/README.md to refer
specifically to the Ingestion Gateway microservice per review feedback.

TAG=agy
CONV=acf882de-1561-404c-ba2e-ae0940451165
…in CTK v2 README

Clarify that full metrics dashboard and chart visualization functionality
requires both `enable_metrics` (for metrics ingestion) and
`dashboard_service_deployment_enabled` (for dashboard backend & UI) to be enabled.

TAG=agy
CONV=acf882de-1561-404c-ba2e-ae0940451165
@janzak-dev
janzak-dev marked this pull request as ready for review September 17, 2026 09:24
@janzak-dev janzak-dev added the priority::2-high top of mind. should not wait. label Sep 17, 2026
@janzak-dev
janzak-dev added this pull request to the merge queue Sep 17, 2026
Merged via the queue into main with commit 5f1256b Sep 17, 2026
12 checks passed
@janzak-dev
janzak-dev deleted the docs/ctk-v2-feature-switches branch September 17, 2026 10:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority::2-high top of mind. should not wait.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants