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

Document reloadable configs #125

Merged
merged 2 commits into from
May 29, 2024
Merged

Document reloadable configs #125

merged 2 commits into from
May 29, 2024

Conversation

IanVS
Copy link
Collaborator

@IanVS IanVS commented May 22, 2024

Closes #19

We didn't have any good listing of which options can be reloaded via a SIGHUP vs those that require a full restart to take effect. This adds a simple badge to indicate which options can be reloaded. AFAICT, tun.mtu is only reloadable on linux, but that's the only difference between platforms that I could find.

@IanVS IanVS requested review from nbrownus and bgolat May 22, 2024 19:43
Copy link

netlify bot commented May 22, 2024

Deploy Preview for nebula-docs-dn ready!

Name Link
🔨 Latest commit c577e59
🔍 Latest deploy log https://app.netlify.com/sites/nebula-docs-dn/deploys/665763e23650b10008b1ff92
😎 Deploy Preview https://deploy-preview-125--nebula-docs-dn.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@jasikpark
Copy link
Collaborator

Since the default is meant to be "reloadable" wouldn't it make sense to add pills just for the cases where options are "non-reloadable"?

Copy link
Collaborator

@jasikpark jasikpark left a comment

Choose a reason for hiding this comment

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

the design of using a pill sounds fine to me, i'll let others validate that the config options are correctly assigned as reloadable/non-reloadable

@@ -39,22 +39,24 @@ pki:

## pki.cert

<Pill className="mb-24">Required</Pill>
<Pill className="mb-24">Required</Pill> <Pill className="mb-24">Reloadable</Pill>

Choose a reason for hiding this comment

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

We should note that while a certificate is reloadable, it will only be accepted if the ip address hasnt changed. All other properties of the cert can change though

Copy link

@nbrownus nbrownus left a comment

Choose a reason for hiding this comment

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

Happy to move forward as it is

@IanVS IanVS merged commit 4f72fda into main May 29, 2024
7 checks passed
@jasikpark jasikpark deleted the reload-docs branch May 29, 2024 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add badges to indicate config values that are reloadable
3 participants