DCM Projects 배포 및 관리¶

인터페이스 도구¶

DCM Projects 에 사용할 수 있는 인터페이스 옵션은 다음과 같습니다.

Git 통합¶

DCM project 정의 파일이 저장된 Git 리포지토리에 연결합니다.

필수 역할 및 권한¶

DCM project 오브젝트를 생성하는 사용자의 역할에는 다음과 같은 역할과 권한이 있어야 합니다.

• CREATE DCM PROJECT ON SCHEMA 권한:

  CopyExpand

  GRANT CREATE DCM PROJECT ON SCHEMA <schema_name> TO ROLE <role_name>;
  

  Show lessSee more

  Scroll to top

다음 경우에 |dcm-object|를 만듭니다.¶

다음 옵션 중 하나를 사용하여 DCM project 오브젝트를 생성합니다.

CREATE [OR REPLACE] DCM PROJECT [IF NOT EXISTS] <my_project>
[COMMENT = 'my comment'];

snow dcm create <my_project> --if-not-exists

snow dcm create <my_project> --if-not-exists

snow dcm create # uses the name specified in the default target from the manifest

snow dcm create --target # uses the named target from the manifest

DCM 관리 오브젝트에 대한 소유권¶

DCM project 를 배포하는 역할에는 기본적으로 배포된 모든 오브젝트에 대한 OWNERSHIP 권한이 있습니다.

프로젝트 정의에는 다른 역할에 대한 GRANT OWNERSHIP 문이 포함될 수 있습니다. Snowflake는 DCM project 소유자 역할이 자신이 보유한 다른 하위 수준 역할에만 DCM 관리 오브젝트의 소유권을 부여할 것을 권장합니다. 그러면 프로젝트 소유자 역할이 새 오브젝트 소유자 역할의 권한을 “상속”하므로 프로젝트는 이 오브젝트를 계속 관리할 수 있습니다.

DCM project 소유자 역할이 자신이 보유하지 않은 다른 역할에 DCM 관리 오브젝트의 소유권을 부여하는 경우, 프로젝트 소유자 역할에 더 이상 소유권이 없으므로 프로젝트는 이 배포된 오브젝트를 더 이상 관리할 수 없습니다. 이후 배포는 실패합니다. 프로젝트에서 오브젝트 정의를 제거하거나 프로젝트 소유자 역할에 소유권을 다시 부여해야 합니다.

DCM project 에서 관리할 기존 오브젝트를 마이그레이션하려는 경우, DCM project 오브젝트를 소유한 역할에는 DCM project 에서 관리할 오브젝트에 대한 소유권 권한(직접 또는 다른 역할을 통해 상속됨)도 있어야 합니다.

PLAN 명령 실행¶

PLAN 명령은 다음 정보를 입력으로 사용합니다.

• 매니페스트 파일의 경로

  CLI는 매니페스트(default_target 또는 --target 플래그)에서 대상을 읽습니다. SQL 명령의 경우 매니페스트 파일의 경로와 프로젝트 이름을 제공해야 합니다.

• Jinja 변수에 대해 정의된 값(선택 사항).

• 대상의 ``templating_config``는 구성 프로필을 자동으로 선택합니다. SQL 명령의 경우, USING CONFIGURATION 절을 사용하여 프로필을 지정합니다.

• 덮어쓸 구성 프로필의 하나 이상의 값(선택 사항).

다음은 PLAN 명령을 실행하는 방법의 예제입니다.

Snowflake CLISnowsightSQL

로컬 IDE 터미널에서 또는 Git 워크플로의 일부로 snow dcm plan 명령을 실행합니다.

로컬 디렉터리에서 DCM 프로젝트를 계획하는 CLI 명령의 예제는 다음과 같습니다.

CopyExpand

cd ./Quickstarts/DCM_Project_Quickstart_1/
snow dcm plan

Show lessSee more

Scroll to top

Snowflake 스테이지 또는 Git 리포지토리 복제본에서 DCM 프로젝트를 계획하는 CLI 명령의 예제는 다음과 같습니다.

CopyExpand

snow dcm plan --target PROD_US --save-output

Show lessSee more

Scroll to top

선택적 인자로 DCM 프로젝트를 계획하는 CLI 명령의 예제는 다음과 같습니다.

CopyExpand

