Skip to content

container Submodule

Structs

AWSRegistryProps

Initializer 

1
2
3
4
5
6
from gcix import container

container.AWSRegistryProps(
  account_id: str = None,
  region: str = None
)

Properties

Name Type Description
account_id str AWS account id.
region str AWS region where the ECR repository lives in.
account_idOptional 
1
account_id: str
  • Type: str
  • Default: AWSAccount.awsAccountId()

AWS account id.

regionOptional 
1
region: str
  • Type: str
  • Default: AWSAccount.awsRegion()

AWS region where the ECR repository lives in.

BuildContainerCollectionProps

Initializer 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from gcix import container

container.BuildContainerCollectionProps(
  registry: typing.Union[str, Registry],
  docker_client_config: DockerClientConfig = None,
  do_crane_push: bool = None,
  do_dive_scan: bool = None,
  do_trivyignore_check: bool = None,
  do_trivy_scan: bool = None,
  image_name: str = None,
  image_tag: str = None,
  job_name: str = None,
  job_stage: str = None
)

Properties

Name Type Description
registry typing.Union[str, Registry] Container registry to push the image to.
docker_client_config DockerClientConfig Creates the Docker configuration file base on objects settings, to authenticate against given registries.
do_crane_push bool Set to false to skip the Crane push job.
do_dive_scan bool Set to false to skip the Dive scan job.
do_trivyignore_check bool Set to false to skip the existance check of the .trivyignore file.
do_trivy_scan bool Set to false to skip the Trivy scan job.
image_name str Image name with stage in the registry.
image_tag str Image tag.
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
registryRequired 
1
registry: typing.Union[str, Registry]
  • Type: typing.Union[str, Registry]
  • Default: Registry.DOCKER

Container registry to push the image to.

If the container registry needs authentication, you have to provide a DockerClientConfig object with credentials.

docker_client_configOptional 
1
docker_client_config: DockerClientConfig
  • Type: DockerClientConfig
  • Default: DockerClientConfig with login to the official Docker Hub and expecting credentials given as environment variables REGISTRY_USER and REGISTRY_LOGIN.

Creates the Docker configuration file base on objects settings, to authenticate against given registries.

do_crane_pushOptional 
1
do_crane_push: bool
  • Type: bool
  • Default: true

Set to false to skip the Crane push job.

do_dive_scanOptional 
1
do_dive_scan: bool
  • Type: bool
  • Default: true

Set to false to skip the Dive scan job.

do_trivyignore_checkOptional 
1
do_trivyignore_check: bool
  • Type: bool
  • Default: true

Set to false to skip the existance check of the .trivyignore file.

do_trivy_scanOptional 
1
do_trivy_scan: bool
  • Type: bool
  • Default: true

Set to false to skip the Trivy scan job.

image_nameOptional 
1
image_name: str
  • Type: str
  • Default: PredefinedVariables.ciProjectDir

Image name with stage in the registry.

e.g. username/imageName.

image_tagOptional 
1
image_tag: str
  • Type: str
  • Default: PredefinedVariables.ciCommitRefName

Image tag.

Depending of the build it defaults either to the git tag or to the actual branch name.

job_nameOptional 
1
job_name: str
  • Type: str

The name of the Bootstrap job.

job_stageOptional 
1
job_stage: str
  • Type: str

The stage of the Bootstrap job.

CopyContainerCollectionProps

Initializer 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from gcix import container

container.CopyContainerCollectionProps(
  image_name: str,
  image_tag: str,
  docker_client_config: DockerClientConfig = None,
  do_dive_scan: bool = None,
  do_trivyignore_check: bool = None,
  do_trivy_scan: bool = None,
  dst_registry: typing.Union[str, Registry] = None,
  job_name: str = None,
  job_stage: str = None,
  src_registry: typing.Union[str, Registry] = None
)

Properties

Name Type Description
image_name str Image name with stage in the registry.
image_tag str Container image tag to pull from srcRegistry and push to dstRegistry.
docker_client_config DockerClientConfig Creates the Docker configuration file base on objects settings, to authenticate against given registries.
do_dive_scan bool Set to false to skip the Dive scan job.
do_trivyignore_check bool Set to false to skip the existance check of the .trivyignore file.
do_trivy_scan bool Set to false to skip the Trivy scan job.
dst_registry typing.Union[str, Registry] Container registry to push the image to.
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
src_registry typing.Union[str, Registry] Container registry to pull the image from.
image_nameRequired 
1
image_name: str
  • Type: str

Image name with stage in the registry.

e.g. username/image_name.

image_tagRequired 
1
image_tag: str
  • Type: str

Container image tag to pull from srcRegistry and push to dstRegistry.

docker_client_configOptional 
1
docker_client_config: DockerClientConfig
  • Type: DockerClientConfig
  • Default: DockerClientConfig with login to the official Docker Hub and expecting credentials given as environment variables REGISTRY_USER and REGISTRY_LOGIN.

Creates the Docker configuration file base on objects settings, to authenticate against given registries.

do_dive_scanOptional 
1
do_dive_scan: bool
  • Type: bool
  • Default: true

Set to false to skip the Dive scan job.

do_trivyignore_checkOptional 
1
do_trivyignore_check: bool
  • Type: bool
  • Default: true

Set to false to skip the existance check of the .trivyignore file.

do_trivy_scanOptional 
1
do_trivy_scan: bool
  • Type: bool
  • Default: true

Set to false to skip the Trivy scan job.

dst_registryOptional 
1
dst_registry: typing.Union[str, Registry]
  • Type: typing.Union[str, Registry]
  • Default: Registry.DOCKER

Container registry to push the image to.

If the container registry needs authentication, you have to provide a DockerClientConfig object with credentials.

job_nameOptional 
1
job_name: str
  • Type: str

The name of the Bootstrap job.

job_stageOptional 
1
job_stage: str
  • Type: str

The stage of the Bootstrap job.

src_registryOptional 
1
src_registry: typing.Union[str, Registry]
  • Type: typing.Union[str, Registry]
  • Default: Registry.DOCKER

Container registry to pull the image from.

If the container registry needs authentication, you have to provide a DockerClientConfig object with credentials.

CraneCopyProps

Initializer 

1
2
3
4
5
6
7
8
9
from gcix import container

container.CraneCopyProps(
  dst_registry: typing.Union[str, Registry],
  src_registry: typing.Union[str, Registry],
  docker_client_config: DockerClientConfig = None,
  job_name: str = None,
  job_stage: str = None
)

Properties

Name Type Description
dst_registry typing.Union[str, Registry] Registry URL to copy container image to.
src_registry typing.Union[str, Registry] Registry URL to copy container image from.
docker_client_config DockerClientConfig Creates the Docker configuration file base on objects settings, used by crane to authenticate against given registries.
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
dst_registryRequired 
1
dst_registry: typing.Union[str, Registry]

Registry URL to copy container image to.

src_registryRequired 
1
src_registry: typing.Union[str, Registry]

Registry URL to copy container image from.

docker_client_configOptional 
1
docker_client_config: DockerClientConfig

Creates the Docker configuration file base on objects settings, used by crane to authenticate against given registries.

job_nameOptional 
1
job_name: str
  • Type: str

The name of the Bootstrap job.

job_stageOptional 
1
job_stage: str
  • Type: str

The stage of the Bootstrap job.

CranePullProps

Initializer 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from gcix import container

container.CranePullProps(
  src_registry: typing.Union[str, Registry],
  docker_client_config: DockerClientConfig = None,
  image_name: str = None,
  image_tag: str = None,
  job_name: str = None,
  job_stage: str = None,
  tar_path: str = None
)

Properties

Name Type Description
src_registry typing.Union[str, Registry] Registry URL to pull container image from.
docker_client_config DockerClientConfig Creates the Docker configuration file base on objects settings, to authenticate against given registries.
image_name str Container image with namespace to pull from srcRegistry.
image_tag str Tag of the image which will be pulled.
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
tar_path str Path where to save the container image tarball.
src_registryRequired 
1
src_registry: typing.Union[str, Registry]

Registry URL to pull container image from.

docker_client_configOptional 
1
docker_client_config: DockerClientConfig
  • Type: DockerClientConfig
  • Default: DockerClientConfig with login to the official Docker Hub and expecting credentials given as environment variables REGISTRY_USER and REGISTRY_LOGIN.

Creates the Docker configuration file base on objects settings, to authenticate against given registries.

image_nameOptional 
1
image_name: str
  • Type: str
  • Default: PredefinedVariables.ciProjectName

Container image with namespace to pull from srcRegistry.

image_tagOptional 
1
image_tag: str
  • Type: str
  • Default: latest

Tag of the image which will be pulled.

job_nameOptional 
1
job_name: str
  • Type: str

The name of the Bootstrap job.

job_stageOptional 
1
job_stage: str
  • Type: str

The stage of the Bootstrap job.

tar_pathOptional 
1
tar_path: str
  • Type: str
  • Default: PredefinedVariables.ciProjectDir

Path where to save the container image tarball.

CranePushProps

Initializer 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from gcix import container

container.CranePushProps(
  dst_registry: typing.Union[str, Registry],
  docker_client_config: DockerClientConfig = None,
  image_name: str = None,
  image_tag: str = None,
  job_name: str = None,
  job_stage: str = None,
  tar_path: str = None
)

Properties

Name Type Description
dst_registry typing.Union[str, Registry] Registry URL to copy container image to.
docker_client_config DockerClientConfig Creates the Docker configuration file base on objects settings, to authenticate against given registries.
image_name str Container image name, searched for in imagePath and gets .tar appended.
image_tag str The tag the image will be tagged with.
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
tar_path str Path where to find the container image tarball.
dst_registryRequired 
1
dst_registry: typing.Union[str, Registry]

Registry URL to copy container image to.

docker_client_configOptional 
1
docker_client_config: DockerClientConfig

Creates the Docker configuration file base on objects settings, to authenticate against given registries.

Defaults to a DockerClientConfig with login to the official Docker Hub and expecting credentials given as environment variables REGISTRY_USER and REGISTRY_LOGIN.

image_nameOptional 
1
image_name: str
  • Type: str
  • Default: PredefinedVariables.ciProjectName

Container image name, searched for in imagePath and gets .tar appended.

image_tagOptional 
1
image_tag: str
  • Type: str
  • Default: PredefinedVariables.ciCommitTag

The tag the image will be tagged with.

job_nameOptional 
1
job_name: str
  • Type: str

The name of the Bootstrap job.

job_stageOptional 
1
job_stage: str
  • Type: str

The stage of the Bootstrap job.

tar_pathOptional 
1
tar_path: str
  • Type: str
  • Default: PredefinedVariables.ciProjectDir

Path where to find the container image tarball.

DiveScanProps

Initializer 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from gcix import container

container.DiveScanProps(
  highest_user_wasted_percent: typing.Union[int, float] = None,
  highest_wasted_bytes: typing.Union[int, float] = None,
  ignore_errors: bool = None,
  image_name: str = None,
  image_path: str = None,
  job_name: str = None,
  job_stage: str = None,
  lowest_efficiency: typing.Union[int, float] = None,
  source: str = None
)

Properties

Name Type Description
highest_user_wasted_percent typing.Union[int, float] Highest allowable percentage of bytes wasted (as a ratio between 0-1), otherwise CI validation will fail.
highest_wasted_bytes typing.Union[int, float] Highest allowable bytes wasted, otherwise CI validation will fail.
ignore_errors bool Ignore image parsing errors and run the analysis anyway.
image_name str Name of the container image to scan, if source is docker-archive argument gets prefix .tar.
image_path str Path to the image can be either a remote container registry, as well as a local path to an image.
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
lowest_efficiency typing.Union[int, float] Lowest allowable image efficiency (as a ratio between 0-1), otherwise CI validation will fail.
source str The container engine to fetch the image from.
highest_user_wasted_percentOptional 
1
highest_user_wasted_percent: typing.Union[int, float]
  • Type: typing.Union[int, float]
  • Default: 0.1

Highest allowable percentage of bytes wasted (as a ratio between 0-1), otherwise CI validation will fail.

highest_wasted_bytesOptional 
1
highest_wasted_bytes: typing.Union[int, float]
  • Type: typing.Union[int, float]

Highest allowable bytes wasted, otherwise CI validation will fail.

ignore_errorsOptional 
1
ignore_errors: bool
  • Type: bool
  • Default: false

Ignore image parsing errors and run the analysis anyway.

image_nameOptional 
1
image_name: str
  • Type: str
  • Default: PredefinedVariables.ciProjectName

Name of the container image to scan, if source is docker-archive argument gets prefix .tar.

image_pathOptional 
1
image_path: str
  • Type: str
  • Default: PredefinedVariables.ciProjectPath

Path to the image can be either a remote container registry, as well as a local path to an image.

job_nameOptional 
1
job_name: str
  • Type: str

The name of the Bootstrap job.

job_stageOptional 
1
job_stage: str
  • Type: str

The stage of the Bootstrap job.

lowest_efficiencyOptional 
1
lowest_efficiency: typing.Union[int, float]
  • Type: typing.Union[int, float]
  • Default: 0.9

Lowest allowable image efficiency (as a ratio between 0-1), otherwise CI validation will fail.

sourceOptional 
1
source: str
  • Type: str
  • Default: "docker-archive

The container engine to fetch the image from.

Allowed values: docker, podman, docker-archive

DockerBuildProps

Initializer 

1
2
3
4
5
6
7
8
9
from gcix import container

container.DockerBuildProps(
  repository: str,
  context: str = None,
  job_name: str = None,
  job_stage: str = None,
  tag: str = None
)

Properties

Name Type Description
repository str The Docker repository name ([<registry>/]<image>).
context str The Docker build context (the directory containing the Dockerfile).
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
tag str A Docker image tag applied to the image.
repositoryRequired 
1
repository: str
  • Type: str

The Docker repository name ([<registry>/]<image>).

contextOptional 
1
context: str
  • Type: str
  • Default: .

The Docker build context (the directory containing the Dockerfile).

job_nameOptional 
1
job_name: str
  • Type: str

The name of the Bootstrap job.

job_stageOptional 
1
job_stage: str
  • Type: str

The stage of the Bootstrap job.

tagOptional 
1
tag: str
  • Type: str

A Docker image tag applied to the image.

If not set docker uses latest

DockerClientConfigProps

Initializer 

1
2
3
4
5
from gcix import container

container.DockerClientConfigProps(
  config_file_path: str = None
)

Properties

Name Type Description
config_file_path str Docker client config path.
config_file_pathOptional 
1
config_file_path: str
  • Type: str
  • Default: $HOME/.docker/config.json

Docker client config path.

DockerPushProps

Initializer 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from gcix import container

container.DockerPushProps(
  container_image: str,
  job_name: str = None,
  job_stage: str = None,
  login_env_var: str = None,
  registry: str = None,
  tag: str = None,
  user_env_var: str = None
)

Properties

Name Type Description
container_image str The name of the Docker image to push to the registry.
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
login_env_var str If you have to login to the registry before the push, you have to provide the name of the environment variable, which contains the password or token, here.
registry str The Docker registry the image should be pushed to.
tag str The Docker image tag that should be pushed to the registry.
user_env_var str If you have to login to the registry before the push, you have to provide the name of the environment variable, which contains the username value, here.
container_imageRequired 
1
container_image: str
  • Type: str

The name of the Docker image to push to the registry.

job_nameOptional 
1
job_name: str
  • Type: str

The name of the Bootstrap job.

job_stageOptional 
1
job_stage: str
  • Type: str

The stage of the Bootstrap job.

login_env_varOptional 
1
login_env_var: str
  • Type: str

If you have to login to the registry before the push, you have to provide the name of the environment variable, which contains the password or token, here.

DO NOT PROVIDE THE LOGIN VALUE ITSELF! This would be a security issue!

registryOptional 
1
registry: str
  • Type: str
  • Default: index.docker.io/v1

The Docker registry the image should be pushed to.

tagOptional 
1
tag: str
  • Type: str
  • Default: latest

The Docker image tag that should be pushed to the registry.

user_env_varOptional 
1
user_env_var: str
  • Type: str

If you have to login to the registry before the push, you have to provide the name of the environment variable, which contains the username value, here.

DO NOT PROVIDE THE USERNAME VALUE ITSELF! This would be a security issue!

KanikoExecuteProps

Initializer 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from gcix import container

container.KanikoExecuteProps(
  build_args: typing.Mapping[typing.Any] = None,
  build_target: str = None,
  context: str = None,
  docker_client_config: DockerClientConfig = None,
  dockerfile: str = None,
  enable_push: bool = None,
  image_name: str = None,
  image_tag: str = None,
  job_name: str = None,
  job_stage: str = None,
  registries: typing.Union[typing.List[str], typing.List[Registry]] = None,
  tar_path: str = None,
  verbosity: str = None
)

Properties

Name Type Description
build_args typing.Mapping[typing.Any] Container build arguments, used to instrument the container image build.
build_target str For container multistage builds name of the build stage you want to create.
context str Context which will be send to kaniko.
docker_client_config DockerClientConfig Creates the Docker configuration file base on objects settings, to authenticate against given registries.
dockerfile str Name of the dockerfile to use.
enable_push bool Enable push to container registry, disabled to allow subsequent jobs to.
image_name str Image name which will be created.
image_tag str The tag the image will be tagged with.
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
registries typing.Union[typing.List[str], typing.List[Registry]] List of container registries to push created image to.
tar_path str Container images created by kaniko are tarball files.
verbosity str Verbosity of kaniko logging.
build_argsOptional 
1
build_args: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]

Container build arguments, used to instrument the container image build.

build_targetOptional 
1
build_target: str
  • Type: str

For container multistage builds name of the build stage you want to create.

Image tag will be appended with the build_target. e.g. latest-buildtarget.

contextOptional 
1
context: str
  • Type: str

Context which will be send to kaniko.

Defaults to None which implies the local directory is the context.

docker_client_configOptional 
1
docker_client_config: DockerClientConfig

Creates the Docker configuration file base on objects settings, to authenticate against given registries.

Defaults to a DockerClientConfig with login to the official Docker Hub and expecting credentials given as environment variables REGISTRY_USER and REGISTRY_LOGIN.

dockerfileOptional 
1
dockerfile: str
  • Type: str
  • Default: "Dockerfile"

Name of the dockerfile to use.

File is relative to context.

enable_pushOptional 
1
enable_push: bool
  • Type: bool
  • Default: false act on container tarball.

Enable push to container registry, disabled to allow subsequent jobs to.

image_nameOptional 
1
image_name: str
  • Type: str
  • Default: PredefinedVariables.CI_PROJECT_NAME.

Image name which will be created.

image_tagOptional 
1
image_tag: str
  • Type: str
  • Default: PredefinedVariables.CI_COMMIT_TAG

The tag the image will be tagged with.

job_nameOptional 
1
job_name: str
  • Type: str

The name of the Bootstrap job.

job_stageOptional 
1
job_stage: str
  • Type: str

The stage of the Bootstrap job.

registriesOptional 
1
registries: typing.Union[typing.List[str], typing.List[Registry]]
  • Type: typing.Union[typing.List[str], typing.List[Registry]]

List of container registries to push created image to.

tar_pathOptional 
1
tar_path: str
  • Type: str

Container images created by kaniko are tarball files.

This is the path where to store the image, will be named with suffix .tar. This path will be created if not present.

verbosityOptional 
1
verbosity: str
  • Type: str
  • Default: "info"

Verbosity of kaniko logging.

TrivyIgnoreFileCheckProps

Initializer 

1
2
3
4
5
6
7
from gcix import container

container.TrivyIgnoreFileCheckProps(
  job_name: str = None,
  job_stage: str = None,
  trivyignore_path: str = None
)

Properties

Name Type Description
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
trivyignore_path str Path to the .trivyignore file.
job_nameOptional 
1
job_name: str
  • Type: str

The name of the Bootstrap job.

job_stageOptional 
1
job_stage: str
  • Type: str

The stage of the Bootstrap job.

trivyignore_pathOptional 
1
trivyignore_path: str
  • Type: str
  • Default: PredefinedVariables.ciProjectDir/.trivyignore

Path to the .trivyignore file.

TrivyScanLocalImageProps

Initializer 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from gcix import container

container.TrivyScanLocalImageProps(
  debug: bool = None,
  exit_if_vulnerable: bool = None,
  image_name: str = None,
  image_path: str = None,
  job_name: str = None,
  job_stage: str = None,
  output_format: str = None,
  severity: str = None,
  trivy_config: str = None,
  vulnerability_types: str = None
)

Properties

Name Type Description
debug bool If trivy should run in debug mode.
exit_if_vulnerable bool Exit code when vulnerabilities were found.
image_name str Container image name, searched for in imagePath and gets .tar appended.
image_path str Path where to find the container image.
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
output_format str Scan output format, possible values (table, json).
severity str Severities of vulnerabilities to be displayed (comma separated).
trivy_config str Additional options to pass to trivy binary.
vulnerability_types str List of vulnerability types (comma separated).
debugOptional 
1
debug: bool
  • Type: bool
  • Default: false

If trivy should run in debug mode.

exit_if_vulnerableOptional 
1
exit_if_vulnerable: bool
  • Type: bool
  • Default: true

Exit code when vulnerabilities were found.

If true exit code is 1 else 0.

image_nameOptional 
1
image_name: str
  • Type: str
  • Default: PredefinedVariables.CI_PROJECT_NAME

Container image name, searched for in imagePath and gets .tar appended.

image_pathOptional 
1
image_path: str
  • Type: str
  • Default: PredefinedVariables.CI_PROJECT_DIR

Path where to find the container image.

job_nameOptional 
1
job_name: str
  • Type: str

The name of the Bootstrap job.

job_stageOptional 
1
job_stage: str
  • Type: str

The stage of the Bootstrap job.

output_formatOptional 
1
output_format: str
  • Type: str
  • Default: "table"

Scan output format, possible values (table, json).

severityOptional 
1
severity: str
  • Type: str
  • Default: "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL"

Severities of vulnerabilities to be displayed (comma separated).

trivy_configOptional 
1
trivy_config: str
  • Type: str

Additional options to pass to trivy binary.

vulnerability_typesOptional 
1
vulnerability_types: str
  • Type: str
  • Default: "os,library"

List of vulnerability types (comma separated).

Classes

BuildContainerCollection

Creates a gcip.Sequence to build, scan and push a container image.

The build step is executed by KanikoExecute, it will build the container image an outputs it to a tarball. There are two scan's, optimization scan with DiveScan to scan storage wasting in container image and a vulnerability scan with TrivyScanLocalImage. Both outputs are uploaded as an artifact to the GitLab instance. The container image is uploaded with CranePush.

Initializers 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from gcix import container

container.BuildContainerCollection(
  registry: typing.Union[str, Registry],
  docker_client_config: DockerClientConfig = None,
  do_crane_push: bool = None,
  do_dive_scan: bool = None,
  do_trivyignore_check: bool = None,
  do_trivy_scan: bool = None,
  image_name: str = None,
  image_tag: str = None,
  job_name: str = None,
  job_stage: str = None
)
Name Type Description
registry typing.Union[str, Registry] Container registry to push the image to.
docker_client_config DockerClientConfig Creates the Docker configuration file base on objects settings, to authenticate against given registries.
do_crane_push bool Set to false to skip the Crane push job.
do_dive_scan bool Set to false to skip the Dive scan job.
do_trivyignore_check bool Set to false to skip the existance check of the .trivyignore file.
do_trivy_scan bool Set to false to skip the Trivy scan job.
image_name str Image name with stage in the registry.
image_tag str Image tag.
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
registryRequired
  • Type: typing.Union[str, Registry]
  • Default: Registry.DOCKER

Container registry to push the image to.

If the container registry needs authentication, you have to provide a DockerClientConfig object with credentials.

docker_client_configOptional
  • Type: DockerClientConfig
  • Default: DockerClientConfig with login to the official Docker Hub and expecting credentials given as environment variables REGISTRY_USER and REGISTRY_LOGIN.

Creates the Docker configuration file base on objects settings, to authenticate against given registries.

do_crane_pushOptional
  • Type: bool
  • Default: true

Set to false to skip the Crane push job.

do_dive_scanOptional
  • Type: bool
  • Default: true

Set to false to skip the Dive scan job.

do_trivyignore_checkOptional
  • Type: bool
  • Default: true

Set to false to skip the existance check of the .trivyignore file.

do_trivy_scanOptional
  • Type: bool
  • Default: true

Set to false to skip the Trivy scan job.

image_nameOptional
  • Type: str
  • Default: PredefinedVariables.ciProjectDir

Image name with stage in the registry.

e.g. username/imageName.

image_tagOptional
  • Type: str
  • Default: PredefinedVariables.ciCommitRefName

Image tag.

Depending of the build it defaults either to the git tag or to the actual branch name.

job_nameOptional
  • Type: str

The name of the Bootstrap job.

job_stageOptional
  • Type: str

The stage of the Bootstrap job.

Methods

Name Description
add_children Add gcix.Jobs or other gcix.JobCollections to this JobCollection.
add_dependencies No description.
add_needs No description.
add_parent No description.
add_tags No description.
add_variables No description.
append_rules No description.
append_scripts No description.
assign_artifacts No description.
assign_cache No description.
get_all_instance_names Return all instance names from the given child.
initialize_allow_failure Calling gcix.Job.assignAllowFailure() to all jobs within this JobCollection that haven't been set the allowFailure before.
initialize_artifacts Sets gcix.Job.artifacts to all jobs within this JobCollection that haven't been set the artifacs before.
initialize_cache Calling gcix.Job.assigneCache() to all jobs within this JobCollection that haven't been set the cache before.
initialize_dependencies Calling gcix.Job.assignDependencies() to all jobs within the first stage of this JobCollection that haven't been added dependencies before.
initialize_image Calling gcix.Job.assignImage() to all jobs within this JobCollection.
initialize_needs Calling gcix.Job.assignNeeds() to all jobs within the first stage of this JobCollection that haven't been added needs before.
initialize_rules Calling gcix.Job.append_rules() to all jobs within this JobCollection that haven't been added rules before.
initialize_tags Calling gcix.Job.addTags([...]) to all jobs within this JobCollection that haven't been added tags before.
initialize_variables Calling gcix.Job.addVariables({...}) to all jobs within this JobCollection that haven't been added variables before.
is_equal isEqual checks if this object is equal to given object.
override_allow_failure Calling gcix.Job.assignAllowFailure() to all jobs within this JobCollection overriding any previous set value.
override_dependencies Calling gcix.Job.assignDependencies() to all jobs within the first stage of this JobCollection and overriding any previously added dependencies to that jobs.
override_image Calling gcix.Job.assignImage() to all jobs within this JobCollection overriding any previous set value.
override_needs Calling gcix.Job.assignNeeds() to all jobs within the first stage of this JobCollection and overriding any previously added needs to that jobs.
override_rules Calling gcix.Job.overrideRules() to all jobs within this JobCollection and overriding any previously added rules to that jobs.
override_tags Calling gcix.Job.addTags([...]) to all jobs within this JobCollection and overriding any previously added tags to that jobs.
override_variables Calling gcix.Job.addVariables({...}) to all jobs within this JobCollection and overriding any previously added variables to that jobs.
prepend_rules No description.
prepend_scripts No description.
render Returns a representation of any object which implements IBase.
add_children 
1
2
3
4
5
def add_children(
  jobs_or_job_collections: typing.List[typing.Union[Job, JobCollection]],
  name: str = None,
  stage: str = None
) -> JobCollection

Add gcix.Jobs or other gcix.JobCollections to this JobCollection.

Adding a child creates a copy of that child. You should provide a name or stage when adding children, to make them different from other places where they will be used.

jobs_or_job_collectionsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection]]
nameOptional
  • Type: str
stageOptional
  • Type: str
add_dependencies 
1
2
3
def add_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> JobCollection
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_needs 
1
2
3
def add_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> JobCollection
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_parent 
1
2
3
def add_parent(
  parent: JobCollection
) -> None
parentRequired
  • Type: gcix.JobCollection
add_tags 
1
2
3
def add_tags(
  tags: typing.List[str]
) -> JobCollection
tagsRequired
  • Type: typing.List[str]
add_variables 
1
2
3
def add_variables(
  variables: typing.Mapping[str]
) -> JobCollection
variablesRequired
  • Type: typing.Mapping[str]
append_rules 
1
2
3
def append_rules(
  rules: typing.List[Rule]
) -> JobCollection
rulesRequired
  • Type: typing.List[gcix.Rule]
append_scripts 
1
2
3
def append_scripts(
  scripts: typing.List[str]
) -> JobCollection
scriptsRequired
  • Type: typing.List[str]
assign_artifacts 
1
2
3
def assign_artifacts(
  artifacts: Artifacts
) -> JobCollection
artifactsRequired
  • Type: gcix.Artifacts
assign_cache 
1
2
3
def assign_cache(
  cache: Cache
) -> JobCollection
cacheRequired
  • Type: gcix.Cache
get_all_instance_names 
1
2
3
def get_all_instance_names(
  child: typing.Union[Job, JobCollection] = None
) -> OrderedStringSet

Return all instance names from the given child.

That means all combinations of the childs name and stage within this JobCollection and all parent JobCollection's.

childOptional
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
initialize_allow_failure 
1
2
3
def initialize_allow_failure(
  allow_failure: typing.Union[bool, typing.List[typing.Union[int, float]]]
) -> JobCollection

Calling gcix.Job.assignAllowFailure() to all jobs within this JobCollection that haven't been set the allowFailure before.

allow_failureRequired
  • Type: typing.Union[bool, typing.List[typing.Union[int, float]]]
initialize_artifacts 
1
2
3
def initialize_artifacts(
  artifacts: Artifacts
) -> JobCollection

Sets gcix.Job.artifacts to all jobs within this JobCollection that haven't been set the artifacs before.

artifactsRequired
  • Type: gcix.Artifacts
initialize_cache 
1
2
3
def initialize_cache(
  cache: Cache
) -> JobCollection

Calling gcix.Job.assigneCache() to all jobs within this JobCollection that haven't been set the cache before.

cacheRequired
  • Type: gcix.Cache
initialize_dependencies 
1
2
3
def initialize_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> JobCollection

Calling gcix.Job.assignDependencies() to all jobs within the first stage of this JobCollection that haven't been added dependencies before.

An empty parameter list means that jobs will get an empty dependency list and thus does not download artifacts by default.

dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
initialize_image 
1
2
3
def initialize_image(
  image: typing.Union[str, Image]
) -> JobCollection

Calling gcix.Job.assignImage() to all jobs within this JobCollection.

imageRequired
  • Type: typing.Union[str, gcix.Image]
initialize_needs 
1
2
3
def initialize_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> JobCollection

Calling gcix.Job.assignNeeds() to all jobs within the first stage of this JobCollection that haven't been added needs before.

An empty parameter list means that jobs will get an empty dependency list and thus does not depend on other jobs by default.

needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
initialize_rules 
1
2
3
def initialize_rules(
  rules: typing.List[Rule]
) -> JobCollection

Calling gcix.Job.append_rules() to all jobs within this JobCollection that haven't been added rules before.

rulesRequired
  • Type: typing.List[gcix.Rule]
initialize_tags 
1
2
3
def initialize_tags(
  tags: typing.List[str]
) -> JobCollection

Calling gcix.Job.addTags([...]) to all jobs within this JobCollection that haven't been added tags before.

tagsRequired
  • Type: typing.List[str]
initialize_variables 
1
2
3
def initialize_variables(
  variables: typing.Mapping[str]
) -> JobCollection

Calling gcix.Job.addVariables({...}) to all jobs within this JobCollection that haven't been added variables before.

variablesRequired
  • Type: typing.Mapping[str]
is_equal 
1
2
3
def is_equal(
  comparable: IBase
) -> bool

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: gcix.IBase
override_allow_failure 
1
2
3
def override_allow_failure(
  allow_failure: typing.Union[bool, typing.List[typing.Union[int, float]]]
) -> JobCollection

Calling gcix.Job.assignAllowFailure() to all jobs within this JobCollection overriding any previous set value.

allow_failureRequired
  • Type: typing.Union[bool, typing.List[typing.Union[int, float]]]
override_dependencies 
1
2
3
def override_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> JobCollection

Calling gcix.Job.assignDependencies() to all jobs within the first stage of this JobCollection and overriding any previously added dependencies to that jobs.

An empty parameter list means that jobs will get an empty dependency list and thus does not download artifacts.

dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
override_image 
1
2
3
def override_image(
  image: typing.Union[str, Image]
) -> JobCollection

Calling gcix.Job.assignImage() to all jobs within this JobCollection overriding any previous set value.

imageRequired
  • Type: typing.Union[str, gcix.Image]
override_needs 
1
2
3
def override_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> JobCollection

Calling gcix.Job.assignNeeds() to all jobs within the first stage of this JobCollection and overriding any previously added needs to that jobs.

An empty parameter list means that jobs will get an empty dependency list and thus does not depend on other jobs.

needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
override_rules 
1
2
3
def override_rules(
  rules: typing.List[Rule]
) -> JobCollection

Calling gcix.Job.overrideRules() to all jobs within this JobCollection and overriding any previously added rules to that jobs.

rulesRequired
  • Type: typing.List[gcix.Rule]
override_tags 
1
2
3
def override_tags(
  tags: typing.List[str]
) -> JobCollection

Calling gcix.Job.addTags([...]) to all jobs within this JobCollection and overriding any previously added tags to that jobs.

tagsRequired
  • Type: typing.List[str]
override_variables 
1
2
3
def override_variables(
  variables: typing.Mapping[str]
) -> JobCollection

Calling gcix.Job.addVariables({...}) to all jobs within this JobCollection and overriding any previously added variables to that jobs.

variablesRequired
  • Type: typing.Mapping[str]
prepend_rules 
1
2
3
def prepend_rules(
  rules: typing.List[Rule]
) -> JobCollection
rulesRequired
  • Type: typing.List[gcix.Rule]
prepend_scripts 
1
2
3
def prepend_scripts(
  scripts: typing.List[str]
) -> JobCollection
scriptsRequired
  • Type: typing.List[str]
render 
1
def render() -> typing.Any

Returns a representation of any object which implements IBase.

The rendered representation is used by the gcix to dump it in YAML format as part of the .gitlab-ci.yml pipeline.

Properties

Name Type Description
last_jobs_executed typing.List[gcix.Job] This property returns all Jobs from the last stage of this JobCollection.
nested_jobs typing.List[gcix.Job] No description.
populated_jobs typing.List[gcix.Job] Returns a list with populated copies of all nested jobs of this JobCollection.
children typing.List[gcix.ChildDict] No description.
ordered_tags gcix.OrderedStringSet No description.
ordered_tags_for_initialization gcix.OrderedStringSet No description.
ordered_tags_for_replacement gcix.OrderedStringSet No description.
parents typing.List[typing.Union[gcix.Job, gcix.JobCollection]] No description.
allow_failure_for_initialization typing.Union[str, bool, typing.List[typing.Union[int, float]]] No description.
allow_failure_for_replacement typing.Union[str, bool, typing.List[typing.Union[int, float]]] No description.
artifacts gcix.Artifacts No description.
artifacts_for_initialization gcix.Artifacts No description.
artifacts_for_replacement gcix.Artifacts No description.
cache gcix.Cache No description.
cache_for_initialization gcix.Cache No description.
dependencies typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
dependencies_for_initialization typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
dependencies_for_replacement typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
image_for_initialization typing.Union[str, gcix.Image] No description.
image_for_replacement typing.Union[str, gcix.Image] No description.
needs typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
needs_for_initialization typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
needs_for_replacement typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
rules_for_initialization typing.List[gcix.Rule] No description.
rules_for_replacement typing.List[gcix.Rule] No description.
rules_to_append typing.List[gcix.Rule] No description.
rules_to_prepend typing.List[gcix.Rule] No description.
scripts_to_append typing.List[str] No description.
scripts_to_prepend typing.List[str] No description.
variables typing.Mapping[str] No description.
variables_for_initialization typing.Mapping[str] No description.
variables_for_replacement typing.Mapping[str] No description.
crane_push_job CranePush Crane push job.
dive_scan_job DiveScan Dive scan job.
docker_client_config DockerClientConfig Creates the Docker configuration file base on objects settings, to authenticate against given registries.
do_crane_push bool Set to false to skip the Crane push job.
do_dive_scan bool Set to false to skip the Dive scan job.
do_trivyignore_check bool Set to false to skip the existance check of the .trivyignore file.
do_trivy_scan bool Set to false to skip the Trivy scan job.
image_name str Image name with stage in the registry.
image_tag str Image tag.
kaniko_execute_job KanikoExecute Kaniko execute job.
registry typing.Union[str, Registry] Container registry to push the image to.
trivy_ignore_file_check_job TrivyIgnoreFileCheck Trivy ignore file check job.
trivy_scan_local_image_job TrivyScanLocalImage Trivy scan local image job.
last_jobs_executedRequired 
1
last_jobs_executed: typing.List[Job]
  • Type: typing.List[gcix.Job]

This property returns all Jobs from the last stage of this JobCollection.

This is typically be requested from a job which has setup this JobCollection as need, to determine all actual jobs of this JobCollection as need.

nested_jobsRequired 
1
nested_jobs: typing.List[Job]
  • Type: typing.List[gcix.Job]
populated_jobsRequired 
1
populated_jobs: typing.List[Job]
  • Type: typing.List[gcix.Job]

Returns a list with populated copies of all nested jobs of this JobCollection.

Populated means, that all attributes of a Job which depends on its context are resolved to their final values. The context is primarily the JobCollection within the jobs resides but also dependencies to other jobs and JobCollection's. Thus this JobCollection will apply its own configuration, like variables to add, tags to set, etc., to all its jobs and JobCollection's.

Copies means what it says, that the returned job are not the same job objects, originally added to this JobCollection, but copies of them.

Nested means, that also jobs from JobCollection's within this JobCollection, are returned, as well as jobs from JobCollection's within JobCollection's within this JobCollection and so on.

childrenRequired 
1
children: typing.List[ChildDict]
  • Type: typing.List[gcix.ChildDict]
ordered_tagsRequired 
1
ordered_tags: OrderedStringSet
  • Type: gcix.OrderedStringSet
ordered_tags_for_initializationRequired 
1
ordered_tags_for_initialization: OrderedStringSet
  • Type: gcix.OrderedStringSet
ordered_tags_for_replacementRequired 
1
ordered_tags_for_replacement: OrderedStringSet
  • Type: gcix.OrderedStringSet
parentsRequired 
1
parents: typing.List[typing.Union[Job, JobCollection]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection]]
allow_failure_for_initializationOptional 
1
allow_failure_for_initialization: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
  • Type: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
allow_failure_for_replacementOptional 
1
allow_failure_for_replacement: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
  • Type: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
artifactsOptional 
1
artifacts: Artifacts
  • Type: gcix.Artifacts
artifacts_for_initializationOptional 
1
artifacts_for_initialization: Artifacts
  • Type: gcix.Artifacts
artifacts_for_replacementOptional 
1
artifacts_for_replacement: Artifacts
  • Type: gcix.Artifacts
cacheOptional 
1
cache: Cache
  • Type: gcix.Cache
cache_for_initializationOptional 
1
cache_for_initialization: Cache
  • Type: gcix.Cache
dependenciesOptional 
1
dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
dependencies_for_initializationOptional 
1
dependencies_for_initialization: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
dependencies_for_replacementOptional 
1
dependencies_for_replacement: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
image_for_initializationOptional 
1
image_for_initialization: typing.Union[str, Image]
  • Type: typing.Union[str, gcix.Image]
image_for_replacementOptional 
1
image_for_replacement: typing.Union[str, Image]
  • Type: typing.Union[str, gcix.Image]
needsOptional 
1
needs: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
needs_for_initializationOptional 
1
needs_for_initialization: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
needs_for_replacementOptional 
1
needs_for_replacement: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
rules_for_initializationOptional 
1
rules_for_initialization: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
rules_for_replacementOptional 
1
rules_for_replacement: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
rules_to_appendOptional 
1
rules_to_append: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
rules_to_prependOptional 
1
rules_to_prepend: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
scripts_to_appendOptional 
1
scripts_to_append: typing.List[str]
  • Type: typing.List[str]
scripts_to_prependOptional 
1
scripts_to_prepend: typing.List[str]
  • Type: typing.List[str]
variablesOptional 
1
variables: typing.Mapping[str]
  • Type: typing.Mapping[str]
variables_for_initializationOptional 
1
variables_for_initialization: typing.Mapping[str]
  • Type: typing.Mapping[str]
variables_for_replacementOptional 
1
variables_for_replacement: typing.Mapping[str]
  • Type: typing.Mapping[str]
crane_push_jobRequired 
1
crane_push_job: CranePush

Crane push job.

dive_scan_jobRequired 
1
dive_scan_job: DiveScan

Dive scan job.

docker_client_configRequired 
1
docker_client_config: DockerClientConfig

Creates the Docker configuration file base on objects settings, to authenticate against given registries.

do_crane_pushRequired 
1
do_crane_push: bool
  • Type: bool

Set to false to skip the Crane push job.

do_dive_scanRequired 
1
do_dive_scan: bool
  • Type: bool

Set to false to skip the Dive scan job.

do_trivyignore_checkRequired 
1
do_trivyignore_check: bool
  • Type: bool

Set to false to skip the existance check of the .trivyignore file.

do_trivy_scanRequired 
1
do_trivy_scan: bool
  • Type: bool

Set to false to skip the Trivy scan job.

image_nameRequired 
1
image_name: str
  • Type: str

Image name with stage in the registry.

e.g. username/imageName.

image_tagRequired 
1
image_tag: str
  • Type: str

Image tag.

Depending of the build it defaults either to the git tag or to the actual branch name.

kaniko_execute_jobRequired 
1
kaniko_execute_job: KanikoExecute

Kaniko execute job.

registryRequired 
1
registry: typing.Union[str, Registry]

Container registry to push the image to.

If the container registry needs authentication, you have to provide a DockerClientConfig object with credentials.

trivy_ignore_file_check_jobRequired 
1
trivy_ignore_file_check_job: TrivyIgnoreFileCheck

Trivy ignore file check job.

trivy_scan_local_image_jobRequired 
1
trivy_scan_local_image_job: TrivyScanLocalImage

Trivy scan local image job.

CopyContainerCollection

Creates a gcip.Sequence to pull, scan and push a container image.

The pull step is executed by CranePull, it will pull the container image and outputs it to a tarball. There are two scan's, optimization scan with DiveScan to scan storage wasting in container image and a vulnerability scan with TrivyScanLocalImage. Both outputs are uploaded as an artifact to the GitLab instance. Built container image is uploaded with CranePush.

NOTE: We decided to use caches instead of artifacts to pass the Docker image tar archive from one job to another. This is because those tar archives could become very large - especially larger then the maximum artifact size limit. This limit can just be adjusted by the admin of the gitlab instance, so your pipeline would never work, your Gitlab provider would not adjust this limit for you. For caches on the other hand you can define storage backends at the base of your Gitlab runners.

Furthermore we set the cache key to the pipeline ID. This is because the name and tag of the image does not ensure that the downloaded tar is unique, as the image behind the image tag could be overridden. So we ensure uniqueness by downloading the image once per pipeline.

Initializers 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from gcix import container

container.CopyContainerCollection(
  image_name: str,
  image_tag: str,
  docker_client_config: DockerClientConfig = None,
  do_dive_scan: bool = None,
  do_trivyignore_check: bool = None,
  do_trivy_scan: bool = None,
  dst_registry: typing.Union[str, Registry] = None,
  job_name: str = None,
  job_stage: str = None,
  src_registry: typing.Union[str, Registry] = None
)
Name Type Description
image_name str Image name with stage in the registry.
image_tag str Container image tag to pull from srcRegistry and push to dstRegistry.
docker_client_config DockerClientConfig Creates the Docker configuration file base on objects settings, to authenticate against given registries.
do_dive_scan bool Set to false to skip the Dive scan job.
do_trivyignore_check bool Set to false to skip the existance check of the .trivyignore file.
do_trivy_scan bool Set to false to skip the Trivy scan job.
dst_registry typing.Union[str, Registry] Container registry to push the image to.
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
src_registry typing.Union[str, Registry] Container registry to pull the image from.
image_nameRequired
  • Type: str

Image name with stage in the registry.

e.g. username/image_name.

image_tagRequired
  • Type: str

Container image tag to pull from srcRegistry and push to dstRegistry.

docker_client_configOptional
  • Type: DockerClientConfig
  • Default: DockerClientConfig with login to the official Docker Hub and expecting credentials given as environment variables REGISTRY_USER and REGISTRY_LOGIN.

Creates the Docker configuration file base on objects settings, to authenticate against given registries.

do_dive_scanOptional
  • Type: bool
  • Default: true

Set to false to skip the Dive scan job.

do_trivyignore_checkOptional
  • Type: bool
  • Default: true

Set to false to skip the existance check of the .trivyignore file.

do_trivy_scanOptional
  • Type: bool
  • Default: true

Set to false to skip the Trivy scan job.

dst_registryOptional
  • Type: typing.Union[str, Registry]
  • Default: Registry.DOCKER

Container registry to push the image to.

If the container registry needs authentication, you have to provide a DockerClientConfig object with credentials.

job_nameOptional
  • Type: str

The name of the Bootstrap job.

job_stageOptional
  • Type: str

The stage of the Bootstrap job.

src_registryOptional
  • Type: typing.Union[str, Registry]
  • Default: Registry.DOCKER

Container registry to pull the image from.

If the container registry needs authentication, you have to provide a DockerClientConfig object with credentials.

Methods

Name Description
add_children Add gcix.Jobs or other gcix.JobCollections to this JobCollection.
add_dependencies No description.
add_needs No description.
add_parent No description.
add_tags No description.
add_variables No description.
append_rules No description.
append_scripts No description.
assign_artifacts No description.
assign_cache No description.
get_all_instance_names Return all instance names from the given child.
initialize_allow_failure Calling gcix.Job.assignAllowFailure() to all jobs within this JobCollection that haven't been set the allowFailure before.
initialize_artifacts Sets gcix.Job.artifacts to all jobs within this JobCollection that haven't been set the artifacs before.
initialize_cache Calling gcix.Job.assigneCache() to all jobs within this JobCollection that haven't been set the cache before.
initialize_dependencies Calling gcix.Job.assignDependencies() to all jobs within the first stage of this JobCollection that haven't been added dependencies before.
initialize_image Calling gcix.Job.assignImage() to all jobs within this JobCollection.
initialize_needs Calling gcix.Job.assignNeeds() to all jobs within the first stage of this JobCollection that haven't been added needs before.
initialize_rules Calling gcix.Job.append_rules() to all jobs within this JobCollection that haven't been added rules before.
initialize_tags Calling gcix.Job.addTags([...]) to all jobs within this JobCollection that haven't been added tags before.
initialize_variables Calling gcix.Job.addVariables({...}) to all jobs within this JobCollection that haven't been added variables before.
is_equal isEqual checks if this object is equal to given object.
override_allow_failure Calling gcix.Job.assignAllowFailure() to all jobs within this JobCollection overriding any previous set value.
override_dependencies Calling gcix.Job.assignDependencies() to all jobs within the first stage of this JobCollection and overriding any previously added dependencies to that jobs.
override_image Calling gcix.Job.assignImage() to all jobs within this JobCollection overriding any previous set value.
override_needs Calling gcix.Job.assignNeeds() to all jobs within the first stage of this JobCollection and overriding any previously added needs to that jobs.
override_rules Calling gcix.Job.overrideRules() to all jobs within this JobCollection and overriding any previously added rules to that jobs.
override_tags Calling gcix.Job.addTags([...]) to all jobs within this JobCollection and overriding any previously added tags to that jobs.
override_variables Calling gcix.Job.addVariables({...}) to all jobs within this JobCollection and overriding any previously added variables to that jobs.
prepend_rules No description.
prepend_scripts No description.
render Returns a representation of any object which implements IBase.
add_children 
1
2
3
4
5
def add_children(
  jobs_or_job_collections: typing.List[typing.Union[Job, JobCollection]],
  name: str = None,
  stage: str = None
) -> JobCollection

Add gcix.Jobs or other gcix.JobCollections to this JobCollection.

Adding a child creates a copy of that child. You should provide a name or stage when adding children, to make them different from other places where they will be used.

jobs_or_job_collectionsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection]]
nameOptional
  • Type: str
stageOptional
  • Type: str
