generated fromnginx/template-repository
- Notifications
You must be signed in to change notification settings - Fork100
Mkingst tech specs updated#535
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
mkingst wants to merge3 commits intomainChoose a base branch
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Open
Uh oh!
There was an error while loading.Please reload this page.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
✅ Deploy Preview will be available once build job completes!
|
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.
love it,@mkingst .@travisamartin if you have a different review, I'll happily yield.
| @@ -1,7 +1,7 @@ | |||
| --- | |||
| description: '' | |||
| docs: DOCS-1211 | |||
| title: Manually install on a virtual machine or bare metal (deprecated) | |||
| title: Manually install on a virtual machine or bare metal (Manual Method) | |||
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.
It's a little redundant:
Suggested change
| title: Manually install on a virtual machine or bare metal (Manual Method) | |
| title: Manually install on a virtual machine or bare metal |
| @@ -14,7 +14,7 @@ type: | |||
| Follow the steps in this guide to install or upgrade NGINX Instance Manager. | |||
| {{<call-out "caution" "Deprecated documentation notice" "fa fa-exclamation-triangle" >}} | |||
| This document outlines manual stepsthat have been replaced bya simplified script-basedprocess. For most users, we recommend using the updated process documented [here]({{< ref "nim/deploy/vm-bare-metal/install.md" >}}).{{</call-out>}} | |||
| This document outlines manual stepsto install NGINX Instance Manager. There is alsoa simplified script-basedinstallation guide on the other section that we reccommend for faster deployment. For most users, we recommend using the updated process documented [here]({{< ref "nim/deploy/vm-bare-metal/install.md" >}}). If there are issues when running the script, these manual steps may be better suited to specific environments.{{</call-out>}} | |||
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.
Suggested change
| This document outlines manual steps to install NGINX Instance Manager.There is also a simplified script-based installation guide on the other section that we reccommend for faster deployment.For most users, we recommendusing the updatedprocess documented[here]({{< ref "nim/deploy/vm-bare-metal/install.md" >}}). If there are issues when running the script, these manual steps may be better suited to specific environments. {{</call-out>}} | |
| This document outlines manual steps to install NGINX Instance Manager. For most users, we recommendthat you use our script-basedprocess documented[here]({{< ref "nim/deploy/vm-bare-metal/install.md" >}}). If there are issues when running the script, these manual steps may be better suited. {{</call-out>}} |
| #### Directory Requirements for NGINX Instance Manager | ||
| Below are the directory requirements and storage recommendations for fresh, minimal, and moderate usage (<100 instances) of NGINX Instance Manager (NIM). |
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.
Suggested change
| Below arethedirectory requirements and storagerecommendations for fresh, minimal, and moderate usage (<100 instances) of NGINX Instance Manager (NIM). | |
| We recommend that you allocate at leastthefollowing space on the specified directories. Theserecommendations apply for fresh, minimal, and moderate usage (<100 instances) of NGINX Instance Manager (NIM). |
| Below are the directory requirements and storage recommendations for fresh, minimal, and moderate usage (<100 instances) of NGINX Instance Manager (NIM). | ||
| Important Note: These recommendations apply if you are using NGINX Agent to connect NGINX instances to NIM for full management capabilities (e.g., managing configurations, viewing metrics, applying WAF policies, managing certificates, etc.). If the use case is solely usage reporting, as introduced in R33+, the Agent is not required, and resources needed are significantly reduced. For usage reporting-only deployments, NIM simply receives and stores usage data sent directly from the instances, which does not require the same resource allocation outlined below. |
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 presume you're referring to volume requirements for each noted directory
Suggested change
| Important Note:These recommendations apply if you are using NGINX Agent to connect NGINX instances to NIM for full management capabilities (e.g.,managing configurations, viewing metrics, applying WAF policies, managing certificates, etc.). If the use case is solely usage reporting, as introduced in R33+, the Agent is not required, and resources needed are significantly reduced. For usage reporting-only deployments, NIM simply receives and stores usage data sent directly from the instances, which does not require the same resource allocation outlined below. | |
| {{< note >}}These recommendations apply if you are using NGINX Agent to connect NGINX instances to NIM for full management capabilities, such asmanaging configurations, viewing metrics, applying WAF policies,andmanaging certificates. | |
| If the use case is solely usage reporting, as introduced in R33+, you do not need to use NGINX Agent. This significantly reduces required resources. If your deployment is for reporting-only deployments, NIM receives and stores usage data sent directly from the instances, which do not require the same resources outlined here. {{< /note >}} |
| - /var/lib/nms/streaming: Stores NATS streaming messages; recommend 500MB. | ||
| - /var/lib/nms/secrets: Stores secrets for LLM license handshakes; recommend 10MB. | ||
| - /var/lib/nms/modules: Stores static content like manager.json; recommend 100KB (12KB minimum). | ||
| - /var/lib/clickhouse: Stores ClickHouse metrics data; recommend 2.5GB per instance (25GB for 10 instances, 250GB for 100 instances). This is only required if ClickHouse metrics are enabled. In NIM 2.20, lightweight mode can be deployed without ClickHouse (no metrics collected). |
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.
Some of what's drafted is redundant. However, this is begging for a link to answer "What if I'm deploying > 100 instances of NIM"
Suggested change
| - /var/lib/clickhouse: Stores ClickHouse metrics data; recommend 2.5GB per instance (25GB for 10 instances, 250GB for 100 instances). This isonlyrequiredif ClickHouse metrics are enabled. In NIM 2.20,lightweight modecanbe deployedwithout ClickHouse (no metrics collected). | |
| - /var/lib/clickhouse: Stores ClickHouse metrics data; recommend 2.5GB per instance. Requiredonly if ClickHouse metrics are enabled. In NIM 2.20,youcandeploy lightweight modewithout ClickHouse. |
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 is just a guideline. Up to 100 is the norm, over that would require significant testing but we are only talking about storage here. We mention larger deployments in the "sizing" section here and suggest 2tb.https://docs.nginx.com/nginx-instance-manager/fundamentals/tech-specs/#large-nginx-configuration-deployments
| - /etc/nms/: Stores NIM configuration files; recommend 50MB. | ||
| - /etc/nginx: Stores NGINX configuration files; typical size is 10–50MB (confirm with specific deployments). | ||
| **Key Considerations**: |
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.
Suggested change
| **Key Considerations**: | |
| **Key Considerations**: | |
Comment on lines +104 to +105
| -Resources listed above are necessary for instance management using NIM (via NGINX Agent). | ||
| -For usage reporting-only deployments (without management via Agent): |
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.
style. We discourage the use of Latin terms
Suggested change
| -Resources listed above are necessary for instance management using NIM (via NGINX Agent). | |
| -For usage reporting-only deployments (without managementvia Agent): | |
| -Resources listed above are necessary for instance management using NIM (through NGINX Agent). | |
| -For usage reporting-only deployments (without managementthrough Agent): |
| -Resources listed above are necessary for instance management using NIM (via NGINX Agent). | ||
| -For usage reporting-only deployments (without management via Agent): | ||
| No ClickHouse metrics are collected. | ||
| Resource requirements are significantly reduced, as the usage data is only received and stored by NIM. This generally requires much less disk space and memory allocation. The intended use case (management vs. usage reporting) is critical to avoid allocating unnecessary resources. Regular monitoring, backups, and adjustments are still recommended to optimize operations. |
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.
Suggested change
| Resource requirements are significantly reduced, as the usage data is only received and stored by NIM. This generally requires much less disk space and memory allocation. The intended use case (managementvs. usage reporting) is critical to avoid allocating unnecessary resources.Regularmonitoring, backups, and adjustments are still recommended to optimize operations. | |
| Resource requirements are significantly reduced, as the usage data is only received and stored by NIM. This generally requires much less disk space and memory allocation. The intended use case (managementversus usage reporting) is critical to avoid allocating unnecessary resources.We still recommend regularmonitoring, backups, and adjustments to optimize operations. |
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Labels
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed changes
Many Customers have asked for more information on what directories need to be reserved on baremetal installations. This has been added.
Also, removed "deprecated" on the manual steps for VM/Bare-metal, as some customers have issues with the script and may need to resort to installing NIM manually nd those steps are still correct.
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.↩