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

Document ansible-core architecture #2131

Open
mariolenz opened this issue Nov 11, 2024 · 5 comments
Open

Document ansible-core architecture #2131

mariolenz opened this issue Nov 11, 2024 · 5 comments
Labels
techreview needs technical review

Comments

@mariolenz
Copy link
Contributor

I'm looking for documentation about the architecture and inner workings of ansible-core. I didn't find anything about this. Maybe it exists, in that case it should be made easier to find.

I think knowing more about ansible-core, which is the base of the Ansible ecosystem, would help people to contribute. Not only to ansible-core itself, but also to other projects.

For example, I was looking for a way to cache sessions to a remote API. I learned that each task is a separate process. But I think this isn't documented. At least, I didn't find this anywhere. Someone had to tell me.

I think documenting the inner workings of ansible-core would be helpful to the Ansible community at large. Not everyone has the time to find out by reading (and understanding!) the source code.

@ansible-documentation-bot ansible-documentation-bot bot added the needs_triage Needs a first human triage before being processed. label Nov 11, 2024
@oraNod oraNod added the DaWGs Good discussion item for the DaWGs label Nov 11, 2024
@webknjaz
Copy link
Member

@mariolenz
Copy link
Contributor Author

@webknjaz Your link doesn't explain or document how ansible-core really works...

@samccann samccann added techreview needs technical review and removed DaWGs Good discussion item for the DaWGs needs_triage Needs a first human triage before being processed. labels Nov 12, 2024
@samccann
Copy link
Contributor

related issue #1295

@sivel
Copy link
Member

sivel commented Nov 12, 2024

fwiw, we have no real documentation about this internal or otherwise. I think some people have little bits and pieces, and some really old whiteboard photos. This is, however, roughly on our TODO list to get something together by June 2025 as part of onboarding documentation we are in need of.

I'll attach a photo of a flow diagram we needed a few years back, and a script I created a while ago called fakesible.py that attempts to show in much less code an overall idea of how core works.

core-flow

https://gist.github.com/sivel/cd0ebabf9fea5401099e7820c58fb0dc

@mariolenz
Copy link
Contributor Author

@sivel Thanks! The flow diagram doesn't make everything clear to me, but it's a start 😃

Would be great if you (as in you, the core team and not you personally) could work a bit on it publish this somewhere.

I agree that this would, apart from helping the community at large, be a good thing to have for your onboarding documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
techreview needs technical review
Projects
Status: 🆕 Triage
Development

No branches or pull requests

5 participants