FlexDeploy - Git Plugin Guide
The FlexDeploy Git plugin makes it easy to interact with source code stored in a Git repository. This plugin requires a Git client to be stored on the FlexDeploy server and any endpoints which will execute Git plugin operations. FlexDeploy allows users to configure Git repository connection details to be shared by various projects and other configurations at a project level. This allows workflows to perform clone and tag operations within a workflow.
Create SCM Instance for Git and define URL, User and Password information. You can also validate connection when creating SCM Instance for Git.
At project level, select Git as SCM Type and provide details like Branch, Sparse Folders, Tag etc. which are defined as Groovy scripts.
See Using SSH protocol with GitHub to setup SSH connectivity to GitHub.
See Using SSH protocol with Bitbucket to setup SSH connectivity to Bitbucket.
Supported Versions
1.7.9+
Key Features
Executes native commands using Git client
Supports partial and shallow checkouts from Git Repository
Integration Properties
Property Name | Required | Description |
---|---|---|
| Yes | The URL to the remote GIT repository. |
| Yes | The username to the remote GIT repository. |
| Yes | The password for |
| No | Timeout (milliseconds) for Git command execution. |
| No | Commit URL is automatically derived for GitHub, GitLab, Bitbucket, Azure DevOps, Oracle Developer Cloud etc. For other providers or on-prem installations, you should configure this property. @Since 6.5.0.13 Git Commit URL. Able to use the following variable {COMMIT} |
| No | File URL in Git repository is automatically derived for GitHub, GitLab, Bitbucket, Azure DevOps, Oracle Developer Cloud etc. For other providers or on-prem installations, you should configure this property. Git Repository File URL. Able to use the following variables {BRANCH} {FILEPATH} {SPARSE_CHECKOUT_FOLDERS} Ex https://repo.mydomain.com/MyOrg/FD-REPO/blob/{BRANCH}/{SPARSE_CHECKOUT_FOLDERS}{FILEPATH} |
| No | Commit URL for File is automatically derived for GitHub, GitLab, Bitbucket, Azure DevOps, Oracle Developer Cloud etc. For other providers or on-prem installations, you should configure this property. Git Repository File URL for Commit. Able to use the following variables {BRANCH} {FILEPATH} {SPARSE_CHECKOUT_FOLDERS} {COMMIT} |
Target Properties
Property Name | Required | Description |
---|---|---|
| No | The GIT executable folder. |
Plugin Operations
Git Installation Steps
Git 1.7.9 or higher is needed for FlexDeploy. If yum installs a lower version by default, then you need to get the Git source code and build it for install. Here is reference - https://tecadmin.net/install-git-2-0-on-centos-rhel-fedora/.
Run these steps as root. You can download a newer version than 2.7.1 as well.
yes | yum install curl-devel expat-devel gettext-devel openssl-devel zlib-devel
yes | yum install gcc perl-ExtUtils-MakeMaker
cd $HOME
tar -xvzf v2.7.1.tar.gz
cd git-2.7.1/
make prefix=/usr/local all
make prefix=/usr/local install
On some other target groups including some Oracle Cloud instances, it may be necessary to either change lines 7+8 by removing the /local or by adding symlinks in /usr. The git executable must be on the path without running the .bash_profile or any other scripts because FlexDeploy won't run those scripts when SSHing to the endpoint.
Token authentication is required for GIT operations
Personal access tokens (PATs) are an alternative to using passwords for authentication to GitHub when using the GitHub API or the command line.
To create a Personal access token, follow the below link
While generating Key Scope items is completely based on your requirement.
Basic permission to grant this token is required, Repo- Full control of private repositories
Admin:repo_hook- read:repo_hook read repository hooks for a clone, if you are doing commit from FlexDeploy then you need write:repo_hook
After generates token, In FlexDeploy, Update GIT password with the token at GIT Instance under Topology - Integrations - Source control tab
Multiple SSH Keys for different repositories
If you have more than one source control account with the same domain name (i.e. github.com, bitbucket.org, etc) and wish to use a different SSH key for each account follow the below instructions:
Generate your SSH keys if you have don’t have them already. SSH key must be RSA algorithm (ssh-keygen -t rsa). It’s recommended to store the SSH keys in the .ssh folder.
Ensure <FlexDeploy_User_Home/.ssh folder exists. The .ssh folder should already be there in the home directory since ~/.ssh directory is automatically created when the user runs the ssh command for the first time. If the directory doesn’t exist on your system, create it using the command below:
mkdir -p ~/.ssh && chmod 700 ~/.ssh
Create the configuration file name “config” in the <FlexDeploy_User_Home>/.ssh/ directory of the user running FlexDeploy, if it doesn’t already exist.
The SSH config file takes the following structure:
Host hostname1 SSH_OPTION value SSH_OPTION value Host hostname2 SSH_OPTION value Host * SSH_OPTION value
Add the appropriate entries for your organization and use case. In this example, we’ll add one entry with Host “bitbucket-alt”
Host bitbucket-alt HostName bitbucket.org IdentityFile ~/.ssh/<your_SSH_key> IdentitiesOnly yes
On the account instance, set Host value in the URL.
I.E. ssh://git@bitbucket-alt/flexagon/dummy-repo.git
Effectively, you can use alternate SSH key for any SCM account by changing the URL.
- style