Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update aqua.d/conf.yaml example in README for SaaS and On-Prem compatibility #2564

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

devmedcoding
Copy link

  • Updated the aqua.d/conf.yaml example in the README to reflect the configuration changes for compatibility with both Aqua SaaS and On-Prem environments.
  • Added a new auth_type parameter to specify whether the environment is saas or onprem.
  • Updated comments to guide users on using appropriate credentials and URLs based on their deployment type.
  • Included instructions for configuring the api_user and password for On-Prem and api_key and api_secret for SaaS authentication.
  • Clarified the behavior of the integration for both environments and ensured proper tagging guidance.

This update provides clear instructions for configuring the Aqua Datadog integration, reducing confusion for users with different deployment setups.

…ibility

- Updated the `aqua.d/conf.yaml` example in the README to reflect the configuration changes for compatibility with both Aqua SaaS and On-Prem environments.
- Added a new `auth_type` parameter to specify whether the environment is `saas` or `onprem`.
- Updated comments to guide users on using appropriate credentials and URLs based on their deployment type.
- Included instructions for configuring the `api_user` and `password` for On-Prem and `api_key` and `api_secret` for SaaS authentication.
- Clarified the behavior of the integration for both environments and ensured proper tagging guidance.

This update provides clear instructions for configuring the Aqua Datadog integration, reducing confusion for users with different deployment setups.
@devmedcoding devmedcoding requested review from a team as code owners December 11, 2024 22:13
Copy link
Contributor

@brett0000FF brett0000FF left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution! I left a small suggestion for you to consider. I think it might be more clear if we specifically connect the instructions with the config values.

Comment on lines +48 to +49
For SaaS, change the `api_key` and `api_secret` parameter values and configure them for your environment.
For On-Prem, change the `api_user` and `password` parameter values and configure them for your environment.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
For SaaS, change the `api_key` and `api_secret` parameter values and configure them for your environment.
For On-Prem, change the `api_user` and `password` parameter values and configure them for your environment.
For `auth_method: saas`, configure the `api_key` and `api_secret` parameter values for your environment.
For `auth_method: onprem`, configure the `api_user` and `password` parameter values for your environment.

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