add_dependencies 
1
2
3
def add_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> JobCollection
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_needs 
1
2
3
def add_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> JobCollection
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_parent 
1
2
3
def add_parent(
  parent: JobCollection
) -> None
parentRequired
  • Type: gcix.JobCollection
add_tags 
1
2
3
def add_tags(
  tags: typing.List[str]
) -> JobCollection
tagsRequired
  • Type: typing.List[str]
add_variables 
1
2
3
def add_variables(
  variables: typing.Mapping[str]
) -> JobCollection
variablesRequired
  • Type: typing.Mapping[str]
append_rules 
1
2
3
def append_rules(
  rules: typing.List[Rule]
) -> JobCollection
rulesRequired
  • Type: typing.List[gcix.Rule]
append_scripts 
1
2
3
def append_scripts(
  scripts: typing.List[str]
) -> JobCollection
scriptsRequired
  • Type: typing.List[str]
assign_artifacts 
1
2
3
def assign_artifacts(
  artifacts: Artifacts
) -> JobCollection
artifactsRequired
  • Type: gcix.Artifacts
assign_cache 
1
2
3
def assign_cache(
  cache: Cache
) -> JobCollection
cacheRequired
  • Type: gcix.Cache
get_all_instance_names 
1
2
3
def get_all_instance_names(
  child: typing.Union[Job, JobCollection] = None
) -> OrderedStringSet

Return all instance names from the given child.

That means all combinations of the childs name and stage within this JobCollection and all parent JobCollection's.

childOptional
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
initialize_allow_failure 
1
2
3
def initialize_allow_failure(
  allow_failure: typing.Union[bool, typing.List[typing.Union[int, float]]]
) -> JobCollection

Calling gcix.Job.assignAllowFailure() to all jobs within this JobCollection that haven't been set the allowFailure before.

allow_failureRequired
  • Type: typing.Union[bool, typing.List[typing.Union[int, float]]]
initialize_artifacts 
1
2
3
def initialize_artifacts(
  artifacts: Artifacts
) -> JobCollection

Sets gcix.Job.artifacts to all jobs within this JobCollection that haven't been set the artifacs before.

artifactsRequired
  • Type: gcix.Artifacts
initialize_cache 
1
2
3
def initialize_cache(
  cache: Cache
) -> JobCollection

Calling gcix.Job.assigneCache() to all jobs within this JobCollection that haven't been set the cache before.

cacheRequired
  • Type: gcix.Cache
initialize_dependencies 
1
2
3
def initialize_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> JobCollection

Calling gcix.Job.assignDependencies() to all jobs within the first stage of this JobCollection that haven't been added dependencies before.

An empty parameter list means that jobs will get an empty dependency list and thus does not download artifacts by default.

dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
initialize_image 
1
2
3
def initialize_image(
  image: typing.Union[str, Image]
) -> JobCollection

Calling gcix.Job.assignImage() to all jobs within this JobCollection.

imageRequired
  • Type: typing.Union[str, gcix.Image]
initialize_needs 
1
2
3
def initialize_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> JobCollection

Calling gcix.Job.assignNeeds() to all jobs within the first stage of this JobCollection that haven't been added needs before.

An empty parameter list means that jobs will get an empty dependency list and thus does not depend on other jobs by default.

needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
initialize_rules 
1
2
3
def initialize_rules(
  rules: typing.List[Rule]
) -> JobCollection

Calling gcix.Job.append_rules() to all jobs within this JobCollection that haven't been added rules before.

rulesRequired
  • Type: typing.List[gcix.Rule]
initialize_tags 
1
2
3
def initialize_tags(
  tags: typing.List[str]
) -> JobCollection

Calling gcix.Job.addTags([...]) to all jobs within this JobCollection that haven't been added tags before.

tagsRequired
  • Type: typing.List[str]
initialize_variables 
1
2
3
def initialize_variables(
  variables: typing.Mapping[str]
) -> JobCollection

Calling gcix.Job.addVariables({...}) to all jobs within this JobCollection that haven't been added variables before.

variablesRequired
  • Type: typing.Mapping[str]
is_equal 
1
2
3
def is_equal(
  comparable: IBase
) -> bool

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: gcix.IBase
override_allow_failure 
1
2
3
def override_allow_failure(
  allow_failure: typing.Union[bool, typing.List[typing.Union[int, float]]]
) -> JobCollection

Calling gcix.Job.assignAllowFailure() to all jobs within this JobCollection overriding any previous set value.

allow_failureRequired
  • Type: typing.Union[bool, typing.List[typing.Union[int, float]]]
override_dependencies 
1
2
3
def override_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> JobCollection

Calling gcix.Job.assignDependencies() to all jobs within the first stage of this JobCollection and overriding any previously added dependencies to that jobs.

An empty parameter list means that jobs will get an empty dependency list and thus does not download artifacts.

dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
override_image 
1
2
3
def override_image(
  image: typing.Union[str, Image]
) -> JobCollection

Calling gcix.Job.assignImage() to all jobs within this JobCollection overriding any previous set value.

imageRequired
  • Type: typing.Union[str, gcix.Image]
override_needs 
1
2
3
def override_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> JobCollection

Calling gcix.Job.assignNeeds() to all jobs within the first stage of this JobCollection and overriding any previously added needs to that jobs.

An empty parameter list means that jobs will get an empty dependency list and thus does not depend on other jobs.

needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
override_rules 
1
2
3
def override_rules(
  rules: typing.List[Rule]
) -> JobCollection

Calling gcix.Job.overrideRules() to all jobs within this JobCollection and overriding any previously added rules to that jobs.

rulesRequired
  • Type: typing.List[gcix.Rule]
override_tags 
1
2
3
def override_tags(
  tags: typing.List[str]
) -> JobCollection

Calling gcix.Job.addTags([...]) to all jobs within this JobCollection and overriding any previously added tags to that jobs.

tagsRequired
  • Type: typing.List[str]
override_variables 
1
2
3
def override_variables(
  variables: typing.Mapping[str]
) -> JobCollection

Calling gcix.Job.addVariables({...}) to all jobs within this JobCollection and overriding any previously added variables to that jobs.

variablesRequired
  • Type: typing.Mapping[str]
prepend_rules 
1
2
3
def prepend_rules(
  rules: typing.List[Rule]
) -> JobCollection
rulesRequired
  • Type: typing.List[gcix.Rule]
prepend_scripts 
1
2
3
def prepend_scripts(
  scripts: typing.List[str]
) -> JobCollection
scriptsRequired
  • Type: typing.List[str]
render 
1
def render() -> typing.Any

Returns a representation of any object which implements IBase.

The rendered representation is used by the gcix to dump it in YAML format as part of the .gitlab-ci.yml pipeline.

Properties

Name Type Description
last_jobs_executed typing.List[gcix.Job] This property returns all Jobs from the last stage of this JobCollection.
nested_jobs typing.List[gcix.Job] No description.
populated_jobs typing.List[gcix.Job] Returns a list with populated copies of all nested jobs of this JobCollection.
children typing.List[gcix.ChildDict] No description.
ordered_tags gcix.OrderedStringSet No description.
ordered_tags_for_initialization gcix.OrderedStringSet No description.
ordered_tags_for_replacement gcix.OrderedStringSet No description.
parents typing.List[typing.Union[gcix.Job, gcix.JobCollection]] No description.
allow_failure_for_initialization typing.Union[str, bool, typing.List[typing.Union[int, float]]] No description.
allow_failure_for_replacement typing.Union[str, bool, typing.List[typing.Union[int, float]]] No description.
artifacts gcix.Artifacts No description.
artifacts_for_initialization gcix.Artifacts No description.
artifacts_for_replacement gcix.Artifacts No description.
cache gcix.Cache No description.
cache_for_initialization gcix.Cache No description.
dependencies typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
dependencies_for_initialization typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
dependencies_for_replacement typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
image_for_initialization typing.Union[str, gcix.Image] No description.
image_for_replacement typing.Union[str, gcix.Image] No description.
needs typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
needs_for_initialization typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
needs_for_replacement typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
rules_for_initialization typing.List[gcix.Rule] No description.
rules_for_replacement typing.List[gcix.Rule] No description.
rules_to_append typing.List[gcix.Rule] No description.
rules_to_prepend typing.List[gcix.Rule] No description.
scripts_to_append typing.List[str] No description.
scripts_to_prepend typing.List[str] No description.
variables typing.Mapping[str] No description.
variables_for_initialization typing.Mapping[str] No description.
variables_for_replacement typing.Mapping[str] No description.
crane_pull_job CranePull CranPull job.
crane_push_job CranePush No description.
docker_client_config DockerClientConfig Creates the Docker configuration file base on objects settings, to authenticate against given registries.
do_dive_scan bool Set to false to skip the Dive scan job.
do_trivyignore_check bool Set to false to skip the existance check of the .trivyignore file.
do_trivy_scan bool Set to false to skip the Trivy scan job.
dst_registry typing.Union[str, Registry] Container registry to push the image to.
image_name str Image name with stage in the registry.
image_tag str Container image tag to pull from srcRegistry and push to dstRegistry.
src_registry typing.Union[str, Registry] Container registry to pull the image from.
dive_scan_job DiveScan Dive scan job.
trivy_ignore_file_check_job TrivyIgnoreFileCheck Trivy ignore file check job.
trivy_scan_local_image_job TrivyScanLocalImage Trivy scan local image job.
last_jobs_executedRequired 
1
last_jobs_executed: typing.List[Job]
  • Type: typing.List[gcix.Job]

This property returns all Jobs from the last stage of this JobCollection.

This is typically be requested from a job which has setup this JobCollection as need, to determine all actual jobs of this JobCollection as need.

nested_jobsRequired 
1
nested_jobs: typing.List[Job]
  • Type: typing.List[gcix.Job]
populated_jobsRequired 
1
populated_jobs: typing.List[Job]
  • Type: typing.List[gcix.Job]

Returns a list with populated copies of all nested jobs of this JobCollection.

Populated means, that all attributes of a Job which depends on its context are resolved to their final values. The context is primarily the JobCollection within the jobs resides but also dependencies to other jobs and JobCollection's. Thus this JobCollection will apply its own configuration, like variables to add, tags to set, etc., to all its jobs and JobCollection's.

Copies means what it says, that the returned job are not the same job objects, originally added to this JobCollection, but copies of them.

Nested means, that also jobs from JobCollection's within this JobCollection, are returned, as well as jobs from JobCollection's within JobCollection's within this JobCollection and so on.

childrenRequired 
1
children: typing.List[ChildDict]
  • Type: typing.List[gcix.ChildDict]
ordered_tagsRequired 
1
ordered_tags: OrderedStringSet
  • Type: gcix.OrderedStringSet
ordered_tags_for_initializationRequired 
1
ordered_tags_for_initialization: OrderedStringSet
  • Type: gcix.OrderedStringSet
ordered_tags_for_replacementRequired 
1
ordered_tags_for_replacement: OrderedStringSet
  • Type: gcix.OrderedStringSet
parentsRequired 
1
parents: typing.List[typing.Union[Job, JobCollection]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection]]
allow_failure_for_initializationOptional 
1
allow_failure_for_initialization: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
  • Type: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
allow_failure_for_replacementOptional 
1
allow_failure_for_replacement: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
  • Type: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
artifactsOptional 
1
artifacts: Artifacts
  • Type: gcix.Artifacts
artifacts_for_initializationOptional 
1
artifacts_for_initialization: Artifacts
  • Type: gcix.Artifacts
artifacts_for_replacementOptional 
1
artifacts_for_replacement: Artifacts
  • Type: gcix.Artifacts
cacheOptional 
1
cache: Cache
  • Type: gcix.Cache
cache_for_initializationOptional 
1
cache_for_initialization: Cache
  • Type: gcix.Cache
dependenciesOptional 
1
dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
dependencies_for_initializationOptional 
1
dependencies_for_initialization: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
dependencies_for_replacementOptional 
1
dependencies_for_replacement: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
image_for_initializationOptional 
1
image_for_initialization: typing.Union[str, Image]
  • Type: typing.Union[str, gcix.Image]
image_for_replacementOptional 
1
image_for_replacement: typing.Union[str, Image]
  • Type: typing.Union[str, gcix.Image]
needsOptional 
1
needs: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
needs_for_initializationOptional 
1
needs_for_initialization: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
needs_for_replacementOptional 
1
needs_for_replacement: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
rules_for_initializationOptional 
1
rules_for_initialization: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
rules_for_replacementOptional 
1
rules_for_replacement: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
rules_to_appendOptional 
1
rules_to_append: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
rules_to_prependOptional 
1
rules_to_prepend: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
scripts_to_appendOptional 
1
scripts_to_append: typing.List[str]
  • Type: typing.List[str]
scripts_to_prependOptional 
1
scripts_to_prepend: typing.List[str]
  • Type: typing.List[str]
variablesOptional 
1
variables: typing.Mapping[str]
  • Type: typing.Mapping[str]
variables_for_initializationOptional 
1
variables_for_initialization: typing.Mapping[str]
  • Type: typing.Mapping[str]
variables_for_replacementOptional 
1
variables_for_replacement: typing.Mapping[str]
  • Type: typing.Mapping[str]
crane_pull_jobRequired 
1
crane_pull_job: CranePull

CranPull job.

crane_push_jobRequired 
1
crane_push_job: CranePush
docker_client_configRequired 
1
docker_client_config: DockerClientConfig

Creates the Docker configuration file base on objects settings, to authenticate against given registries.

do_dive_scanRequired 
1
do_dive_scan: bool
  • Type: bool

Set to false to skip the Dive scan job.

do_trivyignore_checkRequired 
1
do_trivyignore_check: bool
  • Type: bool

Set to false to skip the existance check of the .trivyignore file.

do_trivy_scanRequired 
1
do_trivy_scan: bool
  • Type: bool

Set to false to skip the Trivy scan job.

dst_registryRequired 
1
dst_registry: typing.Union[str, Registry]

Container registry to push the image to.

If the container registry needs authentication, you have to provide a DockerClientConfig object with credentials.

image_nameRequired 
1
image_name: str
  • Type: str

Image name with stage in the registry.

e.g. username/image_name.

image_tagRequired 
1
image_tag: str
  • Type: str

Container image tag to pull from srcRegistry and push to dstRegistry.

src_registryRequired 
1
src_registry: typing.Union[str, Registry]

Container registry to pull the image from.

If the container registry needs authentication, you have to provide a DockerClientConfig object with credentials.

dive_scan_jobOptional 
1
dive_scan_job: DiveScan

Dive scan job.

trivy_ignore_file_check_jobOptional 
1
trivy_ignore_file_check_job: TrivyIgnoreFileCheck

Trivy ignore file check job.

trivy_scan_local_image_jobOptional 
1
trivy_scan_local_image_job: TrivyScanLocalImage

Trivy scan local image job.

CraneCopy

Creates a job to copy container images with crane. See crane.

Copying an image is useful, if you want to have container images as close as possible to your cluster or servers.

This subclass of Job will configure following defaults for the superclass:

  • name: crane-copy
  • stage: deploy
  • image: PredefinedImages.CRANE

Initializers 

1
2
3
4
5
6
7
8
9
from gcix import container

container.CraneCopy(
  dst_registry: typing.Union[str, Registry],
  src_registry: typing.Union[str, Registry],
  docker_client_config: DockerClientConfig = None,
  job_name: str = None,
  job_stage: str = None
)
Name Type Description
dst_registry typing.Union[str, Registry] Registry URL to copy container image to.
src_registry typing.Union[str, Registry] Registry URL to copy container image from.
docker_client_config DockerClientConfig Creates the Docker configuration file base on objects settings, used by crane to authenticate against given registries.
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
dst_registryRequired

Registry URL to copy container image to.

src_registryRequired

Registry URL to copy container image from.

docker_client_configOptional

Creates the Docker configuration file base on objects settings, used by crane to authenticate against given registries.

job_nameOptional
  • Type: str

The name of the Bootstrap job.

job_stageOptional
  • Type: str

The stage of the Bootstrap job.

Methods

