Merge pull request #1128 from mavimo/devel

Added documentation to APT module
This commit is contained in:
Michael DeHaan 2012-09-28 16:12:58 -07:00
commit f51f10def5
2 changed files with 115 additions and 0 deletions

78
apt
View file

@ -19,6 +19,84 @@
# along with this software. If not, see <http://www.gnu.org/licenses/>.
#
DOCUMENTATION = '''
---
module: apt
short_description: Manages apt-packages (such as for Debian/Ubuntu).
description:
- Manages apt-packages (such as for Debian/Ubuntu).
version_added: "0.0.2"
options:
name:
description:
- A package name or package specifier with version, like foo or foo=1.0
required: false
default: null
state:
description:
- Indicate the package state
required: false
default: present
choices: [ "installed", "latest", "remove", "absent", "present" ]
update_cache:
description:
- Run the equivalent of apt-get update before the operation. Can be run as part of the package installation or a seperate step
required: false
default: "no"
choices: [ "yes", "no" ]
purge:
description:
- Will forge purge of configuration files if state is set to 'absent'.
required: false
default: "no"
choices: [ "yes", "no" ]
default_release:
description:
- Corresponds to the -t option for apt and sets pin priorities
required: false
default: null
install_recommends:
description:
- Corresponds to the --no-install-recommends option for apt, default behavior works as apt's default behavior, 'no' does not install recommended packages. Suggested packages are never installed.
required: false
default: "no"
choices: [ "yes", "no" ]
force:
description:
- If yes, force installs/removes.
required: false
default: "no"
choices: [ "yes", "no" ]
author: Matthew Williams
'''
EXAMPLES = [
"""
- code: apt pkg=foo update-cache=yes
description: Update repositories cache and install 'foo' package
""",
"""
- code: apt pkg=foo state=removed
description: Remove 'foo' package
""",
"""
- code: apt pkg=foo state=installed
description: Install the the package 'foo'
""",
"""
- code: apt pkg=foo=1.00 state=installed
description: Install the version '1.00' of package 'foo'
""",
"""
- code: apt pkg=nginx state=latest default-release=squeeze-backports update-cache=yes
description: Update the repository cache and update package 'ngnix' to latest versione using default release 'squeeze-backport'
""",
"""
- code: apt pkg=openjdk-6-jdk state=latest install-recommends=no
description: Install latest version of 'openjdk-6-jdk' ignoring 'install-recomands'
"""
]
import traceback
# added to stave off future warnings about apt api
import warnings

View file

@ -23,6 +23,43 @@
# action: apt_repository repo=ppa:nginx/stable state=present
#
DOCUMENTATION = '''
---
module: apt_repository
short_description: Manages apt repositores (such as for Debian/Ubuntu).
description:
- Manages apt repositores (such as for Debian/Ubuntu).
version_added: "0.7"
options:
repo:
description:
- The repository name/value
required: true
default: null
state:
description:
- The repository state
required: false
default: present
choices: [ "present", "absent" ]
notes:
- This module require 'apt-add-repository' wwill be available on destination server. To ensure this package is available use 'apt' module and install 'python-software-properties' package before use this module.
- This module work only on Ubuntu and unstable Debian, see U(https://github.com/ansible/ansible/pull/1082, this issue)
- A bug in 'apt-add-repository' always add 'deb' and 'deb-src' type for repo (see the U(https://bugs.launchpad.net/ubuntu/+source/software-properties/+bug/987264, issue on lunchpad)), if some repo don't have source (eg: MongoDB repo from 10gen) the system fail on update repositories.
author: Matt Wright
'''
EXAMPLES = [
"""
- code: apt_repository repo=ppa://nginx/stable
description: Add nginx stable repository from PPA
""",
"""
- code: apt_repository repo='deb http://archive.canonical.com/ubuntu hardy partner'
description: Add specified repository into sources.
"""
]
import platform
APT = "/usr/bin/apt-get"