Ansible Role: serdigital64.devops.dops_git_client

Purpose

Manage provisioning of client side GIT.

Supported features in the current version:

  • Deploy application. Packages are defined in the variable dops_git_client_profiles.
  • Setup user configuration
    • Create default gitconfig
      • user.name
      • user.email
      • init.defaultBranch
  • Provision GIT local repositories:
    • sets initial project gitconfig
      • user.name
      • user.email
      • init.defaultBranch
    • Create .gitignore file
    • initializes project directory: git init

The dops_git_client Ansible-Role is part of the A:Platform64 project and is available in the devops Ansible-Collection.

Usage

The following example is an Ansible Playbook that includes all the supported features:

use this link if viewing the doc on github

---
- name: "DevOps / GIT / Client / Usage example"
  hosts: "localhost"
  gather_facts: true
  vars:
    target_user: "{{ lookup('env','USER') }}"
    target_users:
      - name: "{{ target_user }}"
        group: "{{ target_user }}"
        home: "/home/{{ target_user }}"
        user_name: "{{ target_user }}"
        user_email: "{{ target_user }}@localhost.localdomain"
    test_repo: "/home/{{ target_user }}/test-repo"

  tasks:
    - name: "Example: Install GIT, configure CLI, create local repository"
      vars:
        dops_git_client:
          resolve_prereq: true
          deploy: true
          provision: true
        dops_git_client_repositories:
          - name: "test repo"
            path: "{{ test_repo }}"
            owner: "{{ target_user }}"
            email: "{{ target_user }}@localhost"
            branch: "dev"
            ignore:
              - ".cache"
              - ".tmp"
      ansible.builtin.include_role:
        name: "serdigital64.devops.dops_git_client"

    - name: "Example: create default user configuration for already installed git"
      vars:
        dops_git_client:
          setup: true
        dops_git_client_users: "{{ target_users }}"
      ansible.builtin.include_role:
        name: "serdigital64.devops.dops_git_client"
...

The playbook can be run by executing:

# Set ANSIBLE_COLLECTIONS_PATHS to the default install location. Change as needed.
ANSIBLE_COLLECTIONS_PATHS="${HOME}/.ansible/collections"
ansible-playbook "${ANSIBLE_COLLECTIONS_PATHS}/ansible_collections/serdigital64/devops/playbooks/dops_git_client.yml"

Role Parameters

Actions

  • Use action-parameters to control what tasks are enabled for the role to execute.
  • Parameters should be declared as task level vars as they are intented to be dynamic.
dops_git_client:
  resolve_prereq:
  deploy:
  setup:
  provision:
Parameter Required? Type Default Purpose / Value
dops_git_client.resolve_prereq no boolean false Enable automatic resolution of prequisites
dops_git_client.deploy no boolean false Enable installation of application package
dops_git_client.setup no boolean false Enable application configuration
dops_git_client.provision no boolean false Enable provisioning of application components

End State

  • Use end-state parameters to define the target state after role execution.
  • Parameters should be declared in host_vars or group_vars as they are intended to be permanent.
dops_git_client_application:
  client:
    name:
    type:
    version:
    installed:
  extras:
    name:
    type:
    version:
    installed:
dops_git_client_users:
  - user:
    group:
    home:
    user_name:
    user_email:
    default_branch:
dops_git_client_repositories:
  - name:
    path:
    owner:
    email:
    branch:
    ignore:
      -
Parameter Required? Type Default Purpose / Value
dops_git_client_application yes(deploy) dictionary Set application package end state
dops_git_client_application.client yes dictionary Set application package end state
dops_git_client_application.client.name yes string "git" Select application package name
dops_git_client_application.client.type yes string "distro" Select application package type
dops_git_client_application.client.version yes string "latest" Select application package version
dops_git_client_application.client.installed yes boolean true Set application package end state
dops_git_client_application.extras no dictionary Set application package end state
dops_git_client_application.extras.name no string "extras" Select application package name
dops_git_client_application.extras.type no string "distro" Select application package type
dops_git_client_application.extras.version no string "latest" Select application package version
dops_git_client_application.extras.installed no boolean false Set application package end state
dops_git_client_users yes(setup) list List of users
dops_git_client_users.0.user yes(setup) string User login name
dops_git_client_users.0.group yes(setup) string User primary group
dops_git_client_users.0.home yes(setup) string Home directory
dops_git_client_users.0.user_name yes(setup) string Set gitconfig parameter
dops_git_client_users.0.user_email yes(setup) string Set gitconfig parameter
dops_git_client_users.0.default_branch no string "main" Set gitconfig parameter
dops_git_client_repositories yes(provision) dictionary Define GIT repositories to be provisioned
dops_git_client_repositories.0.name yes string Project short name
dops_git_client_repositories.0.path yes string Project full path
dops_git_client_repositories.0.owner yes string Project owner. User must already exist
dops_git_client_repositories.0.email yes string Project owner's email
dops_git_client_repositories.0.branch no string "main" GIT default branch name
dops_git_client_repositories.0.ignore no list [] List of paths for gitignore
dops_git_client_repositories.0.ignore.0 no string Path pattern

Deployment

OS Compatibility

The operating system compatibility list is defined in the variable: dops_git_client_platforms

Dependencies

  • Ansible Collections:
    • serdigital64.backup
    • serdigital64.system

Prerequisites

The Ansible engine must be already installed and configured for privileged access and remote execution.

In addition the following prerequisites can be automatically solved when running the playbook by setting the role action: resolve_prereq: true

  • Package manager for the target application is installed and enabled.

Installation Procedure

Manually install Ansible Collections from the Ansible Galaxy repository:

ansible-galaxy collection install --upgrade serdigital64.devops

Automatic installation is also available by deploying A:Platform64

Contributing

Help on implementing new features and maintaining the code base is welcomed.

Please see the guidelines for further details.

Author

License

GPL-3.0-or-later