Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Grants migration guide #2455

Merged
merged 7 commits into from
Feb 6, 2024
Merged

chore: Grants migration guide #2455

merged 7 commits into from
Feb 6, 2024

Conversation

sfc-gh-jcieslak
Copy link
Collaborator

  • Migration guide - step-by-step migration of grant resources
  • Small change in test.tf (introduce resource dependency for proper delete order)

Copy link

github-actions bot commented Feb 2, 2024

Integration tests failure for eea409220345142e3d7084c1bfe90acb726f16b4

sfc-gh-asawicki
sfc-gh-asawicki previously approved these changes Feb 2, 2024
MIGRATION_GUIDE.md Outdated Show resolved Hide resolved
#### 3.1.2. terraform import

Write the `terraform import` command with the ID so that the resource will be able to parse and fill the state correctly.
You can find import syntax in the documentation for a given resource, [here](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/grant_privileges_to_account_role#import)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but it's already there 🤔

```

#### 1. terraform list

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i would probably put a few sentences why you are doing this. "first we need to list all the grant resources that will need to be migrated. We can do that by running the terraform state list command".

Tip: for larger configurations, its best to filter the results using the grep commands;

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


#### 2. terraform rm

Now choose which one you would to migrate next and remove it from the state with `terraform state rm <resource_address>`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

again, an explanation here i think is important. i certainly hesitated for a few seconds when I read that I needed to remove something from my statefile. Just something so the person doesn't worry they will lose their resource

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added more details, hopefully more helpful

After running `terraform plan` you'll see if there are any changes we have to do before applying our generated configuration.
If no errors are appearing you can run `terraform apply` to import state into generated configurations.

#### 3.3.4. Thoughts on configuration generation
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would recommend changing the title here to something more clear. like "Limitations of Configuration Generation".

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@@ -1,9 +1,170 @@
# Migration guide

This document is meant to help you migrate your Terraform config to new newest version. In migration guides we will only
describe deprecations or breaking changes and help you to change your configuration to keep the same (or similar) behaviour
This document is meant to help you migrate your Terraform config to the new newest version. In migration guides, we will only
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we link this in the dicussions? or from the discussions?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, good idea. I'll put it as a comment in the grant discussion.

Copy link

github-actions bot commented Feb 5, 2024

Integration tests failure for 1e422b22b07c74d29dc0500d17f6ab433f7aa2df

@sfc-gh-jcieslak sfc-gh-jcieslak changed the title Grants migration guide chore: Grants migration guide Feb 6, 2024
Copy link

github-actions bot commented Feb 6, 2024

Integration tests failure for f45c1eb7bcb48402eb4a41bfef41521ee9409b21

@sfc-gh-jcieslak sfc-gh-jcieslak merged commit 62c70fd into main Feb 6, 2024
6 of 8 checks passed
@sfc-gh-jcieslak sfc-gh-jcieslak deleted the grants-migration-guide branch February 6, 2024 10:27
Copy link

github-actions bot commented Feb 6, 2024

Integration tests failure for 9672d5acfcabc9d6d6039855cfdc74fdbce5e253

sfc-gh-jcieslak pushed a commit that referenced this pull request Feb 15, 2024
🤖 I have created a release *beep* *boop*
---


# Release notes
[0.86.0](v0.85.0...v0.86.0)
(2024-02-15)


## 🎉 **What's new**

* add refresh_mode and initialize to dynamic tables
([#2437](#2437))
([d301b20](d301b20))
* add resource snowflake_user_password_policy_attachment
([#2162](#2162))
([#2307](#2307))
([93af462](93af462))
* create a workaround for granting privileges on all pipes
([#2477](#2477))
([64f2346](64f2346))
* Handle IMPORTED PRIVILEGES privileges in privilege-to-role granting
resources
([#2471](#2471))
([eb20051](eb20051))
* use external functions
([#2454](#2454))
([417d473](417d473))
* use funcs from sdk
([#2462](#2462))
([a5f969c](a5f969c))
* use sdk for procedures
([#2450](#2450))
([94ac78a](94ac78a))
* Use sdk in table constraint resource
([#2466](#2466))
([d685603](d685603))
* Use tables from SDK
([#2453](#2453))
([fdb4f88](fdb4f88))


## 🔧 **Misc**

* Add migration notes to the docs and change jira integration
([#2497](#2497))
([b17f1af](b17f1af))
* Change email and issue reporter
([#2470](#2470))
([5865655](5865655))
* Grants migration guide
([#2455](#2455))
([62c70fd](62c70fd))
* Remove unused old implementation from snowflake pkg
([#2458](#2458))
([2d0e508](2d0e508))
* update password policy attachment
([#2485](#2485))
([6ec9ff7](6ec9ff7))


## 🐛 **Bug fixes**

* allow DT warehouse to be updated in-place
([#2439](#2439))
([d565af1](d565af1))
* correct test dependencies
([#2493](#2493))
([dfb247f](dfb247f))
* FileFormat not detecting changes correctly
([#2436](#2436))
([018bb74](018bb74))
* Fix few smaller issues
([#2507](#2507))
([a836871](a836871))
* Fix functions and small other fixes
([#2503](#2503))
([0d4aba4](0d4aba4)),
closes
[#2490](#2490)
* Fix tag tests in view and in materialized view
([#2457](#2457))
([2de942a](2de942a))
* Fix task related issues
([#2479](#2479))
([0385650](0385650))
* Fix tests that base on default data retention
([#2465](#2465))
([682e28c](682e28c))
* grant privileges to share test terraform dependencies
([#2473](#2473))
([ede8d95](ede8d95))
* parameter issues
([#2463](#2463))
([7ee4986](7ee4986))
* parse dynamic table query from DDL
([#2438](#2438))
([d76815c](d76815c))
* Remove title and body temporarily from jira integration
([#2499](#2499))
([672c97d](672c97d))
* SHOW GRANTS mapping for share data type
([#2508](#2508))
([feb4d44](feb4d44))
* user error handling
([#2486](#2486))
([dfa52b2](dfa52b2))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: snowflake-release-please[bot] <105954990+snowflake-release-please[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants