设置 Snowflake 以使用 Git¶

配置为不进行身份验证¶

要设置 Snowflake 以在不进行身份验证的情况下使用 Git 存储库，请按照以下步骤操作：

1. 创建支持无需身份验证即可访问的 API 集成，并指定以下详细信息：

   • 将 git_https_api 指定为 API_PROVIDER 参数的值

   • 将请求必须限制到的 HTTPS 端点指定为 API_ALLOWED_PREFIXES 参数的值

   有关更多信息，请参阅 CREATE API INTEGRATION。

   CREATE OR REPLACE API INTEGRATION my_git_api_integration
     API_PROVIDER = git_https_api
     API_ALLOWED_PREFIXES = ('https://example.com/my-account')
     ENABLED = TRUE;
   

   Copy

2. 按照 创建 Snowflake Git 存储库克隆 中所述创建 Git 存储库克隆。

配置为使用令牌进行身份验证¶

要让 Snowflake 使用用户名和个人访问令牌 (PAT) 等令牌向 Git 存储库进行身份验证，请按照以下步骤操作：

1. 在 基本身份验证密钥 中提供凭据。

   要提供 Snowflake 用于向存储库进行身份验证的凭据，请创建包含以下内容的密钥：

   • TYPE 值为 password

   • 用户名和令牌，例如个人访问令牌 (PAT)

     如果您的 Git 存储库托管在 Bitbucket 上，请指定 x-token-auth 作为用户名值。

     备注

     有关在 GitHub 中创建个人访问令牌的信息，请参阅 ` 文档中的 <https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens (https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)>管理个人访问令牌 `_GitHub。

   有关创建密钥所用的 SQL 命令的更多信息，请参阅 CREATE SECRET。

   以下示例中的代码使用用户名和用户的个人访问令牌创建了名为 my_git_secret 的密钥，用作凭据：

   CREATE OR REPLACE SECRET my_git_secret
     TYPE = password
     USERNAME = 'gladyskravitz'
     PASSWORD = 'ghp_token';
   

   Copy

2. 创建支持使用令牌进行身份验证的 API 集成。

   要创建 API 集成，以在不进行身份验证的情况下访问 Git 存储库，请指定以下详细信息：

   • 将 git_https_api 指定为 API_PROVIDER 参数的值

   • 将请求必须限制到的 HTTPS 端点指定为 API_ALLOWED_PREFIXES 参数的值

   有关更多信息，请参阅 CREATE API INTEGRATION。

   CREATE OR REPLACE API INTEGRATION my_git_api_integration
     API_PROVIDER = git_https_api
     API_ALLOWED_PREFIXES = ('https://github.com/my-account')
     ALLOWED_AUTHENTICATION_SECRETS = (my_git_secret)
     ENABLED = TRUE;
   

   Copy

3. 按照 创建 Snowflake Git 存储库克隆 中所述创建 Git 存储库克隆。

配置为使用 OAuth 进行身份验证¶

要设置 Snowflake 以使其使用 OAuth 流程对远程 Git 存储库进行身份验证，请按照以下步骤操作：

1. 创建支持通过 OAuth 进行身份验证的 API 集成。

   使用 OAuth2 流程指定身份验证方式时，请创建一个指定以下内容的 API 集成：

   • 将 git_https_api 指定为 API_PROVIDER 参数的值

   • 将请求必须限制到的 HTTPS 端点指定为 API_ALLOWED_PREFIXES 参数的值

     这必须是在 https://github.com 的前缀。仅在 github.com 托管的存储库支持使用 OAuth 进行身份验证。

   • API_USER_AUTHENTICATION，其值为 (TYPE = SNOWFLAKE_GITHUB_APP)

   有关更多信息，请参阅 CREATE API INTEGRATION。

   以下示例中的代码会创建名为 API 的 my_git_api_integration 集成：

   CREATE OR REPLACE API INTEGRATION my_git_api_integration
     API_PROVIDER = git_https_api
     API_ALLOWED_PREFIXES = ('https://github.com')
     API_USER_AUTHENTICATION = (TYPE = SNOWFLAKE_GITHUB_APP)
     ENABLED = TRUE;
   

   Copy

2. 如 创建 Git 工作区 中所述，创建连接到 Git 存储库的工作区。

配置专用链接连接¶

在配置 Snowflake 以访问远程 Git 存储库之前，必须在 Snowflake 和云服务提供商之间设置专用链接。

要将配置更改应用于 Snowflake 和您的基础架构，请按照以下步骤操作：

