CI/CD 와 Snowflake CLI 통합하기

Snowflake CLI 는 GitHub Actions 와 같이 인기 있는 CI/CD (지속적 통합 및 지속적 전달) 시스템과 프레임워크를 통합하여 SQL, Snowpark, Native Apps 또는 Notebooks에 대한 Snowflake 워크플로를 효율적으로 자동화합니다.

참고

향후 릴리스에는 Jenkins 및 Azure DevOps 에 대한 지원이 포함될 예정입니다.

다음 그림은 Snowflake CLI 의 일반적인 CI/CD 워크플로를 보여줍니다.

Snowflake CI/CD 워크플로

CI/CD 워크플로 단계

  1. 저장: Snowflake 파일을 안전하게 관리하기 위한 원격 Git 리포지토리를 구성합니다.

  2. 코드: 기본 설정에 맞게 IDE 또는 Snowsight를 사용하여 Snowflake 코드를 개발합니다.

  3. 설치: Snowflake CLI 를 설치 하고 원하는 CI/CD 공급자(예: GitHub Actions)를 프로비저닝합니다.

  4. 배포: Snowflake CLI 와 선택한 CI/CD 도구를 결합하여 배포를 자동화합니다.

  5. 모니터링: Snowflake의 Snowflake Trail 을 사용하여 코드 및 워크플로 성능을 추적하여 실시간 인사이트를 얻습니다.

  6. 반복: 지속적인 개선을 위해 프로젝트에 소규모 업데이트를 자주 적용하고, 변경 사항이 작을수록 관리가 간편해지고 필요한 경우 롤백할 수 있습니다.

GitHub Actions를 사용한 CI/CD

Snowflake CLI 작업은 Snowflake CLI 를 CI/CD 파이프라인에 통합하도록 설계된 GitHub 작업입니다. 이를 통해 GitHub 워크플로 내에서 Snowflake CLI 명령의 실행을 자동화할 수 있습니다.

Snowflake CLI 작업 사용하기

Snowflake CLI Github Actions는 CI/CD 워크플로에서 Snowflake CLI 를 설치하고 사용하는 프로세스를 간소화합니다. CLI 는 프로젝트의 종속성과 충돌하지 않도록 격리된 방식으로 설치됩니다. ~/.snowflake/ 디렉터리 내에 입력 구성 파일을 자동으로 설정합니다.

입력 매개 변수

Snowflake CLI 작업은 Github 워크플로 YAML 파일(예: <repo-name>/.github/workflows/my-workflow.yaml)에서 다음 입력을 사용합니다.

  • cli-version: 지정된 Snowflake CLI 버전(예: 3.6.0)입니다. 이 버전을 입력하지 않으면 Snowflake CLI 의 최신 버전이 사용됩니다.

  • default-config-file-path: 리포지토리에 있는 구성 파일(config.toml)의 경로입니다. 경로는 리포지토리의 루트를 기준으로 해야 합니다. 임시 연결(-x 옵션)을 사용하는 경우에는 구성 파일이 필요하지 않습니다.

CI/CD 워크플로에서 작업을 안전하게 구성하기

Github 작업을 사용하려면 다음을 수행해야 합니다.

  1. 개인 키를 생성합니다. 자세한 내용은 키 페어 인증 및 키 페어 순환 섹션을 참조하십시오.

  2. 계정, 개인 키, 암호 구문 등의 자격 증명을 GitHub 시크릿에 저장합니다. 자세한 내용은 GitHub 작업 설명서 를 참조하십시오.

연결 정의하기

임시 연결 또는 구성 파일에 정의된 연결로 Snowflake에 연결하도록 GitHub 작업을 정의할 수 있습니다. 연결 관리에 대한 자세한 내용은 Snowflake 연결 관리하기 섹션을 참조하십시오.

임시 연결 사용

임시 연결에 대한 자세한 내용은 임시 연결 사용 섹션을 참조하십시오.

임시 연결을 위한 Snowflake 자격 증명을 설정하려면 다음 단계를 따르십시오.

  1. 다음과 같이 SNOWFLAKE_<key>=<value> 의 형식으로 GitHub 워크플로의 환경 변수에 시크릿을 매핑합니다.

    env:
  SNOWFLAKE_PRIVATE_KEY_RAW: ${{ secrets.SNOWFLAKE_PRIVATE_KEY_RAW }}
  SNOWFLAKE_ACCOUNT: ${{ secrets.SNOWFLAKE_ACCOUNT }}
    Copy
  2. Snowflake CLI 작업을 구성합니다.

    최신 버전의 Snowflake CLI 를 사용하는 경우 cli-version 매개 변수를 포함할 필요가 없습니다. 다음은 Snowflake CLI 버전 3.6.0을 구체적으로 사용하는 작업을 지시하는 예입니다.

    - uses: snowflakedb/snowflake-cli-action@v1.5
  with:
    cli-version: "3.6.0"
    Copy

#. Optional: If your private key is encrypted, to set up a passphrase, set the PRIVATE_KEY_PASSPHRASE environment variable to the private key passphrase. Snowflake uses this passphrase to decrypt the private key. For example:

- name: Execute Snowflake CLI command
  env:
    PRIVATE_KEY_PASSPHRASE: ${{ secrets.PASSPHARSE }}
Copy

개인 키 대신 비밀번호를 사용하려면 다음과 같이 SNOWFLAKE_AUTHENTICATOR 환경 변수를 설정 해제하고 SNOWFLAKE_PASSWORD 변수를 추가합니다.

- name: Execute Snowflake CLI command
  env:
    SNOWFLAKE_USER: ${{ secrets.SNOWFLAKE_USER }}
    SNOWFLAKE_ACCOUNT: ${{ secrets.SNOWFLAKE_ACCOUNT }}
    SNOWFLAKE_PASSWORD: ${{ secrets.SNOWFLAKE_PASSWORD }}
Copy

참고

비밀번호 및 MFA 사용 환경을 개선하려면 MFA 캐싱을 구성하는 것이 좋습니다.

환경 변수에 Snowflake 자격 증명을 설정하는 방법에 대한 자세한 내용은 Snowflake 자격 증명에 환경 변수 사용 섹션을 참조하고, GitHub CI/CD 워크플로 내에서 환경 변수를 정의하는 방법에 대한 자세한 내용은 단일 워크플로의 환경 변수 정의하기 섹션을 참조하십시오.

  1. 아래와 같이 임시 연결로 실행하려는 snow 명령을 추가합니다.

    run: |
  snow --version
  snow connection test --temporary-connection
    Copy

다음은 완성된 샘플 <repo-name>/.github/workflows/my-workflow.yaml 파일을 보여주는 예입니다.

name: deploy
on: [push]

jobs:
  version:
    name: "Check Snowflake CLI version"
    runs-on: ubuntu-latest
    steps:
      # Snowflake CLI installation
      - uses: snowflakedb/snowflake-cli-action@v1.5

        # Use the CLI
      - name: Execute Snowflake CLI command
        env:
          SNOWFLAKE_AUTHENTICATOR: SNOWFLAKE_JWT
          SNOWFLAKE_USER: ${{ secrets.SNOWFLAKE_USER }}
          SNOWFLAKE_ACCOUNT: ${{ secrets.SNOWFLAKE_ACCOUNT }}
          SNOWFLAKE_PRIVATE_KEY_RAW: ${{ secrets.SNOWFLAKE_PRIVATE_KEY_RAW }}
          PRIVATE_KEY_PASSPHRASE: ${{ secrets.PASSPHARSE }} # Passphrase is only necessary if private key is encrypted.
        run: |
          snow --help
          snow connection test -x
Copy

작업이 Snowflake에 성공적으로 연결되는지 확인한 후 snow notebook create 또는 snow git execute 와 같은 Snowflake CLI 명령을 더 추가할 수 있습니다. 지원되는 명령에 대한 자세한 내용은 Snowflake CLI 명령 참조 섹션을 참조하십시오.

구성 파일 사용하기

연결 정의에 대한 자세한 내용은 연결 정의 섹션을 참조하십시오.

특정 연결에 대한 Snowflake 자격 증명을 설정하려면 다음 단계를 따르십시오.

  1. 아래와 같이 Git 리포지토리의 루트에 빈 구성 연결이 있는 config.toml 파일을 만듭니다.

    default_connection_name = "myconnection"

