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.

Sign up for GitHub

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: Document godebug flag usage #3429

Merged
merged 2 commits into from
Mar 4, 2025
+23 −0
Merged

chore: Document godebug flag usage #3429

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
73ba109
Document tls issue and godebug usage
sfc-gh-jcieslak Mar 3, 2025
0e64e9b
Changes after review
sfc-gh-jcieslak Mar 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions CREATING_ISSUES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
* [Granting PUBLIC role fails](#granting-public-role-fails)
* [Issues with grant_ownership resource](#issues-with-grant_ownership)
* [Using QUOTED_IDENTIFIERS_IGNORE_CASE with the provider](#using-quoted_identifiers_ignore_case-with-the-provider)
* [Experiencing Go related issues (e.g., using Suricata-based firewalls, like AWS Network Firewall, with >=v1.0.4 version of the provider)](#experiencing-go-related-issues-eg-using-suricata-based-firewalls-like-aws-network-firewall-with-v104-version-of-the-provider)

This guide was made to aid with creating the GitHub issues, so you can maximize your chances of getting help as quickly as possible.
To correctly report the issue, we suggest going through the following steps.
Expand Down Expand Up @@ -128,6 +129,9 @@ Please refer to [this document](https://github.com/Snowflake-Labs/terraform-prov
│ Error: open snowflake connection: 390144 (08004): JWT token is invalid.
│
```

**Related issues**: [Experiencing Go related issues (e.g., using Suricata-based firewalls, like AWS Network Firewall, with >=v1.0.4 version of the provider)](#experiencing-go-related-issues-eg-using-suricata-based-firewalls-like-aws-network-firewall-with-v104-version-of-the-provider)

**Solution**: Go to the [official Snowflake documentation](https://docs.snowflake.com/en/user-guide/key-pair-auth-troubleshooting#list-of-errors) and search by error code (390144 in this case).

[GitHub issue reference](https://github.com/Snowflake-Labs/terraform-provider-snowflake/issues/2432#issuecomment-1915074774)
Expand Down Expand Up @@ -292,3 +296,11 @@ during `terrform apply` they may fail with the `Error: Provider produced inconsi
**Related issues:** [#2967](https://github.com/Snowflake-Labs/terraform-provider-snowflake/issues/2967)

**Solution:** Either turn off the parameter or adjust your configurations to use only upper-cased names for identifiers and import back the resources.

### Experiencing Go related issues (e.g., using Suricata-based firewalls, like AWS Network Firewall, with >=v1.0.4 version of the provider)

**Problem:** The communication from the provider is dropped, because of the firewalls that are incompatible with the `tlskyber` setting introduced in [Go v1.23](https://go.dev/doc/godebug#go-123).

**Related issues:** [#3421](https://github.com/Snowflake-Labs/terraform-provider-snowflake/issues/3421)

**Solution:** [Solution described in the migration guide for v1.0.3 to v1.0.4 upgrade](./MIGRATION_GUIDE.md#new-go-version-and-conflicts-with-suricata-based-firewalls-like-aws-network-firewall).
11 changes: 11 additions & 0 deletions MIGRATION_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,17 @@ across different versions.
### Fixed external_function VARCHAR return_type
VARCHAR external_function return_type did not work correctly before ([#3392](https://github.com/Snowflake-Labs/terraform-provider-snowflake/issues/3392)) but was fixed in this version.

### New Go version and conflicts with Suricata-based firewalls (like AWS Network Firewall)
In this version we bumped our underlying Go version to v1.23.6.
Based on issue [#3421](https://github.com/Snowflake-Labs/terraform-provider-snowflake/issues/3421)
it seems it introduces changes to the standard library that may not be supported by other third party software.
The issue presents one of those changes that seem to be introduced in Golang's network package.
One thing that is valuable in such cases is to check the [GODEBUG](https://go.dev/doc/godebug)
documentation page (especially [history section](https://go.dev/doc/godebug#history)).
It specifies a set of parameters which can be turned on/off depending on
what features of Go would you like to use or resign from. The solution for this issue was to set
the GODEBUG environment variable to `GODEBUG=tlskyber=0`.

## v1.0.2 ➞ v1.0.3

### Fixed METRIC_LEVEL parameter
Expand Down
Loading