Skip to content

fix: N1C. Help users look for "out of sync" Instances in a CSG #422

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.

Sign up for GitHub

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

fix: N1C. Help users look for "out of sync" Instances in a CSG #422

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d1d05a2
Point to Out of Sync
mjang Apr 16, 2025
7e9bed0
Highilght note
mjang Apr 16, 2025
b4c6d67
Don't overcommit
mjang Apr 16, 2025
fcb88a7
remove overcommit
mjang Apr 16, 2025
14c15b9
typo
mjang Apr 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions content/nginx-one/how-to/config-sync-groups/manage-config-sync-groups.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Copy link
Contributor

Choose a reason for hiding this comment

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

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!

Copy link
Contributor

Choose a reason for hiding this comment

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

Feels like far too much information to throw into a note: might feel better once it's had an edit pass.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@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].

In that case, review and resolve discrepencies between the Instance and the rest of the Config Sync Group. {{< /note >}}
Copy link
Contributor

Choose a reason for hiding this comment

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

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 >}}


### Add an existing instance to a Config Sync Group {#add-an-existing-instance-to-a-config-sync-group}

You can add existing NGINX instances that are already registered with NGINX One to a Config Sync Group.
Expand Down
Loading