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

Jump to bottom

[Docs]: Example Provider Configuration doesn't show anything about "user", still has deprecated "username" #2925

Open
1 task
sfc-gh-zhowe opened this issue Jul 10, 2024 · 2 comments
Open
1 task

[Docs]: Example Provider Configuration doesn't show anything about "user", still has deprecated "username" #2925

sfc-gh-zhowe opened this issue Jul 10, 2024 · 2 comments
Labels
category:provider_config docs Used to mark issues with documentation remark/questions

Comments

@sfc-gh-zhowe
Copy link

Object type(s)

No response

Documentation Link

https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs#example-provider-configuration

Description

Down in the details below, this section talks about user/username, but the example at the top only mentions the deprecated username:

user (String) Username. Can also be sourced from the SNOWFLAKE_USER environment variable. Required unless using profile.
username (String, Deprecated) Username for username+password authentication. Can also be sourced from the SNOWFLAKE_USERNAME environment variable. Required unless using profile.

References

No response

Would you like to implement a fix?

  • Yeah, I'll take it 😎
@sfc-gh-zhowe sfc-gh-zhowe added the docs Used to mark issues with documentation remark/questions label Jul 10, 2024
@sfc-gh-asawicki
Copy link
Collaborator

Hey @sfc-gh-zhowe. Thanks for creating the issue.

The documentation for the provider setup lacks multiple examples, and we plan to address it during the upcoming https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/ROADMAP.md#providers-configuration-rework. Until then, we will accept the contribution following https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/CONTRIBUTING.md.

@sfc-gh-jmichalak sfc-gh-jmichalak mentioned this issue Oct 31, 2024
Merged
2 tasks
sfc-gh-jmichalak added a commit that referenced this issue Nov 7, 2024
@sfc-gh-jmichalak
feat: Rework config hierarchy (#3166)
04cd9f0 
<!-- Feel free to delete comments as you fill this in -->
- add remaining fields to the schema
- deprecate `account`
- implement and use a helper function for matching provider versions in
acceptance tests
- use helpers to fill config values
- add acceptance tests for all fields in the config
- move some code to internal package
- improve documentation: describe config hierarchy and provide better
config file examples
- improve and test sdk.MergeConfig
- move mock helper to a separate package because it caused unnecessarily
registered `sqlmock` driver in one of the tests
<!-- summary of changes -->

## Test Plan
<!-- detail ways in which this PR has been tested or needs to be tested
-->
* [x] acceptance tests
<!-- add more below if you think they are relevant -->
* [x] unit tests

## References
<!-- issues documentation links, etc  -->


#1881

#2145

#2925

#2983

#3104

## TODO
- acceptance test for fields regarding private keys - will be done in
SNOW-1754319
- unskip some tests after creating a compatible config for older
versions
@sfc-gh-jmichalak sfc-gh-jmichalak mentioned this issue Nov 8, 2024
Merged
sfc-gh-jmichalak pushed a commit that referenced this issue Nov 8, 2024
@snowflake-release-please
chore(main): release 0.98.0 (#3137)
003999e 
##
[0.98.0](v0.97.0...v0.98.0)
(2024-11-08)

Feature scope readiness for V1:
[link](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/v1-preparations/ESSENTIAL_GA_OBJECTS.MD)
([Roadmap
reference](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/ROADMAP.md#wrap-up-the-functional-scope)).
:exclamation: Migration guide: [v0.97.0 ->
v0.98.0](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/MIGRATION_GUIDE.md#v0970--v0980)

### 🎉 What's new
- New resources:
- authentication_policy
([#3098](#3098)),
references
[#2880](#2880)
- external_volume
([#3106](#3106)),
partially references
[#2980](#2980)
- stream_on_directory_table
([#3129](#3129))
- stream_on_view
([#3150](#3150))
- primary_connection, secondary_connection
([#3162](#3162))
- secret_with_basic_authentication, secret_with_generic_string,
secret_with_oauth_authorization_code_grant,
secret_with_oauth_client_credentials
([#3110](#3110)),
([#3141](#3141))
- New data sources:
- connections
([#3155](#3155)),
([#3173](#3173))
- secrets
([#3131](#3131))
- Reworked:
- provider configuration hierarchy
([#3166](#3166)),
references
[#1881](#1881),
[#2145](#2145),
[#2925](#2925),
[#2983](#2983),
[#3104](#3104)
- provider configuration fields
([#3152](#3152))
streams data source
([#3151](#3151))
- SDK upgrades:
- Upgrade tag SDK
([#3126](#3126))
- Recreate streams when they are stale
([#3129](#3129))
### 🔧  Misc
- Add object renaming research summary
([#3172](#3172))
- Test support for object renaming
([#3130](#3130)),
([#3147](#3147)),
([#3154](#3154))
- Add tests to issue
[#3117](#3117)
([#3133](#3133))
- New roadmap entry
([#3158](#3158))
- Test more authentication methods
([#3178](#3178))
- Minor fixes
([#3174](#3174))
### 🐛  Bug fixes
- Apply various fixes
([#3176](#3176)),
this addresses BCR 2024_08, references
[#2717](#2717),
[#3005](#3005),
[#3125](#3125),
[#3127](#3127),
[#3153](#3153)
- Connection and secret data sources tests
([#3177](#3177))
- Fix grant import docs
([#3183](#3183)),
resolves
[#3179](https://github.com/Snowflake-Labs/terraform-provider-snowflake/discussions/3179)
- Fix user resource import
([#3181](#3181))
- Handle external type changes in stream resources
([#3164](#3164))
- Do not use OR REPLACE on initial creation in resources with
copy_grants
([#3129](#3129))
- Address issue
[#2201](#2201)
by introducing new stream resources

Co-authored-by: snowflake-release-please[bot] <105954990+snowflake-release-please[bot]@users.noreply.github.com>
@sfc-gh-jmichalak
Copy link
Collaborator

sfc-gh-jmichalak commented Nov 12, 2024 •
edited
Loading

Hi @sfc-gh-zhowe 👋

We've released a new v0.98.0 version (release, migration guide) with adjusted documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
category:provider_config docs Used to mark issues with documentation remark/questions
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@sfc-gh-zhowe @sfc-gh-asawicki @sfc-gh-jmichalak