Adding docker_login (#3494)
* Adding docker_login * Set correct version_added. * Fix github credentials
This commit is contained in:
Chris Houseknecht
Matt Clay
parent
9284c80039
commit
c5b7e456bd
1 changed files with 303 additions and 0 deletions
303
lib/ansible/modules/cloud/docker/docker_login.py
Normal file
303
lib/ansible/modules/cloud/docker/docker_login.py
Normal file
|
|
@ -0,0 +1,303 @@
|
|||
#!/usr/bin/python
|
||||
#
|
||||
# (c) 2016 Olaf Kilian <olaf.kilian@symanex.com>
|
||||
# Chris Houseknecht, <house@redhat.com>
|
||||
# James Tanner, <jtanner@redhat.com>
|
||||
#
|
||||
# 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/>.
|
||||
#
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: docker_login
|
||||
|
||||
short_description: Log into a Docker registry.
|
||||
|
||||
version_added: "2.0"
|
||||
|
||||
description:
|
||||
- Provides functionality similar to the "docker login" command.
|
||||
- Authenticate with a docker registry and add the credentials to your local Docker config file. Adding the
|
||||
credentials to the config files allows future connections to the registry using tools such as Ansible's Docker
|
||||
modules, the Docker CLI and docker-py without needing to provide credentials.
|
||||
- Running in check mode will perform the authentication without updating the config file.
|
||||
|
||||
options:
|
||||
registry_url:
|
||||
description:
|
||||
- The registry URL.
|
||||
default: "https://index.docker.io/v1/"
|
||||
aliases:
|
||||
- registry
|
||||
- url
|
||||
username:
|
||||
description:
|
||||
- The username for the registry account
|
||||
required: true
|
||||
default: null
|
||||
password:
|
||||
description:
|
||||
- The plaintext password for the registry account
|
||||
required: true
|
||||
default: null
|
||||
email:
|
||||
description:
|
||||
- "The email address for the registry account. NOTE: private registries may not require this,
|
||||
but Docker Hub requires it."
|
||||
default: None
|
||||
reauthorize:
|
||||
description:
|
||||
- Refresh exiting authentication found in the configuration file.
|
||||
default: false
|
||||
aliases:
|
||||
- reauth
|
||||
config_path:
|
||||
description:
|
||||
- Custom path to the Docker CLI configuration file.
|
||||
default: ~/.docker/config.json
|
||||
aliases:
|
||||
- self.config_path
|
||||
- dockercfg_path
|
||||
|
||||
extends_documentation_fragment:
|
||||
- docker
|
||||
|
||||
requirements:
|
||||
- "python >= 2.6"
|
||||
- "docker-py >= 1.7.0"
|
||||
- "Docker API >= 1.20"
|
||||
|
||||
authors:
|
||||
- "Olaf Kilian <olaf.kilian@symanex.com>"
|
||||
- "Chris Houseknecht (@chouseknecht)"
|
||||
- "James Tanner (@jctanner)"
|
||||
|
||||
version_added: "2.0"
|
||||
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
||||
- name: Log into DockerHub
|
||||
docker_login:
|
||||
username: docker
|
||||
password: rekcod
|
||||
email: docker@docker.io
|
||||
|
||||
- name: Log into private registry and force re-authorization
|
||||
docker_login:
|
||||
registry: your.private.registry.io
|
||||
username: yourself
|
||||
password: secrets3
|
||||
reauthorize: yes
|
||||
|
||||
- name: Log into DockerHub using a custom config file
|
||||
docker_login:
|
||||
username: docker
|
||||
password: rekcod
|
||||
email: docker@docker.io
|
||||
config_path: /tmp/.mydockercfg
|
||||
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
actions:
|
||||
description: List of actions taken by the module.
|
||||
returned: always
|
||||
type: list
|
||||
sample: [
|
||||
"Log into https://index.docker.io/v1/",
|
||||
"Updated config file /Users/chouseknecht/.docker/config.json with new authorization for https://index.docker.io/v1/"
|
||||
]
|
||||
login_results:
|
||||
descriptoin: Results from the login.
|
||||
returned: always
|
||||
type: dict
|
||||
sample:{
|
||||
"email": "testuer@yahoo.com",
|
||||
"password": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER",
|
||||
"serveraddress": "localhost:5000",
|
||||
"username": "testuser"
|
||||
}
|
||||
}
|
||||
'''
|
||||
|
||||
import base64
|
||||
|
||||
from ansible.module_utils.docker_common import *
|
||||
|
||||
|
||||
class LoginManager(DockerBaseClass):
|
||||
|
||||
def __init__(self, client, results):
|
||||
|
||||
super(LoginManager, self).__init__()
|
||||
|
||||
self.client = client
|
||||
self.results = results
|
||||
parameters = self.client.module.params
|
||||
self.check_mode = self.client.check_mode
|
||||
|
||||
self.registry_url = parameters.get('registry_url')
|
||||
self.username = parameters.get('username')
|
||||
self.password = parameters.get('password')
|
||||
self.email = parameters.get('email')
|
||||
self.reauthorize = parameters.get('reauthorize')
|
||||
self.config_path = parameters.get('config_path')
|
||||
|
||||
self.login()
|
||||
|
||||
def fail(self, msg):
|
||||
self.client.fail(msg)
|
||||
|
||||
def login(self):
|
||||
'''
|
||||
Log into the registry with provided username/password. On success update the config
|
||||
file with the new authorization.
|
||||
|
||||
:return: None
|
||||
'''
|
||||
|
||||
if self.email and not re.match(EMAIL_REGEX, self.email):
|
||||
self.fail("Parameter error: the email address appears to be incorrect. Expecting it to match "
|
||||
"/%s/" % (EMAIL_REGEX))
|
||||
|
||||
self.results['actions'].append("Logged into %s" % (self.registry_url))
|
||||
self.log("Log into %s with username %s" % (self.registry_url, self.username))
|
||||
try:
|
||||
response = self.client.login(
|
||||
self.username,
|
||||
password=self.password,
|
||||
email=self.email,
|
||||
registry=self.registry_url,
|
||||
reauth=self.reauthorize,
|
||||
dockercfg_path=self.config_path
|
||||
)
|
||||
except Exception, exc:
|
||||
self.fail("Logging into %s for user %s failed - %s" % (self.registry_url, self.username, str(exc)))
|
||||
self.results['login_result'] = response
|
||||
|
||||
if not self.check_mode:
|
||||
self.update_config_file()
|
||||
|
||||
def config_file_exists(self, path):
|
||||
if os.path.exists(path):
|
||||
self.log("Configuration file %s exists" % (path))
|
||||
return True
|
||||
self.log("Configuration file %s not found." % (path))
|
||||
return False
|
||||
|
||||
def create_config_file(self, path):
|
||||
'''
|
||||
Create a config file with a JSON blob containing an auths key.
|
||||
|
||||
:return: None
|
||||
'''
|
||||
|
||||
self.log("Creating docker config file %s" % (path))
|
||||
config_path_dir = os.path.dirname(path)
|
||||
if not os.path.exists(config_path_dir):
|
||||
try:
|
||||
os.makedirs(config_path_dir)
|
||||
except Exception, exc:
|
||||
self.fail("Error: failed to create %s - %s" % (config_path_dir, str(exc)))
|
||||
self.write_config(path, dict(auths=dict()))
|
||||
|
||||
def write_config(self, path, config):
|
||||
try:
|
||||
json.dump(config, open(path, "w"), indent=5, sort_keys=True)
|
||||
except Exception, exc:
|
||||
self.fail("Error: failed to write config to %s - %s" % (path, str(exc)))
|
||||
|
||||
def update_config_file(self):
|
||||
'''
|
||||
If the authorization not stored in the config file or reauthorize is True,
|
||||
update the config file with the new authorization.
|
||||
|
||||
:return: None
|
||||
'''
|
||||
|
||||
path = os.path.expanduser(self.config_path)
|
||||
if not self.config_file_exists(path):
|
||||
self.create_config_file(path)
|
||||
|
||||
try:
|
||||
# read the existing config
|
||||
config = json.load(open(path, "r"))
|
||||
except ValueError:
|
||||
self.log("Error reading config from %s" % (path))
|
||||
config = dict()
|
||||
|
||||
if not config.get('auths'):
|
||||
self.log("Adding auths dict to config.")
|
||||
config['auths'] = dict()
|
||||
|
||||
if not config['auths'].get(self.registry_url):
|
||||
self.log("Adding registry_url %s to auths." % (self.registry_url))
|
||||
config['auths'][self.registry_url] = dict()
|
||||
|
||||
encoded_credentials = dict(
|
||||
auth=base64.b64encode(self.username + b':' + self.password),
|
||||
email=self.email
|
||||
)
|
||||
|
||||
if config['auths'][self.registry_url] != encoded_credentials or self.reauthorize:
|
||||
# Update the config file with the new authorization
|
||||
config['auths'][self.registry_url] = encoded_credentials
|
||||
self.log("Updating config file %s with new authorization for %s" % (path, self.registry_url))
|
||||
self.results['actions'].append("Updated config file %s with new authorization for %s" % (
|
||||
path, self.registry_url))
|
||||
self.results['changed'] = True
|
||||
self.write_config(path, config)
|
||||
|
||||
|
||||
def main():
|
||||
|
||||
argument_spec=dict(
|
||||
registry_url=dict(type='str', required=False, default=DEFAULT_DOCKER_REGISTRY, aliases=['registry', 'url']),
|
||||
username=dict(type='str', required=True),
|
||||
password=dict(type='str', required=True, no_log=True),
|
||||
email=dict(type='str'),
|
||||
reauthorize=dict(type='bool', default=False, aliases=['reauth']),
|
||||
config_path=dict(type='str', default='~/.docker/config.json', aliases=['self.config_path',
|
||||
'dockercfg_path']),
|
||||
)
|
||||
|
||||
required_if = [
|
||||
('registry_url', DEFAULT_DOCKER_REGISTRY, ['email'])
|
||||
]
|
||||
|
||||
client = AnsibleDockerClient(
|
||||
argument_spec=argument_spec,
|
||||
supports_check_mode=True,
|
||||
required_if=required_if
|
||||
)
|
||||
|
||||
results = dict(
|
||||
changed=False,
|
||||
actions=[],
|
||||
login_result={}
|
||||
)
|
||||
|
||||
LoginManager(client, results)
|
||||
client.module.exit_json(**results)
|
||||
|
||||
# import module snippets
|
||||
from ansible.module_utils.basic import *
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Reference in a new issue