Name Description
add_dependencies No description.
add_needs No description.
add_parent This method is called by gcix.JobCollections when the job is added to that JobCollection.
add_tags No description.
add_variables No description.
append_rules No description.
append_scripts No description.
assign_allow_failure No description.
assign_artifacts No description.
assign_cache No description.
assign_dependencies No description.
assign_image Sets the image of this job.
assign_needs No description.
assign_tags No description.
copy Returns an independent, deep copy object of this job.
extend_name This method is used by gcix.JobCollections to populate the jobs name.
extend_stage This method is used by gcix.JobCollections to populate the jobs name and stage.
extend_stage_value This method is used by gcix.JobCollections to populate the jobs stage.
get_all_instance_names Return all instance names from the given child.
is_equal isEqual checks if this object is equal to given object.
prepend_rules No description.
prepend_scripts No description.
render Returns a representation of any object which implements IBase.
add_dependencies 
1
2
3
def add_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_needs 
1
2
3
def add_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_parent 
1
2
3
def add_parent(
  parent: typing.Union[Job, JobCollection]
) -> None

This method is called by gcix.JobCollections when the job is added to that JobCollection.

The job needs to know its parents when getAllInstanceNames() is called.

parentRequired
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
add_tags 
1
2
3
def add_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
add_variables 
1
2
3
def add_variables(
  variables: typing.Mapping[str]
) -> Job
variablesRequired
  • Type: typing.Mapping[str]
append_rules 
1
2
3
def append_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
append_scripts 
1
2
3
def append_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
assign_allow_failure 
1
2
3
def assign_allow_failure(
  allow_failure: typing.Union[bool, typing.List[typing.Union[int, float]]]
) -> Job
allow_failureRequired
  • Type: typing.Union[bool, typing.List[typing.Union[int, float]]]
assign_artifacts 
1
2
3
def assign_artifacts(
  artifacts: Artifacts
) -> Job
artifactsRequired
  • Type: gcix.Artifacts
assign_cache 
1
2
3
def assign_cache(
  cache: Cache
) -> Job
cacheRequired
  • Type: gcix.Cache
assign_dependencies 
1
2
3
def assign_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_image 
1
2
3
def assign_image(
  image: typing.Union[str, Image]
) -> Job

Sets the image of this job.

For a simple container image you can provide the origin of the image. If you want to set the entrypoint, you have to provide an Image object instead.

!! Any previous values will be overwritten.

imageRequired
  • Type: typing.Union[str, gcix.Image]
assign_needs 
1
2
3
def assign_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_tags 
1
2
3
def assign_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
copy 
1
def copy() -> Job

Returns an independent, deep copy object of this job.

extend_name 
1
2
3
def extend_name(
  name: str
) -> None

This method is used by gcix.JobCollections to populate the jobs name.

nameRequired
  • Type: str
extend_stage 
1
2
3
def extend_stage(
  stage: str
) -> None

This method is used by gcix.JobCollections to populate the jobs name and stage.

stageRequired
  • Type: str
extend_stage_value 
1
2
3
def extend_stage_value(
  stage: str
) -> None

This method is used by gcix.JobCollections to populate the jobs stage.

stageRequired
  • Type: str
get_all_instance_names 
1
2
3
def get_all_instance_names(
  child: typing.Union[Job, JobCollection] = None
) -> OrderedStringSet

Return all instance names from the given child.

That means all combinations of the childs name and stage within this sequence and all parent sequences.

childOptional
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
is_equal 
1
2
3
def is_equal(
  comparable: IBase
) -> bool

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: gcix.IBase
prepend_rules 
1
2
3
def prepend_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
prepend_scripts 
1
2
3
def prepend_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
render 
1
def render() -> typing.Any

Returns a representation of any object which implements IBase.

The rendered representation is used by the gcix to dump it in YAML format as part of the .gitlab-ci.yml pipeline.

Properties

Name Type Description
tags typing.List[str] Getter method to receive added tags.
allow_failure typing.Union[str, bool, typing.List[typing.Union[int, float]]] No description.
name str No description.
ordered_tags gcix.OrderedStringSet No description.
parents typing.List[typing.Union[gcix.Job, gcix.JobCollection]] No description.
scripts typing.List[str] No description.
stage str No description.
artifacts gcix.Artifacts No description.
cache gcix.Cache No description.
dependencies typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
image gcix.Image No description.
needs typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
original gcix.Job No description.
rules typing.List[gcix.Rule] No description.
variables typing.Mapping[str] No description.
dst_registry typing.Union[str, Registry] Registry URL to copy container image to.
src_registry typing.Union[str, Registry] Registry URL to copy container image from.
docker_client_config DockerClientConfig Creates the Docker configuration file base on objects settings, used by crane to authenticate against given registries.
tagsRequired 
1
tags: typing.List[str]
  • Type: typing.List[str]

Getter method to receive added tags.

allow_failureRequired 
1
allow_failure: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
  • Type: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
nameRequired 
1
name: str
  • Type: str
ordered_tagsRequired 
1
ordered_tags: OrderedStringSet
  • Type: gcix.OrderedStringSet
parentsRequired 
1
parents: typing.List[typing.Union[Job, JobCollection]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection]]
scriptsRequired 
1
scripts: typing.List[str]
  • Type: typing.List[str]
stageRequired 
1
stage: str
  • Type: str
artifactsOptional 
1
artifacts: Artifacts
  • Type: gcix.Artifacts
cacheOptional 
1
cache: Cache
  • Type: gcix.Cache
dependenciesOptional 
1
dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
imageOptional 
1
image: Image
  • Type: gcix.Image
needsOptional 
1
needs: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
originalOptional 
1
original: Job
  • Type: gcix.Job
rulesOptional 
1
rules: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
variablesOptional 
1
variables: typing.Mapping[str]
  • Type: typing.Mapping[str]
dst_registryRequired 
1
dst_registry: typing.Union[str, Registry]

Registry URL to copy container image to.

src_registryRequired 
1
src_registry: typing.Union[str, Registry]

Registry URL to copy container image from.

docker_client_configOptional 
1
docker_client_config: DockerClientConfig

Creates the Docker configuration file base on objects settings, used by crane to authenticate against given registries.

CranePull

Creates a job to pull container image from remote container registry with crane.

This subclass of Job will configure following defaults for the superclass:

  • name: crane
  • stage: pull
  • image: PredefinedImages.CRANE

Initializers 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from gcix import container

container.CranePull(
  src_registry: typing.Union[str, Registry],
  docker_client_config: DockerClientConfig = None,
  image_name: str = None,
  image_tag: str = None,
  job_name: str = None,
  job_stage: str = None,
  tar_path: str = None
)
Name Type Description
src_registry typing.Union[str, Registry] Registry URL to pull container image from.
docker_client_config DockerClientConfig Creates the Docker configuration file base on objects settings, to authenticate against given registries.
image_name str Container image with namespace to pull from srcRegistry.
image_tag str Tag of the image which will be pulled.
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
tar_path str Path where to save the container image tarball.
src_registryRequired

Registry URL to pull container image from.

docker_client_configOptional
  • Type: DockerClientConfig
  • Default: DockerClientConfig with login to the official Docker Hub and expecting credentials given as environment variables REGISTRY_USER and REGISTRY_LOGIN.

Creates the Docker configuration file base on objects settings, to authenticate against given registries.

image_nameOptional
  • Type: str
  • Default: PredefinedVariables.ciProjectName

Container image with namespace to pull from srcRegistry.

image_tagOptional
  • Type: str
  • Default: latest

Tag of the image which will be pulled.

job_nameOptional
  • Type: str

The name of the Bootstrap job.

job_stageOptional
  • Type: str

The stage of the Bootstrap job.

tar_pathOptional
  • Type: str
  • Default: PredefinedVariables.ciProjectDir

Path where to save the container image tarball.

Methods

Name Description
add_dependencies No description.
add_needs No description.
add_parent This method is called by gcix.JobCollections when the job is added to that JobCollection.
add_tags No description.
add_variables No description.
append_rules No description.
append_scripts No description.
assign_allow_failure No description.
assign_artifacts No description.
assign_cache No description.
assign_dependencies No description.
assign_image Sets the image of this job.
assign_needs No description.
assign_tags No description.
copy Returns an independent, deep copy object of this job.
extend_name This method is used by gcix.JobCollections to populate the jobs name.
extend_stage This method is used by gcix.JobCollections to populate the jobs name and stage.
extend_stage_value This method is used by gcix.JobCollections to populate the jobs stage.
get_all_instance_names Return all instance names from the given child.
is_equal isEqual checks if this object is equal to given object.
prepend_rules No description.
prepend_scripts No description.
render Returns a representation of any object which implements IBase.
add_dependencies 
1
2
3
def add_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_needs 
1
2
3
def add_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_parent 
1
2
3
def add_parent(
  parent: typing.Union[Job, JobCollection]
) -> None

This method is called by gcix.JobCollections when the job is added to that JobCollection.

The job needs to know its parents when getAllInstanceNames() is called.

parentRequired
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
add_tags 
1
2
3
def add_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
add_variables 
1
2
3
def add_variables(
  variables: typing.Mapping[str]
) -> Job
variablesRequired
  • Type: typing.Mapping[str]
append_rules 
1
2
3
def append_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
append_scripts 
1
2
3
def append_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
assign_allow_failure 
1
2
3
def assign_allow_failure(
  allow_failure: typing.Union[bool, typing.List[typing.Union[int, float]]]
) -> Job
allow_failureRequired
  • Type: typing.Union[bool, typing.List[typing.Union[int, float]]]
assign_artifacts 
1
2
3
def assign_artifacts(
  artifacts: Artifacts
) -> Job
artifactsRequired
  • Type: gcix.Artifacts
assign_cache 
1
2
3
def assign_cache(
  cache: Cache
) -> Job
cacheRequired
  • Type: gcix.Cache
assign_dependencies 
1
2
3
def assign_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_image 
1
2
3
def assign_image(
  image: typing.Union[str, Image]
) -> Job

Sets the image of this job.

For a simple container image you can provide the origin of the image. If you want to set the entrypoint, you have to provide an Image object instead.

!! Any previous values will be overwritten.

imageRequired
  • Type: typing.Union[str, gcix.Image]
assign_needs 
1
2
3
def assign_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_tags 
1
2
3
def assign_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
copy 
1
def copy() -> Job

Returns an independent, deep copy object of this job.

extend_name 
1
2
3
def extend_name(
  name: str
) -> None

This method is used by gcix.JobCollections to populate the jobs name.

nameRequired
  • Type: str
extend_stage 
1
2
3
def extend_stage(
  stage: str
) -> None

This method is used by gcix.JobCollections to populate the jobs name and stage.

stageRequired
  • Type: str
extend_stage_value 
1
2
3
def extend_stage_value(
  stage: str
) -> None

This method is used by gcix.JobCollections to populate the jobs stage.

stageRequired
  • Type: str
get_all_instance_names 
1
2
3
def get_all_instance_names(
  child: typing.Union[Job, JobCollection] = None
) -> OrderedStringSet

Return all instance names from the given child.

That means all combinations of the childs name and stage within this sequence and all parent sequences.

childOptional
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
is_equal 
1
2
3
def is_equal(
  comparable: IBase
) -> bool

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: gcix.IBase
prepend_rules 
1
2
3
def prepend_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
prepend_scripts 
1
2
3
def prepend_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
render 
1
def render() -> typing.Any

Returns a representation of any object which implements IBase.

The rendered representation is used by the gcix to dump it in YAML format as part of the .gitlab-ci.yml pipeline.

Properties

Name Type Description
tags typing.List[str] Getter method to receive added tags.
allow_failure typing.Union[str, bool, typing.List[typing.Union[int, float]]] No description.
name str No description.
ordered_tags gcix.OrderedStringSet No description.
parents typing.List[typing.Union[gcix.Job, gcix.JobCollection]] No description.
scripts typing.List[str] No description.
stage str No description.
artifacts gcix.Artifacts No description.
cache gcix.Cache No description.
dependencies typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
image gcix.Image No description.
needs typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
original gcix.Job No description.
rules typing.List[gcix.Rule] No description.
variables typing.Mapping[str] No description.
docker_client_config DockerClientConfig Creates the Docker configuration file base on objects settings, to authenticate against given registries.
image_name str Container image with namespace to pull from srcRegistry.
image_tag str Tag of the image which will be pulled.
src_registry typing.Union[str, Registry] Registry URL to pull container image from.
tar_path str Path where to save the container image tarball.
tagsRequired 
1
tags: typing.List[str]
  • Type: typing.List[str]

Getter method to receive added tags.

allow_failureRequired 
1
allow_failure: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
  • Type: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
nameRequired 
1
name: str
  • Type: str
ordered_tagsRequired 
1
ordered_tags: OrderedStringSet
  • Type: gcix.OrderedStringSet
parentsRequired 
1
parents: typing.List[typing.Union[Job, JobCollection]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection]]
scriptsRequired 
1
scripts: typing.List[str]
  • Type: typing.List[str]
stageRequired 
1
stage: str
  • Type: str
artifactsOptional 
1
artifacts: Artifacts
  • Type: gcix.Artifacts
cacheOptional 
1
cache: Cache
  • Type: gcix.Cache
dependenciesOptional 
1
dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
imageOptional 
1
image: Image
  • Type: gcix.Image
needsOptional 
1
needs: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
originalOptional 
1
original: Job
  • Type: gcix.Job
rulesOptional 
1
rules: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
variablesOptional 
1
variables: typing.Mapping[str]
  • Type: typing.Mapping[str]
docker_client_configRequired 
1
docker_client_config: DockerClientConfig

Creates the Docker configuration file base on objects settings, to authenticate against given registries.

image_nameRequired 
1
image_name: str
  • Type: str

Container image with namespace to pull from srcRegistry.

image_tagRequired 
1
image_tag: str
  • Type: str

Tag of the image which will be pulled.

src_registryRequired 
1
src_registry: typing.Union[str, Registry]

Registry URL to pull container image from.

tar_pathRequired 
1
tar_path: str
  • Type: str

Path where to save the container image tarball.

CranePush

Creates a job to push container image to remote container registry with crane.

The image to copy must be in a tarball format. It gets validated with crane and is pushed to dst_registry destination registry.

This subclass of Job will configure following defaults for the superclass:

  • name: crane-push
  • stage: deploy
  • image: PredefinedImages.CRANE

Initializers 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from gcix import container

container.CranePush(
  dst_registry: typing.Union[str, Registry],
  docker_client_config: DockerClientConfig = None,
  image_name: str = None,
  image_tag: str = None,
  job_name: str = None,
  job_stage: str = None,
  tar_path: str = None
)
Name Type Description
dst_registry typing.Union[str, Registry] Registry URL to copy container image to.
docker_client_config DockerClientConfig Creates the Docker configuration file base on objects settings, to authenticate against given registries.
image_name str Container image name, searched for in imagePath and gets .tar appended.
image_tag str The tag the image will be tagged with.
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
tar_path str Path where to find the container image tarball.
dst_registryRequired

Registry URL to copy container image to.

docker_client_configOptional

Creates the Docker configuration file base on objects settings, to authenticate against given registries.

Defaults to a DockerClientConfig with login to the official Docker Hub and expecting credentials given as environment variables REGISTRY_USER and REGISTRY_LOGIN.

image_nameOptional
  • Type: str
  • Default: PredefinedVariables.ciProjectName

Container image name, searched for in imagePath and gets .tar appended.

image_tagOptional
  • Type: str
  • Default: PredefinedVariables.ciCommitTag

The tag the image will be tagged with.

job_nameOptional
  • Type: str

The name of the Bootstrap job.

job_stageOptional
  • Type: str

The stage of the Bootstrap job.

tar_pathOptional
  • Type: str
  • Default: PredefinedVariables.ciProjectDir

Path where to find the container image tarball.

Methods

Name Description
add_dependencies No description.
add_needs No description.
add_parent This method is called by gcix.JobCollections when the job is added to that JobCollection.
add_tags No description.
add_variables No description.
append_rules No description.
append_scripts No description.
assign_allow_failure No description.
assign_artifacts No description.
assign_cache No description.
assign_dependencies No description.
assign_image Sets the image of this job.
assign_needs No description.
assign_tags No description.
copy Returns an independent, deep copy object of this job.
extend_name This method is used by gcix.JobCollections to populate the jobs name.
extend_stage This method is used by gcix.JobCollections to populate the jobs name and stage.
extend_stage_value This method is used by gcix.JobCollections to populate the jobs stage.
get_all_instance_names Return all instance names from the given child.
is_equal isEqual checks if this object is equal to given object.
prepend_rules No description.
prepend_scripts No description.
render Returns a representation of any object which implements IBase.
add_dependencies 
1
2
3
def add_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_needs 
1
2
3
def add_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_parent 
1
2
3
def add_parent(
  parent: typing.Union[Job, JobCollection]
) -> None

This method is called by gcix.JobCollections when the job is added to that JobCollection.

The job needs to know its parents when getAllInstanceNames() is called.

parentRequired
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
add_tags 
1
2
3
def add_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
add_variables 
1
2
3
def add_variables(
  variables: typing.Mapping[str]
) -> Job
variablesRequired
  • Type: typing.Mapping[str]
append_rules 
1
2
3
def append_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
append_scripts 
1
2
3
def append_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
assign_allow_failure 
1
2
3
def assign_allow_failure(
  allow_failure: typing.Union[bool, typing.List[typing.Union[int, float]]]
) -> Job
allow_failureRequired
  • Type: typing.Union[bool, typing.List[typing.Union[int, float]]]
assign_artifacts 
1
2
3
def assign_artifacts(
  artifacts: Artifacts
) -> Job
artifactsRequired
  • Type: gcix.Artifacts
assign_cache 
1
2
3
def assign_cache(
  cache: Cache
) -> Job
cacheRequired
  • Type: gcix.Cache
assign_dependencies 
1
2
3
def assign_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_image 
1
2
3
def assign_image(
  image: typing.Union[str, Image]
) -> Job

Sets the image of this job.

For a simple container image you can provide the origin of the image. If you want to set the entrypoint, you have to provide an Image object instead.

!! Any previous values will be overwritten.

imageRequired
  • Type: typing.Union[str, gcix.Image]
assign_needs 
1
2
3
def assign_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_tags 
1
2
3
def assign_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
copy 
1
def copy() -> Job

Returns an independent, deep copy object of this job.

extend_name 
1
2
3
def extend_name(
  name: str
) -> None

This method is used by gcix.JobCollections to populate the jobs name.

nameRequired
  • Type: str
extend_stage 
1
2
3
def extend_stage(
  stage: str
) -> None

This method is used by gcix.JobCollections to populate the jobs name and stage.

stageRequired
  • Type: str
extend_stage_value 
1
2
3
def extend_stage_value(
  stage: str
) -> None

This method is used by gcix.JobCollections to populate the jobs stage.

stageRequired
  • Type: str
get_all_instance_names 
1
2
3
def get_all_instance_names(
  child: typing.Union[Job, JobCollection] = None
) -> OrderedStringSet

Return all instance names from the given child.

That means all combinations of the childs name and stage within this sequence and all parent sequences.

childOptional
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
is_equal 
1
2
3
def is_equal(
  comparable: IBase
) -> bool

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: gcix.IBase
prepend_rules 
1
2
3
def prepend_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
prepend_scripts 
1
2
3
def prepend_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
render 
1
def render() -> typing.Any

Returns a representation of any object which implements IBase.

The rendered representation is used by the gcix to dump it in YAML format as part of the .gitlab-ci.yml pipeline.

Properties

Name Type Description
tags typing.List[str] Getter method to receive added tags.
allow_failure typing.Union[str, bool, typing.List[typing.Union[int, float]]] No description.
name str No description.
ordered_tags gcix.OrderedStringSet No description.
parents typing.List[typing.Union[gcix.Job, gcix.JobCollection]] No description.
scripts typing.List[str] No description.
stage str No description.
artifacts gcix.Artifacts No description.
cache gcix.Cache No description.
dependencies typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
image gcix.Image No description.
needs typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
original gcix.Job No description.
rules typing.List[gcix.Rule] No description.
variables typing.Mapping[str] No description.
docker_client_config DockerClientConfig Creates the Docker configuration file base on objects settings, to authenticate against given registries.
dst_registry typing.Union[str, Registry] Registry URL to copy container image to.
image_name str Container image name, searched for in imagePath and gets .tar appended.
image_tag str The tag the image will be tagged with.
tar_path str Path where to find the container image tarball.
tagsRequired 
1
tags: typing.List[str]
  • Type: typing.List[str]

Getter method to receive added tags.

allow_failureRequired 
1
allow_failure: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
  • Type: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
nameRequired 
1
name: str
  • Type: str
ordered_tagsRequired 
1
ordered_tags: OrderedStringSet
  • Type: gcix.OrderedStringSet
parentsRequired 
1
parents: typing.List[typing.Union[Job, JobCollection]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection]]
scriptsRequired 
1
scripts: typing.List[str]
  • Type: typing.List[str]
stageRequired 
1
stage: str
  • Type: str
artifactsOptional 
1
artifacts: Artifacts
  • Type: gcix.Artifacts
cacheOptional 
1
cache: Cache
  • Type: gcix.Cache
dependenciesOptional 
1
dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
imageOptional 
1
image: Image
  • Type: gcix.Image
needsOptional 
1
needs: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
originalOptional 
1
original: Job
  • Type: gcix.Job
rulesOptional 
1
rules: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
variablesOptional 
1
variables: typing.Mapping[str]
  • Type: typing.Mapping[str]
docker_client_configRequired 
1
docker_client_config: DockerClientConfig

Creates the Docker configuration file base on objects settings, to authenticate against given registries.

Defaults to a DockerClientConfig with login to the official Docker Hub and expecting credentials given as environment variables REGISTRY_USER and REGISTRY_LOGIN.

dst_registryRequired 
1
dst_registry: typing.Union[str, Registry]

Registry URL to copy container image to.

image_nameRequired 
1
image_name: str
  • Type: str

Container image name, searched for in imagePath and gets .tar appended.

image_tagRequired 
1
image_tag: str
  • Type: str

The tag the image will be tagged with.

tar_pathRequired 
1
tar_path: str
  • Type: str

Path where to find the container image tarball.

DiveScan

Scan your images with wagoodman/dive.

dive will scan your container image layers and will output the efficency of each layer. You can see which layer and which file is consuming the most storage and optimize the layers if possible. It prevents container images and its layers beeing polluted with files like apt or yum cache's. The output produced by dive is uploaded as an artifact to the GitLab instance.

This subclass of Job will configure following defaults for the superclass:

  • name: dive
  • stage: check
  • image: PredefinedImages.DIVE
  • artifacts: Path 'dive.txt'

Initializers 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from gcix import container

container.DiveScan(
  highest_user_wasted_percent: typing.Union[int, float] = None,
  highest_wasted_bytes: typing.Union[int, float] = None,
  ignore_errors: bool = None,
  image_name: str = None,
  image_path: str = None,
  job_name: str = None,
  job_stage: str = None,
  lowest_efficiency: typing.Union[int, float] = None,
  source: str = None
)
Name Type Description
highest_user_wasted_percent typing.Union[int, float] Highest allowable percentage of bytes wasted (as a ratio between 0-1), otherwise CI validation will fail.
highest_wasted_bytes typing.Union[int, float] Highest allowable bytes wasted, otherwise CI validation will fail.
ignore_errors bool Ignore image parsing errors and run the analysis anyway.
image_name str Name of the container image to scan, if source is docker-archive argument gets prefix .tar.
image_path str Path to the image can be either a remote container registry, as well as a local path to an image.
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
lowest_efficiency typing.Union[int, float] Lowest allowable image efficiency (as a ratio between 0-1), otherwise CI validation will fail.
source str The container engine to fetch the image from.
highest_user_wasted_percentOptional
  • Type: typing.Union[int, float]
  • Default: 0.1

Highest allowable percentage of bytes wasted (as a ratio between 0-1), otherwise CI validation will fail.

highest_wasted_bytesOptional
  • Type: typing.Union[int, float]

Highest allowable bytes wasted, otherwise CI validation will fail.

ignore_errorsOptional
  • Type: bool
  • Default: false

Ignore image parsing errors and run the analysis anyway.

image_nameOptional
  • Type: str
  • Default: PredefinedVariables.ciProjectName

Name of the container image to scan, if source is docker-archive argument gets prefix .tar.

image_pathOptional
  • Type: str
  • Default: PredefinedVariables.ciProjectPath

Path to the image can be either a remote container registry, as well as a local path to an image.

job_nameOptional
  • Type: str

The name of the Bootstrap job.

job_stageOptional
  • Type: str

The stage of the Bootstrap job.

lowest_efficiencyOptional
  • Type: typing.Union[int, float]
  • Default: 0.9

Lowest allowable image efficiency (as a ratio between 0-1), otherwise CI validation will fail.

sourceOptional
  • Type: str
  • Default: "docker-archive

The container engine to fetch the image from.

Allowed values: docker, podman, docker-archive

Methods

Name Description
add_dependencies No description.
add_needs No description.
add_parent This method is called by gcix.JobCollections when the job is added to that JobCollection.
add_tags No description.
add_variables No description.
append_rules No description.
append_scripts No description.
assign_allow_failure No description.
assign_artifacts No description.
assign_cache No description.
assign_dependencies No description.
assign_image Sets the image of this job.
assign_needs No description.
assign_tags No description.
copy Returns an independent, deep copy object of this job.
extend_name This method is used by gcix.JobCollections to populate the jobs name.
extend_stage This method is used by gcix.JobCollections to populate the jobs name and stage.
extend_stage_value This method is used by gcix.JobCollections to populate the jobs stage.
get_all_instance_names Return all instance names from the given child.
is_equal isEqual checks if this object is equal to given object.
prepend_rules No description.
prepend_scripts No description.
render Returns a representation of any object which implements IBase.
add_dependencies 
1
2
3
def add_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_needs 
1
2
3
def add_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_parent 
1
2
3
def add_parent(
  parent: typing.Union[Job, JobCollection]
) -> None

This method is called by gcix.JobCollections when the job is added to that JobCollection.

The job needs to know its parents when getAllInstanceNames() is called.

parentRequired
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
add_tags 
1
2
3
def add_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
add_variables 
1
2
3
def add_variables(
  variables: typing.Mapping[str]
) -> Job
variablesRequired
  • Type: typing.Mapping[str]
append_rules 
1
2
3
def append_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
append_scripts 
1
2
3
def append_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
assign_allow_failure 
1
2
3
def assign_allow_failure(
  allow_failure: typing.Union[bool, typing.List[typing.Union[int, float]]]
) -> Job
allow_failureRequired
  • Type: typing.Union[bool, typing.List[typing.Union[int, float]]]
assign_artifacts 
1
2
3
def assign_artifacts(
  artifacts: Artifacts
) -> Job
artifactsRequired
  • Type: gcix.Artifacts
assign_cache 
1
2
3
def assign_cache(
  cache: Cache
) -> Job
cacheRequired
  • Type: gcix.Cache
assign_dependencies 
1
2
3
def assign_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_image 
1
2
3
def assign_image(
  image: typing.Union[str, Image]
) -> Job

Sets the image of this job.

For a simple container image you can provide the origin of the image. If you want to set the entrypoint, you have to provide an Image object instead.

!! Any previous values will be overwritten.

imageRequired
  • Type: typing.Union[str, gcix.Image]
assign_needs 
1
2
3
def assign_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_tags 
1
2
3
def assign_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
copy 
1
def copy() -> Job

Returns an independent, deep copy object of this job.

extend_name 
1
2
3
def extend_name(
  name: str
) -> None

This method is used by gcix.JobCollections to populate the jobs name.

nameRequired
  • Type: str
extend_stage 
1
2
3
def extend_stage(
  stage: str
) -> None

This method is used by gcix.JobCollections to populate the jobs name and stage.

stageRequired
  • Type: str
extend_stage_value 
1
2
3
def extend_stage_value(
  stage: str
) -> None

This method is used by gcix.JobCollections to populate the jobs stage.

stageRequired
  • Type: str
get_all_instance_names 
1
2
3
def get_all_instance_names(
  child: typing.Union[Job, JobCollection] = None
) -> OrderedStringSet

Return all instance names from the given child.

That means all combinations of the childs name and stage within this sequence and all parent sequences.

childOptional
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
is_equal 
1
2
3
def is_equal(
  comparable: IBase
) -> bool

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: gcix.IBase
prepend_rules 
1
2
3
def prepend_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
prepend_scripts 
1
2
3
def prepend_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
render 
1
def render() -> typing.Any

Returns a representation of any object which implements IBase.

The rendered representation is used by the gcix to dump it in YAML format as part of the .gitlab-ci.yml pipeline.

Properties

Name Type Description
tags typing.List[str] Getter method to receive added tags.
allow_failure typing.Union[str, bool, typing.List[typing.Union[int, float]]] No description.
name str No description.
ordered_tags gcix.OrderedStringSet No description.
parents typing.List[typing.Union[gcix.Job, gcix.JobCollection]] No description.
scripts typing.List[str] No description.
stage str No description.
artifacts gcix.Artifacts No description.
cache gcix.Cache No description.
dependencies typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
image gcix.Image No description.
needs typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
original gcix.Job No description.
rules typing.List[gcix.Rule] No description.
variables typing.Mapping[str] No description.
highest_user_wasted_percent typing.Union[int, float] Highest allowable percentage of bytes wasted (as a ratio between 0-1), otherwise CI validation will fail.
ignore_errors bool Ignore image parsing errors and run the analysis anyway.
image_name str Name of the container image to scan, if source is docker-archive argument gets prefix .tar.
image_path str Path to the image can be either a remote container registry, as well as a local path to an image.
lowest_efficiency typing.Union[int, float] Lowest allowable image efficiency (as a ratio between 0-1), otherwise CI validation will fail.
source str The container engine to fetch the image from.
highest_wasted_bytes typing.Union[int, float] Highest allowable bytes wasted, otherwise CI validation will fail.
tagsRequired 
1
tags: typing.List[str]
  • Type: typing.List[str]

Getter method to receive added tags.

allow_failureRequired 
1
allow_failure: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
  • Type: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
nameRequired 
1
name: str
  • Type: str
ordered_tagsRequired 
1
ordered_tags: OrderedStringSet
  • Type: gcix.OrderedStringSet
parentsRequired 
1
parents: typing.List[typing.Union[Job, JobCollection]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection]]
scriptsRequired 
1
scripts: typing.List[str]
  • Type: typing.List[str]
stageRequired 
1
stage: str
  • Type: str
artifactsOptional 
1
artifacts: Artifacts
  • Type: gcix.Artifacts
cacheOptional 
1
cache: Cache
  • Type: gcix.Cache
dependenciesOptional 
1
dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
imageOptional 
1
image: Image
  • Type: gcix.Image
needsOptional 
1
needs: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
originalOptional 
1
original: Job
  • Type: gcix.Job
rulesOptional 
1
rules: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
variablesOptional 
1
variables: typing.Mapping[str]
  • Type: typing.Mapping[str]
highest_user_wasted_percentRequired 
1
highest_user_wasted_percent: typing.Union[int, float]
  • Type: typing.Union[int, float]

Highest allowable percentage of bytes wasted (as a ratio between 0-1), otherwise CI validation will fail.

ignore_errorsRequired 
1
ignore_errors: bool
  • Type: bool

Ignore image parsing errors and run the analysis anyway.

image_nameRequired 
1
image_name: str
  • Type: str

Name of the container image to scan, if source is docker-archive argument gets prefix .tar.

image_pathRequired 
1
image_path: str
  • Type: str

Path to the image can be either a remote container registry, as well as a local path to an image.

lowest_efficiencyRequired 
1
lowest_efficiency: typing.Union[int, float]
  • Type: typing.Union[int, float]

Lowest allowable image efficiency (as a ratio between 0-1), otherwise CI validation will fail.

sourceRequired 
1
source: str
  • Type: str

The container engine to fetch the image from.

Allowed values: docker, podman, docker-archive

highest_wasted_bytesOptional 
1
highest_wasted_bytes: typing.Union[int, float]
  • Type: typing.Union[int, float]

Highest allowable bytes wasted, otherwise CI validation will fail.

DockerBuild

Runs docker build.

Example:

1
2
import { Build } from "@gcix/gcix"
const buildJob = Build({repository: "myrepo/myimage", tag: "v0.1.0"})

This subclass of Job will configure following defaults for the superclass:

  • name: docker
  • stage: build

Initializers 

1
2
3
4
5
6
7
8
9
from gcix import container

container.DockerBuild(
  repository: str,
  context: str = None,
  job_name: str = None,
  job_stage: str = None,
  tag: str = None
)
Name Type Description
repository str The Docker repository name ([<registry>/]<image>).
context str The Docker build context (the directory containing the Dockerfile).
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
tag str A Docker image tag applied to the image.
repositoryRequired
  • Type: str

The Docker repository name ([<registry>/]<image>).

contextOptional
  • Type: str
  • Default: .

The Docker build context (the directory containing the Dockerfile).

job_nameOptional
  • Type: str

The name of the Bootstrap job.

job_stageOptional
  • Type: str

The stage of the Bootstrap job.

tagOptional
  • Type: str

A Docker image tag applied to the image.

If not set docker uses latest

Methods

Name Description
add_dependencies No description.
add_needs No description.
add_parent This method is called by gcix.JobCollections when the job is added to that JobCollection.
add_tags No description.
add_variables No description.
append_rules No description.
append_scripts No description.
assign_allow_failure No description.
assign_artifacts No description.
assign_cache No description.
assign_dependencies No description.
assign_image Sets the image of this job.
assign_needs No description.
assign_tags No description.
copy Returns an independent, deep copy object of this job.
extend_name This method is used by gcix.JobCollections to populate the jobs name.
extend_stage This method is used by gcix.JobCollections to populate the jobs name and stage.
extend_stage_value This method is used by gcix.JobCollections to populate the jobs stage.
get_all_instance_names Return all instance names from the given child.
is_equal isEqual checks if this object is equal to given object.
prepend_rules No description.
prepend_scripts No description.
render Returns a representation of any object which implements IBase.
add_dependencies 
1
2
3
def add_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_needs 
1
2
3
def add_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_parent 
1
2
3
def add_parent(
  parent: typing.Union[Job, JobCollection]
) -> None

This method is called by gcix.JobCollections when the job is added to that JobCollection.

The job needs to know its parents when getAllInstanceNames() is called.

parentRequired
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
add_tags 
1
2
3
def add_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
add_variables 
1
2
3
def add_variables(
  variables: typing.Mapping[str]
) -> Job
variablesRequired
  • Type: typing.Mapping[str]
append_rules 
1
2
3
def append_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
append_scripts 
1
2
3
def append_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
assign_allow_failure 
1
2
3
def assign_allow_failure(
  allow_failure: typing.Union[bool, typing.List[typing.Union[int, float]]]
) -> Job
allow_failureRequired
  • Type: typing.Union[bool, typing.List[typing.Union[int, float]]]
assign_artifacts 
1
2
3
def assign_artifacts(
  artifacts: Artifacts
) -> Job
artifactsRequired
  • Type: gcix.Artifacts
assign_cache 
1
2
3
def assign_cache(
  cache: Cache
) -> Job
cacheRequired
  • Type: gcix.Cache
assign_dependencies 
1
2
3
def assign_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_image 
1
2
3
def assign_image(
  image: typing.Union[str, Image]
) -> Job

Sets the image of this job.

For a simple container image you can provide the origin of the image. If you want to set the entrypoint, you have to provide an Image object instead.

!! Any previous values will be overwritten.

imageRequired
  • Type: typing.Union[str, gcix.Image]
assign_needs 
1
2
3
def assign_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_tags 
1
2
3
def assign_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
copy 
1
def copy() -> Job

Returns an independent, deep copy object of this job.

extend_name 
1
2
3
def extend_name(
  name: str
) -> None

This method is used by gcix.JobCollections to populate the jobs name.

nameRequired
  • Type: str
extend_stage 
1
2
3
def extend_stage(
  stage: str
) -> None

This method is used by gcix.JobCollections to populate the jobs name and stage.

stageRequired
  • Type: str
extend_stage_value 
1
2
3
def extend_stage_value(
  stage: str
) -> None

This method is used by gcix.JobCollections to populate the jobs stage.

stageRequired
  • Type: str
get_all_instance_names 
1
2
3
def get_all_instance_names(
  child: typing.Union[Job, JobCollection] = None
) -> OrderedStringSet

Return all instance names from the given child.

That means all combinations of the childs name and stage within this sequence and all parent sequences.

childOptional
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
is_equal 
1
2
3
def is_equal(
  comparable: IBase
) -> bool

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: gcix.IBase
prepend_rules 
1
2
3
def prepend_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
prepend_scripts 
1
2
3
def prepend_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
render 
1
def render() -> typing.Any

Returns a representation of any object which implements IBase.

The rendered representation is used by the gcix to dump it in YAML format as part of the .gitlab-ci.yml pipeline.

Properties

Name Type Description
tags typing.List[str] Getter method to receive added tags.
allow_failure typing.Union[str, bool, typing.List[typing.Union[int, float]]] No description.
name str No description.
ordered_tags gcix.OrderedStringSet No description.
parents typing.List[typing.Union[gcix.Job, gcix.JobCollection]] No description.
scripts typing.List[str] No description.
stage str No description.
artifacts gcix.Artifacts No description.
cache gcix.Cache No description.
dependencies typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
image gcix.Image No description.
needs typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
original gcix.Job No description.
rules typing.List[gcix.Rule] No description.
variables typing.Mapping[str] No description.
context str The Docker build context (the directory containing the Dockerfile).
repository str The Docker repository name ([<registry>/]<image>).
tag str A Docker image tag applied to the image.
tagsRequired 
1
tags: typing.List[str]
  • Type: typing.List[str]

Getter method to receive added tags.

allow_failureRequired 
1
allow_failure: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
  • Type: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
nameRequired 
1
name: str
  • Type: str
ordered_tagsRequired 
1
ordered_tags: OrderedStringSet
  • Type: gcix.OrderedStringSet
parentsRequired 
1
parents: typing.List[typing.Union[Job, JobCollection]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection]]
scriptsRequired 
1
scripts: typing.List[str]
  • Type: typing.List[str]
stageRequired 
1
stage: str
  • Type: str
artifactsOptional 
1
artifacts: Artifacts
  • Type: gcix.Artifacts
cacheOptional 
1
cache: Cache
  • Type: gcix.Cache
dependenciesOptional 
1
dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
imageOptional 
1
image: Image
  • Type: gcix.Image
needsOptional 
1
needs: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
originalOptional 
1
original: Job
  • Type: gcix.Job
rulesOptional 
1
rules: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
variablesOptional 
1
variables: typing.Mapping[str]
  • Type: typing.Mapping[str]
contextRequired 
1
context: str
  • Type: str

The Docker build context (the directory containing the Dockerfile).

repositoryRequired 
1
repository: str
  • Type: str

The Docker repository name ([<registry>/]<image>).

tagRequired 
1
tag: str
  • Type: str

A Docker image tag applied to the image.

DockerClientConfig

Class which represents a docker client configuration.

After creating an instance of this class you can add new credential helper, basic authentication settings or default credential store.

Initializers 

1
2
3
4
5
from gcix import container

container.DockerClientConfig(
  config_file_path: str = None
)
Name Type Description
config_file_path str Docker client config path.
config_file_pathOptional
  • Type: str
  • Default: $HOME/.docker/config.json

Docker client config path.

Methods

Name Description
add_auth Adds basic authentication auths setting to the configuration.
add_cred_helper Adds a Credentials helper credHelpers for a registry.
add_raw Adds arbitrary settings to configuration.
assign_creds_store Sets the credsStore setting for clients. See docker login#credentials-store.
shell_command Renders the shell command for creating the docker client config.
add_auth 
1
2
3
4
5
def add_auth(
  registry: str,
  username_env_var: str = None,
  password_env_var: str = None
) -> DockerClientConfig

Adds basic authentication auths setting to the configuration.

This method acts a little special, because of some security aspects. The method, takse three arguments, registry, username_env_var and password_env_var. Arguments ending wit *_env_var, are ment to be available as a gcip.Job variable.

registryRequired
  • Type: str

Name of the container registry to set creds_helper for.

username_env_varOptional
  • Type: str

Name of the environment variable which as the registry username stored.

password_env_varOptional
  • Type: str

Name of the environment variable which as the registry password stored.

add_cred_helper 
1
2
3
4
def add_cred_helper(
  registry: str,
  cred_helper: str
) -> DockerClientConfig

Adds a Credentials helper credHelpers for a registry.

See docker login#credential-helpers

registryRequired
  • Type: str

Name of the container registry to set creds_helper for.

cred_helperRequired
  • Type: str

Name of the credential helper to use together with the registry.

add_raw 
1
2
3
def add_raw(
  raw_input: typing.Mapping[typing.Any]
) -> DockerClientConfig

Adds arbitrary settings to configuration.

Be aware and warned! You can overwrite any predefined settings with this method. This method is intendet to be used, if non suitable method is available and you have to set a configuration setting.

raw_inputRequired
  • Type: typing.Mapping[typing.Any]

Dictionary of non-available settings to be set.

assign_creds_store 
1
2
3
def assign_creds_store(
  creds_store: str
) -> DockerClientConfig

Sets the credsStore setting for clients. See docker login#credentials-store.

Be aware, that if you set the credsStore and add creds_helper or username and password authentication, those authentication methods are not used.

Clients which can authenticate against a registry can handle the credential store itself, mostly you do not want to set the credsStore. Use credsHelpers instead.

creds_storeRequired
  • Type: str

Should be the suffix of the program to use (i.e. everything after docker-credential-). osxkeychain, to use docker-credential-osxkeychain or ecr-login, to use docker-crendential-ecr-login.

shell_command 
1
def shell_command() -> typing.List[str]

Renders the shell command for creating the docker client config.

The render method uses json.dumps() to dump the configuration as a json string and escapes it for the shell. In Jobs which needed the configuration the rendered output should be redirected to the appropriate destination e.g. ~/.docker/config.json. This ensures, that environment variables are substituted.

Properties

Name Type Description
config IDockerClientConfigType Docker client configuration.
config_file_path str Docker client config path.
configRequired 
1
config: IDockerClientConfigType

Docker client configuration.

config_file_pathRequired 
1
config_file_path: str
  • Type: str

Docker client config path.

DockerPush

Runs docker push and optionally docker login before.

Example:

1
2
3
4
5
6
7
8
9
import { Push } from "@gcix/gcix"

const pushJob = new Push({
                registry: "index.docker.io/v1/gcix/gcix",
                image: "gcip",
                tag: "v0.1.0",
                userEnvVar: "DOCKER_USER",
                loginEnvVar: "DOCKER_TOKEN"
            })

The userEnvVar and loginEnvVar should be created as protected and masked custom environment variable configured in the UI.

This subclass of Job will configure following defaults for the superclass:

  • name: docker
  • stage: deploy

Initializers 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from gcix import container

container.DockerPush(
  container_image: str,
  job_name: str = None,
  job_stage: str = None,
  login_env_var: str = None,
  registry: str = None,
  tag: str = None,
  user_env_var: str = None
)
Name Type Description
container_image str The name of the Docker image to push to the registry.
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
login_env_var str If you have to login to the registry before the push, you have to provide the name of the environment variable, which contains the password or token, here.
registry str The Docker registry the image should be pushed to.
tag str The Docker image tag that should be pushed to the registry.
user_env_var str If you have to login to the registry before the push, you have to provide the name of the environment variable, which contains the username value, here.
container_imageRequired
  • Type: str

The name of the Docker image to push to the registry.

job_nameOptional
  • Type: str

The name of the Bootstrap job.

job_stageOptional
  • Type: str

The stage of the Bootstrap job.

login_env_varOptional
  • Type: str

If you have to login to the registry before the push, you have to provide the name of the environment variable, which contains the password or token, here.

DO NOT PROVIDE THE LOGIN VALUE ITSELF! This would be a security issue!

registryOptional
  • Type: str
  • Default: index.docker.io/v1

The Docker registry the image should be pushed to.

tagOptional
  • Type: str
  • Default: latest

The Docker image tag that should be pushed to the registry.

user_env_varOptional
  • Type: str

If you have to login to the registry before the push, you have to provide the name of the environment variable, which contains the username value, here.

DO NOT PROVIDE THE USERNAME VALUE ITSELF! This would be a security issue!

Methods

Name Description
add_dependencies No description.
add_needs No description.
add_parent This method is called by gcix.JobCollections when the job is added to that JobCollection.
add_tags No description.
add_variables No description.
append_rules No description.
append_scripts No description.
assign_allow_failure No description.
assign_artifacts No description.
assign_cache No description.
assign_dependencies No description.
assign_image Sets the image of this job.
assign_needs No description.
assign_tags No description.
copy Returns an independent, deep copy object of this job.
extend_name This method is used by gcix.JobCollections to populate the jobs name.
extend_stage This method is used by gcix.JobCollections to populate the jobs name and stage.
extend_stage_value This method is used by gcix.JobCollections to populate the jobs stage.
get_all_instance_names Return all instance names from the given child.
is_equal isEqual checks if this object is equal to given object.
prepend_rules No description.
prepend_scripts No description.
render Returns a representation of any object which implements IBase.
add_dependencies 
1
2
3
def add_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_needs 
1
2
3
def add_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_parent 
1
2
3
def add_parent(
  parent: typing.Union[Job, JobCollection]
) -> None

This method is called by gcix.JobCollections when the job is added to that JobCollection.

The job needs to know its parents when getAllInstanceNames() is called.

parentRequired
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
add_tags 
1
2
3
def add_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
add_variables 
1
2
3
def add_variables(
  variables: typing.Mapping[str]
) -> Job
variablesRequired
  • Type: typing.Mapping[str]
append_rules 
1
2
3
def append_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
append_scripts 
1
2
3
def append_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
assign_allow_failure 
1
2
3
def assign_allow_failure(
  allow_failure: typing.Union[bool, typing.List[typing.Union[int, float]]]
) -> Job
allow_failureRequired
  • Type: typing.Union[bool, typing.List[typing.Union[int, float]]]
assign_artifacts 
1
2
3
def assign_artifacts(
  artifacts: Artifacts
) -> Job
artifactsRequired
  • Type: gcix.Artifacts
assign_cache 
1
2
3
def assign_cache(
  cache: Cache
) -> Job
cacheRequired
  • Type: gcix.Cache
assign_dependencies 
1
2
3
def assign_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_image 
1
2
3
def assign_image(
  image: typing.Union[str, Image]
) -> Job

Sets the image of this job.

For a simple container image you can provide the origin of the image. If you want to set the entrypoint, you have to provide an Image object instead.

!! Any previous values will be overwritten.

imageRequired
  • Type: typing.Union[str, gcix.Image]
assign_needs 
1
2
3
def assign_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_tags 
1
2
3
def assign_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
copy 
1
def copy() -> Job

Returns an independent, deep copy object of this job.

extend_name 
1
2
3
def extend_name(
  name: str
) -> None

This method is used by gcix.JobCollections to populate the jobs name.

nameRequired
  • Type: str
extend_stage 
1
2
3
def extend_stage(
  stage: str
) -> None

This method is used by gcix.JobCollections to populate the jobs name and stage.

stageRequired
  • Type: str
extend_stage_value 
1
2
3
def extend_stage_value(
  stage: str
) -> None

This method is used by gcix.JobCollections to populate the jobs stage.

stageRequired
  • Type: str
get_all_instance_names 
1
2
3
def get_all_instance_names(
  child: typing.Union[Job, JobCollection] = None
) -> OrderedStringSet

Return all instance names from the given child.

That means all combinations of the childs name and stage within this sequence and all parent sequences.

childOptional
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
is_equal 
1
2
3
def is_equal(
  comparable: IBase
) -> bool

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: gcix.IBase
prepend_rules 
1
2
3
def prepend_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
prepend_scripts 
1
2
3
def prepend_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
render 
1
def render() -> typing.Any

Returns a representation of any object which implements IBase.

The rendered representation is used by the gcix to dump it in YAML format as part of the .gitlab-ci.yml pipeline.

Properties

Name Type Description
tags typing.List[str] Getter method to receive added tags.
allow_failure typing.Union[str, bool, typing.List[typing.Union[int, float]]] No description.
name str No description.
ordered_tags gcix.OrderedStringSet No description.
parents typing.List[typing.Union[gcix.Job, gcix.JobCollection]] No description.
scripts typing.List[str] No description.
stage str No description.
artifacts gcix.Artifacts No description.
cache gcix.Cache No description.
dependencies typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
image gcix.Image No description.
needs typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
original gcix.Job No description.
rules typing.List[gcix.Rule] No description.
variables typing.Mapping[str] No description.
container_image str The name of the Docker image to push to the registry.
registry str The Docker registry the image should be pushed to.
tag str The Docker image tag that should be pushed to the registry.
login_env_var str If you have to login to the registry before the push, you have to provide the name of the environment variable, which contains the password or token, here.
user_env_var str If you have to login to the registry before the push, you have to provide the name of the environment variable, which contains the username value, here.
tagsRequired 
1
tags: typing.List[str]
  • Type: typing.List[str]

