mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Fix minor issues with docker_login docs (#35081)
* Fix typos in docker_login reauthorize parameter * Remove note about docker_login email address Docker Hub no longer requires an email address. * Remove check for email parameter with Docker Hub This is no longer required, so login should not fail if it's not provided.
This commit is contained in:
parent
ccb7909cc5
commit
1e7ab24e40
1 changed files with 2 additions and 9 deletions
|
@ -46,11 +46,10 @@ options:
|
||||||
email:
|
email:
|
||||||
required: False
|
required: False
|
||||||
description:
|
description:
|
||||||
- "The email address for the registry account. NOTE: private registries may not require this,
|
- "The email address for the registry account."
|
||||||
but Docker Hub requires it."
|
|
||||||
reauthorize:
|
reauthorize:
|
||||||
description:
|
description:
|
||||||
- Refresh exiting authentication found in the configuration file.
|
- Refresh existing authentication found in the configuration file.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'no'
|
default: 'no'
|
||||||
aliases:
|
aliases:
|
||||||
|
@ -98,7 +97,6 @@ EXAMPLES = '''
|
||||||
docker_login:
|
docker_login:
|
||||||
username: docker
|
username: docker
|
||||||
password: rekcod
|
password: rekcod
|
||||||
email: docker@docker.io
|
|
||||||
|
|
||||||
- name: Log into private registry and force re-authorization
|
- name: Log into private registry and force re-authorization
|
||||||
docker_login:
|
docker_login:
|
||||||
|
@ -111,13 +109,11 @@ EXAMPLES = '''
|
||||||
docker_login:
|
docker_login:
|
||||||
username: docker
|
username: docker
|
||||||
password: rekcod
|
password: rekcod
|
||||||
email: docker@docker.io
|
|
||||||
config_path: /tmp/.mydockercfg
|
config_path: /tmp/.mydockercfg
|
||||||
|
|
||||||
- name: Log out of DockerHub
|
- name: Log out of DockerHub
|
||||||
docker_login:
|
docker_login:
|
||||||
state: absent
|
state: absent
|
||||||
email: docker@docker.com
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
|
@ -324,9 +320,6 @@ def main():
|
||||||
login_result={}
|
login_result={}
|
||||||
)
|
)
|
||||||
|
|
||||||
if client.module.params['state'] == 'present' and client.module.params['registry_url'] == DEFAULT_DOCKER_REGISTRY and not client.module.params['email']:
|
|
||||||
client.module.fail_json(msg="'email' is required when logging into DockerHub")
|
|
||||||
|
|
||||||
LoginManager(client, results)
|
LoginManager(client, results)
|
||||||
if 'actions' in results:
|
if 'actions' in results:
|
||||||
del results['actions']
|
del results['actions']
|
||||||
|
|
Loading…
Reference in a new issue