Auto DevOps 사용자 정의

Tier: Free, Premium, Ultimate Offering: GitLab.com, 자체 운영, GitLab Dedicated

귀하의 요구에 맞게 Auto DevOps 구성 요소를 사용자 정의할 수 있습니다. 예를 들어, 다음을 수행할 수 있습니다.

Auto DevOps 배너

Auto DevOps가 비활성화된 경우, 적어도 Maintainer 역할을 갖고 있는 사용자에게 배너가 표시됩니다:

Auto DevOps 배너

다음 대상에 대해 배너를 비활성화할 수 있습니다:

  • 사용자가 직접 해제하는 경우
  • 프로젝트가 명시적으로 Auto DevOps를 비활성화함으로써

  • 관리자가 다음을 Rails 콘솔에서 실행함으로써 GitLab 인스턴스 전체에서: 

    Feature.enable(:auto_devops_banner_disabled)

  • 관리자 엑세스 토큰으로 REST API를 통해: 

    curl --data "value=true" --header "PRIVATE-TOKEN: <personal_access_token>" "https://gitlab.example.com/api/v4/features/auto_devops_banner_disabled"

사용자 정의 빌드팩

프로젝트에서 자동 빌드팩 감지에 실패하거나 빌드를 좀 더 세밀하게 제어해야 하는 경우 빌드팩을 자체적으로 사용자 정의할 수 있습니다.

Cloud Native 빌드팩으로 빌드팩 사용자 정의

다음 중 하나를 명시하세요:

여러 빌드팩

Auto Test가 .buildpacks 파일을 사용할 수 없기 때문에 Auto DevOps는 여러 빌드팩을 지원하지 않습니다. .buildpacks 파일을 구문 분석하는 백엔드에서 사용되는 heroku-buildpack-multi은 필요한 명령인 bin/test-compile 및 bin/test을 제공하지 않기 때문입니다.

한 가지 사용자 정의 빌드팩만 사용하려면 프로젝트 CI/CD 변수 BUILDPACK_URL를 제공해야 합니다.

사용자 정의 도커파일

프로젝트 저장소의 루트에 Dockerfile이 있는 경우, Auto DevOps는 Dockerfile을 기반으로 Docker 이미지를 빌드합니다. 빌드팩을 사용하는 것보다 빠를 수 있으며 특히 Dockerfile이 Alpine을 기반으로 한 경우 이미지가 더 작을 수 있습니다.

DOCKERFILE_PATH CI/CD 변수를 설정하면 Auto Build는 대신 해당 위치에 있는 Dockerfile을 찾습니다.

docker build에 인수 전달

AUTO_DEVOPS_BUILD_IMAGE_EXTRA_ARGS 프로젝트 CI/CD 변수를 사용하여 docker build에 인수를 전달할 수 있습니다.

예를 들어, 기본 ruby:latest 대신 ruby:alpine을 기반으로 Docker 이미지를 빌드하려면 다음을 수행하세요:

  1. AUTO_DEVOPS_BUILD_IMAGE_EXTRA_ARGS를 --build-arg=RUBY_VERSION=alpine로 설정합니다.

  2. 사용자 정의 Dockerfile에 다음을 추가합니다: 

    ARG RUBY_VERSION=latest
FROM ruby:$RUBY_VERSION

# ... 여기에 내용을 입력하세요

여러분은 스페이스 및 개행과 같은 복잡한 값들을 전달하기 위해 Base64 인코딩을 사용할 수 있습니다. 복잡하고 인코딩되지 않은 값들은 문자 이스케이핑에 문제를 일으킬 수 있습니다.

경고: Docker 빌드 인수로 비밀을 전달하지 마십시오. 비밀이 이미지에 지속될 수 있습니다. 자세한 내용은 비밀 정보 관련 모베스트 프랙티스 토론을 참조하십시오.

사용자 정의 컨테이너 이미지

기본적으로 Auto Deploy는 Auto Build에 의해 GitLab 레지스트리에 빌드되고 푸시된 컨테이너 이미지를 배포합니다. 다음의 변수를 정의하여 이 동작을 덮어쓸 수 있습니다:

