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 clarification for server.ssl.supportedProtocols setting #22244

Merged
merged 3 commits into from
Aug 22, 2018

Conversation

marius-dr
Copy link
Member

Added clarification that the server.ssl.supportedProtocols setting has to be an array. With the current wording you can assume that you can set it as a simple string.

@kobelb @legrego pinging you to confirm that the current behavior in Kibana in regards to this is the expected one. (if it's set as not an array it gives a fatal error:
FATAL { ValidationError: child "server" fails because [child "ssl" fails because [child "supportedProtocols" fails because ["supportedProtocols" must be an array]]])

Added clarification that the setting has to be an array. With the current wording you can assume that you can just add it as a simple string.
@marius-dr marius-dr added Team:Docs Team:Security Team focused on: Auth, Users, Roles, Spaces, Audit Logging, and more! labels Aug 22, 2018
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@kobelb
Copy link
Contributor

kobelb commented Aug 22, 2018

Thanks for looking into this @marius-dr, that value does indeed have to be an array. My only concern is with the phrasing, if we say that the "values have to be an array" it makes me think that multiple things have to be arrays. What if instead we changed it to:

server.ssl.supportedProtocols::: Default: TLSv1, TLSv1.1, TLSv1.2 An array of supported protocols with versions. Valid protocols: TLSv1, TLSv1.1, TLSv1.2.

@marius-dr
Copy link
Member Author

@kobelb that phrasing is better indeed. Changed it now.

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Copy link
Contributor

@kobelb kobelb left a comment

Choose a reason for hiding this comment

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

LGTM - thanks Marius!!

@marius-dr marius-dr merged commit a5f7413 into master Aug 22, 2018
@kobelb
Copy link
Contributor

kobelb commented Aug 22, 2018

@marius-dr you mind backporting this as far back as we can without too many conflicts?

marius-dr added a commit to marius-dr/kibana that referenced this pull request Aug 22, 2018
…22244)

* Add clarification for server.ssl.supportedProtocols setting

Added clarification that the setting has to be an array. With the current wording you can assume that you can just add it as a simple string.

* Update settings.asciidoc
marius-dr added a commit to marius-dr/kibana that referenced this pull request Aug 22, 2018
…22244)

* Add clarification for server.ssl.supportedProtocols setting

Added clarification that the setting has to be an array. With the current wording you can assume that you can just add it as a simple string.

* Update settings.asciidoc
marius-dr added a commit that referenced this pull request Aug 23, 2018
…22265)

* Add clarification for server.ssl.supportedProtocols setting

Added clarification that the setting has to be an array. With the current wording you can assume that you can just add it as a simple string.

* Update settings.asciidoc
marius-dr added a commit that referenced this pull request Aug 23, 2018
…22263)

* Add clarification for server.ssl.supportedProtocols setting

Added clarification that the setting has to be an array. With the current wording you can assume that you can just add it as a simple string.

* Update settings.asciidoc
@marius-dr marius-dr deleted the marius-dr-docs-update branch August 23, 2018 15:06
marius-dr added a commit that referenced this pull request Aug 24, 2018
…22264)

* Add clarification for server.ssl.supportedProtocols setting

Added clarification that the setting has to be an array. With the current wording you can assume that you can just add it as a simple string.

* Update settings.asciidoc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Docs Team:Security Team focused on: Auth, Users, Roles, Spaces, Audit Logging, and more!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants