alibaba / ansible-provider-docs

Aliyun Ansible Modules Documentation

This project contains the source code of Module Documentation for Aliyun Ansible. Follow below instructions to generate documentation from DOCUMENTATION string in the modules.

Pre-Requisites (Ubuntu OS)

• make utility
  
  Make utility is required to generate html docs. Install make utility by running below command on Ubuntu.

sudo apt-get -y install make 

• python version 2.7.X
  
  Run below command to install python.

sudo apt-get -y install python2.7

Check python installation by running below command.

python --version

• Install pip
  
  Run below command to install pip and other packages.

sudo apt-get -y install python-pip python-dev dos2unix

• Install sphinx and theme:

pip install sphinx==1.4.8 sphinx_rtd_theme

Build the documentation

To build module documentation you'll need to run below command in ansible-provider-docs/docs/docsite folder.

cd docs/docsite
make webdocs 

The generated html files are in _build/html/ folder

ansible-provider-docs's Issues

nios_next_ip only works for ipv4

We need similar function to nios_next_ip lookup but for ipv6 networks

Exception occured building docs

I have installed all the dependencies according to the documentation and run make webdocs in the appropriate directory however I get this error...

Exception occurred:
  File "/home/byron/tmp/ansible-provider-docs/venv/local/lib/python2.7/site-packages/sphinx/util/parallel.py", line 97, in _join_one
    exc, result = pipe.recv()
EOFError
The full traceback has been saved in /tmp/sphinx-err-1Rwvgc.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!

The contents of /tmp/sphinx-err-1Rwvgc.log are as follows...

# Sphinx version: 1.4.8
# Python version: 2.7.16 (CPython)
# Docutils version: 0.15.2 release
# Jinja2 version: 2.10.1
# Last messages:
#   reading sources... [ 78%] modules/vyos_system_module .. modules/win_pagefile_module
#   reading sources... [ 81%] modules/win_path_module .. modules/zfs_facts_module
#   reading sources... [ 84%] modules/zfs_module .. plugins/callback/osx_say
#   reading sources... [ 87%] plugins/callback/profile_roles .. plugins/inventory/yaml
#   reading sources... [ 90%] plugins/lookup .. plugins/lookup/vars
#   reading sources... [ 93%] plugins/plugins .. user_guide/command_line_tools
#   reading sources... [ 96%] user_guide/index .. user_guide/windows_winrm
#   reading sources... [100%] vmware/faq .. vmware/vmware_troubleshooting
#   
#   waiting for workers...
# Loaded extensions:
#   alabaster (0.7.12) from /home/byron/tmp/ansible-provider-docs/venv/local/lib/python2.7/site-packages/alabaster/__init__.pyc
#   sphinx.ext.autodoc (1.4.8) from /home/byron/tmp/ansible-provider-docs/venv/local/lib/python2.7/site-packages/sphinx/ext/autodoc.pyc
#   sphinx.ext.intersphinx (1.4.8) from /home/byron/tmp/ansible-provider-docs/venv/local/lib/python2.7/site-packages/sphinx/ext/intersphinx.pyc
Traceback (most recent call last):
  File "/home/byron/tmp/ansible-provider-docs/venv/local/lib/python2.7/site-packages/sphinx/cmdline.py", line 244, in main
    app.build(opts.force_all, filenames)
  File "/home/byron/tmp/ansible-provider-docs/venv/local/lib/python2.7/site-packages/sphinx/application.py", line 297, in build
    self.builder.build_update()
  File "/home/byron/tmp/ansible-provider-docs/venv/local/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 251, in build_update
    'out of date' % len(to_build))
  File "/home/byron/tmp/ansible-provider-docs/venv/local/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 265, in build
    self.doctreedir, self.app))
  File "/home/byron/tmp/ansible-provider-docs/venv/local/lib/python2.7/site-packages/sphinx/environment.py", line 567, in update
    self._read_parallel(docnames, app, nproc=app.parallel)
  File "/home/byron/tmp/ansible-provider-docs/venv/local/lib/python2.7/site-packages/sphinx/environment.py", line 625, in _read_parallel
    tasks.join()
  File "/home/byron/tmp/ansible-provider-docs/venv/local/lib/python2.7/site-packages/sphinx/util/parallel.py", line 92, in join
    self._join_one()
  File "/home/byron/tmp/ansible-provider-docs/venv/local/lib/python2.7/site-packages/sphinx/util/parallel.py", line 97, in _join_one
    exc, result = pipe.recv()
EOFError

Request for Documentation: docker module

Hello. I am using ansible to manage a lot of docker images and containers on my servers. I make extensive use of the docker_image and docker_container modules. However when it comes to running docker commands (e.g. docker run x), I have resorted to using the shell module.
I see that there is a docker module here but I don't see how to use it. The documentation is very small, and there are no examples. I don't know python or I would try to read the source code.
It would be very helpful if this module included more documentation and some examples. Thank you.

https://github.com/alibaba/ansible-provider-docs/blob/master/lib/ansible/plugins/connection/docker.py
https://docs.ansible.com/ansible/latest/plugins/connection/docker.html

KV secrets API v2

API request to kv v2 (http://server:8200/v1/secret/data/secretName)
...
"data = self.client.read(self.secret)"
...
returns extra data scope
... "response":{"data":{"data":{"secretKey" ...