Skip to content

Update changelog.md #629

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update changelog.md #629

wants to merge 2 commits into from

Conversation

achawla2012
Copy link
Contributor

Add change log for alerting on config recommendation on instance and csg

Proposed changes

Problem: NGINX One is intaking metrics from customer's data planes that can indicate large negative outcomes. Such as , NGINX One checks for config recommendation impacts. All of this information is extremely valuable, but only if the customer is aware of it in a timely enough fashion to take action.

Solution: If user's data-path has config recommendaations, we proactively notify, so that use can take action to remedy.

Testing: Instances/Csgs in F5 NGINX One console, and is alerted on config recommendations.

Solution: Explain the approach you took to implement the solution, highlighting any significant design decisions or
considerations.

Testing: Describe any testing that you did.

Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.

If this PR addresses an issue on GitHub, ensure that you link to it here:

Closes #ISSUE

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • [] I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content.

Add change log for alerting on config recommendation on instance and csg
@achawla2012 achawla2012 requested a review from a team as a code owner May 29, 2025 20:48
@github-actions github-actions bot added documentation Improvements or additions to documentation product/nginx-one NGINX One Console labels May 29, 2025
Copy link

github-actions bot commented May 29, 2025

🎉 Thank you for your contribution! It appears you have not yet signed the F5 Contributor License Agreement (CLA), which is required for your changes to be incorporated into an F5 Open Source Software (OSS) project. Please kindly read the F5 CLA and reply on a new comment with the following text to agree:


I have hereby read the F5 CLA and agree to its terms


You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

Copy link
Contributor

@mjang mjang left a comment

Choose a reason for hiding this comment

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

Let's wait until the alerts are available on the linked page

Comment on lines +33 to +42
## May 30, 2025

### Alert when instance has config recommendations

We now include an alert in the [F5 Distributed Cloud](https://docs.cloud.f5.com/docs-v2/platform/reference/alerts-reference) when instance has config recommendation.

### Alert when csg has config recommendations

We now include an alert in the [F5 Distributed Cloud](https://docs.cloud.f5.com/docs-v2/platform/reference/alerts-reference) when csg has config recommendation.

Copy link
Contributor

Choose a reason for hiding this comment

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

We'll keep on hold for now, until the alerts are ready. For editing:

Suggested change
## May 30, 2025
### Alert when instance has config recommendations
We now include an alert in the [F5 Distributed Cloud](https://docs.cloud.f5.com/docs-v2/platform/reference/alerts-reference) when instance has config recommendation.
### Alert when csg has config recommendations
We now include an alert in the [F5 Distributed Cloud](https://docs.cloud.f5.com/docs-v2/platform/reference/alerts-reference) when csg has config recommendation.
<!-- Date TBD -->
## Month, Day, 2025
### Alert for recommendations on an instance
We now include an alert in the [F5 Distributed Cloud](https://docs.cloud.f5.com/docs-v2/platform/reference/alerts-reference) when NGINX One Console has recommendations for your instance configuration.
### Alert for recommendations on a Config Sync Group
We now include an alert in the [F5 Distributed Cloud](https://docs.cloud.f5.com/docs-v2/platform/reference/alerts-reference) when NGINX One Console has recommendations for your Config Sync Group.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation product/nginx-one NGINX One Console
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants