Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

feature: Secure your fleet, NGINX One#731

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
mjang wants to merge3 commits intomain
base:main
Choose a base branch
Loading
fromsecure-your-fleet-r3

Conversation

mjang
Copy link
Contributor

Proposed changes

Create end-to-end "use-case" documentation for admins / security engineers who want to use NGINX One Console to "Secure your fleet".

Fleets of NGINX deployments frequently include dozens and many more instances. With this use case, an admin/security engineer can set up the NGINX One Console to send them alerts for appropriate issues. Today, those issues include CVEs and other detected security "misconfigurations" identified by NGINX One Console.

This use case goes somewhat beyond NGINX One Console. This PR removes roadblocks to success in the following ways:

  • It clarifies what users need to access the NGINX One Console, specifically with:

    • Supporting checks of appropriate licenses
    • Describing the detailed process of setting up a tenant
  • It then shows users, step by step, how to set up notifications when one/more of their instances have CVEs and other detected security issues.

Replaces#637

Checklist

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

  • I have read thecontributing guidelines
  • I have signed theF5 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 toConventional Commits
  • I have ensured that documentation content adheres tothe 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 updatedREADME.md andCHANGELOG.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 toour style guide for guidance about placeholder content.

@mjangmjang self-assigned thisJun 23, 2025
@mjangmjang requested review froma team ascode ownersJune 23, 2025 14:11
@github-actionsgithub-actionsbot added documentationImprovements or additions to documentation product/nginx-oneNGINX One Console labelsJun 23, 2025
@github-actionsGitHub Actions
Copy link

Deploy Preview will be available once build job completes!

NameLink
😎 Deploy Previewhttps://frontdoor-test-docs.nginx.com/previews/docs/731/

Copy link
Contributor

@ADubhlaoichADubhlaoich left a comment
edited
Loading

Choose a reason for hiding this comment

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

LGTM. Small LOGAF non-blocking edit suggestions.

If the PR replaces#637, then that should probably be closed.

@mjangmjang mentioned this pull requestJun 23, 2025
10 tasks
@jputrino
Copy link
Contributor

I find the order in which the docs are presented confusing. Is "Manage your fleet" really before "Get started"? Shouldn't "Manage your instances" include items like Connect your instances and Draft configurations?

I could see 3 top-level headings on the landing page: Get started, Secure your fleet, and Manage your fleet. Or maybe 4, if we also add one for Admin tasks (like RBAC, metrics, etc.).

@mjang
Copy link
ContributorAuthor

I find the order in which the docs are presented confusing. Is "Manage your fleet" really before "Get started"? Shouldn't "Manage your instances" include items like Connect your instances and Draft configurations?

I could see 3 top-level headings on the landing page: Get started, Secure your fleet, and Manage your fleet. Or maybe 4, if we also add one for Admin tasks (like RBAC, metrics, etc.).

Will be addressed in an internal issue (num-200 in internal-docs repo)

@mjangmjangforce-pushed thesecure-your-fleet-r3 branch from2caef64 to7152a0dCompareJuly 2, 2025 16:52
@mjangmjang requested a review froma team as acode ownerJuly 2, 2025 16:52
@github-actionsgithub-actionsbot added product/nimNGINX Instance Manager product/ngfIssues related to NGINX Gateway Fabric product/agentNGINX Agent toolingBack end, repository, Hugo, and all things not related to content product/controllerNGINX Controller (EOS product) product/meshNGINX Service Mesh (EOS product) labelsJul 2, 2025
@mjang
Copy link
ContributorAuthor

If that change doesn't get in, then we need to rewrite the adding alerts part of configure alert policy to something like this:

  • Enable 'Show Advanced Fields'
  • Choose Matching RegEx of Alertname
  • Type in [name of CVE alert/security recommendation alert]

image (20)

@mjangmjang mentioned this pull requestJul 9, 2025
10 tasks
@mjangmjangforce-pushed thesecure-your-fleet-r3 branch 3 times, most recently from2f9fbfe tocb81103CompareJuly 15, 2025 18:17
nd-product: NGINX One
---

With this page, you'll learn how to set up alerts in F5 Distributed Cloud. Once configured, you'll see the CVEs and insecure configurations associated with your NGINX fleet. These instructions are intended for those responsible for keeping their NGINX infrastructure and application traffic secure. It assumes you know how to:
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we spell out CVE on first mention? Or is this a well-known domain acronym?

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

Maybe I have the "curse of knowledge" on this one. It's not spelled out in the UI. You're welcome to say "that's not good enough".

Screenshot 2025-07-16 at 7 14 36 AM

@mjang
Copy link
ContributorAuthor

@travisamartin thank you for the detailed review. I've accepted all but 2 of your suggestions.

@mjangmjangforce-pushed thesecure-your-fleet-r3 branch fromd50497a to495246fCompareJuly 17, 2025 14:37
This commit adds a new landing page archetype, which has theability to display various cards to highlight specific items. Thearchetype includes inline guidance like other archetypes, includingexplanations of new frontmatter parameters and a new card shortcode.---------Co-authored-by: Mike Jang <3287976+mjang@users.noreply.github.com>Co-authored-by: Alan Dooley <a.dooley@f5.com>Co-authored-by: Alan Dooley <a.dooley@f5.com>Co-authored-by: Travis Martin <33876974+travisamartin@users.noreply.github.com>
@mjangmjangforce-pushed thesecure-your-fleet-r3 branch from40b4b3d to783a943CompareJuly 18, 2025 14:25
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@travisamartintravisamartintravisamartin left review comments

@jasonclopperjasonclopperjasonclopper left review comments

@ADubhlaoichADubhlaoichADubhlaoich approved these changes

@y82y82y82 approved these changes

At least 2 approving reviews are required to merge this pull request.

Assignees

@mjangmjang

Labels
documentationImprovements or additions to documentationproduct/agentNGINX Agentproduct/controllerNGINX Controller (EOS product)product/meshNGINX Service Mesh (EOS product)product/ngfIssues related to NGINX Gateway Fabricproduct/nginx-oneNGINX One Consoleproduct/nimNGINX Instance ManagertoolingBack end, repository, Hugo, and all things not related to content
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

6 participants
@mjang@jputrino@ADubhlaoich@y82@travisamartin@jasonclopper

[8]ページ先頭

©2009-2025 Movatter.jp