항목 기본값 다음으로 덮어쓸 수 있음
이미지 경로 브랜치 파이프라인의 경우 $CI_REGISTRY_IMAGE/$CI_COMMIT_REF_SLUG. 태그 파이프라인의 경우 $CI_REGISTRY_IMAGE $CI_APPLICATION_REPOSITORY
이미지 태그 브랜치 파이프라인의 경우 $CI_COMMIT_SHA. 태그 파이프라인의 경우 $CI_COMMIT_TAG $CI_APPLICATION_TAG

이러한 변수는 Auto Build 및 Auto Container Scanning에도 영향을 미칩니다. $CI_APPLICATION_REPOSITORY:$CI_APPLICATION_TAG로 이미지를 빌드하고 푸시하고 싶지 않다면 Jobs/Deploy.gitlab-ci.yml만 포함하거나 빌드 작업 비활성화 변수를 사용하십시오.

Auto Container Scanning을 사용하고 $CI_APPLICATION_REPOSITORY에 대한 값이 설정된 경우, $CS_DEFAULT_BRANCH_IMAGE도 업데이트해야 합니다. 자세한 내용은 기본 브랜치 이미지 설정을 참조하십시오.

.gitlab-ci.yml에서 다음은 예시 설정입니다: 

variables:
  CI_APPLICATION_REPOSITORY: <your-image-repository>
  CI_APPLICATION_TAG: <the-tag>

API를 사용하여 Auto DevOps 확장

GitLab API로 Auto DevOps 구성을 확장하고 관리할 수 있습니다:

빌드 환경으로 CI/CD 변수 전달

CI/CD 변수를 빌드 환경으로 전달하려면 AUTO_DEVOPS_BUILD_IMAGE_FORWARDED_CI_VARIABLES CI/CD 변수에 전달하고 싶은 변수 이름을 추가하십시오. 여러 변수를 쉼표로 구분하여 입력하세요.

예를 들어 다음과 같이 CI_COMMIT_SHA 및 CI_ENVIRONMENT_NAME 변수를 전달하려면: 

variables:
  AUTO_DEVOPS_BUILD_IMAGE_FORWARDED_CI_VARIABLES: CI_COMMIT_SHA,CI_ENVIRONMENT_NAME

빌드팩을 사용하는 경우, 전달된 변수는 자동으로 환경 변수로 사용할 수 있습니다.

Dockerfile을 사용하는 경우:

  1. 실험적 Dockerfile 구문을 활성화하려면 Dockerfile에 다음을 추가하십시오: 

    # syntax = docker/dockerfile:experimental

  2. 빌드 환경에서 시크릿을 사용하도록 하려면 시크릿 파일을 마운트하고 $COMMAND를 실행하기 전에 시크릿을 소스로 지정하십시오: 

    RUN --mount=type=secret,id=auto-devops-build-secrets . /run/secrets/auto-devops-build-secrets && $COMMAND

AUTO_DEVOPS_BUILD_IMAGE_FORWARDED_CI_VARIABLES가 설정된 경우, Auto DevOps는 실험적 Docker BuildKit 기능을 활성화하여 --secret 플래그를 사용합니다.

사용자 정의 Helm 차트

자동 DevOps는 Helm을 사용하여 애플리케이션을 Kubernetes에 배포합니다. 프로젝트 리포지토리에 차트를 번들링하여 사용하거나 프로젝트 CI/CD 변수를 지정하여 사용하여 사용중인 Helm 차트를 재정의할 수 있습니다.

  • 번들된 차트 - 프로젝트에 ./chart 디렉토리와 그 안에 Chart.yaml 파일이 있다면, 자동 DevOps는 해당 차트를 감지하고 기본 차트대신 사용합니다.
  • 프로젝트 변수 - 프로젝트 CI/CD 변수 AUTO_DEVOPS_CHART를 생성하고 사용자 정의 차트의 URL을 지정하세요. 또한 다섯 개의 프로젝트 변수를 생성할 수 있습니다:
    • AUTO_DEVOPS_CHART_REPOSITORY - 사용자 정의 차트 저장소의 URL입니다.
    • AUTO_DEVOPS_CHART - 차트의 경로입니다.
    • AUTO_DEVOPS_CHART_REPOSITORY_INSECURE - Helm 명령에 --insecure-skip-tls-verify 인수를 추가하려면 값을 비어있지 않은 값으로 설정하세요.
    • AUTO_DEVOPS_CHART_CUSTOM_ONLY - 사용자 정의 차트만 사용하려면 값을 비어있지 않은 값으로 설정하세요. 기본적으로 GitLab에서 최신 차트가 다운로드됩니다.
    • AUTO_DEVOPS_CHART_VERSION - 배포 차트의 버전입니다.

