Documentation on Platforms is either incomplete or missing references

Issue Type

• Feature request

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

platforms:
  - name: instance-1
    groups:
      - group1
      - group2
    children:
      - child_group1

However, through trial and error I have found many more working properties.

platforms:
  - name: some-platform
    image: # docker image
    command: # docker run CMD instruction
    volumes:
    - # volume mounts
    privileged: true/false
    pre_build_image: true/false

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.

[gmolkvk]

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.

[timblaktu]

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