-
Notifications
You must be signed in to change notification settings - Fork 662
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
Documentation on Platforms is either incomplete or missing references #2854
Comments
PS. If someone could point me to a source of truth for all options I would be happy to open a PR. |
I have found the solution for the environment variables.
|
I was looking for some docs regarding the platforms, especially |
This is the commit, where |
Seems like docker driver was removed from the core project #2811 and the documentation has moved with it. Looks like theres a full list of properties here https://github.com/ansible-community/molecule-docker/blob/master/molecule_docker/driver.py#L56 I don't know your doc generator so I can't answer this. Is it possible to pull python classes from another github repo? Would be great to have documentation for the drivers on the molecule documentation. If maintainers are not interested in this feel free to close. |
It's really annoying when you have to dive into the source to find out every detail of configuration. Ease of finding full documentation is a key aspect of software quality. |
@jkirk @gmolkvk, I don't see any docs anywhere about how the docker driver is used. Just examples and blog posts around the internet where people have grokked how it works from the source code. I just spent several days figuring out how to do the most basic of things with molecule - test a playbook using docker driver. Figuring out what image is used for each scenario, and how dependencies get installed on it (prepare.yml?? Dockerfile.j2?? pre_build_image?? the answer is "yes" :-() is not documented. scouring the web for answers finds numerous other molecule newbies that have been similarly frustrated, but I don't see any evidence of why this has never been changed/adopted? I will start with a simple fork/PR to improve the immediate issues I see. |
JFTR, I just stumbled about some notes about "pre_build_image", see: https://molecule.readthedocs.io/en/latest/examples.html?highlight=service%20started%20failed#customizing-the-docker-image-used-by-a-scenario-platform
|
Oh, nice! This info has been added via @timblaktu in #3604! Thanks very much! |
@zhan9san Could you clarify how you believe this issue is completed? As far as I can tell, the MR linked here is about "pre_build_image", which is just one of the many available properties for the docker "platform". See https://github.com/ansible-community/molecule-docker/blob/legacy/master/molecule_docker/driver.py#L62 The original topic of this issue is about the sparse documentation at https://molecule.readthedocs.io/en/latest/configuration.html#platforms I estimate that many (new) users may be frustrated when trying to find how to work with molecule when they cannot find this information. |
The links above do not work anymore.
FTR, the code for the molecule docker driver can now be found here: FTR, the code for the podman docker driver can now be found here:
So, I also still can not answer the following questions when looking at the documentation:
What is a good location to put this info in and prepare a documentation proposal? |
Issue Type
Molecule and Ansible details
N/A - This is about the latest documentation at https://molecule.readthedocs.io/en/latest/configuration.html#platforms
Desired Behavior
Perhaps I am missing something here, but I cannot seem to find any proper documentation about the supported properties for the class molecule.platforms.Platforms. I understand these may differ per platform type. Eg. docker may have other properties than Podman? But I would like to be able to somehow find what may be specified.
At time of writing this issue, the most verbose example in your documentation is the following
However, through trial and error I have found many more working properties.
Where would I start to look for a specification of all supported properties? Could the documentation be updated to refer to that?
I run into this problem when trying to find out how to pass "--env" variables to the container.
The text was updated successfully, but these errors were encountered: