-
Notifications
You must be signed in to change notification settings - Fork 63
feat(dremio): Onboarding STACKIT Dremio #1482
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
Open
bjarneschroeder
wants to merge
33
commits into
stackitcloud:main
Choose a base branch
from
bjarneschroeder:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+3,684
−3
Open
Changes from all commits
Commits
Show all changes
33 commits
Select commit
Hold shift + click to select a range
3cd9438
fix(Docs): Adding `services` to path in utils creation step description.
723c020
feat(dremio): Initial Commit for onboarding of the STACKIT Dremio ser…
f608724
feat(dremio): Adding Dremio instance resource.
32ca5c8
chore(dremio): Linting
86989ea
fix(dremio): Providing default region in SDK config.
7f06e2d
feat(dremio): Adding example for Dremio instance
894102e
feat(dremio): Preparing resource methods for data source usage.
1aa2a78
feat(dremio): Adding dremio instance data resource.
1d1fc6e
fix(dremio): Linting & Formatting
494fa39
feat(dremio): Adding acceptance tests for Dremio instance.
763d72e
feat(dremio): First draft for Dremio user resource
1bc40ee
fix(dremio): Removing some obsolete comments & fixing typos in Dremio…
e6af5ef
fix(dremio): Fully align instance data source with resource.
9775d71
fix(dremio): Fixing acceptance tests.
e433562
fix(dremio): Make Dremio users actually creatable
768dfec
feat(dremio): Adding user unit tests
6ff89af
feat(dremio): Adding Dremio user data source.
8fb1781
feat(dremio): Adding Dremio user to acceptance tests (draft).
e54f25b
fix(dremio): Implementing review suggestions for datasources.
0a5b63e
feat(dremio): Updating dremio SDK containing enums.
0bec9ca
feat(dremio): Implementing review feedback from PR.
96d4dab
fix(dremio): Adding default description for user, so state does not b…
8899741
fix(dremio): Fixing acceptance tests.
713ca04
fix(dremio): Linter
aca56f6
feat(dremio): Adding example for Dremio users
dfb9019
fix(dremio): Implementing PR feedback
395ff96
feat(dremio): Specifying Dremio as experimental
d29ed9b
fix(dremo): Formatting
2d616fa
feat(dremio): Adding description for experimental state in README.
1be2f8a
fix(dremio): Fix experimental state check
3d89482
fix(dremio): Generate docs.
e41f6ce
feat(dremio): Removing state & error_message from tf state
04e7e46
chore(dremio): Regenerating docs
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "stackit_dremio_instance Data Source - stackit" | ||
| subcategory: "" | ||
| description: |- | ||
| Manages a STACKIT Dremio instance. | ||
| ~> This datasource is part of the dremio experiment and is likely going to undergo significant changes or be removed in the future. Use it at your own discretion. | ||
| --- | ||
|
|
||
| # stackit_dremio_instance (Data Source) | ||
|
|
||
| Manages a STACKIT Dremio instance. | ||
|
|
||
| ~> This datasource is part of the dremio experiment and is likely going to undergo significant changes or be removed in the future. Use it at your own discretion. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| data "stackit_dremio_instance" "example" { | ||
| project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||
| region = "eu01" | ||
| instance_id = "example-instance-id" | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `instance_id` (String) The Dremio instance ID. | ||
| - `project_id` (String) STACKIT Project ID to which the resource is associated. | ||
|
|
||
| ### Optional | ||
|
|
||
| - `description` (String) The description is a longer text chosen by the user to provide more context for the resource. | ||
| - `region` (String) The STACKIT region name the resource is located in. If not defined, the provider region is used. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `authentication` (Attributes) Dremio instance authentication settings. A change here triggers a Dremio restart and will incur downtime. (see [below for nested schema](#nestedatt--authentication)) | ||
| - `display_name` (String) The display name is a short name chosen by the user to identify the resource. | ||
| - `endpoints` (Attributes) The available endpoints of the Dremio instance. (see [below for nested schema](#nestedatt--endpoints)) | ||
| - `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`region`,`instance_id`". | ||
|
|
||
| <a id="nestedatt--authentication"></a> | ||
| ### Nested Schema for `authentication` | ||
|
|
||
| Optional: | ||
|
|
||
| - `azuread` (Attributes) Azure Active Directory authentication configuration. (see [below for nested schema](#nestedatt--authentication--azuread)) | ||
| - `oauth` (Attributes) OIDC authentication configuration. (see [below for nested schema](#nestedatt--authentication--oauth)) | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `type` (String) Type of authentication (local-only, azuread, oauth). | ||
|
|
||
| <a id="nestedatt--authentication--azuread"></a> | ||
| ### Nested Schema for `authentication.azuread` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `authority_url` (String) The Azure AD authority URL. | ||
| - `client_id` (String) The Azure AD client ID. | ||
| - `client_secret` (String, Sensitive) The Azure AD client secret. | ||
| - `redirect_url` (String) The Azure AD redirect URL. | ||
|
|
||
|
|
||
| <a id="nestedatt--authentication--oauth"></a> | ||
| ### Nested Schema for `authentication.oauth` | ||
|
|
||
| Optional: | ||
|
|
||
| - `parameters` (Attributes List) Any additional parameters the Identity Provider requires. (see [below for nested schema](#nestedatt--authentication--oauth--parameters)) | ||
| - `scope` (String) A list of space-separated scopes. The `openid` scope is always required; other scopes can vary by provider. | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `authority_url` (String) The Issuer location URI, where the OIDC provider configuration can be found. | ||
| - `client_id` (String) The client ID assigned by the Identity Provider. | ||
| - `client_secret` (String, Sensitive) The client secret generated by the Identity Provider. | ||
| - `jwt_claims` (Attributes) Maps fields from the JWT token to fields Dremio requires. (see [below for nested schema](#nestedatt--authentication--oauth--jwt_claims)) | ||
| - `redirect_url` (String) The URL where the Dremio instance is hosted. The URL must match the redirect URL set in the Identity Provider. | ||
|
|
||
| <a id="nestedatt--authentication--oauth--parameters"></a> | ||
| ### Nested Schema for `authentication.oauth.parameters` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `name` (String) Parameter name. | ||
| - `value` (String) Parameter value. | ||
|
|
||
|
|
||
| <a id="nestedatt--authentication--oauth--jwt_claims"></a> | ||
| ### Nested Schema for `authentication.oauth.jwt_claims` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `user_name` (String) Mapped user name claim (e.g. email). | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <a id="nestedatt--endpoints"></a> | ||
| ### Nested Schema for `endpoints` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `arrow_flight` (String) The arrow flight endpoint of the Dremio instance. | ||
| - `catalog` (String) The Apache Iceberg endpoint of the Dremio instance. | ||
| - `ui` (String) The UI endpoint of the Dremio instance. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "stackit_dremio_user Data Source - stackit" | ||
| subcategory: "" | ||
| description: |- | ||
| Manages a STACKIT Dremio instances user. | ||
| ~> This datasource is part of the dremio experiment and is likely going to undergo significant changes or be removed in the future. Use it at your own discretion. | ||
| --- | ||
|
|
||
| # stackit_dremio_user (Data Source) | ||
|
|
||
| Manages a STACKIT Dremio instances user. | ||
|
|
||
| ~> This datasource is part of the dremio experiment and is likely going to undergo significant changes or be removed in the future. Use it at your own discretion. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| data "stackit_dremio_user" "example" { | ||
| project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||
| region = "eu01" | ||
| instance_id = "example-instance-id" | ||
| user_id = "example-user-id" | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `instance_id` (String) The Dremio instance ID. | ||
| - `project_id` (String) STACKIT Project ID to which the resource is associated. | ||
| - `user_id` (String) The Dremio user ID. | ||
|
|
||
| ### Optional | ||
|
|
||
| - `description` (String) The description of the user. | ||
| - `region` (String) The STACKIT region name the resource is located in. If not defined, the provider region is used. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `email` (String) The email address of the user. | ||
| - `first_name` (String) The first name of the user. | ||
| - `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`region`,`instance_id`,`user_id`". | ||
| - `last_name` (String) The last name of the user. | ||
| - `name` (String) The username of the user. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "stackit_dremio_instance Resource - stackit" | ||
| subcategory: "" | ||
| description: |- | ||
| Manages a STACKIT Dremio instance. | ||
| ~> This resource is part of the dremio experiment and is likely going to undergo significant changes or be removed in the future. Use it at your own discretion. | ||
| --- | ||
|
|
||
| # stackit_dremio_instance (Resource) | ||
|
|
||
| Manages a STACKIT Dremio instance. | ||
|
|
||
| ~> This resource is part of the dremio experiment and is likely going to undergo significant changes or be removed in the future. Use it at your own discretion. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| resource "stackit_dremio_instance" "example" { | ||
| project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||
| region = "eu01" | ||
| display_name = "exampleName" | ||
| description = "Example description" | ||
| authentication = { | ||
| type = "local-only" // "oauth" or "azuread" for IDP config | ||
|
|
||
| oauth = { // only needed if "oauth" is given as type | ||
| authority_url = "authority" | ||
| client_id = "client-id" | ||
| client_secret = "client-secret" | ||
| jwt_claims = { | ||
| user_name = "example" | ||
| } | ||
| scope = "idp-scope" | ||
| parameters = [ | ||
| { "name" : "example", "value" : "example-value" } | ||
| ] | ||
| } | ||
|
|
||
| azuread = { // only needed if "azuread" is given as type | ||
| authority_url = "authority" | ||
| client_id = "client-id" | ||
| client_secret = "client-secret" | ||
| } | ||
| } | ||
| } | ||
|
|
||
| import { | ||
| to = stackit_dremio_instance.import_example | ||
| id = "${var.project_id},${var.region},${var.instance_id}" | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `authentication` (Attributes) Dremio instance authentication settings. A change here triggers a Dremio restart and will incur downtime. (see [below for nested schema](#nestedatt--authentication)) | ||
| - `display_name` (String) The display name is a short name chosen by the user to identify the resource. | ||
| - `project_id` (String) STACKIT Project ID to which the resource is associated. | ||
|
|
||
| ### Optional | ||
|
|
||
| - `description` (String) The description is a longer text chosen by the user to provide more context for the resource. | ||
| - `region` (String) The STACKIT region name the resource is located in. If not defined, the provider region is used. | ||
| - `timeouts` (Attributes) (see [below for nested schema](#nestedatt--timeouts)) | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `endpoints` (Attributes) The available endpoints of the Dremio instance. (see [below for nested schema](#nestedatt--endpoints)) | ||
| - `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`region`,`instance_id`". | ||
| - `instance_id` (String) The Dremio instance ID. | ||
|
|
||
| <a id="nestedatt--authentication"></a> | ||
| ### Nested Schema for `authentication` | ||
|
|
||
| Required: | ||
|
|
||
| - `type` (String) Type of authentication (local-only, azuread, oauth). | ||
|
|
||
| Optional: | ||
|
|
||
| - `azuread` (Attributes) Azure Active Directory authentication configuration. (see [below for nested schema](#nestedatt--authentication--azuread)) | ||
| - `oauth` (Attributes) OIDC authentication configuration. (see [below for nested schema](#nestedatt--authentication--oauth)) | ||
|
|
||
| <a id="nestedatt--authentication--azuread"></a> | ||
| ### Nested Schema for `authentication.azuread` | ||
|
|
||
| Required: | ||
|
|
||
| - `authority_url` (String) The Azure AD authority URL. | ||
| - `client_id` (String) The Azure AD client ID. | ||
| - `client_secret` (String, Sensitive) The Azure AD client secret. | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `redirect_url` (String) The Azure AD redirect URL. | ||
|
|
||
|
|
||
| <a id="nestedatt--authentication--oauth"></a> | ||
| ### Nested Schema for `authentication.oauth` | ||
|
|
||
| Required: | ||
|
|
||
| - `authority_url` (String) The Issuer location URI, where the OIDC provider configuration can be found. | ||
| - `client_id` (String) The client ID assigned by the Identity Provider. | ||
| - `client_secret` (String, Sensitive) The client secret generated by the Identity Provider. | ||
| - `jwt_claims` (Attributes) Maps fields from the JWT token to fields Dremio requires. (see [below for nested schema](#nestedatt--authentication--oauth--jwt_claims)) | ||
|
|
||
| Optional: | ||
|
|
||
| - `parameters` (Attributes List) Any additional parameters the Identity Provider requires. (see [below for nested schema](#nestedatt--authentication--oauth--parameters)) | ||
| - `scope` (String) A list of space-separated scopes. The `openid` scope is always required; other scopes can vary by provider. | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `redirect_url` (String) The URL where the Dremio instance is hosted. The URL must match the redirect URL set in the Identity Provider. | ||
|
|
||
| <a id="nestedatt--authentication--oauth--jwt_claims"></a> | ||
| ### Nested Schema for `authentication.oauth.jwt_claims` | ||
|
|
||
| Required: | ||
|
|
||
| - `user_name` (String) Mapped user name claim (e.g. email). | ||
|
|
||
|
|
||
| <a id="nestedatt--authentication--oauth--parameters"></a> | ||
| ### Nested Schema for `authentication.oauth.parameters` | ||
|
|
||
| Required: | ||
|
|
||
| - `name` (String) Parameter name. | ||
| - `value` (String) Parameter value. | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <a id="nestedatt--timeouts"></a> | ||
| ### Nested Schema for `timeouts` | ||
|
|
||
| Optional: | ||
|
|
||
| - `create` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). | ||
| - `delete` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. | ||
| - `read` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled. | ||
| - `update` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). | ||
|
|
||
|
|
||
| <a id="nestedatt--endpoints"></a> | ||
| ### Nested Schema for `endpoints` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `arrow_flight` (String) The arrow flight endpoint of the Dremio instance. | ||
| - `catalog` (String) The Apache Iceberg endpoint of the Dremio instance. | ||
| - `ui` (String) The UI endpoint of the Dremio instance. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.