-
Notifications
You must be signed in to change notification settings - Fork 125
N1C CSG unmanaged certificates #1597
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,115 @@ | ||||||||||
| --- | ||||||||||
| nd-content-type: concept | ||||||||||
| nd-docs: DOCS-000 | ||||||||||
| nd-product: NONECO | ||||||||||
| title: Unmanaged certificates in Config Sync Groups | ||||||||||
| toc: true | ||||||||||
| weight: 200 | ||||||||||
| --- | ||||||||||
|
|
||||||||||
| ## Overview | ||||||||||
|
|
||||||||||
| Unmanaged certificates are SSL/TLS certificates that you install and manage manually on NGINX instances. Unlike managed certificates that are uploaded and distributed through the NGINX One Console, unmanaged certificates are installed directly on individual instances and referenced by their file paths in NGINX configuration files. You are responsible for distributing, updating, and maintaining these certificates across your infrastructure. | ||||||||||
|
|
||||||||||
| ### Unmanaged certificates in Config Sync Groups | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Markdown format rule (look up MD022)
Suggested change
|
||||||||||
| Config Sync Groups (CSGs) in NGINX One Console ensure configuration consistency across connected NGINX instances. While managed certificates uploaded through the Console are automatically synchronized and tracked, unmanaged certificates follow a different model that provides visibility without automated management. | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Moving phrase to the start of the next paragraph.
Suggested change
|
||||||||||
|
|
||||||||||
| When you use unmanaged certificates in a CSG, NGINX One Console does not synchronize the certificate files themselves. However, it tracks their metadata to help you verify consistency across instances and understand the state of your certificates. | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| ## How unmanaged certificates work in Config Sync Groups | ||||||||||
|
|
||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Suggestion (not a requirement): add an intro to the subsections that follow:
Suggested change
|
||||||||||
| ### Certificate tracking and visibility | ||||||||||
|
|
||||||||||
| When you use unmanaged certificates in a Config Sync Group: | ||||||||||
|
|
||||||||||
| - The NGINX Agent collects certificate metadata from each instance | ||||||||||
| - The Console displays unmanaged certificates based on their file paths and metadata | ||||||||||
| - Certificate consistency is determined by comparing certificate contents and file paths across instances | ||||||||||
|
|
||||||||||
| ### Consistent certificates | ||||||||||
|
|
||||||||||
| When all instances in a CSG reference identical certificate files with the same file paths: | ||||||||||
|
|
||||||||||
| - Their contents and metadata match across all instances | ||||||||||
| - The CSG displays a single unmanaged certificate entry for that file path | ||||||||||
|
|
||||||||||
| ### Inconsistent certificates | ||||||||||
|
|
||||||||||
| If certificate contents differ between instances, even when file paths are the same: | ||||||||||
|
|
||||||||||
| - Each unique certificate appears as a separate unmanaged entry in the Console | ||||||||||
| - Certificates are identified by their content and associated instance | ||||||||||
| - The CSG displays separate certificate entries in the configuration | ||||||||||
|
|
||||||||||
| If certificate file paths differ between instances: | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If it's actually CSG publication that may fail, I suggest revising this to:
Suggested change
|
||||||||||
|
|
||||||||||
| - CSG publication may fail | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just checking. Is it CSG or certificate publication that can fail?
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If it is CSG publication that can fail, I'd change current line 44 (comment added there) |
||||||||||
| - The CSG configuration will be out of sync | ||||||||||
| - Instances may not receive proper configuration updates | ||||||||||
|
|
||||||||||
| ## Requirements for unmanaged certificates | ||||||||||
|
|
||||||||||
| To use unmanaged certificates effectively in Config Sync Groups, you must: | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| - **Manual installation**: Install certificates manually on each NGINX instance in the CSG | ||||||||||
| - **Identical file paths**: Ensure that file paths referencing unmanaged certificates are identical across all instances | ||||||||||
| - **Content consistency**: Maintain identical certificate file contents across all instances to ensure proper tracking | ||||||||||
| - **User responsibility**: Take full responsibility for certificate distribution, updates, and consistency | ||||||||||
|
|
||||||||||
| ## Important considerations | ||||||||||
|
|
||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| ### Certificate tracking | ||||||||||
|
|
||||||||||
| - The NGINX One Console tracks unmanaged certificates by their content and file paths | ||||||||||
| - When certificates are consistent across all instances, their contents and metadata match, and a single consolidated entry appears in the CSG | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| - If certificate content differs between instances, multiple unique unmanaged certificates are displayed as separate entries | ||||||||||
|
|
||||||||||
| ### Synchronization limitations | ||||||||||
|
|
||||||||||
| - **No automated sync**: Unmanaged certificates are not synchronized by the Console | ||||||||||
| - **Manual updates**: You must manually update certificates on each instance when they expire or need rotation | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For consistency:
Suggested change
|
||||||||||
| - **No validation**: The Console does not perform validation or rotation logic for unmanaged certificates | ||||||||||
|
|
||||||||||
| ### Configuration options | ||||||||||
|
|
||||||||||
| If you don't want metadata tracking for unmanaged certificates, you can configure the NGINX Agent to ignore certificate directories using the `allowed_directories` setting. | ||||||||||
|
|
||||||||||
| ## Best practices | ||||||||||
|
|
||||||||||
| ### Converting to managed certificates | ||||||||||
|
Comment on lines
+77
to
+79
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I understand the parallel nature of what you've done. But it's a best practice to consolidate titles when there's only one subsection:
Suggested change
|
||||||||||
|
|
||||||||||
| To maintain consistent visibility and automated management across CSGs, consider converting unmanaged certificates to managed certificates by: | ||||||||||
|
|
||||||||||
| 1. Uploading them through the NGINX One Console | ||||||||||
| 2. Leveraging the managed certificate solution for automated synchronization | ||||||||||
| 3. Taking advantage of centralized certificate management features | ||||||||||
|
|
||||||||||
| ## Troubleshooting | ||||||||||
|
|
||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| ### Certificate inconsistencies | ||||||||||
|
|
||||||||||
| If you see multiple entries for what should be the same certificate: | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I see you've numbered these options. In general, I number steps when users have to do them, in order. If ordering is not required, I'd replace the numbers with bullets |
||||||||||
|
|
||||||||||
| 1. Verify that file paths are identical across all instances | ||||||||||
| 2. Check that certificate file contents match across all instances | ||||||||||
| 3. Ensure certificates were installed correctly on all instances | ||||||||||
| 4. Review NGINX Agent logs for any collection issues | ||||||||||
|
|
||||||||||
| If CSG publication is failing or configurations are out of sync: | ||||||||||
|
|
||||||||||
| 1. Confirm that all certificate file paths are identical across instances | ||||||||||
| 2. Verify that referenced certificate files exist on all instances | ||||||||||
| 3. Check NGINX configuration syntax for certificate references | ||||||||||
|
|
||||||||||
| ### Visibility issues | ||||||||||
|
|
||||||||||
| If unmanaged certificates aren't appearing in the Console: | ||||||||||
|
|
||||||||||
| 1. Confirm that the NGINX Agent is running and connected | ||||||||||
| 2. Check that certificate directories are not excluded by `allowed_directories` settings | ||||||||||
| 3. Verify that NGINX configuration files correctly reference the certificate paths | ||||||||||
|
|
||||||||||
| ## Related topics | ||||||||||
|
|
||||||||||
| - [Manage Config Sync Groups]({{< ref "manage-config-sync-groups.md" >}}) | ||||||||||
| - [Add a file to a Config Sync Group]({{< ref "add-file-csg.md" >}}) | ||||||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -329,6 +329,19 @@ The **Config Sync Status** column on the **Config Sync Groups** page provides in | |||||
|
|
||||||
| Monitor the **Config Sync Status** column. It can help you ensure that your configurations are consistently applied across all instances in a group. | ||||||
|
|
||||||
| ## Working with unmanaged certificates | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We avoid gerunds (-ing words) in section titles. Exception: troubleshooting
Suggested change
|
||||||
|
|
||||||
| Config Sync Groups can work with both managed and unmanaged certificates. While managed certificates are uploaded through the NGINX One Console and automatically synchronized across instances, unmanaged certificates require manual installation and management. | ||||||
|
|
||||||
| When using unmanaged certificates in Config Sync Groups: | ||||||
|
|
||||||
| - **Manual distribution**: You must manually install certificates on each instance in the group | ||||||
| - **Consistent file paths**: Certificate file paths must be identical across all instances for proper synchronization | ||||||
| - **Visibility without management**: NGINX One tracks unmanaged certificate metadata to help you verify consistency, but does not synchronize the certificates themselves | ||||||
| - **Status impact**: Inconsistent certificate file paths or missing certificates can affect the Config Sync Group status | ||||||
|
|
||||||
| For detailed information about how unmanaged certificates work in Config Sync Groups, including requirements, best practices, and troubleshooting, see [Unmanaged certificates in Config Sync Groups]({{< ref "/nginx-one-console/nginx-configs/certificates/csg-unmanaged-certificates.md" >}}). | ||||||
|
|
||||||
| ## See also | ||||||
|
|
||||||
| - [Create and manage data plane keys]({{< ref "/nginx-one-console/connect-instances/create-manage-data-plane-keys.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.