snow dcm plan
--variable "wh_size='MEDIUM'" --variable "teams = ['TEAM_A', 'TEAM_B']"
--save-output

Show lessSee more

Scroll to top

변수는 큰따옴표로 묶어야 하며, 문자열 값에는 작은따옴표가 추가되어야 합니다. 값 목록에는 대괄호가 필요합니다.

정의 파일 경로¶

매니페스트 및 정의 파일의 위치를 참조하는 옵션은 다음과 같습니다.

• 작업 공간 경로에서

  Snowsight 사용자 인터페이스에는 현재 작업 공간 내의 모든 DCM project 정의가 자동으로 나열됩니다. 이러한 경로 중 하나를 선택할 수 있으며, 작업 공간은 이를 사용하여 DCM 명령을 실행합니다.

  작업 공간에서 SQL 명령을 수동으로 실행하려는 경우, 작업 공간 내에서 동일한 경로를 참조할 수도 있습니다.

  팁: 작업 공간의 모든 파일 뒤에 있는 점 3개 메뉴를 사용하면 해당 파일의 전체 경로를 SQL 코드에 복사할 수 있습니다.

  작업 공간 경로에서 DCM 프로젝트를 계획하는 SQL 명령의 예제는 다음과 같습니다.

  CopyExpand

  EXECUTE DCM PROJECT DCM_PROJECT_DEV
    PLAN
    USING CONFIGURATION DEV
  FROM
    'snow://workspace/USER$.PUBLIC.DEFAULT$/versions/live/Quickstarts/DCM_Project_Quickstart_1'
  

  Show lessSee more

  Scroll to top

• 디스크의 로컬 Git 리포지토리 복제본에서

  로컬 IDE에서 CLI 명령을 실행하기 전에 manifest.yml 파일이 포함된 디렉터리를 선택합니다. 또는 사용하려는 매니페스트와 정의가 포함된 다른 로컬 디렉터리를 지정할 수 있습니다.

  로컬 Git 리포지토리의 현재 디렉터리에서 DCM project 를 계획하는 CLI 명령의 예제는 다음과 같습니다.

  CopyExpand

  cd ./Quickstarts/DCM_Project_Quickstart_1/
  
  snow dcm plan
  
  snow dcm plan --target PROD
  

  Show lessSee more

  Scroll to top

  로컬 Git 리포지토리 복제본의 다른 디렉터리에서 DCM project 를 계획하는 CLI 명령의 예제는 다음과 같습니다.

  CopyExpand

  snow dcm plan DCM_PROJECT_DEV --configuration DEV --from ./Quickstarts/DCM_Project_Quickstart_2/
  

  Show lessSee more

  Scroll to top

• 워크플로의 원격 리포지토리에서

  DCM 명령이 CI/CD 워크플로에서 실행되는 경우 동일한 CLI 구문을 사용할 수 있습니다.

  로컬 Git 리포지토리 복제본에서 DCM project 를 계획하는 CI/CD 워크플로의 예제는 다음과 같습니다.

  CopyExpand

  steps:
    - name: Clone Repo
      uses: actions/checkout@v4
    - name: Setup SnowCLI
      uses: snowflakedb/snowflake-cli-action@v2.0
    - name: Run PLAN
      run: |
        cd ./Quickstarts/DCM_Project_Quickstart_1/
        snow dcm plan --target PROD --save-output
  

  Show lessSee more

  Scroll to top

• Snowflake의 스테이지 또는 Git 리포지토리 복제본에서

  DCM 명령을 실행하는 Snowflake 내에서 프로시저 또는 작업을 실행하려는 경우, 이 SQL 명령은 계정 내의 Snowflake 스테이지 또는 Git 리포지토리 복제본에 대한 절대 경로를 참조할 수 있습니다.

  Git 리포지토리 복제본의 경우 최신 버전을 사용하려면 먼저 ALTER GIT REPOSITORY FETCH를 실행하는 것이 좋습니다.

  '@...' 경로는 DCM SQL 명령을 실행할 때만 사용할 수 있습니다.

  Snowflake의 스테이지 또는 Git 리포지토리 복제본에서 DCM 프로젝트를 계획하는 SQL 명령의 예제는 다음과 같습니다.

  CopyExpand

  EXECUTE DCM PROJECT DCM_PROJECT_DEV
    PLAN
    USING CONFIGURATION DEV
  FROM
    '@DCM_DEMO.DEPLOY.DCM_DEMO/branches/main/Quickstarts/DCM_Project_Quickstart_1/'
  

  Show lessSee more

  Scroll to top