Helm 차트 값 사용자 정의

기본 Helm 차트의 values.yaml 파일에서 기본 값들을 재정의하려면: - .gitlab/auto-deploy-values.yaml라는 이름의 파일을 리포지토리에 추가하세요. 이 파일은 기본적으로 Helm 업그레이드에 사용됩니다. - 다른 이름 또는 경로로 파일을 추가하세요. 그리고 HELM_UPGRADE_VALUES_FILE CI/CD 변수에 파일의 경로와 이름을 설정하세요.

위의 옵션으로는 일부 값을 재정의할 수 없지만, 이 이슈에서 이 동작을 변경하도록 제안했습니다. replicaCount와 같은 설정을 재정의하려면 REPLICAS 빌드 및 배포 CI/CD 변수를 사용하세요.

helm upgrade 사용자 정의

auto-deploy-image는 helm upgrade 명령을 사용합니다. 이 명령을 사용자 정의하려면 HELM_UPGRADE_EXTRA_ARGS CI/CD 변수로 옵션을 전달하세요.

예를 들어, helm upgrade 실행 시 프리- 및 포스트-업그레이드 후크를 비활성화하려면: 

variables:
  HELM_UPGRADE_EXTRA_ARGS: --no-hooks

옵션의 전체 목록은 공식 helm upgrade 문서를 참조하세요.

Helm 차트를 하나의 환경으로 제한

사용자 정의 차트를 한 가지 환경으로 제한하려면 CI/CD 변수에 환경 스코프를 추가하세요. 자세한 내용은 CI/CD 변수의 환경 스코프 제한을 참조하세요.

.gitlab-ci.yml 사용자 정의

자동 DevOps는 Auto DevOps 템플릿을 사용하여 .gitlab-ci.yml 파일의 구현입니다. 템플릿은 .gitlab-ci.yml의 모든 구현에서 사용 가능한 기능만을 사용합니다.

자동 DevOps 파이프라인에 사용자 정의 동작을 추가하려면:

  1. 리포지토리 루트에 다음 내용이 포함된 .gitlab-ci.yml 파일을 추가하세요: 

    include:
  - template: Auto-DevOps.gitlab-ci.yml

  2. .gitlab-ci.yml 파일에 변경 사항을 추가하세요. 변경 사항은 Auto DevOps 템플릿과 병합됩니다. 변경 사항을 병합하는 include의 자세한 내용은 include 문서를 참조하세요.

Auto DevOps 파이프라인에서 동작을 제거하려면:

  1. Auto DevOps 템플릿을 프로젝트로 복사하세요.
  2. 템플릿의 사본을 필요에 맞게 편집하세요.

Auto DevOps의 개별 구성 요소 사용

Auto DevOps가 제공하는 기능의 하위 집합만 필요한 경우, 자체 .gitlab-ci.yml에 개별 Auto DevOps 작업을 포함할 수 있습니다. 각 작업에 필요한 stage를 꼭 정의하세요.

예를 들어, 자동 빌드를 사용하려면 다음을 .gitlab-ci.yml에 추가하세요: 

stages:
  - build

include:
  - template: Jobs/Build.gitlab-ci.yml

사용 가능한 작업 목록은 Auto DevOps 템플릿을 참조하세요.

여러 Kubernetes 클러스터 사용

Auto DevOps를 위한 여러 Kubernetes 클러스터를 참조하세요.

Kubernetes 네임스페이스 사용자 정의

GitLab 14.5 및 이전 버전에서는 environment:kubernetes:namespace를 사용하여 환경의 네임스페이스를 지정할 수 있었습니다. 그러나 이 기능은 폐기되었습니다, 인증서 기반 통합과 함께.

이제 KUBE_NAMESPACE 환경 변수를 사용하고 환경 스코프를 제한해야 합니다.

로컬 Docker 레지스트리에 호스팅된 이미지 사용

