Gitlab Store

Description

A gitlab repository

Type

gitlab

Category

File

This store only allows reading a file based on a fileToken.
The file token must have the following format: gitlab://[store name]/[branch]/path/to/file

Therefore, it is not possible with this filestore to:

  • List files in this filestore

  • Add or modify new files

  • Delete a file

Configuration in States

The Gitlab Store can be configured directly in the States interface via the Data Stores module. The following configuration mode is available:

Parameters

Name

Description

Mandatory

Default

Comment

Base URI

The host address of the GitLab instance

Yes

e.g. https://gitlab.example.com

Access Token

The access token used to authenticate to the GitLab repository

Yes

Value is hidden

Project ID

The ID of the project in GitLab

Yes



Local Configuration

The local configuration is defined in a JSON file (stores.json) deployed directly on the Workers' server. A locally configured store takes priority over a store with the same name configured in the States interface.

Name

Description

Type

Mandatory

Comment

BaseUri

Host address of Gitlab

string

True


AccessToken

The access token used to connect to the GitLab repository

string

True


ProjectId

Id of the project in GitLab

string

True



JSON
{
    "Name": "git",
    "Type": "gitlab",
    "HealthCheck": true,
    "Config": {
        "BaseUri": "https://gitlab.com",
	 	"AccessToken": "xxx",
	 	"ProjectId": "210"
    }
}