community.general.bitbucket_pipeline_key_pair – Manages Bitbucket pipeline SSH key pair

Note

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

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_pipeline_key_pair.

Synopsis

  • Manages Bitbucket pipeline SSH key pair.

Parameters

Parameter Choices/Defaults 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.
password
string
added in 4.0.0 of community.general
The App password.
If not set the environment variable BITBUCKET_PASSWORD will be used.
private_key
string
The private key.
public_key
string
The public key.
repository
string / required
The repository name.
state
string / required
    Choices:
  • absent
  • present
Indicates desired state of the key pair.
user
string
added in 4.0.0 of community.general
The username.
If not set the environment variable BITBUCKET_USERNAME will be used.
workspace
string / required
The repository owner.
Alias username has been deprecated and will become an alias of user in community.general 6.0.0.

aliases: username

Notes

Note

  • Check mode is supported.

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

  • Bitbucket App password can be created from Bitbucket profile -> Personal Settings -> App passwords.

  • If both OAuth and Basic Auth credentials are passed, OAuth credentials take precedence.

Examples

- name: Create or update SSH key pair
  community.general.bitbucket_pipeline_key_pair:
    repository: 'bitbucket-repo'
    workspace: bitbucket_workspace
    public_key: '{{lookup("file", "bitbucket.pub") }}'
    private_key: '{{lookup("file", "bitbucket") }}'
    state: present

- name: Remove SSH key pair
  community.general.bitbucket_pipeline_key_pair:
    repository: bitbucket-repo
    workspace: bitbucket_workspace
    state: absent

Authors

  • Evgeniy Krysanov (@catcombo)