#!/usr/bin/python # -*- coding: utf-8 -*- # (c) 2012, Matt Wright <matt@nobien.net> # # This file is part of Ansible # # Ansible is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # Ansible is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with Ansible. If not, see <http://www.gnu.org/licenses/>. # # Example: # - name: add nginx repo # action: apt_repository repo=ppa:nginx/stable state=present # DOCUMENTATION = ''' --- module: apt_repository short_description: Manages apt repositores description: - Manages apt repositories (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: - If the repository is added, C(apt-get update) is invoked. - This module works on Debian and Ubuntu only and requires C(apt-add-repository) be available on the destination server. To ensure this package is available use the M(apt) module and install the C(python-software-properties) package (or C(software-properties-common) in Ubuntu 13.04 or newer) before using this module. - This module cannot be used on Debian Squeeze (Version 6) as there is no C(add-apt-repository) in C(python-software-properties) - A bug in C(apt-add-repository) always adds C(deb) and C(deb-src) types for repositories (see the issue on Launchpad U(https://bugs.launchpad.net/ubuntu/+source/software-properties/+bug/987264)), if a repo doesn't have source information (eg MongoDB repo from 10gen) the system will fail while updating repositories. author: Matt Wright requirements: [ python-apt ] ''' EXAMPLES = ''' # Add nginx stable repository from PPA - apt_repository: repo=ppa:nginx/stable # Add specified repository into sources. - apt_repository: repo='deb http://archive.canonical.com/ubuntu hardy partner' ''' import platform try: import apt import apt_pkg HAVE_PYAPT = True except ImportError: HAVE_PYAPT = False APT = "/usr/bin/apt-get" ADD_APT_REPO = 'add-apt-repository' def check_cmd_needs_y(): if platform.dist()[0] == 'debian' or float(platform.dist()[1]) >= 11.10: return True return False def repo_exists(module, repo): configured = False slist = apt_pkg.SourceList() if not slist.read_main_list(): module.fail_json(msg="Failed to parse sources.list") for metaindex in slist.list: if repo in metaindex.uri: configured = True return configured def main(): add_apt_repository = None arg_spec = dict( repo=dict(required=True), state=dict(default='present', choices=['present', 'absent']) ) module = AnsibleModule(argument_spec=arg_spec, supports_check_mode=True) if not HAVE_PYAPT: module.fail_json(msg="Could not import python modules: apt, apt_pkg. Please install python-apt package.") add_apt_repository = module.get_bin_path(ADD_APT_REPO, True) if check_cmd_needs_y(): add_apt_repository += ' -y' repo = module.params['repo'] state = module.params['state'] repo_url = repo if 'ppa:' in repo_url and not 'http://' in repo_url: # looks like ppa:nginx/stable repo_url = repo.split(':')[1] elif len(repo_url.split(' ')) > 1: # could be: # http://myserver/path/to/repo free non-free # deb http://myserver/path/to/repo free non-free for i in repo_url.split(): for prot in ['http', 'file', 'ftp']: if prot in i: repo_url = i break exists = repo_exists(module, repo_url) rc = 0 out = '' err = '' if state == 'absent' and exists: if module.check_mode: module.exit_json(changed=True) cmd = '%s "%s" --remove' % (add_apt_repository, repo) rc, out, err = module.run_command(cmd) elif state == 'present' and not exists: if module.check_mode: module.exit_json(changed=True) cmd = '%s "%s"' % (add_apt_repository, repo) rc, out, err = module.run_command(cmd) else: module.exit_json(changed=False, repo=repo, state=state) if rc != 0: module.fail_json(msg=err) else: changed = True if state == 'present' and changed: rc, out, err = module.run_command('%s update' % APT) module.exit_json(changed=changed, repo=repo, state=state) # this is magic, see lib/ansible/module_common.py #<<INCLUDE_ANSIBLE_MODULE_COMMON>> main()