계획 출력¶

표준 계획 출력에는 JSON 형식의 계획 실행에 대한 다음 정보가 포함됩니다.

version: 2
metadata:
  timestamp: <timestamp>
  query_id: <query_id>
  project_name: <project_name>
  user: <user>
  role_name: <role_name>
  command: <command>
  changes:
    - kind: <kind>
        "attribute_name": <attribute_name>,
        "value": <value>
        "changes": [
          {
            "kind": <kind>,
            "attribute_name": <attribute_name>,
            "value": <value>
          }
        ]
      }
    ]
  }
}

계획 출력의 예제:

{
  "version": 2,
  "metadata": {
    "timestamp": <timestamp>,
    "query_id": <query_id>,
    "project_name": <project_name>,
    "user": <user>,
    "role_name": <role_name>,
    "command": <command>
  },
  "changeset": [
    {
      "type": "CREATE",
      "object_id": {
        "domain": "TABLE",
        "name": "CUSTOMER_SUMMARY",
        "fqn": "MY_DB.ANALYTICS.CUSTOMER_SUMMARY",
        "database": "MY_DB",
        "schema": "ANALYTICS"
      },
      "changes": [
        {
          "kind": "set",
          "attribute_name": "warehouse_size",
          "value": "XSMALL"
        },
        {
          "kind": "set",
          "attribute_name": "query",
          "value": "SELECT customer_id, SUM(amount) AS total FROM orders GROUP BY customer_id"
        }
      ]
    },
    {
      "type": "ALTER",
      "object_id": {
        "domain": "DYNAMIC_TABLE",
        "name": "ORDER_DETAILS",
        "fqn": "MY_DB.ANALYTICS.ORDER_DETAILS",
        "database": "MY_DB",
        "schema": "ANALYTICS"
      },
      "changes": [
        {
          "kind": "changed",
          "attribute_name": "warehouse_size",
          "value": "SMALL",
          "prev_value": "XSMALL"
        },
        {
          "kind": "collection",
          "collection_name": "columns",
          "id_label": "name",
          "changes": [
            {
              "kind": "added",
              "item_id": "DISCOUNT_AMOUNT",
              "changes": [
                {
                  "kind": "set",
                  "attribute_name": "data_type",
                  "value": "NUMBER(10,2)"
                }
              ]
            },
            {
              "kind": "modified",
              "item_id": "ORDER_STATUS",
              "changes": [
                {
                  "kind": "changed",
                  "attribute_name": "data_type",
                  "value": "VARCHAR(50)",
                  "prev_value": "VARCHAR(20)"
                }
              ]
            },
            {
              "kind": "removed",
              "item_id": "LEGACY_FLAG"
            }
          ]
        }
      ]
    },
    {
      "type": "DROP",
      "object_id": {
        "domain": "VIEW",
        "name": "OLD_REPORT_VIEW",
        "fqn": "MY_DB.ANALYTICS.OLD_REPORT_VIEW",
        "database": "MY_DB",
        "schema": "ANALYTICS"
      },
      "changes": []
    }
  ]
}

DEPLOY 명령 실행¶

DEPLOY 명령을 실행하려면 다음 입력을 제공합니다.

• 매니페스트 파일의 경로.

• 구성 프로필이 매니페스트에 정의된 경우 구성 프로필의 이름을 지정해야 합니다.

• 기본값을 재정의하는 구성 프로필 값(선택 사항).

• 배포 *별칭*(선택 사항).

다음은 DEPLOY 명령을 실행하는 방법의 예제입니다.

EXECUTE DCM PROJECT DCM_DEMO.PROJECTS.DCM_PROJECT_DEV
  DEPLOY
FROM
  'snow://workspace/USER$.PUBLIC.DEFAULT$/versions/live/Quickstarts/DCM_Project_Quickstart_1';

EXECUTE DCM PROJECT DCM_DEMO.PROJECTS.DCM_PROJECT_DEV
  DEPLOY AS "testing 2 teams"
  USING CONFIGURATION DEV (wh_size => 'MEDIUM', teams => ['TEAM_A', 'TEAM_B'])
FROM
  'snow://workspace/USER$.PUBLIC.DEFAULT$/versions/live/Quickstarts/DCM_Project_Quickstart_1';

