-
Notifications
You must be signed in to change notification settings - Fork 330
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
EE guides: add run_community_ee_image.rst #222
Conversation
Where is this community-ee coming from, and where to find more information on it? That information should also be linked in the documentation, just saying "set of popular collections" is not very helpful as the user has no clue which ones these are. |
I would expect the community EE to be public first before this is merged. Also, is there a reason why the community EE is not part of the https://github.com/ansible-community/images repository? That was supposed to be the place for community maintained EEs and ansible-test images (though the EE part never really was properly used so far, mainly because creating an EE for Ansible itself never worked due to conflicting requirements). |
|
||
.. code-block:: bash | ||
|
||
ansible-navigator exec "ansible localhost -m setup" --execution-environment-image ghcr.io/ansible/community-ee:latest --mode stdout |
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.
The section says "Running a playbook", but now you removed the playbook :-)
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.
hehe, well spotted! Replaced playbook
with more abstract ansible
, PTAL. thanks!
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 would also show how to use the EE with a playbook and an inventory file (probably in a new section). Running direct commands on localhost is nice, but not something that generalizes well... if someone simpy replaces ansible localhost -m setup
with ansible-playbook -i inventory playbook.yml
, or even start to build a Docker image upon the community-ee image with their playbook and inventory in it, they won't use the EE as intended.
Having a direct command as the first step to use an EE is fine, but how to properly use it should be shown right after that (and not only after clicking a link or having to search for more information on it).
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.
Ah, great feedback, makes a lot of sense. thanks!
- Added an example (not to overwhelm the doc, it's only about localhost but i put a ref to the example from another page if users need it right now)
- Also added the community-ee as a base image to the building guide as by default it would use navigator's default image already containing a lot of other stuff and not aiming to be a base image i think
PTAL
docs/docsite/rst/getting_started_ee/run_execution_environment.rst
Outdated
Show resolved
Hide resolved
@felixfontein @oraNod PTAL |
=========================================== | ||
|
||
You can run ansible without the need to build a custom EE. | ||
Use the ``community-ee`` image that includes ``ansible-core`` and a set of Ansible community collections. |
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.
Looking at https://github.com/ansible-community/ansible-build-data/pull/278/files, I don't see any community collections. It's just ansible.*
ones.
@felixfontein @gotmax23, fair questions, thanks for the feedback! There'll be an announcement made within a few weeks about the new EE getting-started docs and the image. First of all, I'd like to highlight that, as the power of EE unfolds when users build Things will be documented, of course. The location for the image you're suggesting sounds good. |
can we merge this? (i believe community-ee deserves a separate page and its introduction doesn't fit this getting started / or at least this PR) |
@Andersson007 sorry I'm a bit behind here - why would we merge this before the ee is actually available and announced? A prior comment said 'a few weeks' ... so seems more appropriate to add to the docs closer to that time? |
docs/docsite/rst/getting_started_ee/run_execution_environment.rst
Outdated
Show resolved
Hide resolved
docs/docsite/rst/getting_started_ee/run_execution_environment.rst
Outdated
Show resolved
Hide resolved
docs/docsite/rst/getting_started_ee/run_execution_environment.rst
Outdated
Show resolved
Hide resolved
The plan is that we'll have all the docs in place before the announcement. We can merge it closer, no problem. |
Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
53e6127
to
8f5f8cf
Compare
I deliberately added only UPDATE: I now see there's a not solved question about quay.io, put a comment |
I checked and everything seems fine, sorry for the noise, the comment about screwing up the history was deleted, the above comment is relevant ^. |
Thanks everyone for the great discussion! |
Thanks @Andersson007 |
thanks everyone! |
EE guides: add run_community_ee_image.rst
Rationale: in case users want just try it w/o building a custom one