modules: fix examples to use FQCN (#644)

* modules: fix examples to use FQCN

* fix

* fix

* fix
This commit is contained in:
Andrew Klychkov 2020-07-13 22:50:31 +03:00 committed by GitHub
commit 41cfdda6a3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
533 changed files with 2130 additions and 2130 deletions

View file

@ -59,7 +59,7 @@ notes:
EXAMPLES = r'''
- name: Create access key
bitbucket_access_key:
community.general.bitbucket_access_key:
repository: 'bitbucket-repo'
username: bitbucket_username
key: '{{lookup("file", "bitbucket.pub") }}'
@ -67,7 +67,7 @@ EXAMPLES = r'''
state: present
- name: Delete access key
bitbucket_access_key:
community.general.bitbucket_access_key:
repository: bitbucket-repo
username: bitbucket_username
label: Bitbucket

View file

@ -57,7 +57,7 @@ notes:
EXAMPLES = r'''
- name: Create or update SSH key pair
bitbucket_pipeline_key_pair:
community.general.bitbucket_pipeline_key_pair:
repository: 'bitbucket-repo'
username: bitbucket_username
public_key: '{{lookup("file", "bitbucket.pub") }}'
@ -65,7 +65,7 @@ EXAMPLES = r'''
state: present
- name: Remove SSH key pair
bitbucket_pipeline_key_pair:
community.general.bitbucket_pipeline_key_pair:
repository: bitbucket-repo
username: bitbucket_username
state: absent

View file

@ -61,7 +61,7 @@ notes:
EXAMPLES = r'''
- name: Create known hosts from the list
bitbucket_pipeline_known_host:
community.general.bitbucket_pipeline_known_host:
repository: 'bitbucket-repo'
username: bitbucket_username
name: '{{ item }}'
@ -71,14 +71,14 @@ EXAMPLES = r'''
- example.com
- name: Remove known host
bitbucket_pipeline_known_host:
community.general.bitbucket_pipeline_known_host:
repository: bitbucket-repo
username: bitbucket_username
name: bitbucket.org
state: absent
- name: Specify public key file
bitbucket_pipeline_known_host:
community.general.bitbucket_pipeline_known_host:
repository: bitbucket-repo
username: bitbucket_username
name: bitbucket.org

View file

@ -64,7 +64,7 @@ notes:
EXAMPLES = r'''
- name: Create or update pipeline variables from the list
bitbucket_pipeline_variable:
community.general.bitbucket_pipeline_variable:
repository: 'bitbucket-repo'
username: bitbucket_username
name: '{{ item.name }}'
@ -76,7 +76,7 @@ EXAMPLES = r'''
- { name: AWS_SECRET, value: qwe789poi123vbn0, secured: True }
- name: Remove pipeline variable
bitbucket_pipeline_variable:
community.general.bitbucket_pipeline_variable:
repository: bitbucket-repo
username: bitbucket_username
name: AWS_ACCESS_KEY

View file

@ -46,7 +46,7 @@ options:
EXAMPLES = '''
- name: Checkout
bzr:
community.general.bzr:
name: bzr+ssh://foosball.example.org/path/to/branch
dest: /srv/checkout
version: 22

View file

@ -60,72 +60,72 @@ options:
EXAMPLES = '''
- name: Add a setting to ~/.gitconfig
git_config:
community.general.git_config:
name: alias.ci
scope: global
value: commit
- name: Add a setting to ~/.gitconfig
git_config:
community.general.git_config:
name: alias.st
scope: global
value: status
- name: Remove a setting from ~/.gitconfig
git_config:
community.general.git_config:
name: alias.ci
scope: global
state: absent
- name: Add a setting to ~/.gitconfig
git_config:
community.general.git_config:
name: core.editor
scope: global
value: vim
- name: Add a setting system-wide
git_config:
community.general.git_config:
name: alias.remotev
scope: system
value: remote -v
- name: Add a setting to a system scope (default)
git_config:
community.general.git_config:
name: alias.diffc
value: diff --cached
- name: Add a setting to a system scope (default)
git_config:
community.general.git_config:
name: color.ui
value: auto
- name: Make etckeeper not complaining when it is invoked by cron
git_config:
community.general.git_config:
name: user.email
repo: /etc
scope: local
value: 'root@{{ ansible_fqdn }}'
- name: Read individual values from git config
git_config:
community.general.git_config:
name: alias.ci
scope: global
- name: Scope system is also assumed when reading values, unless list_all=yes
git_config:
community.general.git_config:
name: alias.diffc
- name: Read all values from git config
git_config:
community.general.git_config:
list_all: yes
scope: global
- name: When list_all is yes and no scope is specified, you get configuration from all scopes
git_config:
community.general.git_config:
list_all: yes
- name: Specify a repository to include local settings
git_config:
community.general.git_config:
list_all: yes
repo: /path/to/repo.git
'''

View file

@ -77,7 +77,7 @@ notes:
EXAMPLES = '''
- name: Add a new read-only deploy key to a GitHub repository using basic authentication
github_deploy_key:
community.general.github_deploy_key:
owner: "johndoe"
repo: "example"
name: "new-deploy-key"
@ -87,7 +87,7 @@ EXAMPLES = '''
password: "supersecretpassword"
- name: Remove an existing deploy key from a GitHub repository
github_deploy_key:
community.general.github_deploy_key:
owner: "johndoe"
repository: "example"
name: "new-deploy-key"
@ -98,7 +98,7 @@ EXAMPLES = '''
state: absent
- name: Add a new deploy key to a GitHub repository, replace an existing key, use an OAuth2 token to authenticate
github_deploy_key:
community.general.github_deploy_key:
owner: "johndoe"
repository: "example"
name: "new-deploy-key"
@ -107,7 +107,7 @@ EXAMPLES = '''
token: "ABAQDAwXxn7kIMNWzcDfo..."
- name: Re-add a deploy key to a GitHub repository but with a different name
github_deploy_key:
community.general.github_deploy_key:
owner: "johndoe"
repository: "example"
name: "replace-deploy-key"
@ -116,7 +116,7 @@ EXAMPLES = '''
password: "supersecretpassword"
- name: Add a new deploy key to a GitHub repository using 2FA
github_deploy_key:
community.general.github_deploy_key:
owner: "johndoe"
repo: "example"
name: "new-deploy-key-2"
@ -126,7 +126,7 @@ EXAMPLES = '''
otp: 123456
- name: Add a read-only deploy key to a repository hosted on GitHub Enterprise
github_deploy_key:
community.general.github_deploy_key:
github_url: "https://api.example.com"
owner: "janedoe"
repo: "example"

View file

@ -61,7 +61,7 @@ author: "Phillip Gentry, CX Inc (@pcgentry)"
EXAMPLES = '''
- name: Create a new service hook ignoring duplicates
github_hooks:
community.general.github_hooks:
action: create
hookurl: http://11.111.111.111:2222
user: '{{ gituser }}'
@ -71,7 +71,7 @@ EXAMPLES = '''
# Cleaning all hooks for this repo that had an error on the last update.
# Since this works for all hooks in a repo it is probably best that this would be called from a handler.
- name: Clean all hooks
github_hooks:
community.general.github_hooks:
action: cleanall
user: '{{ gituser }}'
oauthkey: '{{ oauthkey }}'

View file

@ -46,7 +46,7 @@ get_status:
EXAMPLES = '''
- name: Check if GitHub issue is closed or not
github_issue:
community.general.github_issue:
organization: ansible
repo: ansible
issue: 23642

View file

@ -65,27 +65,27 @@ requirements:
EXAMPLES = '''
- name: Get latest release of a public repository
github_release:
community.general.github_release:
user: ansible
repo: ansible
action: latest_release
- name: Get latest release of testuseer/testrepo
github_release:
community.general.github_release:
token: tokenabc1234567890
user: testuser
repo: testrepo
action: latest_release
- name: Get latest release of test repo using username and password. Ansible 2.4.
github_release:
community.general.github_release:
user: testuser
password: secret123
repo: testrepo
action: latest_release
- name: Create a new release
github_release:
community.general.github_release:
token: tokenabc1234567890
user: testuser
repo: testrepo

View file

@ -86,7 +86,7 @@ author:
EXAMPLES = '''
- name: create a new webhook that triggers on push (password auth)
github_webhook:
community.general.github_webhook:
repository: ansible/ansible
url: https://www.example.com/hooks/
events:
@ -95,7 +95,7 @@ EXAMPLES = '''
password: "{{ github_password }}"
- name: Create a new webhook in a github enterprise installation with multiple event triggers (token auth)
github_webhook:
community.general.github_webhook:
repository: myorg/myrepo
url: https://jenkins.example.com/ghprbhook/
content_type: json
@ -109,7 +109,7 @@ EXAMPLES = '''
github_url: https://github.example.com
- name: Delete a webhook (password auth)
github_webhook:
community.general.github_webhook:
repository: ansible/ansible
url: https://www.example.com/hooks/
state: absent

View file

@ -46,14 +46,14 @@ author:
EXAMPLES = '''
- name: List hooks for a repository (password auth)
github_webhook_info:
community.general.github_webhook_info:
repository: ansible/ansible
user: "{{ github_user }}"
password: "{{ github_password }}"
register: ansible_webhooks
- name: List hooks for a repository on GitHub Enterprise (token auth)
github_webhook_info:
community.general.github_webhook_info:
repository: myorg/myrepo
user: "{{ github_user }}"
token: "{{ github_user_api_token }}"

View file

@ -61,7 +61,7 @@ options:
EXAMPLES = '''
- name: "Adding a project deploy key"
gitlab_deploy_key:
community.general.gitlab_deploy_key:
api_url: https://gitlab.example.com/
api_token: "{{ api_token }}"
project: "my_group/my_project"
@ -70,7 +70,7 @@ EXAMPLES = '''
key: "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9w..."
- name: "Update the above deploy key to add push access"
gitlab_deploy_key:
community.general.gitlab_deploy_key:
api_url: https://gitlab.example.com/
api_token: "{{ api_token }}"
project: "my_group/my_project"
@ -79,7 +79,7 @@ EXAMPLES = '''
can_push: yes
- name: "Remove the previous deploy key from the project"
gitlab_deploy_key:
community.general.gitlab_deploy_key:
api_url: https://gitlab.example.com/
api_token: "{{ api_token }}"
project: "my_group/my_project"

View file

@ -65,7 +65,7 @@ options:
EXAMPLES = '''
- name: "Delete GitLab Group"
gitlab_group:
community.general.gitlab_group:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
validate_certs: False
@ -73,7 +73,7 @@ EXAMPLES = '''
state: absent
- name: "Create GitLab Group"
gitlab_group:
community.general.gitlab_group:
api_url: https://gitlab.example.com/
validate_certs: True
api_username: dj-wasabi
@ -84,7 +84,7 @@ EXAMPLES = '''
# The group will by created at https://gitlab.dj-wasabi.local/super_parent/parent/my_first_group
- name: "Create GitLab SubGroup"
gitlab_group:
community.general.gitlab_group:
api_url: https://gitlab.example.com/
validate_certs: True
api_username: dj-wasabi

View file

@ -110,7 +110,7 @@ options:
EXAMPLES = '''
- name: "Adding a project hook"
gitlab_hook:
community.general.gitlab_hook:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
project: "my_group/my_project"
@ -122,7 +122,7 @@ EXAMPLES = '''
token: "my-super-secret-token-that-my-ci-server-will-check"
- name: "Delete the previous hook"
gitlab_hook:
community.general.gitlab_hook:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
project: "my_group/my_project"
@ -130,7 +130,7 @@ EXAMPLES = '''
state: absent
- name: "Delete a hook by numeric project id"
gitlab_hook:
community.general.gitlab_hook:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
project: 10

View file

@ -99,7 +99,7 @@ options:
EXAMPLES = '''
- name: Delete GitLab Project
gitlab_project:
community.general.gitlab_project:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
validate_certs: False
@ -108,7 +108,7 @@ EXAMPLES = '''
delegate_to: localhost
- name: Create GitLab Project in group Ansible
gitlab_project:
community.general.gitlab_project:
api_url: https://gitlab.example.com/
validate_certs: True
api_username: dj-wasabi

View file

@ -63,7 +63,7 @@ options:
EXAMPLES = '''
- name: Set or update some CI/CD variables
gitlab_project_variable:
community.general.gitlab_project_variable:
api_url: https://gitlab.com
api_token: secret_access_token
project: markuman/dotfiles
@ -73,7 +73,7 @@ EXAMPLES = '''
SECRET_ACCESS_KEY: 321cba
- name: Set or update some CI/CD variables
gitlab_project_variable:
community.general.gitlab_project_variable:
api_url: https://gitlab.com
api_token: secret_access_token
project: markuman/dotfiles
@ -87,7 +87,7 @@ EXAMPLES = '''
variable_type: env_var
- name: Delete one variable
gitlab_project_variable:
community.general.gitlab_project_variable:
api_url: https://gitlab.com
api_token: secret_access_token
project: markuman/dotfiles

View file

@ -98,7 +98,7 @@ options:
EXAMPLES = '''
- name: "Register runner"
gitlab_runner:
community.general.gitlab_runner:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
registration_token: 4gfdsg345
@ -110,7 +110,7 @@ EXAMPLES = '''
locked: False
- name: "Delete runner"
gitlab_runner:
community.general.gitlab_runner:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
description: Docker Machine t1

View file

@ -105,7 +105,7 @@ options:
EXAMPLES = '''
- name: "Delete GitLab User"
gitlab_user:
community.general.gitlab_user:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
validate_certs: False
@ -113,7 +113,7 @@ EXAMPLES = '''
state: absent
- name: "Create GitLab User"
gitlab_user:
community.general.gitlab_user:
api_url: https://gitlab.example.com/
validate_certs: True
api_username: dj-wasabi
@ -129,7 +129,7 @@ EXAMPLES = '''
access_level: owner
- name: "Block GitLab User"
gitlab_user:
community.general.gitlab_user:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
validate_certs: False
@ -137,7 +137,7 @@ EXAMPLES = '''
state: blocked
- name: "Unblock GitLab User"
gitlab_user:
community.general.gitlab_user:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
validate_certs: False

View file

@ -69,14 +69,14 @@ notes:
EXAMPLES = '''
- name: Ensure the current working copy is inside the stable branch and deletes untracked files if any.
hg:
community.general.hg:
repo: https://bitbucket.org/user/repo1
dest: /home/user/repo1
revision: stable
purge: yes
- name: Get information about the repository whether or not it has already been cloned locally.
hg:
community.general.hg:
repo: git://bitbucket.org/user/repo
dest: /srv/checkout
clone: no