Getter method to receive added tags.

allow_failureRequired 
1
allow_failure: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
  • Type: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
nameRequired 
1
name: str
  • Type: str
ordered_tagsRequired 
1
ordered_tags: OrderedStringSet
  • Type: gcix.OrderedStringSet
parentsRequired 
1
parents: typing.List[typing.Union[Job, JobCollection]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection]]
scriptsRequired 
1
scripts: typing.List[str]
  • Type: typing.List[str]
stageRequired 
1
stage: str
  • Type: str
artifactsOptional 
1
artifacts: Artifacts
  • Type: gcix.Artifacts
cacheOptional 
1
cache: Cache
  • Type: gcix.Cache
dependenciesOptional 
1
dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
imageOptional 
1
image: Image
  • Type: gcix.Image
needsOptional 
1
needs: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
originalOptional 
1
original: Job
  • Type: gcix.Job
rulesOptional 
1
rules: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
variablesOptional 
1
variables: typing.Mapping[str]
  • Type: typing.Mapping[str]
container_imageRequired 
1
container_image: str
  • Type: str

The name of the Docker image to push to the registry.

registryRequired 
1
registry: str
  • Type: str

The Docker registry the image should be pushed to.

tagRequired 
1
tag: str
  • Type: str

The Docker image tag that should be pushed to the registry.

login_env_varOptional 
1
login_env_var: str
  • Type: str

If you have to login to the registry before the push, you have to provide the name of the environment variable, which contains the password or token, here.

DO NOT PROVIDE THE LOGIN VALUE ITSELF! This would be a security issue!

user_env_varOptional 
1
user_env_var: str
  • Type: str

If you have to login to the registry before the push, you have to provide the name of the environment variable, which contains the username value, here.

DO NOT PROVIDE THE USERNAME VALUE ITSELF! This would be a security issue!

KanikoExecute

Creates a job which builds container images.

This job creates images depending on git branches. e.g If the branch which gets pushed to the remote is named my_awsome_feature the image will be tagged with my-awsome-feature.

This subclass of Job will configure following defaults for the superclass:

  • name: kaniko
  • stage: build
  • image: PredefinedImages.KANIKO

Initializers 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from gcix import container

container.KanikoExecute(
  build_args: typing.Mapping[typing.Any] = None,
  build_target: str = None,
  context: str = None,
  docker_client_config: DockerClientConfig = None,
  dockerfile: str = None,
  enable_push: bool = None,
  image_name: str = None,
  image_tag: str = None,
  job_name: str = None,
  job_stage: str = None,
  registries: typing.Union[typing.List[str], typing.List[Registry]] = None,
  tar_path: str = None,
  verbosity: str = None
)
Name Type Description
build_args typing.Mapping[typing.Any] Container build arguments, used to instrument the container image build.
build_target str For container multistage builds name of the build stage you want to create.
context str Context which will be send to kaniko.
docker_client_config DockerClientConfig Creates the Docker configuration file base on objects settings, to authenticate against given registries.
dockerfile str Name of the dockerfile to use.
enable_push bool Enable push to container registry, disabled to allow subsequent jobs to.
image_name str Image name which will be created.
image_tag str The tag the image will be tagged with.
job_name str The name of the Bootstrap job.
job_stage str The stage of the Bootstrap job.
registries typing.Union[typing.List[str], typing.List[Registry]] List of container registries to push created image to.
tar_path str Container images created by kaniko are tarball files.
verbosity str Verbosity of kaniko logging.
build_argsOptional
  • Type: typing.Mapping[typing.Any]

Container build arguments, used to instrument the container image build.

build_targetOptional
  • Type: str

For container multistage builds name of the build stage you want to create.

Image tag will be appended with the build_target. e.g. latest-buildtarget.

contextOptional
  • Type: str

Context which will be send to kaniko.

Defaults to None which implies the local directory is the context.

docker_client_configOptional

Creates the Docker configuration file base on objects settings, to authenticate against given registries.

Defaults to a DockerClientConfig with login to the official Docker Hub and expecting credentials given as environment variables REGISTRY_USER and REGISTRY_LOGIN.

dockerfileOptional
  • Type: str
  • Default: "Dockerfile"

Name of the dockerfile to use.

File is relative to context.

enable_pushOptional
  • Type: bool
  • Default: false act on container tarball.

Enable push to container registry, disabled to allow subsequent jobs to.

image_nameOptional
  • Type: str
  • Default: PredefinedVariables.CI_PROJECT_NAME.

Image name which will be created.

image_tagOptional
  • Type: str
  • Default: PredefinedVariables.CI_COMMIT_TAG

The tag the image will be tagged with.

job_nameOptional
  • Type: str

The name of the Bootstrap job.

job_stageOptional
  • Type: str

The stage of the Bootstrap job.

registriesOptional
  • Type: typing.Union[typing.List[str], typing.List[Registry]]

List of container registries to push created image to.

tar_pathOptional
  • Type: str

Container images created by kaniko are tarball files.

This is the path where to store the image, will be named with suffix .tar. This path will be created if not present.

verbosityOptional
  • Type: str
  • Default: "info"

Verbosity of kaniko logging.

Methods

Name Description
add_dependencies No description.
add_needs No description.
add_parent This method is called by gcix.JobCollections when the job is added to that JobCollection.
add_tags No description.
add_variables No description.
append_rules No description.
append_scripts No description.
assign_allow_failure No description.
assign_artifacts No description.
assign_cache No description.
assign_dependencies No description.
assign_image Sets the image of this job.
assign_needs No description.
assign_tags No description.
copy Returns an independent, deep copy object of this job.
extend_name This method is used by gcix.JobCollections to populate the jobs name.
extend_stage This method is used by gcix.JobCollections to populate the jobs name and stage.
extend_stage_value This method is used by gcix.JobCollections to populate the jobs stage.
get_all_instance_names Return all instance names from the given child.
is_equal isEqual checks if this object is equal to given object.
prepend_rules No description.
prepend_scripts No description.
render Returns a representation of any object which implements IBase.
add_dependencies 
1
2
3
def add_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_needs 
1
2
3
def add_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
add_parent 
1
2
3
def add_parent(
  parent: typing.Union[Job, JobCollection]
) -> None

This method is called by gcix.JobCollections when the job is added to that JobCollection.

The job needs to know its parents when getAllInstanceNames() is called.

parentRequired
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
add_tags 
1
2
3
def add_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
add_variables 
1
2
3
def add_variables(
  variables: typing.Mapping[str]
) -> Job
variablesRequired
  • Type: typing.Mapping[str]
append_rules 
1
2
3
def append_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
append_scripts 
1
2
3
def append_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
assign_allow_failure 
1
2
3
def assign_allow_failure(
  allow_failure: typing.Union[bool, typing.List[typing.Union[int, float]]]
) -> Job
allow_failureRequired
  • Type: typing.Union[bool, typing.List[typing.Union[int, float]]]
assign_artifacts 
1
2
3
def assign_artifacts(
  artifacts: Artifacts
) -> Job
artifactsRequired
  • Type: gcix.Artifacts
assign_cache 
1
2
3
def assign_cache(
  cache: Cache
) -> Job
cacheRequired
  • Type: gcix.Cache
assign_dependencies 
1
2
3
def assign_dependencies(
  dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
dependenciesRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_image 
1
2
3
def assign_image(
  image: typing.Union[str, Image]
) -> Job

Sets the image of this job.

For a simple container image you can provide the origin of the image. If you want to set the entrypoint, you have to provide an Image object instead.

!! Any previous values will be overwritten.

imageRequired
  • Type: typing.Union[str, gcix.Image]
assign_needs 
1
2
3
def assign_needs(
  needs: typing.List[typing.Union[Job, JobCollection, Need]]
) -> Job
needsRequired
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
assign_tags 
1
2
3
def assign_tags(
  tags: typing.List[str]
) -> Job
tagsRequired
  • Type: typing.List[str]
copy 
1
def copy() -> Job

Returns an independent, deep copy object of this job.

extend_name 
1
2
3
def extend_name(
  name: str
) -> None

This method is used by gcix.JobCollections to populate the jobs name.

nameRequired
  • Type: str
extend_stage 
1
2
3
def extend_stage(
  stage: str
) -> None

This method is used by gcix.JobCollections to populate the jobs name and stage.

stageRequired
  • Type: str
extend_stage_value 
1
2
3
def extend_stage_value(
  stage: str
) -> None

This method is used by gcix.JobCollections to populate the jobs stage.

stageRequired
  • Type: str
get_all_instance_names 
1
2
3
def get_all_instance_names(
  child: typing.Union[Job, JobCollection] = None
) -> OrderedStringSet

Return all instance names from the given child.

That means all combinations of the childs name and stage within this sequence and all parent sequences.

childOptional
  • Type: typing.Union[gcix.Job, gcix.JobCollection]
is_equal 
1
2
3
def is_equal(
  comparable: IBase
) -> bool

isEqual checks if this object is equal to given object.

comparableRequired
  • Type: gcix.IBase
prepend_rules 
1
2
3
def prepend_rules(
  rules: typing.List[Rule]
) -> Job
rulesRequired
  • Type: typing.List[gcix.Rule]
prepend_scripts 
1
2
3
def prepend_scripts(
  scripts: typing.List[str]
) -> Job
scriptsRequired
  • Type: typing.List[str]
render 
1
def render() -> typing.Any

Returns a representation of any object which implements IBase.

The rendered representation is used by the gcix to dump it in YAML format as part of the .gitlab-ci.yml pipeline.

Properties

Name Type Description
tags typing.List[str] Getter method to receive added tags.
allow_failure typing.Union[str, bool, typing.List[typing.Union[int, float]]] No description.
name str No description.
ordered_tags gcix.OrderedStringSet No description.
parents typing.List[typing.Union[gcix.Job, gcix.JobCollection]] No description.
scripts typing.List[str] No description.
stage str No description.
artifacts gcix.Artifacts No description.
cache gcix.Cache No description.
dependencies typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
image gcix.Image No description.
needs typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]] No description.
original gcix.Job No description.
rules typing.List[gcix.Rule] No description.
variables typing.Mapping[str] No description.
context str Context which will be send to kaniko.
docker_client_config DockerClientConfig Creates the Docker configuration file base on objects settings, to authenticate against given registries.
dockerfile str Name of the dockerfile to use.
enable_push bool Enable push to container registry, disabled to allow subsequent jobs to act on container tarball.
image_name str Image name which will be created.
image_tag str The tag the image will be tagged with.
verbosity str Verbosity of kaniko logging.
build_args typing.Mapping[typing.Any] Container build arguments, used to instrument the container image build.
build_target str For container multistage builds name of the build stage you want to create.
registries typing.Union[typing.List[str], typing.List[Registry]] List of container registries to push created image to.
tar_path str Container images created by kaniko are tarball files.
tagsRequired 
1
tags: typing.List[str]
  • Type: typing.List[str]

Getter method to receive added tags.

allow_failureRequired 
1
allow_failure: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
  • Type: typing.Union[str, bool, typing.List[typing.Union[int, float]]]
nameRequired 
1
name: str
  • Type: str
ordered_tagsRequired 
1
ordered_tags: OrderedStringSet
  • Type: gcix.OrderedStringSet
parentsRequired 
1
parents: typing.List[typing.Union[Job, JobCollection]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection]]
scriptsRequired 
1
scripts: typing.List[str]
  • Type: typing.List[str]
stageRequired 
1
stage: str
  • Type: str
artifactsOptional 
1
artifacts: Artifacts
  • Type: gcix.Artifacts
cacheOptional 
1
cache: Cache
  • Type: gcix.Cache
dependenciesOptional 
1
dependencies: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
imageOptional 
1
image: Image
  • Type: gcix.Image
needsOptional 
1
needs: typing.List[typing.Union[Job, JobCollection, Need]]
  • Type: typing.List[typing.Union[gcix.Job, gcix.JobCollection, gcix.Need]]
originalOptional 
1
original: Job
  • Type: gcix.Job
rulesOptional 
1
rules: typing.List[Rule]
  • Type: typing.List[gcix.Rule]
variablesOptional 
1
variables: typing.Mapping[str]
  • Type: typing.Mapping[str]
contextRequired 
1
context: str
  • Type: str

Context which will be send to kaniko.

docker_client_configRequired 
1
docker_client_config: DockerClientConfig

Creates the Docker configuration file base on objects settings, to authenticate against given registries.

Defaults to a DockerClientConfig with login to the official Docker Hub and expecting credentials given as environment variables REGISTRY_USER and REGISTRY_LOGIN.

dockerfileRequired 
1
dockerfile: str
  • Type: str

Name of the dockerfile to use.

File is relative to context.

enable_pushRequired 
1
enable_push: bool
  • Type: bool

Enable push to container registry, disabled to allow subsequent jobs to act on container tarball.

image_nameRequired 
1
image_name: str
  • Type: str

Image name which will be created.

image_tagRequired 
1
image_tag: str
  • Type: str

The tag the image will be tagged with.

verbosityRequired 
1
verbosity: str
  • Type: str

Verbosity of kaniko logging.

build_argsOptional 
1
build_args: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]

Container build arguments, used to instrument the container image build.

build_targetOptional 
1
build_target: str
  • Type: str

For container multistage builds name of the build stage you want to create.

Image tag will be appended with the build_target. e.g. latest-buildtarget.

registriesOptional 
1
registries: typing.Union[typing.List[str], typing.List[Registry]]
  • Type: typing.Union[typing.List[str], typing.List[Registry]]

List of container registries to push created image to.

tar_pathOptional 
1
tar_path: str
  • Type: str

Container images created by kaniko are tarball files.

This is the path where to store the image, will be named with suffix .tar. This path will be created if not present.

PredefinedImages

The PredefinedImages collection supplies commonly utilized container image objects within the gcix framework.

Constants

Name Type Description
ALPINE_GIT gcix.Image A predefined Alpine Git container image object.
BUSYBOX gcix.Image A predefined Busybox container image object.
CRANE gcix.Image A predefined Crane container image object.
DIVE gcix.Image A predefined Dive container image object.
GCIP gcix.Image A predefined GCIP container image object.
GCIX gcix.Image A predefined GCIX container image object.
KANIKO gcix.Image A predefined Kaniko container image object.
TRIVY gcix.Image A predefined Trivy container image object.
ALPINE_GITRequired 
1
ALPINE_GIT: Image
  • Type: gcix.Image

A predefined Alpine Git container image object.

This image is useful for Git operations within containers.

BUSYBOXRequired 
1
BUSYBOX: Image
  • Type: gcix.Image

A predefined Busybox container image object.

CRANERequired 
1
CRANE: Image
  • Type: gcix.Image

A predefined Crane container image object.

DIVERequired 
1
DIVE: Image
  • Type: gcix.Image

A predefined Dive container image object.

GCIPRequired 
1
GCIP: Image
  • Type: gcix.Image

A predefined GCIP container image object.

GCIXRequired 
1
GCIX: Image
  • Type: gcix.Image

A predefined GCIX container image object.

KANIKORequired 
1
KANIKO: Image
  • Type: gcix.Image

A predefined Kaniko container image object.

TRIVYRequired 
1
TRIVY: Image
  • Type: gcix.Image

A predefined Trivy container image object.

Registry

Container registry urls constants.

Static Functions

Name Description
aws Amazon Elastic Container Registry (ECR).
aws 
1
2
3
4
5
6
from gcix import container

container.Registry.aws(
  account_id: str = None,
  region: str = None
)

Amazon Elastic Container Registry (ECR).

If neither accountId nor region is given, the method attempts to evaluate accountId and region using helper functions from aws.AWSAccount. If either of the helper functions does provide a valid value, a ValueError or KeyError exception will be raised.

account_idOptional
  • Type: str
  • Default: AWSAccount.awsAccountId()

AWS account id.

regionOptional
  • Type: str
  • Default: AWSAccount.awsRegion()

AWS region where the ECR repository lives in.

Constants

Name Type Description
DOCKER str No description.
GCR str No description.
QUAY str No description.
DOCKERRequired