ansible.builtin.gitlab_project (v2.7.9) — module

Install Ansible via pip

Install with pip install ansible==2.7.9

Description

When the project does not exist in Gitlab, it will be created.

When the project does exists and state=absent, the project will be deleted.

When changes are made to the project, the project will be updated.

Requirements

• pyapi-gitlab python module

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete Gitlab Project
  gitlab_project:
    server_url: http://gitlab.example.com
    validate_certs: False
    login_token: WnUzDsxjy8230-Dy_k
    name: my_first_project
    state: absent
  delegate_to: localhost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create Gitlab Project in group Ansible
  gitlab_project:
    server_url: https://gitlab.example.com
    validate_certs: True
    login_user: dj-wasabi
    login_password: MySecretPassword
    name: my_first_project
    group: ansible
    issues_enabled: False
    wiki_enabled: True
    snippets_enabled: True
    import_url: http://git.example.com/example/lab.git
    state: present
  delegate_to: localhost

Inputs

    
name:
    description:
    - The name of the project
    required: true

path:
    description:
    - The path of the project you want to create, this will be server_url/<group>/path
    - If not supplied, name will be used.

group:
    description:
    - The name of the group of which this projects belongs to.
    - When not provided, project will belong to user which is configured in 'login_user'
      or 'login_token'
    - When provided with username, project will be created for this user. 'login_user'
      or 'login_token' needs admin rights.

state:
    choices:
    - present
    - absent
    default: present
    description:
    - create or delete project.
    - Possible values are present and absent.

public:
    default: 'no'
    description:
    - If the project is public available or not.
    - Setting this to true is same as setting visibility_level to 20.
    - Possible values are true and false.
    type: bool

import_url:
    default: 'no'
    description:
    - Git repository which will be imported into gitlab.
    - Gitlab server needs read access to this git repository.
    type: bool

login_user:
    description:
    - Gitlab user name.

server_url:
    description:
    - Url of Gitlab server, with protocol (http or https).
    required: true

description:
    description:
    - An description for the project.

login_token:
    description:
    - Gitlab token for logging in.

wiki_enabled:
    default: 'yes'
    description:
    - If an wiki for this project should be available or not.
    - Possible values are true and false.
    type: bool

issues_enabled:
    default: 'yes'
    description:
    - Whether you want to create issues or not.
    - Possible values are true and false.
    type: bool

login_password:
    description:
    - Gitlab password for login_user

validate_certs:
    aliases:
    - verify_ssl
    default: 'yes'
    description:
    - When using https if SSL certificate needs to be verified.
    type: bool

snippets_enabled:
    default: 'yes'
    description:
    - If creating snippets should be available or not.
    - Possible values are true and false.
    type: bool

visibility_level:
    default: 0
    description:
    - Private. visibility_level is 0. Project access must be granted explicitly for each
      user.
    - Internal. visibility_level is 10. The project can be cloned by any logged in user.
    - Public. visibility_level is 20. The project can be cloned without any authentication.
    - Possible values are 0, 10 and 20.

merge_requests_enabled:
    default: 'yes'
    description:
    - If merge requests can be made or not.
    - Possible values are true and false.
    type: bool