cd ./Quickstarts/DCM_Project_Quickstart_1/
snow dcm deploy DCM_DEMO.PROJECTS.DCM_PROJECT_DEV

snow dcm deploy --target PROD_US

snow dcm deploy DCM_DEMO.PROJECTS.DCM_PROJECT_DEV \
--configuration DEV \
--variable "wh_size='MEDIUM'" --variable "teams = ['TEAM_A', 'TEAM_B']" \
--alias 'testing 2 teams'

표준 계획 출력 구조의 경우 계획 출력 섹션을 참조하세요.

DCM project 에서 관리하는 모든 오브젝트 표시¶

SHOW ENTITIES IN DCM PROJECT 명령을 사용하면 현재 특정 DCM project 에서 관리하는 모든 Snowflake 오브젝트의 목록을 볼 수 있습니다. 모든 오브젝트의 정규화된 이름 목록을 제공합니다. 결과를 확인하려면 사용자에게 DCM project 에 대한 READ 권한 및 관리 오브젝트 자체를 확인할 수 있는 권한이 모두 필요합니다.

:code:`LIKE`를 사용하여 이름으로 검색하거나 흐름 연산자를 사용하여 결과 세트를 추가로 처리 또는 필터링할 수 있습니다.

마찬가지로, 이 프로젝트와 함께 정의되고 배포되는 SHOW GRANTS 및 SHOW FUTURE GRANTS 권한도 사용할 수 있습니다.

현재 DCM project 에서 관리하는 모든 오브젝트를 확인하는 예제는 다음과 같습니다.

SHOW ENTITIES LIKE '%DASHBOARD%' IN DCM PROJECT DCM_DEMO.PROJECTS.DCM_PROJECT_DEV;

SHOW ENTITIES IN DCM PROJECT DCM_DEMO.PROJECTS.DCM_PROJECT_DEV
  ->> SELECT * FROM $1 WHERE "object_type" = 'DYNAMIC_TABLE';

SHOW [FUTURE] GRANTS IN DCM PROJECT DCM_DEMO.PROJECTS.DCM_PROJECT_DEV;

DCM project 에서 오브젝트 분리¶

ALTER <오브젝트> 명령과 UNSET DCM PROJECT 절을 사용하면 배포된 후 현재 DCM project 에서 관리되는 오브젝트를 분리할 수 있습니다. 이 명령은 오브젝트를 삭제하지 않고 오브젝트와 DCM project 간의 연결을 제거합니다. 다른 DCM project 로 오브젝트 관리를 시작하려는 경우 이 명령을 사용할 수 있습니다.

다시 배포하기 전에 :ref:`프로젝트 정의 파일 <label-dcm_projects_definition_files>`에서 해당 DEFINE 문을 제거해야 합니다. 그렇지 않으면 오브젝트가 DCM project 에 다시 통합됩니다.

DCM project 에서 오브젝트를 분리하는 SQL 명령의 예제는 다음과 같습니다.

ALTER TABLE MY_DB.MY_SCH.MY_TABLE
  UNSET DCM PROJECT;

배포된 권한 부여 또는 실행은 DCM 프로젝트에서 분리할 수 없습니다.

DCM project 삭제¶

DCM project 오브젝트가 삭제되더라도 관리되는 모든 엔터티, 권한 부여 및 기대치는 “관리되지 않는” 상태로 유지됩니다.

DROP DCM PROJECT [IF EXISTS] <my_project>;

snow dcm drop my_project

CI/CD 모범 사례¶

CI/CD 파이프라인을 사용하여 배포를 자동화할 때 다음 사례를 따릅니다.

• 비프로덕션 환경을 대상으로 하는 DCM project 는 프로덕션 환경에 실수로 배포하는 것을 방지하기 위해 프로덕션 환경과 다른 역할이 소유해야 합니다.

