Create Git plugin configurations

Plugin configurations are sets of parameters that can be applied across some, or all, plugin procedures. They can reduce the repetition of common values, create predefined parameter sets, and securely store credentials. Each configuration is given a unique name that is entered in the designated parameter for the plugin procedures that use them. The following steps illustrate how to create a plugin configuration that can be used by one or more plugin procedures.

To create a plugin configuration:

Navigate to DevOps Essentials Plugin Management Plugin configurations.
Select Add plugin configuration to create a new configuration.
In the New Configuration window, specify a Name for the configuration.
Select the Project that the configuration belongs to.
Optionally, add a Description for the configuration.
Select the appropriate Plugin for the configuration.
Configure the plugin configuration parameters.
Select OK.

Depending on your plugin configuration and how you run procedures, the Input parameters Configuration name field may behave differently in the CloudBees CD/RO UI. For more information, refer to Differences in plugin UI behavior.

Git plugin configuration parameters

Parameter Description

Configuration name

Required. The unique name for the configuration.

Description

A description of the configuration.

Authentication types

SCM-specific authentication types.

For GitHub users, either:
- Select key, and provide your SSH key in the Private Key field.
- Select token, and provide your secret key in the Token field.
For GitLab users, either:
- Select key, and provide your SSH key in the Private Key field.
- Select password, and either:
  - Provide your Username and Password.
  - Provide your Username and PAT as the Password.
  - Provide oauth2 as the Username and PAT as the Password.
For Bitbucket users, either:
- Select key, and provide your SSH key in the Private Key field.
- Select password, and either:
  - Provide your Username and Password.
  - Provide your Username and PAT as the Password.

If your account uses two-factor authentication, please consult the documentation of your third-party Git provider regarding the use of passwords.

Username and password

The username and password.

Consult your third-party Git provider for the security details on password usage in checkout calls.

Token

The personal access token that has proper access scope.

Key

The private key that allows access to Git repositories.

The JGit library does not support keys in OpenSSH format. You should use the Git CLI or regenerate the key to a Privacy Enhanced Mail (PEM) format.
This parameter can only be used with Git or SSH protocols, and is not applicable to the HTTP(S) protocol.

Passphrase

The passphrase that is used to encrypt the protected key.

Library to use

You can select Git CLI or JGit lib to work with the Git tree. Some commands are not available in the JGit library, but are independent of resources. If you are using the Git CLI, it must be installed on the resource.

Repository URL for check configuration

The plugin checks if the repository is accessible before saving the configuration values.

Ignore SSL errors

Turns off SSL verification for instances with self-signed certificates.

Check configuration resource

A resource that is used to check the configuration. If you are using the Git CLI, it must be installed on the resource.

HTTP proxy

A proxy server URL that should be used for connections.

Proxy authorization

The username and password for the proxy.

Debug level

This option sets the debug level for logs. If Info is selected, only a summary is displayed. If Debug is selected, debug information is displayed. If Trace is selected, all requests and responses are displayed.