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

Add mTLS flags to 'Configure SSL/TLS' docs #1099

Merged
merged 1 commit into from
Jun 21, 2024

Conversation

kilfoyle
Copy link
Contributor

@kilfoyle kilfoyle commented Jun 4, 2024

This updates the Configure SSL/TLS for self-managed Fleet Servers page to include the recently added mTLS flags. I also added the --fleet-server-policy=fleet-server-policy flag since it was missing, but I see it in the example from the mTLS flags PR.

Closes: #1098


Screenshot 2024-06-04 at 11 42 10 AM
Screenshot 2024-06-04 at 11 42 28 AM

Copy link

github-actions bot commented Jun 4, 2024

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@kilfoyle kilfoyle mentioned this pull request Jun 13, 2024
Copy link
Contributor

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

lgtm w/ small suggestion to take or leave!

`fleet-server-es-cert-key`::
The path to the private key that {fleet-server} will use when connecting to {es}.
`fleet-server-client-auth`::
One of `none`, `optional`, or `required`. Defaults to `none`. {fleet-server}'s client_authentication option for client mTLS connections. If `optional` or `required` is specified, client certificates are verified using CAs specified in the `--certificate-authorities` flag.
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider front-loading the description

Suggested change
One of `none`, `optional`, or `required`. Defaults to `none`. {fleet-server}'s client_authentication option for client mTLS connections. If `optional` or `required` is specified, client certificates are verified using CAs specified in the `--certificate-authorities` flag.
{fleet-server}'s client_authentication option for client mTLS connections. Accepted values: one of `none`, `optional`, or `required`. Defaults to `none`. If `optional` or `required` is specified, client certificates are verified using CAs specified in the `--certificate-authorities` flag.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry @shainaraskas! I pulled the trigger too early and didn't notice this.

@kilfoyle
Copy link
Contributor Author

These settings match what's been outlined in this comment, so I think this is good to merge now.

@kilfoyle kilfoyle merged commit 6974f74 into elastic:main Jun 21, 2024
4 checks passed
mergify bot pushed a commit that referenced this pull request Jun 21, 2024
kilfoyle added a commit that referenced this pull request Jun 21, 2024
(cherry picked from commit 6974f74)

Co-authored-by: David Kilfoyle <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

description of mTLS flags needed for the 'Configure SSL/TLS' docs
2 participants