Skip to content
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

Fix: clarify managed v. deployed certs #291

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

Conversation

mjang
Copy link
Contributor

@mjang mjang commented Mar 17, 2025

Proposed changes

Closes #256

Checklist

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

  • I have read the contributing guidelines
  • I have signed the F5 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 to Conventional Commits
  • I have ensured that documentation content adheres to the 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 updated README.md and CHANGELOG.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 to our style guide for guidance about placeholder content.

@mjang mjang self-assigned this Mar 17, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation product/nginx-one NGINX One Console labels Mar 17, 2025
@mjang mjang added the enhancement New feature or request label Mar 17, 2025
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/291/

@mjang mjang force-pushed the fix-deployed-managed-cert-sections branch from 7fc0462 to e0a508f Compare March 17, 2025 20:33
@mjang mjang requested a review from sylwang March 21, 2025 15:27
@mjang mjang marked this pull request as ready for review March 21, 2025 15:27
@mjang mjang requested a review from a team as a code owner March 21, 2025 15:27
@mjang
Copy link
Contributor Author

mjang commented Mar 21, 2025

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


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 managed 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).
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 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).
From the configuration editor where you normally modify NGINX configuration files of an independent instance or Config Sync Group, you can click on the "delete" icon of a managed certificate object that was previously deployed to the instance or Config Sync Group. You should be able to see the file paths where it was deployed to. Deleting the managed certificate from the NGINX configuration editor will remove the certificate files from those file paths. If the certificate object is a certificate-key pair, and the private key was deployed, you could optionally choose to delete the deployed key from the independent 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
Contributor Author

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 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 delete managed certificates in the following 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


Every instance with a deployed certificate includes paths to certificates in their configuration files. If you remove the deployed file path to one certificate, that change is limited to that one instance.
Every Instance with a certificate includes paths to certificates in their configuration files. If you remove one certificate, that change is limited to that one Instance.
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 a certificate includes paths to certificates in their configuration files. If you remove one certificate, that change is limited to that one Instance.
For a managed certificate that was deployed from the console to your data plane instance, you might have chosen to reference the certificate in the NGINX configuration file, using the file paths specified in the certificate deployment. You can choose to remove those 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.

@mjang mjang requested a review from sylwang March 26, 2025 21:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request product/nginx-one NGINX One Console
Projects
None yet
Development

Successfully merging this pull request may close these issues.

N1C: Possible section rename
4 participants