• 프로덕션 환경을 대상으로 하는 DCM project 는 프로젝트의 모든 오브젝트를 배포하기에 충분한 특별히 맞춤화된 액세스 권한이 있는 프로덕션 배포를 위한 전용 역할이 소유해야 합니다.

  • DCM project 소유권에 일반 관리자 역할을 사용하지 마세요. 개별 개발자가 아닌 서비스 사용자에게만 이러한 역할을 부여합니다.

  • 개별 개발자가 아닌 서비스 사용자에게만 전용 프로덕션 배포 역할을 부여합니다.

  • 중요한 인프라 또는 데이터 제품의 불변성을 보장하기 위해 소유권을 프로덕션 배포 역할로 제한합니다.

    전용 프로덕션 배포 역할이 프로덕션 오브젝트의 소유권을 다른 역할에 부여하는 경우 해당 역할이 부여된 사용자는 프로덕션 오브젝트를 계속 수정하거나 삭제할 수 있습니다.

GitHub Actions 예제¶

이 섹션에서는 DCM Projects 에 대한 일반적인 CI/CD 패턴을 보여주는 샘플 GitHub Actions 워크플로를 제공합니다. Azure DevOps, GitLab CI/CD 또는 Bitbucket Pipelines와 같은 다른 Git 기반 플랫폼에도 동일한 개념이 적용되며, 워크플로 구문만 다릅니다.

각 샘플은 파이프라인 설정, 환경 토폴로지, 조직 요구 사항에 따라 사용자 지정하고 결합할 수 있는 구성 요소를 제공합니다.

샘플 워크플로는 모든 DCM CI/CD 설정에 적용 가능한 다음 패턴을 보여줍니다.

• 매니페스트 기반 구성 각 워크플로는 매니페스트 대상에서 account_identifier, project_owner, ``project_name``을 읽습니다. 이를 통해 환경 구성이 한 곳에 유지되고 GitHub 시크릿에서 중복되는 것을 방지할 수 있습니다.

• 데이터 삭제 방지 배포 워크플로는 ``plan_result.json``을 구문 분석하여 데이터베이스, 스키마, 테이블, 스테이지와 같은 데이터가 포함된 오브젝트에 대한 파괴적인 DROP 작업을 감지하고 해당 작업이 발견되면 배포를 차단합니다.

• 스테이지에서 프로덕션으로 순차적인 승격 프로덕션 배포는 스테이징 배포가 성공하고 동적 테이블을 새로 고치고 데이터 품질 테스트를 통과한 후에만 시작됩니다.

• 정형 계획 출력 구문 분석 워크플로는 ``jq``를 사용하여 ``plan_result.json``에서 작업 수 및 오브젝트 도메인을 추출하므로 사용자 지정 요약 및 검사를 쉽게 빌드할 수 있습니다.

• AI 기반 요약 ``snow cortex complete``은 GitHub 작업 요약에 대한 후처리 스크립트 결과 및 동적 테이블 새로 고침 출력의 자연어 요약을 생성합니다.

이러한 샘플 워크플로를 실행하기 전에 다음 전제 조건을 완료합니다.

• DCM project 파일을 Git 리포지토리에 저장합니다.

• 사용자에게 GitHub Actions를 생성하고 실행할 수 있는 권한을 부여합니다.

• Snowflake 서비스 사용자 자격 증명(SNOWFLAKE_USER, SNOWFLAKE_PASSWORD 또는 개인 액세스 토큰)에 대한 GitHub 시크릿을 구성합니다.

• DCM project 폴더 경로(DCM_PROJECT_PATH)에 대한 GitHub 변수를 구성합니다.

• 각 매니페스트 대상(예 :DCM_STAGE, DCM_PROD_US)에 대한 GitHub 환경을 구성합니다.

GitHub Actions에서 Snowflake 연결 설정에 대한 내용은 블로그 게시물 `GitHub Actions CI/CD에 대한 실용적인 가이드 <https://medium.com/@uche.nkadi/automate-your-dbt-project-on-snowflake-a-practical-guide-to-github-actions-ci-cd-a366b6e061e5>`_의 전반부를 참조하세요.

DCM Projects 의 전체 CI/CD 수명 주기를 다루는 GitHub Actions 워크플로의 세트에 대한 내용은 `Snowflake-labs DCM 리포지토리 <https://github.com/Snowflake-Labs/snowflake_dcm_projects/GitHub_workflows>`_를 참조하세요.

모든 샘플 워크플로는 yq``를 사용하여 매니페스트 대상에서 Snowflake ``account_identifier 및 project_owner 역할을 직접 읽으므로 환경별 구성은 중복된 GitHub 시크릿이 아닌 버전 제어되는 ``manifest.yml``에 저장됩니다. 서비스 사용자 자격 증명만 시크릿으로 저장됩니다.