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

Documentation: improve TLS docs. #3055

Closed
stuclem opened this issue Nov 8, 2016 · 3 comments
Closed

Documentation: improve TLS docs. #3055

stuclem opened this issue Nov 8, 2016 · 3 comments
Assignees
Labels
impact/doc/user Requires changes to official user documentation

Comments

@stuclem
Copy link
Contributor

stuclem commented Nov 8, 2016

The TLS docs need more work.

Comment from @hickeng by email:


I suggest we separate (the TLS doc) in the following manner:

  1. How to supply a server certificate for a VCH (this is a really common thing for many servers - should be the piece people are most familiar with).
  2. How to configure client authentication (mutual authentication)
  3. How to disable TLS
    --> what certificates are required for each of these (certificate authority, server certificate and key, client certificate and key), which role needs which certificates and how they're used in installation.
    --> explicitly not talking about how those certificates are obtained

Then a separate section on the fact that we generate trivial versions of these certificates as a convenience when possible (--tls-cname or --client-network-ip), and that if wanting more control over the certificates than we provide for that the certificates can be generated by standard means (e.g. openssl for linux) or obtained from a certificate provider (https://en.wikipedia.org/wiki/Certificate_authority#Providers)


See also:

@stuclem stuclem added the impact/doc/user Requires changes to official user documentation label Nov 8, 2016
@stuclem stuclem added this to the Doc for GA milestone Nov 8, 2016
@stuclem stuclem self-assigned this Nov 8, 2016
@stuclem
Copy link
Contributor Author

stuclem commented Nov 14, 2016

There's a great writeup of TLS from @hickeng in #3087 (comment).

@stuclem
Copy link
Contributor Author

stuclem commented Dec 7, 2016

Too late for GA. TLS is well-covered by @hickeng 's rewrites. Reinstate the security overview to the doc in a post-GA update.

@stuclem stuclem modified the milestones: Doc for 0.9.0, Doc for GA Dec 7, 2016
@stuclem stuclem modified the milestones: Doc for 0.8 post-GA refresh, Doc for 0.9.0 Dec 14, 2016
@stuclem stuclem removed this from the Doc for 0.8 post-GA refresh milestone Feb 9, 2017
@stuclem
Copy link
Contributor Author

stuclem commented Mar 22, 2017

This issue was moved to vmware/vic-product#70

@stuclem stuclem closed this as completed Mar 22, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact/doc/user Requires changes to official user documentation
Projects
None yet
Development

No branches or pull requests

1 participant