Repository navigation
docs(deploy): document CTK v2 feature switches in README - #896
Merged
Merged
Conversation
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
There was a problem hiding this comment.
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.
…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
andrzejfudro
approved these changes
Sep 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 indeploy/ctk_v2/README.mdhelps operators configure only the required microservices during provisioning.Key Changes
dashboard_service_deployment_enabledflag (provisions Dashboard Service microservice for custom chart/dashboard visualizations).rod_deployment_enabledflag (provisions Resource Optimization & Diagnostics Data Provider).enable_metricsto clarify microservices provisioned (Ingestion Gateway and Ingestion Services).Assumptions
None — requirements were fully specified.
Verification & Testing
python3 ./tools/analyze_diff_size.py --base-ref origin/main...(0 code lines, passed)./.githooks/pre-commit(all linters passed)Related Issues / Bugs
N/A
TAG=agy
CONV=acf882de-1561-404c-ba2e-ae0940451165