1. 在您的云服务提供商中，创建专用链接服务以接收来自 Snowflake 专用端点服务的请求。

   有关详细信息，请参阅知识库文章 通过专用链接配置 Git 与 Snowflake 的集成 (https://community.snowflake.com/s/article/Configuring-Git-Integration-with-Snowflake-over-Private-Link)。

2. 在 Snowflake 中，配置一个专用端点，该端点将通过专用 IP 访问您的基础架构。

   要配置端点，请使用包含以下两个实参的 SYSTEM$PROVISION_PRIVATELINK_ENDPOINT 函数：

   • 云提供商的专用链接服务 ID

   • Git 服务器的域名

   AWSAzure

   SELECT SYSTEM$PROVISION_PRIVATELINK_ENDPOINT(
     'com.amazonaws.vpce.us-west-2.vpce-svc-xxx', // VPC Endpoint Service Name
     'git_address.com' // Git server domain
   );
   

   Copy

3. 在您的云服务提供商中，接受 Snowflake 专用端点设置以完成专用链接连接设置。

4. 要检查配置状态，请调用 SYSTEM$GET_PRIVATELINK_ENDPOINTS_INFO 系统函数。

配置 Snowflake 对远程 Git 存储库的访问权限¶

在 Snowflake 和云服务提供商之间设置专用链接后，您可以配置 Snowflake 对远程 Git 存储库的访问权限。

1. 创建支持使用证书进行身份验证的 API 集成。

   由于 Snowflake 将使用 HTTPS 协议访问您的 Git 服务器，因此域名需要具有有效的证书。根据您使用的是自签名证书还是由证书颁发机构签名的证书，您使用的配置会有所不同。

   • 使用自签名证书：

     

     1. 在 通用字符串密钥 中提供凭据。

        这应该是用于建立 HTTPS 连接的自签名域名的公钥。要向 Snowflake 提供用于向服务器进行身份验证的凭据，请创建包含以下详细信息的密钥：

        • GENERIC_STRING 的 TYPE 参数值

        • 作为 SECRET_STRING 参数值的公共证书字符串

          对于参数的值，请指定密钥字符串，例如公共证书正文。

        CREATE OR REPLACE SECRET my_public_certificate
          TYPE = GENERIC_STRING
          SECRET_STRING = '-----BEGIN CERTIFICATE-----
                    <certificate_body>
                    -----END CERTIFICATE-----';
        

        Copy

     2. 创建用于与 Git API 集成的 API 集成，并指定以下详细信息：

        • API_PROVIDER 参数设置为 git_https_api

        • API_ALLOWED_PREFIXES 设置为允许访问的基础 URL

        • USE_PRIVATELINK_ENDPOINT 参数设置为 TRUE

        • TLS_TRUSTED_CERTIFICATES 参数设置为您创建的密钥的名称，其中包含证书

        有关更多信息，请参阅 CREATE API INTEGRATION。

        CREATE OR REPLACE API INTEGRATION my_git_api_integration
          API_PROVIDER = git_https_api
          API_ALLOWED_PREFIXES = ('https://example.com/my-account')
          ALLOWED_AUTHENTICATION_SECRETS = ALL
          USE_PRIVATELINK_ENDPOINT = TRUE
          TLS_TRUSTED_CERTIFICATES = (my_public_certificate)
          ENABLED = TRUE;
        

        Copy

   • 使用由证书颁发机构签名的证书：

     

     1. 创建用于与 Git API 集成的 API 集成，并指定以下详细信息：

        • API_PROVIDER 参数设置为 git_https_api

        • API_ALLOWED_PREFIXES 设置为允许访问的基础 URL

        • USE_PRIVATELINK_ENDPOINT 参数设置为 TRUE

        • TLS_TRUSTED_CERTIFICATES 参数设置为您创建的密钥的名称，其中包含证书

        有关更多信息，请参阅 CREATE API INTEGRATION。

        CREATE OR REPLACE API INTEGRATION my_git_api_integration
          API_PROVIDER = git_https_api
          API_ALLOWED_PREFIXES = ('https://example.com/my-account')
          ALLOWED_AUTHENTICATION_SECRETS = ALL
          USE_PRIVATELINK_ENDPOINT = TRUE
          ENABLED = TRUE;
        

        Copy

2. 在 基本身份验证密钥 中提供凭据。

   通过专用链接成功连接到 Git 服务器后，您仍必须通过创建另一个为存储库提供凭据的密钥来对存储库进行身份验证。

   要提供 Snowflake 用于向存储库进行身份验证的凭据，请创建包含以下内容的密钥：

   • TYPE 值为 password

   • 用户名和令牌，例如个人访问令牌 (PAT)

     备注

     有关在 GitHub 中创建个人访问令牌的信息，请参阅 ` 文档中的 <https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens (https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)>管理个人访问令牌 `_GitHub。

   有关创建密钥所用的 SQL 命令的更多信息，请参阅 CREATE SECRET。

3. 按照 创建 Snowflake Git 存储库克隆 中所述创建 Git 存储库克隆。