많은 Auto DevOps 작업을 오프라인 환경에서 실행하도록 구성할 수 있습니다:

  1. 필요한 Auto DevOps Docker 이미지를 Docker Hub과 registry.gitlab.com에서 로컬 GitLab 컨테이너 레지스트리로 복사합니다.

  2. 이미지가 호스팅되고 로컬 레지스트리에서 사용 가능한 경우, .gitlab-ci.yml을 편집하여 로컬로 호스팅된 이미지를 가리키도록 설정하세요. 예: 

    include:
  - template: Auto-DevOps.gitlab-ci.yml

variables:
  REGISTRY_URL: "registry.gitlab.example"

build:
  image: "$REGISTRY_URL/docker/auto-build-image:v0.6.0"
  services:
    - name: "$REGISTRY_URL/greg/docker/docker:20.10.16-dind"
      command: ['--tls=false', '--host=tcp://0.0.0.0:2375']

PostgreSQL 데이터베이스 지원

경고: 기본값으로 PostgreSQL 데이터베이스를 프로비저닝하는 것은 GitLab 15.8에서 폐지되었으며 16.0부터 더 이상 기본값으로 제공되지 않을 것입니다. 데이터베이스 프로비저닝을 활성화하려면 관련 CI/CD 변수를 설정하세요.

데이터베이스가 필요한 애플리케이션을 지원하기 위해 기본적으로 PostgreSQL이 프로비저닝됩니다. 데이터베이스에 액세스하는 자격 증명은 미리 구성되어 있습니다.

자격 증명을 사용자 정의하려면 관련 CI/CD 변수를 설정하세요. 또한 사용자 정의 DATABASE_URL을 정의할 수 있습니다: 

postgres://user:password@postgres-host:postgres-port/postgres-database

PostgreSQL 업그레이드

GitLab은 기본적으로 차트 버전 8.2.1을 사용하여 PostgreSQL을 프로비저닝합니다. 버전을 0.7.1에서 8.2.1로 설정할 수 있습니다.

이전 차트 버전을 사용하는 경우 데이터베이스를 새로운 PostgreSQL로 마이그레이션해야 합니다.

기본으로 프로비저닝된 PostgreSQL을 제어하는 CI/CD 변수인 AUTO_DEVOPS_POSTGRES_CHANNEL은 GitLab 13.0에서 2로 변경되었습니다. 기존 PostgreSQL을 사용하려면 AUTO_DEVOPS_POSTGRES_CHANNEL 변수를 1로 설정하세요.

PostgreSQL Helm 차트의 값 사용자 정의

다음 중 하나를 수행하여 사용자 정의 값을 설정하세요:

  • .gitlab/auto-deploy-postgres-values.yaml라는 파일을 저장소에 추가하세요. 찾으면 이 파일이 자동으로 사용됩니다. 이 파일은 기본적으로 PostgreSQL Helm 업그레이드에 사용됩니다.
  • 다른 이름 또는 경로의 파일을 저장소에 추가하고 POSTGRES_HELM_UPGRADE_VALUES_FILE 환경 변수를 경로와 이름으로 설정하세요.
  • POSTGRES_HELM_UPGRADE_EXTRA_ARGS 환경 변수를 설정하세요.

외부 PostgreSQL 데이터베이스 제공업체 사용

Auto DevOps는 프로덕션 환경을 위해 PostgreSQL 컨테이너를 기본적으로 지원합니다. 그러나 AWS Relational Database Service와 같은 외부 관리형 제공업체를 사용하려는 경우가 있을 수 있습니다.

외부 관리형 제공업체를 사용하려면:

  1. 필요한 환경에 대해 기본 PostgreSQL 설치를 비활성화하고 환경 범위의 CI/CD 변수를 사용하세요. 검토 앱 및 스테이징을 위해 기본 PostgreSQL 설정이 충분하기 때문에 production에 대해서만 비활성화하면 될 수 있습니다.

    Auto Metrics

  2. DATABASE_URL 변수를 환경 범위의 변수로 정의하여 애플리케이션에서 사용할 수 있도록 하세요. 이는 다음 형식의 URL이어야 합니다: 

    postgres://user:password@postgres-host:postgres-port/postgres-database

  3. Kubernetes 클러스터가 PostgreSQL이 호스팅된 위치에 대한 네트워크 액세스를 보장하세요.