Skip to content

docs: document support.kubecostEmitterEnabled and support.opencostSourceEnabled flags#95

Open
MikeFindsThings wants to merge 1 commit into
kubecost:mainfrom
MikeFindsThings:docs/document-support-flags
Open

docs: document support.kubecostEmitterEnabled and support.opencostSourceEnabled flags#95
MikeFindsThings wants to merge 1 commit into
kubecost:mainfrom
MikeFindsThings:docs/document-support-flags

Conversation

@MikeFindsThings

Copy link
Copy Markdown

Fixes #94

Summary

Added documentation for two previously undocumented support flags that allow users to override automatic Kubecost enablement.

Changes

  • Added @section Support parameters (Advanced) in charts/finops-agent/values.yaml with detailed parameter documentation
  • Added Advanced Configuration section to README.md explaining use cases and examples
  • Documented that setting to "disabled" forces disable, any other value enables

Flags Documented

  • support.kubecostEmitterEnabled - Override automatic Kubecost emitter enablement
  • support.opencostSourceEnabled - Override automatic OpenCost source enablement

Use Cases

These flags are essential for:

  • Cloudability-only deployments
  • Troubleshooting data pipeline issues
  • Migration scenarios requiring gradual enablement/disablement
  • Cost optimization when Kubecost data is not needed

Testing

  • Documentation added to values.yaml follows existing @param format
  • README.md updated with clear examples
  • Commit message follows conventional commits format

…rceEnabled flags

Fixes kubecost#94

Added documentation for two previously undocumented support flags that
allow users to override automatic Kubecost enablement:

- support.kubecostEmitterEnabled
- support.opencostSourceEnabled

Changes:
- Added @section Support parameters in values.yaml with detailed
  parameter documentation
- Added Advanced Configuration section to README.md explaining use cases
- Documented that setting to 'disabled' forces disable, any other value
  enables

These flags are essential for Cloudability-only deployments,
troubleshooting, and migration scenarios.

@thomasvn thomasvn left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good, thanks for documenting @MikeFindsThings!

cc @jessegoodier for awareness. I believe you first introduced this flag in #25

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.

Document undocumented support.kubecostEmitterEnabled and support.opencostSourceEnabled flags

2 participants