Skip to content

Commit

Permalink
Prepare release: improve documentation, add release summary (#3)
Browse files Browse the repository at this point in the history
* Add release summary for 0.1.0.

* Update README.
  • Loading branch information
felixfontein committed Oct 30, 2020
1 parent f4210b3 commit 81948c7
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 26 deletions.
58 changes: 32 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,37 +12,43 @@ Tested with the current Ansible 2.9 and 2.10 releases and the current developmen

Most modules and plugins require the [Docker SDK for Python](https://pypi.org/project/docker/). For Python 2.6 support, use [the deprecated docker-py library](https://pypi.org/project/docker-py/) instead.

Both libraries cannot be installed at the same time. If you accidentally did install them simultaneously, you have to uninstall *both* before re-installing one of them.

## Included content

* Connection plugins:
- community.docker.docker
- community.docker.docker: use Docker containers as remotes
* Inventory plugins:
- community.docker.docker_machine
- community.docker.docker_swarm
- community.docker.docker_machine: collect Docker machines as inventory
- community.docker.docker_swarm: collect Docker Swarm nodes as inventory
* Modules:
- community.docker.docker_compose
- community.docker.docker_config
- community.docker.docker_container_info
- community.docker.docker_container
- community.docker.docker_host_info
- community.docker.docker_image_info
- community.docker.docker_image
- community.docker.docker_login
- community.docker.docker_network_info
- community.docker.docker_network
- community.docker.docker_node_info
- community.docker.docker_node
- community.docker.docker_prune
- community.docker.docker_secret
- community.docker.docker_stack_info
- community.docker.docker_stack
- community.docker.docker_stack_task_info
- community.docker.docker_swarm_info
- community.docker.docker_swarm
- community.docker.docker_swarm_service_info
- community.docker.docker_swarm_service
- community.docker.docker_volume_info
- community.docker.docker_volume
* Docker:
- community.docker.docker_container: manage Docker containers
- community.docker.docker_container_info: retrieve information on Docker containers
- community.docker.docker_host_info: retrieve information on the Docker daemon
- community.docker.docker_image: manage Docker images
- community.docker.docker_image_info: retrieve information on Docker images
- community.docker.docker_login: log in and out to/from registries
- community.docker.docker_network: manage Docker networks
- community.docker.docker_network_info: retrieve information on Docker networks
- community.docker.docker_prune: prune Docker containers, images, networks, volumes, and build data
- community.docker.docker_volume: manage Docker volumes
- community.docker.docker_volume_info: retrieve information on Docker volumes
* Docker Compose:
- community.docker.docker_compose: manage Docker Compose files
* Docker Swarm:
- community.docker.docker_config: manage configurations
- community.docker.docker_node: manage Docker Swarm nodes
- community.docker.docker_node_info: retrieve information on Docker Swarm nodes
- community.docker.docker_secret: manage secrets
- community.docker.docker_swarm: manage Docker Swarm
- community.docker.docker_swarm_info: retrieve information on Docker Swarm
- community.docker.docker_swarm_service: manage Docker Swarm services
- community.docker.docker_swarm_service_info: retrieve information on Docker Swarm services
* Docker Stack:
- community.docker.docker_stack: manage Docker Stacks
- community.docker.docker_stack_info: retrieve information on Docker Stacks
- community.docker.docker_stack_task_info: retrieve information on tasks in Docker Stacks

## Using this collection

Expand Down
4 changes: 4 additions & 0 deletions changelogs/fragments/0.1.0.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
release_summary: |
The ``community.docker`` continues the work on the Ansible docker modules and plugins from their state in ``community.general`` 1.2.0. The changes listed here are thus relative to the modules and plugins ``community.general.docker*``.
All deprecation removals planned for ``community.general`` 2.0.0 have been applied. All deprecation removals scheduled for ``community.general`` 3.0.0 have been re-scheduled for ``community.docker`` 2.0.0.

0 comments on commit 81948c7

Please sign in to comment.