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

EE guides: add run_community_ee_image.rst #222

Merged
merged 26 commits into from Sep 26, 2023

Conversation

Andersson007
Copy link
Contributor

EE guides: add run_community_ee_image.rst

Rationale: in case users want just try it w/o building a custom one

@github-actions github-actions bot added the needs_triage Needs a first human triage before being processed. label Aug 2, 2023
@Andersson007
Copy link
Contributor Author

@Spredzy @oraNod @samccann

@felixfontein
Copy link
Collaborator

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.

@felixfontein
Copy link
Collaborator

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
Copy link
Collaborator

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 :-)

Copy link
Contributor Author

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!

Copy link
Collaborator

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).

Copy link
Contributor Author

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

@Andersson007
Copy link
Contributor Author

@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.
Copy link
Collaborator

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.

@samccann samccann removed the needs_triage Needs a first human triage before being processed. label Aug 4, 2023
@Andersson007
Copy link
Contributor Author

@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.
I've also put a comment in ansible-community/ansible-build-data#278 (comment)

First of all, I'd like to highlight that, as the power of EE unfolds when users build
their custom images, the goal of this one is to be like a thing for users
who doesn't want to go through the whole getting-started workflow
(setting up environment, building a custom EE, etc.) to try out the technology,
i.e. to quickly run something inside an EE to get intrigued enough to go further.

Things will be documented, of course.
I didn't put the list of the collections over here intentionally to keep the docs newcomer oriented
and give them an opportunity to figure it out themselves.
You're right, some image-associated docs should be there, though i wouldn't consider it as a blocker for announcing
because of the image's purpose described above.

The location for the image you're suggesting sounds good.

@Andersson007
Copy link
Contributor Author

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)

@samccann
Copy link
Contributor

@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?

@Andersson007
Copy link
Contributor Author

@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?

The plan is that we'll have all the docs in place before the announcement. We can merge it closer, no problem.
Your feedback has been reflected, thanks! PTAL

Andersson007 and others added 16 commits September 18, 2023 10:40
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>
@Andersson007
Copy link
Contributor Author

Andersson007 commented Sep 18, 2023

I deliberately added only community-ee-minimal here to avoid any unnecessary details.
we can merge it now
it's a blocker for announcing the EE guide and community-ee-*'s

UPDATE: I now see there's a not solved question about quay.io, put a comment

@Andersson007
Copy link
Contributor Author

I checked and everything seems fine, sorry for the noise, the comment about screwing up the history was deleted, the above comment is relevant ^.

@Andersson007
Copy link
Contributor Author

Thanks everyone for the great discussion!
I've just updated the links (see the last commit) and it's ready for merge.
Then we'll announce the guide as well as the images after this PR gets merged.

@oraNod oraNod merged commit f1c34cd into ansible:devel Sep 26, 2023
7 checks passed
@oraNod
Copy link
Contributor

oraNod commented Sep 26, 2023

Thanks @Andersson007

@Andersson007
Copy link
Contributor Author

thanks everyone!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants