Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/snowflake-labs/terraform-provider-snowflake

Terraform provider for managing Snowflake accounts
https://github.com/snowflake-labs/terraform-provider-snowflake

snowflake terraform

Last synced: 3 days ago
JSON representation

Terraform provider for managing Snowflake accounts

Host: GitHub
URL: https://github.com/snowflake-labs/terraform-provider-snowflake
Owner: Snowflake-Labs
License: mit
Created: 2019-01-15T21:29:36.000Z (almost 6 years ago)
Default Branch: main
Last Pushed: 2024-12-18T14:08:42.000Z (4 days ago)
Last Synced: 2024-12-18T15:23:44.312Z (4 days ago)
Topics: snowflake, terraform
Language: Go
Homepage: https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest
Size: 47.6 MB
Stars: 562
Watchers: 39
Forks: 425
Open Issues: 247
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Roadmap: ROADMAP.md

Awesome Lists containing this project

README

        # Snowflake Terraform Provider

> ⚠️ **Incoming holidays**: The whole team will be absent from the 21st of December to the 7th of January. Our involvement in GitHub issues during this time will be limited. We will look out for the critical issues, though. Merry Christmas and a Happy New Year!

> ⚠️ **Please note**: If you believe you have found a security issue, _please responsibly disclose_ by contacting us at [[email protected]](mailto:[email protected]).

> ⚠️ **Disclaimer**: The project is in v1 version, but some features are in preview. Such resources and data sources are considered preview features in the provider, regardless of their state in Snowflake. We do not guarantee their stability. They will be reworked and marked as a stable feature in future releases. Breaking changes in these features are expected, even without bumping the major version. They are disabled by default. To use them, add the relevant feature name to `preview_features_enabled` field in the [provider configuration](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs#schema). The list of preview features is available below. Please always refer to the [Getting Help](https://github.com/Snowflake-Labs/terraform-provider-snowflake?tab=readme-ov-file#getting-help) section in our Github repo to best determine how to get help for your questions.

> 

> Keep in mind that V1 does not mean we have an official Snowflake support. Please follow [creating issues guidelines](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/CREATING_ISSUES.md).

----

![.github/workflows/ci.yml](https://github.com/Snowflake-Labs/terraform-provider-snowflake/workflows/.github/workflows/ci.yml/badge.svg)

This is a terraform provider for managing [Snowflake](https://www.snowflake.com/) resources.

## Table of contents

* [Snowflake Terraform Provider](#snowflake-terraform-provider)

  * [Table of contents](#table-of-contents)

  * [Getting started](#getting-started)

  * [Migration guide](#migration-guide)

  * [Roadmap](#roadmap)

  * [Getting Help](#getting-help)

  * [Would you like to create an issue?](#would-you-like-to-create-an-issue)

  * [Additional debug logs for `snowflake_grant_privileges_to_role` resource](#additional-debug-logs-for-snowflake_grant_privileges_to_role-resource)

  * [Additional SQL Client configuration](#additional-sql-client-configuration)

  * [Contributing](#contributing)

  * [Releases](#releases)

## Getting started

> If you're still using the `chanzuckerberg/snowflake` source, see [Upgrading from CZI Provider](./CZI_UPGRADE.md) to upgrade to the current version.

Install the Snowflake Terraform provider by adding a requirement block and a provider block to your Terraform codebase:

```hcl

terraform {

  required_providers {

    snowflake = {

      source  = "Snowflake-Labs/snowflake"

      version = ">= 1.0.0"

    }

  }

}

provider "snowflake" {

  organization_name = "organization_name"

  account_name      = "account_name"

  user              = "johndoe"

  password          = "v3ry$3cr3t"

  role              = "ACCOUNTADMIN"

}

```

For more information on provider configuration see the [provider docs on the Terraform registry](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs).

Don't forget to run `terraform init` and you're ready to go! 🚀

Start browsing the [registry docs](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs) to find resources and data sources to use.

## Migration guide

Please check the [migration guide](./MIGRATION_GUIDE.md) when changing the version of the provider.

## Roadmap

Check [Roadmap](./ROADMAP.md).

## Getting Help

Some links that might help you:

- The [introductory tutorial](https://guides.snowflake.com/guide/terraforming_snowflake/#0) shows how to set up your Snowflake account for Terraform (service user, role, authentication, etc) and how to create your first resources in Terraform.

- The [docs on the Terraform registry](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest) are a complete reference of all resources and data sources supported and contain more advanced examples.

- The [discussions area](https://github.com/Snowflake-Labs/terraform-provider-snowflake/discussions) of this repo, we use this forum to discuss new features and changes to the provider.

- **If you are an enterprise customer**, reach out to your account team. This helps us prioritize issues.

- The [issues section](https://github.com/Snowflake-Labs/terraform-provider-snowflake/issues) might already have an issue addressing your question.

## Would you like to create an issue?

If you would like to create a GitHub issue, please read our [guide](./CREATING_ISSUES.md) first.

It contains useful links, FAQ, and commonly known issues with solutions that may already solve your case.

## Additional debug logs for `snowflake_grant_privileges_to_role` resource

Set environment variable `SF_TF_ADDITIONAL_DEBUG_LOGGING` to a non-empty value. Additional logs will be visible with `sf-tf-additional-debug` prefix, e.g.:

```text

2023/12/08 12:58:22.497078 sf-tf-additional-debug [DEBUG] Creating new client from db

```

## Additional SQL Client configuration

Currently underlying sql [gosnowflake](https://github.com/snowflakedb/gosnowflake) driver is wrapped with [instrumentedsql](https://github.com/luna-duclos/instrumentedsql). In order to use raw [gosnowflake](https://github.com/snowflakedb/gosnowflake) driver, set environment variable `SF_TF_NO_INSTRUMENTED_SQL` to a non-empty value.

By default, the underlying driver is set to error level logging. It can be changed by setting `driver_tracing` field in the configuration to one of (from most to least verbose):

- `trace`

- `debug`

- `info`

- `print`

- `warning`

- `error`

- `fatal`

- `panic`

Read more in [provider configuration docs](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs#schema).

## Contributing

Check [Contributing](./CONTRIBUTING.md).

## Releases

Releases will be performed as needed, typically once every 2 weeks.

Releases are published to [the terraform registry](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest). Each change has its own release notes (e.g. https://github.com/Snowflake-Labs/terraform-provider-snowflake/releases/tag/v0.89.0) and migration guide if needed (e.g. https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/MIGRATION_GUIDE.md#v0880--v0890).