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

[Docs] Update Metricbeat and Filebeat documentation to remove mentions of PKI authentication for Kibana APIs #24980

Closed
mbarretta opened this issue Apr 7, 2021 · 3 comments · Fixed by #27422
Assignees
Labels
needs_edit Indicates that the doc changes need an edit after merging. Team:Docs Label for the Observability docs team

Comments

@mbarretta
Copy link

mbarretta commented Apr 7, 2021

In elastic/kibana#82817, support for PKI auth against Kibana APIs was removed. The SSL documentation[0][1][2][3] still reference PKI configuration. This should be removed and a note highlighting the inability to use PKI should be added.

[0]https://www.elastic.co/guide/en/beats/metricbeat/7.12/configuration-ssl.html
[1]https://www.elastic.co/guide/en/beats/filebeat/7.12/configuration-ssl.html
[2]https://www.elastic.co/guide/en/beats/filebeat/7.12/setup-kibana-endpoint.html
[3]https://www.elastic.co/guide/en/beats/metricbeat/7.12/setup-kibana-endpoint.html

@mbarretta mbarretta added the needs_edit Indicates that the doc changes need an edit after merging. label Apr 7, 2021
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Apr 7, 2021
@mbarretta mbarretta added the Team:Docs Label for the Observability docs team label Apr 7, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/obs-docs (Team:Docs)

@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Apr 7, 2021
@EamonnTP
Copy link

EamonnTP commented Jun 8, 2021

Thanks @mbarretta Just to confirm. Do we need to change the paths to the following:

Client:
output.elasticsearch.ssl.certificate_authorities: ["/etc/client/ca.pem"]
output.elasticsearch.ssl.certificate: "/etc/client/cert.pem"
output.elasticsearch.ssl.key: "/etc/client/cert.key"

Server:
output.elasticsearch.ssl.certificate_authorities: ["/etc/server/ca.pem"]
output.elasticsearch.ssl.certificate: "/etc/server/cert.pem"
output.elasticsearch.ssl.key: "/etc/server/cert.key"

In terms of the note, could you provide some guidance on what we need to call out? Do we need to link to another section in the docs?

@mbarretta
Copy link
Author

@EamonnTP

Yes, I think just dropping pki/ from the ssl path examples (you covered them all, I think) will do fine.

Re note, I think a note is only needed in the setup-kibana-endpoint pages. Since the configuration is for the Kibana API connection, I think some text in the intro linking to API authentication methods makes sense. Something like:

Starting with Filebeat 6.0.0, the Kibana dashboards are loaded into Kibana via the Kibana API. This requires a Kibana endpoint configuration. Details on authenticating to the Kibana API can be found in the Kibana API authentication documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs_edit Indicates that the doc changes need an edit after merging. Team:Docs Label for the Observability docs team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants