fix: N1C. Help users look for "out of sync" Instances in a CSG #422
+3
−0
Conversation
This file contains 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
github-actions
bot
added
documentation
mjang
changed the title
✅ Deploy Preview will be available once build job completes!
|
sylwang
reviewed
Apr 16, 2025
| @@ -100,6 +100,9 @@ Now that you created a Config Sync Group, you can add instances to that group. A | |||
|
|
|||
| Any instance that joins the group afterwards inherits that configuration. | |||
|
|
|||
| {{< note >}} If there are conflicts between an instance and the Config Sync Group, you'll see the following [Config Sync Group Status](#config-sync-group-status) message: **Out of Sync**. | |||
There was a problem hiding this comment.
When an instance is out of sync, it wouldn't necessarily be because there is a conflict between the instance and the CSG, it's usually due to some errors in the NGINX configuration that is either not caught when users created the CSG, or something has gone wrong on the data plane instance.
Here is roughly what I think that could be helpful to include in this part of the doc:
Suggested change
| {{< note >}} If there are conflicts between an instance and the Config Sync Group, you'll see the following [Config Sync Group Status](#config-sync-group-status) message: **Out of Sync**. | |
| {{< note >}} If there was any failure while synchronizing the instance's configuration with the Config Sync Group, you'll see the following [Config Sync Group Status](#config-sync-group-status) message: **Out of Sync**. In that case, check the instance details to see its latest publication and the failure cause. You might need to modify the configuration on the Config Sync Group to fix configuration related errors, and you can publish an updated configuration for the Config Sync Group which should re-synchronize the instance. |
Feel free to make any changes as you see fit!
There was a problem hiding this comment.
Feels like far too much information to throw into a note: might feel better once it's had an edit pass.
There was a problem hiding this comment.
@sylwang wdyt?
Suggested change
| {{< note >}} If there are conflicts between an instance and the Config Sync Group, you'll see the following [Config Sync Group Status](#config-sync-group-status) message: **Out of Sync**. | |
| {{< note >}} If you see the following [Config Sync Group Status](#config-sync-group-status) message: **Out of Sync**: | |
| - Review the instance. NGINX One Console can help you identify problems. | |
| - After you change the configuration of the instance or Config Sync Group, [Publish it](#publish-the-config-sync-group-configuration]. |
ADubhlaoich
approved these changes
Apr 17, 2025
| @@ -100,6 +100,9 @@ Now that you created a Config Sync Group, you can add instances to that group. A | |||
|
|
|||
| Any instance that joins the group afterwards inherits that configuration. | |||
|
|
|||
| {{< note >}} If there are conflicts between an instance and the Config Sync Group, you'll see the following [Config Sync Group Status](#config-sync-group-status) message: **Out of Sync**. | |||
| In that case, review and resolve discrepencies between the Instance and the rest of the Config Sync Group. {{< /note >}} | |||
There was a problem hiding this comment.
Suggested change
| In that case, review and resolve discrepencies between the Instance and the rest of the Config Sync Group. {{< /note >}} | |
| In that case, review and resolve discrepancies between the Instance and the rest of the Config Sync Group. {{< /note >}} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Help users understand -- just because you add an Instance to a CSG, they don't automatically sync
Closes #420
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 to our style guide for guidance about placeholder content. ↩