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

Maybe start documenting experimental features but w/ a yellow EXPERIMENTAL pill? #28

Open
jasikpark opened this issue May 27, 2022 · 3 comments

Comments

@jasikpark
Copy link
Collaborator

We currently have some config options which are undocumented b/c they are experimental - should we document them w/ the caveat that they are experimental and likely to break things?

@jasikpark
Copy link
Collaborator Author

The only experimental feature I'm aware of at this point is relays, I think it might mention that it's currently experimental?

@jasikpark
Copy link
Collaborator Author

we use an INFO block to let people know its experimental: https://docs.defined.net/nebula/config/relay

@jasikpark
Copy link
Collaborator Author

lighthouse:
# EXPERIMENTAL: This option my change or disappear in the future.
  # Optionally allows the definition of remote_allow_list blocks
  # specific to an inside VPN IP CIDR.
  #remote_allow_ranges:
    # This rule would only allow only private IPs for this VPN range
    #"10.42.42.0/24":
      #"192.168.0.0/16": true

lighthouse.remote_allow_ranges seems to be another experimental config value

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

No branches or pull requests

1 participant