Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Fix: clarify managed v. deployed certs#291

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
mjang wants to merge8 commits intomain
base:main
Choose a base branch
Loading
fromfix-deployed-managed-cert-sections

Conversation

mjang
Copy link
Contributor

Proposed changes

Closes#256

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read thecontributing guidelines
  • I have signed theF5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere toConventional Commits
  • I have ensured that documentation content adheres tothe style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updatedREADME.md andCHANGELOG.md

Footnotes

  1. 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.

@mjangmjang self-assigned thisMar 17, 2025
@github-actionsgithub-actionsbot added documentationImprovements or additions to documentation product/nginx-oneNGINX One Console labelsMar 17, 2025
@mjangmjang added the enhancementNew feature or request labelMar 17, 2025
@github-actionsGitHub Actions
Copy link

Deploy Preview will be available once build job completes!

NameLink
😎 Deploy Previewhttps://frontdoor-test-docs.nginx.com/previews/docs/291/

@mjangmjangforce-pushed thefix-deployed-managed-cert-sections branch from7fc0462 toe0a508fCompareMarch 17, 2025 20:33
@mjangmjang requested a review fromsylwangMarch 21, 2025 15:27
@mjangmjang marked this pull request as ready for reviewMarch 21, 2025 15:27
@mjangmjang requested a review froma team as acode ownerMarch 21, 2025 15:27
@mjang
Copy link
ContributorAuthor

@sylwang I hope this is more clear! (based on#256 )


You can remove adeployed certificate from an independent instance or from a Config Sync Group. This will remove the certificate's association with theinstance or group, but it does not delete the certificate files from theinstance(s).
You can remove amanaged certificate from an independent instance or from a Config Sync Group. This will remove the certificate's association with theInstance or group, but it does not delete the certificate files from theInstance(s).
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
You can remove a managed certificate froman independent instance orfrom aConfig Sync Group.Thiswill remove the certificate's association withtheInstance or group, but it does notdelete thecertificate files from theInstance(s).
From the configuration editor where you normally modify NGINX configuration files ofan independent instance orConfig Sync Group, you can click on the "delete" icon of a managed certificate object that was previously deployed to the instance orConfig Sync Group.You should be able to see the file paths where it was deployed to. Deleting the managed certificate from the NGINX configuration editorwill remove the certificate files from those file paths. Ifthecertificate object is a certificate-key pair, and the private key was deployed, you could optionally choose todelete thedeployed key from theindependent instance or Config Sync Group, by clicking on the "delete" icon next to the private key file.

Here is a rough summary of what users could do. Feel free to change the wording and improve this paragraph further! : )

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

Suggested change
You canremove amanagedcertificate from an independent instance or from a Config Sync Group. This will removethecertificate's association with the Instance or group, but it does not delete the certificate files from the Instance(s).
You candeletemanagedcertificates inthefollowing ways:
- Navigate to[View and edit NGINX configurations]({{< relref "/nginx-one/how-to/nginx-configs/view-edit-nginx-configurations/" >}})
- You can then delete the certificate from the Instance of your choice.
- Navigate to[Manage Config Sync Groups]({{< relref "/nginx-one/how-to/config-sync-groups/manage-config-sync-groups" >}})
- You can then delete the certificate from the Config Sync Group of your choice.
- Review the list of existing certificates
- From the **Actions** menu, you can then delete that certificate

Copy link
Contributor

@sylwangsylwangApr 16, 2025
edited
Loading

Choose a reason for hiding this comment

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

  • Review the list of existing certificates
    • From theActions menu, you can then delete that certificate

This would be incorrect. The "Actions" menu is from the cert management page, where users can choose to delete a certificate object from N1 Console. However, the contexts here are that users can remove a deployed certificate file from an instance or a CSG. If users want to remove a cert deployment from a specific instance or CSG, they should only be able to do that through the config editor (where users edit NGINX configuration for an instance or a CSG). It would also be helpful to clarify that when users click on the delete icon from the config editor, they would delete the deployed certificate or key file fromspecific file paths.

  • Navigate to [Manage Config Sync Groups]({{< relref "/nginx-one/how-to/config-sync-groups/manage-config-sync-groups" >}})
    • You can then delete the certificate from the Config Sync Group of your choice.

https://frontdoor-test-docs.nginx.com/previews/docs/291/nginx-one/how-to/nginx-configs/manage-config-sync-groups/
In addition, I wasn't able to find any instructions on how users could delete the certificate from a Config Sync Group in this page, so this could be confusing to the reader.

I'm thinking that deleting a certificate file is a special case for deleting an aux file. Since we have a page that documents how to add a file, should we also add a new page that documents how to remove a file? That might be easier in comparison to trying to fit all the details into a small section in the cert management doc.
https://frontdoor-test-docs.nginx.com/previews/docs/291/nginx-one/how-to/nginx-configs/add-file/
https://frontdoor-test-docs.nginx.com/previews/docs/291/nginx-one/how-to/config-sync-groups/add-file-csg/

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

