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 TLS configuration #1968

Open
onitake opened this issue Sep 27, 2019 · 4 comments
Open

Document TLS configuration #1968

onitake opened this issue Sep 27, 2019 · 4 comments
Assignees
Labels
area:documentation All issues pertaining to usability and documentation

Comments

@onitake
Copy link

onitake commented Sep 27, 2019

Right now, the documentation doesn't explain how to secure communication between M3DB and etcd and also between M3DB nodes. There are no TLS options in the example configuration files.

Looking at the source code, TLS seems to be supported, at least for the etcdclusters and seednodes configurations. These two components use a different configuration format, however, and it's not entirely clear what the etcdclusters TLSConfig does. The code comments are meaningless, and the documentation lacks a description of the options.

SeedNodeSecurityConfig is better, in that it has separate options for client and server certificates for the embedded etcd cluster. But there is no documentation either, and the comments are equally meaningless.

As for communication between M3 nodes, is there even some sort of security? I don't see any place where TLS certificates or some other kind of authentication and transport security could be configured.

@martin-mao
Copy link
Collaborator

@schallert Can comment here on TLSConfig for etcd and seed nodes, but in general, communication between M3DB nodes are not secured. The system was designed to be run inside a secure network. You can secure writes into the overall system, but between the components of the system, there are no security mechanisms now.

@onitake
Copy link
Author

onitake commented Sep 18, 2020

@gibbscullen Can you explain why this was closed?
Was the documentation updated?

@gibbscullen
Copy link
Collaborator

Yes, we are actively working on updating the M3 documentation.

@gibbscullen gibbscullen added the area:documentation All issues pertaining to usability and documentation label Sep 18, 2020
@gibbscullen
Copy link
Collaborator

@schallert -- following up on this ... can you comment here on TLSConfig for etcd and seed nodes when have a chance?

@gibbscullen gibbscullen reopened this Mar 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:documentation All issues pertaining to usability and documentation
Projects
None yet
Development

No branches or pull requests

4 participants