[connections.myconnection]
    Copy

    이 파일은 템플릿으로 사용되며 실제 자격 증명을 포함해서는 안 됩니다.

  2. 다음과 같이 SNOWFLAKE_<key>=<value> 의 형식으로 GitHub 워크플로의 환경 변수에 시크릿을 매핑합니다.

    env:
  SNOWFLAKE_CONNECTIONS_MYCONNECTION_PRIVATE_KEY_RAW: ${{ secrets.SNOWFLAKE_PRIVATE_KEY_RAW }}
  SNOWFLAKE_CONNECTIONS_MYCONNECTION_ACCOUNT: ${{ secrets.SNOWFLAKE_ACCOUNT }}
    Copy

#. Configure the Snowflake CLI action. If you use the latest version of Snowflake CLI, you do not need to include the cli-version parameter. The following example specifies a desired version and the name of your default configuration file:

- uses: snowflakedb/snowflake-cli-action@v1.5
  with:
    cli-version: "3.6.0"
    default-config-file-path: "config.toml"
Copy

#. Optional: If your private key is encrypted, to set up a passphrase, set the PRIVATE_KEY_PASSPHRASE environment variable to the private key passphrase. Snowflake uses this passphrase to decrypt the private key. For example:

- name: Execute Snowflake CLI command
  env:
    PRIVATE_KEY_PASSPHRASE: ${{ secrets.PASSPHARSE }}
Copy

개인 키 대신 비밀번호를 사용하려면 다음과 같이 SNOWFLAKE_AUTHENTICATOR 환경 변수를 설정 해제하고 SNOWFLAKE_PASSWORD 변수를 추가합니다.

- name: Execute Snowflake CLI command
  env:
    SNOWFLAKE_CONNECTIONS_MYCONNECTION_USER: ${{ secrets.SNOWFLAKE_USER }}
    SNOWFLAKE_CONNECTIONS_MYCONNECTION_ACCOUNT: ${{ secrets.SNOWFLAKE_ACCOUNT }}
    SNOWFLAKE_CONNECTIONS_MYCONNECTION_PASSWORD: ${{ secrets.SNOWFLAKE_PASSWORD }}
Copy

참고

비밀번호 및 MFA 사용 환경을 개선하려면 MFA 캐싱을 구성하는 것이 좋습니다.

  1. 아래와 같이 명명된 연결로 실행하려는 snow 명령을 추가합니다.

    run: |
  snow --version
  snow connection test
    Copy

다음은 Git 리포지토리에 있는 샘플 config.toml 파일과 완성된 샘플 <repo-name>/.github/workflows/my-workflow.yaml 파일을 보여주는 예입니다.

  • 샘플 config.toml 파일:

    default_connection_name = "myconnection"

[connections.myconnection]
    Copy

  • 샘플 Git 워크플로 파일:

    name: deploy
on: [push]
jobs:
  version:
    name: "Check Snowflake CLI version"
    runs-on: ubuntu-latest
    steps:
      # Checkout step is necessary if you want to use a config file from your repo
      - name: Checkout repo
        uses: actions/checkout@v4
        with:
          persist-credentials: false

        # Snowflake CLI installation
      - uses: snowflakedb/snowflake-cli-action@v1.5
        with:
          default-config-file-path: "config.toml"

        # Use the CLI
      - name: Execute Snowflake CLI command
        env:
          SNOWFLAKE_CONNECTIONS_MYCONNECTION_AUTHENTICATOR: SNOWFLAKE_JWT
          SNOWFLAKE_CONNECTIONS_MYCONNECTION_USER: ${{ secrets.SNOWFLAKE_USER }}
          SNOWFLAKE_CONNECTIONS_MYCONNECTION_ACCOUNT: ${{ secrets.SNOWFLAKE_ACCOUNT }}
          SNOWFLAKE_CONNECTIONS_MYCONNECTION_PRIVATE_KEY_RAW: ${{ secrets.SNOWFLAKE_PRIVATE_KEY_RAW }}
          PRIVATE_KEY_PASSPHRASE: ${{ secrets.PASSPHARSE }} #Passphrase is only necessary if private key is encrypted.
        run: |
          snow --help
          snow connection test
    Copy

작업이 Snowflake에 성공적으로 연결되는지 확인한 후 snow notebook create 또는 snow git execute 와 같은 Snowflake CLI 명령을 더 추가할 수 있습니다. 지원되는 명령에 대한 자세한 내용은 Snowflake CLI 명령 참조 섹션을 참조하십시오.

언어: 한국어