- Notifications
You must be signed in to change notification settings - Fork100
Epic 472 port nginx one labs#681
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
base:main
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Conversation
✅ Deploy Preview will be available once build job completes!
|
content/nginx-one/workshops/lab2/run-workshop-components-with-docker.md OutdatedShow resolvedHide resolved
Uh oh!
There was an error while loading.Please reload this page.
content/nginx-one/workshops/lab3/explore-nginx-one-console-and-features.md OutdatedShow resolvedHide resolved
Uh oh!
There was an error while loading.Please reload this page.
content/nginx-one/workshops/lab3/explore-nginx-one-console-and-features.md OutdatedShow resolvedHide resolved
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
static/workshops/nginx-one/lab2/nginx-oss/etc/nginx/conf.d/stub_status.conf OutdatedShow resolvedHide resolved
Uh oh!
There was an error while loading.Please reload this page.
static/workshops/nginx-one/lab2/nginx-oss/etc/nginx/conf.d/tls-cars.example.com.conf OutdatedShow resolvedHide resolved
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
* Ported lab 5
…entation into epic-472-port-nginx-one-labs
edits from tech reviewCo-authored-by: yar <y82@users.noreply.github.com>
675aa73 to9bc04c0Compare…entation into epic-472-port-nginx-one-labs
| @@ -0,0 +1,18 @@ | |||
| --- | |||
| docs: | |||
| files: | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Note to self: add file references here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Review in progress
| {{<card-layout>}} | ||
| {{<card-section showAsCards="true">}} | ||
| {{<card title="NGINX One Console workshops" titleUrl="/nginx-one/workshops/" icon="wrench" >}} | ||
| Learn how to register and manage NGINX instances in NGINX One Console. View CVE and configuration recommendations. Use Config Sync Groups to deploy JWT licenses and upgrade to the latest NGINX Plus. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Is there a way to set this up with bullets?
- Alternatively, I'm tempted to set up different cards for the "unique" use cases
- We already cover your first sentence in "Manage your NGINX instances"
- Use case: "Review CVEs and our recommended config changes"
- Use case: "Manage groups of instances (Config Sync Groups) to update licenses and upgrade systems with one command"
| - An F5 Distributed Cloud (XC) account | ||
| - NGINX One service enabled in your account |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
You might be able to use these includes:
nginx-one/cloud-access.md
nginx-one/cloud-access-nginx.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
If enabling NGINX One is a separate step, I might need to update cloud-access-nginx.md
| - Manage all your NGINX instances from one place | ||
| - Monitor performance and health metrics | ||
| - Catch security risks like expired SSL certificates and known vulnerabilities | ||
| - Keep track of software versions and get performance tips |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I'd be tempted to add links, but that's a "stretch" goal IMO
| - Use public Docker images of NGINX Open source that already include NGINX Agent | ||
| - Use NGINX Plus containers with NGINX Agent preinstalled | ||
| - Install manually using package managers like `apt` or `yum` | ||
| - Use the one-line curl command that NGINX One provides during registration | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I think I'd like some links to examples
| ## Open and use NGINX One Console | ||
| 1. Go to [https://console.ves.volterra.io/login/start](https://console.ves.volterra.io/login/start). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
When I go to this URL, I get the following screen. We're referring todomain as a tenant
In cloud-access.md, I'm using:
"Navigate tohttps://INSERT_YOUR_TENANT_NAME.console.ves.volterra.io/ to access F5 Distributed Cloud."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Related -- we're about ready to release#731 (Once XC makes theirJune release, maybe on July 14)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This PR may be step 1. I see no showstoppers in this PR. I've made a number of suggestions. If you agree with them and want to move to the next task, I'm good if you want to "save them for later".
| ## Open and use NGINX One Console | ||
| 1. Go to [https://console.ves.volterra.io/login/start](https://console.ves.volterra.io/login/start). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Related -- we're about ready to release#731 (Once XC makes theirJune release, maybe on July 14)
| --- | ||
| ## Create and save a data plane key |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Future issue: we may be able to set up more common content
| By the end of this tutorial, you’ll know how to: | ||
| - Navigate the Overview Dashboard panels |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Comment only. Today I realize,
. it is Overview Dashboard
| ## Next steps | ||
| Go to [Lab 4: Config Sync Groups]({{< ref "nginx-one/workshops/lab4/config-sync-groups.md" >}}) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I like what was done with the previous labs, which intro'd the next lab as <some use case>. Maybe we can do something similar here? Brainstorm idea only:
"Now you're ready to learn how you can modify groups of NGINX instances with one click."
| ## Overview | ||
| In this lab, you create and manage Config Sync Groups in NGINX One Console. Config Sync Groups keep your NGINX instances in sync with a shared configuration. You learn to create a group, add instances, apply a shared config, and fix sync errors. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
(maybe for the future)... I tried something, and it feels wordy:
With a Config Sync Group, you can manage multiple NGINX instances as if they were a single system. For example, you may want to set up a group of NGINX instances in different geographic zones with the same configuration files. When uo set up a Config Sync Group, when you update one file, you're updating the files of every instance in that group.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I've made a number of suggestions. I've spot checked some of the steps, and they work fine
My suggestions are not mandatory, thoughthis comment bothers me. Maybe the best approach is to change the UI
Proposed changes
Write a clear and concise description that helps reviewers understand the purpose and impact of your changes. Use the
following format:
Problem: Give a brief overview of the problem or feature being addressed.
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 anissue 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.
README.mdandCHANGELOG.mdFootnotes
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.↩