community.general.bitbucket_access_key – Manages Bitbucket repository access keys

Note

This plugin is part of the community.general collection (version 3.8.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.bitbucket_access_key.

Synopsis

  • Manages Bitbucket repository access keys (also called deploy keys).

Parameters

Parameter

Comments

client_id

string

The OAuth consumer key.

If not set the environment variable BITBUCKET_CLIENT_ID will be used.

client_secret

string

The OAuth consumer secret.

If not set the environment variable BITBUCKET_CLIENT_SECRET will be used.

key

string

The SSH public key.

label

string / required

The key label.

repository

string / required

The repository name.

state

string / required

Indicates desired state of the access key.

Choices:

  • absent

  • present

username

string / required

The repository owner.

Notes

Note

  • Bitbucket OAuth consumer key and secret can be obtained from Bitbucket profile -> Settings -> Access Management -> OAuth.

  • Bitbucket OAuth consumer should have permissions to read and administrate account repositories.

  • Check mode is supported.

Examples

- name: Create access key
  community.general.bitbucket_access_key:
    repository: 'bitbucket-repo'
    username: bitbucket_username
    key: '{{lookup("file", "bitbucket.pub") }}'
    label: 'Bitbucket'
    state: present

- name: Delete access key
  community.general.bitbucket_access_key:
    repository: bitbucket-repo
    username: bitbucket_username
    label: Bitbucket
    state: absent

Authors

  • Evgeniy Krysanov (@catcombo)