I'm realizing that our coverage of "Edit Configuration" for instances and CSGs are haphazard. I'm going to address@sylwang 's comments, and later, address#427 to "unify" the messaging.

sylwang reacted with thumbs up emoji
Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you for opening a new PR to address this. The new changes look good!


Everyinstance with adeployedcertificate includes paths to certificates in their configuration files. If you removethe deployed file path toone certificate, that change is limited to that oneinstance.
EveryInstance with a certificate includes paths to certificates in their configuration files. If you remove one certificate, that change is limited to that oneInstance.
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
Every Instance with acertificateincludes pathstocertificatesintheirconfigurationfiles. If youremoveone certificate, that change is limited to that one Instance.
For a managedcertificatethat was deployed from the consoletoyour data plane instance, you might have chosen to reference the certificateinthe NGINXconfigurationfile, using the file paths specified in the certificate deployment. You can choose toremovethose certificate references from the NGINX configuration file through the console. This will not affect the deployed certificate on your data plane instance. The certificate and private key files if deployed, will remain on the data plane instance.
If you would like to delete those certificate and private key files from your data plane, follow the instructions above and click on the "delete" icon next to those files in the NGINX configuration editor.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hi@mjang, just checking in, what are your thoughts on this part of the doc?

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

I'd like to avoid references to "Data Plane", as we'll soon incorporateNGF data planes in N1C.

In any case, I think this is superseded byhttps://github.com/nginx/documentation/pull/291/files#diff-2445ce44d5814d8ceb795a09fa3672417a9d86c176326cf9ecbc3036b8fc5702R170-R178

sylwang reacted with thumbs up emoji
@mjangmjang requested a review fromsylwangMarch 26, 2025 21:31
@mjangmjangforce-pushed thefix-deployed-managed-cert-sections branch from59aab3b to6463be3CompareApril 17, 2025 15:07
## Delete a deployed certificate
Every Config Sync Group also includes paths to managed certificates in its configuration files. If you remove a managed certificate to a Config Sync Group, that change affects all instances which belong to that Config Sync Group.

## Delete a managed certificate

To delete a certificate, find the name in the **Certificates** screen. Find the **Actions** column associated with the certificate. Select the ellipsis (`...`) and then select **Delete**. Before deleting that certificate, you should see a warning.

If that certificate is managed and is part of a Config Sync Group, that change affects all instances in that group.

{{< warning >}} Be cautious if you want to delete certificates that are being used by an instance or a Config Sync Group. Deleting such certificates leads to failure in affected NGINX deployments. {{< /warning >}}
Copy link
Contributor

Choose a reason for hiding this comment

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

The only case when it would lead to publication failures for the instance or CSG associated with a certificate, is when users choose to delete a deployed certificate. Let's remove this warning from this section and add it to the section "Deleted a deployed certificate".

@@ -155,22 +161,36 @@ You can modify existing certificates from the **Certificates** screen. Select th

If that certificate is already managed as part of a Config Sync Group, the changes you make affect all instances in that group.

##Remove a deployed certificate
##Delete a deployed certificate
Copy link
Contributor

Choose a reason for hiding this comment

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

The warning

{{< warning >}} Be cautious if you want to delete certificates that are being used in the NGINX configuration of an instance or a Config Sync Group. Deleting deployed certificates can lead to publication failure in affected NGINX instances or Config Sync Groups. {{< /warning >}}

should be added for this section.


You can remove a deployed certificate from an independent instance or from a Config Sync Group. This will remove the certificate's association with the instance or group, but it does not delete the certificate files from the instance(s).
You can remove a deployed certificate from an independent instance or from a Config Sync Group. This action also deletes the certificate files or certificate-key pairs from the data plane Instance(s).
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
You can remove a deployed certificate from an independent instance or from a Config Sync Group. This actionalsodeletes the certificate files or certificate-key pairs from the data plane Instance(s).
You can remove a deployed certificate from an independent instance or from a Config Sync Group. This action deletes the CA certificate files or certificate-key pairs from the data plane Instance(s).


## Delete a deployed certificate
Every Config Sync Group also includes paths to managed certificates in its configuration files. If you remove a managed certificate to a Config Sync Group, that change affects all instances which belong to that Config Sync Group.
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
Every Config Sync Groupalso includes paths to managed certificates in its configuration files. If you remove a managed certificate to a Config Sync Group, that change affects all instances which belong to that Config Sync Group.
Everyinstance orConfig Sync Groupmight include paths to managed certificates in its configuration files. If you remove a managed certificate to a Config Sync Group, that change affects all instances which belong to that Config Sync Group.

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@sylwangsylwangsylwang approved these changes

@ADubhlaoichADubhlaoichADubhlaoich approved these changes

@y82y82y82 approved these changes

At least 2 approving reviews are required to merge this pull request.

Assignees

@mjangmjang

Labels
documentationImprovements or additions to documentationenhancementNew feature or requestproduct/nginx-oneNGINX One Console
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

N1C: Possible section rename
5 participants
@mjang@ADubhlaoich@y82@sylwang@JTorreG

[8]ページ先頭

©2009-2025 Movatter.jp