Gitlab
type: "io.kestra.plugin.singer.taps.Gitlab"
A Singer tap to fetch data from a Gitlab account.
Full documentation can be found here
Properties
apiUrl
- Type: string
- Dynamic: ✔️
- Required: ✔️
- Default:
https://gitlab.com
- Min length:
1
GitLab API/instance URL.
When an API path is omitted,
/api/v4/
is assumed.
fetchMergeRequestCommits
- Type: boolean
- Dynamic: ✔️
- Required: ✔️
- Default:
false
For each Merge Request, also fetch the MR's commits and create the join table merge_request_commits
with the Merge Request and related Commit IDs.
This can slow down extraction considerably because of the many API calls required.
fetchPipelinesExtended
- Type: boolean
- Dynamic: ✔️
- Required: ✔️
- Default:
false
For every Pipeline, also fetch extended details of each of these pipelines.
This can slow down extraction considerably because of the many API calls required.
private_token
- Type: string
- Dynamic: ✔️
- Required: ✔️
- Min length:
1
GitLab personal access token or other API token.
startDate
- Type: string
- Dynamic: ✔️
- Required: ✔️
- Format:
date
Determines how much historical data will be extracted.
Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.
stateName
- Type: string
- Dynamic: ✔️
- Required: ✔️
- Default:
singer-state
The name of singer state file
streamsConfigurations
- Type: array
- SubType: StreamsConfiguration
- Dynamic: ❌
- Required: ✔️
- Min items:
1
The list of stream configurations
ultimateLicense
- Type: boolean
- Dynamic: ✔️
- Required: ✔️
- Default:
false
Enable to pull in extra data (like Epics, Epic Issues and other entities) only available to GitLab Ultimate and GitLab.com Gold accounts.
command
- Type: string
- Dynamic: ✔️
- Required: ❌
Override default singer command
docker
- Type: DockerOptions
- Dynamic: ❌
- Required: ❌
- Default:
{image=python:3.10.12, pullPolicy=ALWAYS}
Docker options when for the DOCKER
runner
groups
- Type: array
- SubType: string
- Dynamic: ✔️
- Required: ❌
Names of groups to extract data from.
Leave empty and provide a project name if you'd like to pull data from a project in a personal user namespace.
pipPackages
- Type: array
- SubType: string
- Dynamic: ✔️
- Required: ❌
Override default pip packages to use a specific version
projects
- Type: array
- SubType: string
- Dynamic: ✔️
- Required: ❌
namespace/project
paths of projects to extract data from.
Leave empty and provide a group name to extract data from all group projects.
Outputs
count
- Type: integer
- Dynamic: ❓
- Required: ❌
Counter of stream items
raw
- Type: string
- SubType: string
- Dynamic: ❌
- Required: ❌
- Format:
uri
Raw singer streams
Json multiline file with raw singer format that can be passed to a target
Definitions
io.kestra.plugin.scripts.runner.docker.Cpu
Properties
cpus
- Type: integer
- Dynamic: ❌
- Required: ❌
The maximum amount of CPU resources a container can use.
For instance, if the host machine has two CPUs and you set
cpus:"1.5"
, the container is guaranteed at most one and a half of the CPUs.
io.kestra.plugin.scripts.runner.docker.Memory
Properties
kernelMemory
- Type: string
- Dynamic: ✔️
- Required: ❌
The maximum amount of kernel memory the container can use.
The minimum allowed value is 4m. Because kernel memory cannot be swapped out, a container which is starved of kernel memory may block host machine resources, which can have side effects on the host machine and on other containers. See --kernel-memory details.
memory
- Type: string
- Dynamic: ✔️
- Required: ❌
The maximum amount of memory resources the container can use.
It is recommended that you set the value to at least 6 megabytes.
memoryReservation
- Type: string
- Dynamic: ✔️
- Required: ❌
Allows you to specify a soft limit smaller than memory
which is activated when Docker detects contention or low memory on the host machine.
If you use
memoryReservation
, it must be set lower thanmemory
for it to take precedence. Because it is a soft limit, it does not guarantee that the container doesn’t exceed the limit.
memorySwap
- Type: string
- Dynamic: ✔️
- Required: ❌
The amount of memory this container is allowed to swap to disk.
If
memory
andmemorySwap
are set to the same value, this prevents containers from using any swap. This is becausememorySwap
is the amount of combined memory and swap that can be used, whilememory
is only the amount of physical memory that can be used.
memorySwappiness
- Type: string
- Dynamic: ✔️
- Required: ❌
The amount of memory this container is allowed to swap to disk.
By default, the host kernel can swap out a percentage of anonymous pages used by a container. You can set
memorySwappiness
to a value between 0 and 100, to tune this percentage.
oomKillDisable
- Type: boolean
- Dynamic: ❌
- Required: ❌
By default, if an out-of-memory (OOM) error occurs, the kernel kills processes in a container.
To change this behavior, use the
oomKillDisable
option. Only disable the OOM killer on containers where you have also set thememory
option. If thememory
flag is not set, the host can run out of memory, and the kernel may need to kill the host system’s processes to free the memory.
io.kestra.plugin.scripts.exec.scripts.models.DockerOptions
Properties
image
- Type: string
- Dynamic: ✔️
- Required: ✔️
- Min length:
1
Docker image to use.
config
- Type:
- string
- object
- Dynamic: ✔️
- Required: ❌
Docker configuration file.
Docker configuration file that can set access credentials to private container registries. Usually located in
~/.docker/config.json
.
cpu
- Type: Cpu
- Dynamic: ❌
- Required: ❌
Limits the CPU usage to a given maximum threshold value.
By default, each container’s access to the host machine’s CPU cycles is unlimited. You can set various constraints to limit a given container’s access to the host machine’s CPU cycles.
credentials
- Type: Credentials
- Dynamic: ✔️
- Required: ❌
deviceRequests
- Type: array
- SubType: DeviceRequest
- Dynamic: ❌
- Required: ❌
A list of device requests to be sent to device drivers.
entryPoint
- Type: array
- SubType: string
- Dynamic: ✔️
- Required: ❌
Docker entrypoint to use.
extraHosts
- Type: array
- SubType: string
- Dynamic: ✔️
- Required: ❌
Extra hostname mappings to the container network interface configuration.
host
- Type: string
- Dynamic: ✔️
- Required: ❌
Docker API URI.
memory
- Type: Memory
- Dynamic: ❌
- Required: ❌
Limits memory usage to a given maximum threshold value.
Docker can enforce hard memory limits, which allow the container to use no more than a given amount of user or system memory, or soft limits, which allow the container to use as much memory as it needs unless certain conditions are met, such as when the kernel detects low memory or contention on the host machine. Some of these options have different effects when used alone or when more than one option is set.
networkMode
- Type: string
- Dynamic: ✔️
- Required: ❌
Docker network mode to use e.g. host
, none
, etc.
pullPolicy
- Type: string
- Dynamic: ❌
- Required: ❌
- Default:
ALWAYS
- Possible Values:
IF_NOT_PRESENT
ALWAYS
NEVER
The image pull policy for a container image and the tag of the image, which affect when Docker attempts to pull (download) the specified image.
shmSize
- Type: string
- Dynamic: ✔️
- Required: ❌
Size of /dev/shm
in bytes.
The size must be greater than 0. If omitted, the system uses 64MB.
user
- Type: string
- Dynamic: ✔️
- Required: ❌
User in the Docker container.
volumes
- Type: array
- SubType: string
- Dynamic: ✔️
- Required: ❌
List of volumes to mount.
Must be a valid mount expression as string, example :
/home/user:/app
.
Volumes mount are disabled by default for security reasons; you must enable them on server configuration by setting kestra.tasks.scripts.docker.volume-enabled
to true
.
io.kestra.plugin.scripts.runner.docker.Credentials
Properties
auth
- Type: string
- Dynamic: ✔️
- Required: ❌
The registry authentication.
The
auth
field is a base64-encoded authentication string ofusername:password
or a token.
identityToken
- Type: string
- Dynamic: ✔️
- Required: ❌
The identity token.
password
- Type: string
- Dynamic: ✔️
- Required: ❌
The registry password.
registry
- Type: string
- Dynamic: ✔️
- Required: ❌
The registry URL.
If not defined, the registry will be extracted from the image name.
registryToken
- Type: string
- Dynamic: ✔️
- Required: ❌
The registry token.
username
- Type: string
- Dynamic: ✔️
- Required: ❌
The registry username.
io.kestra.plugin.scripts.runner.docker.DeviceRequest
Properties
capabilities
- Type: array
- SubType: array
- Dynamic: ❌
- Required: ❌
A list of capabilities; an OR list of AND lists of capabilities.
count
- Type: integer
- Dynamic: ❌
- Required: ❌
deviceIds
- Type: array
- SubType: string
- Dynamic: ✔️
- Required: ❌
driver
- Type: string
- Dynamic: ✔️
- Required: ❌
options
- Type: object
- SubType: string
- Dynamic: ❌
- Required: ❌
Driver-specific options, specified as key/value pairs.
These options are passed directly to the driver.
io.kestra.plugin.singer.models.StreamsConfiguration
Properties
propertiesPattern
- Type: array
- SubType: string
- Dynamic: ❓
- Required: ❌
replicationKeys
- Type: string
- Dynamic: ❓
- Required: ❌
replicationMethod
- Type: string
- Dynamic: ❓
- Required: ❌
- Possible Values:
FULL_TABLE
INCREMENTAL
LOG_BASED
selected
- Type: boolean
- Dynamic: ❓
- Required: ❌
- Default:
true
stream
- Type: string
- Dynamic: ❓
- Required: ❌