-
Notifications
You must be signed in to change notification settings - Fork 154
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 a diagram for CAs and Certs usage between agent, fleet-server and ES #5263
Conversation
Pinging @elastic/elastic-agent-control-plane (Team:Elastic-Agent-Control-Plane) |
This pull request does not have a backport label. Could you fix it @AndersonQ? 🙏
NOTE: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a really good addition to the documentation. What tool did you use to generate this PDF? If the diagrams are created by code, it would be great to include that in the PR as well. Make it easier for others to update.
That is really the only negative I have with this PR is that updating the PDF if anything changes will not be as simple as updating some code and regenerating the graphs.
Thanks for adding this to the docs, @AndersonQ. As Blake said, this is a really useful addition. Have you considered using something like https://github.blog/developer-skills/github/include-diagrams-markdown-files-mermaid/ to generate the diagrams with code? That will solve the update issue that Blake mentioned as well. |
I was a "quick" thing I did for Nima, wasn't really intended to be in our docs, but Creaig pointed out that it's better than nothing. I did it on Miro. I can pass it to mermaid |
thanks for doing this. I was also using it in the other doc we are preparing for CA changes. |
We can probably put this in the user facing documentation in https://github.com/elastic/ingest-docs. CC @kilfoyle +1 to committing the source somewhere or having this in a place we can more easily maintain (shared Whimsical space?). That said I'd rather have hard to maintain documentation than no documentation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with the need to add whatever was used to generate the image.
Thanks for making the diagram!
I used miro to make this diagram, nothing special and anyone on platform ingest should be able to access it |
yeah will add some version of it in to the docs along with the other CA related sections Anderson helped out with. |
e143188
to
cb3f72b
Compare
cba0b66
to
2e3df02
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome! Really appreciate adjusting this to be code based, this is great!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for recreating the diagrams in Mermaid, @AndersonQ. These are super useful!
Sonarqube is expected but will never be triggered as there was no code change, force merging this to unblock @AndersonQ. |
What does this PR do?
Add a diagram showing the certificates and CAs used between the Elastic Agent, Fleet Server and Elasticsearch and their respective cli flag.
Why is it important?
Given the number of possible CAs and certificates and their respective cli options, it's often confusing which one is used on each connection. This diagram helps to explain that.
Checklist
[ ] My code follows the style guidelines of this project[ ] I have commented my code, particularly in hard-to-understand areas[ ] I have made corresponding changes to the documentation[ ] I have made corresponding change to the default configuration files[ ] I have added tests that prove my fix is effective or that my feature works[ ] I have added an entry in./changelog/fragments
using the changelog tool[ ] I have added an integration test or an E2E testDisruptive User Impact
None
How to test this PR locally
N/A
Related issues
Questions to ask yourself