-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(release|registry): provider naming and docs for registry (#8)
- Loading branch information
Showing
12 changed files
with
158 additions
and
23 deletions.
There are no files selected for viewing
This file contains 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 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,46 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "montecarlo Provider" | ||
| subcategory: "" | ||
| description: |- | ||
| This open-source Terraform provider enables users to seamlessly and quickly integrate the Monte Carlo https://www.montecarlodata.com/ data reliabillity platform into their infrastructure as a code (IaC) workflows. Provider ensures this functionality by communicating with Monte Carlo via its GraphQL API. | ||
| --- | ||
|
|
||
| # montecarlo Provider | ||
|
|
||
| This open-source _Terraform_ provider enables users to seamlessly and quickly integrate the **[Monte Carlo](https://www.montecarlodata.com/)** data reliabillity platform into their infrastructure as a code (IaC) workflows. Provider ensures this functionality by communicating with **Monte Carlo** via its GraphQL API. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| terraform { | ||
| required_providers { | ||
| monte_carlo = { | ||
| source = "kiwicom/montecarlo" | ||
| version = "~> 0.0.1" | ||
| } | ||
| } | ||
| } | ||
| provider "monte_carlo" { | ||
| account_service_key = { | ||
| id = "montecarlo" | ||
| token = "montecarlo" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `account_service_key` (Attributes) Monte Carlo generated **Account Service Key** used to authenticate API calls of this provider. Should not be confused with personal API key. <br><br>For more information: https://docs.getmontecarlo.com/docs/creating-an-api-token#creating-an-api-key <br><br> (see [below for nested schema](#nestedatt--account_service_key)) | ||
|
|
||
| <a id="nestedatt--account_service_key"></a> | ||
| ### Nested Schema for `account_service_key` | ||
|
|
||
| Required: | ||
|
|
||
| - `id` (String, Sensitive) Monte Carlo _Account service key_ **ID**. | ||
| - `token` (String, Sensitive) Monte Carlo _Account service key_ **token**. |
This file contains 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,40 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "montecarlo_bigquery_warehouse Resource - terraform-provider-montecarlo" | ||
| subcategory: "" | ||
| description: |- | ||
| This resource represents the integration of Monte Carlo with BigQuery data warehouse. While this resource is not responsible for handling data access and other operations, such as data filtering, it is responsible for managing the connection to BigQuery using the provided service account key. | ||
| --- | ||
|
|
||
| # montecarlo_bigquery_warehouse (Resource) | ||
|
|
||
| This resource represents the integration of Monte Carlo with BigQuery data warehouse. While this resource is not responsible for handling data access and other operations, such as data filtering, it is responsible for managing the connection to BigQuery using the provided service account key. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| resource "montecarlo_bigquery_warehouse" "example" { | ||
| name = "name" | ||
| data_collector_uuid = "uuid" | ||
| service_account_key = "{}" | ||
| deletion_protection = false | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `data_collector_uuid` (String) Unique identifier of data collector this warehouse will be attached to. Its not possible to change data collectors of already created warehouse, therefore if Terraform detects change in this attribute it will plan recreation (which might not be successfull due to deletion protection flag). Since this property is immutable in Monte Carlo warehouses it can be only changed in the configuration | ||
| - `name` (String) The name of the BigQuery warehouse as it will be presented in Monte Carlo. | ||
| - `service_account_key` (String, Sensitive) Service account key used by the warehouse connection for authentication and authorization against BigQuery. The very same service account is used to grant required permissions to Monte Carlo BigQuery warehouse for the data access. For more information follow Monte Carlo documentation: https://docs.getmontecarlo.com/docs/bigquery | ||
|
|
||
| ### Optional | ||
|
|
||
| - `deletion_protection` (Boolean) Whether or not to allow Terraform to destroy the instance. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply that would delete the instance will fail. This setting will prevent the deletion even if the real resource is already deleted. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `connection_uuid` (String) Unique identifier of connection responsible for communication with BigQuery. | ||
| - `uuid` (String) Unique identifier of warehouse managed by this resource. |
This file contains 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,9 @@ | ||
| # Examples | ||
|
|
||
| This directory contains examples that are mostly used for documentation, but can also be run/tested manually via the Terraform CLI. | ||
|
|
||
| The document generation tool looks for files in the following locations by default. All other *.tf files besides the ones mentioned below are ignored by the documentation tool. This is useful for creating examples that can run and/or ar testable even if some parts are not relevant for the documentation. | ||
|
|
||
| * **provider/provider.tf** example file for the provider index page | ||
| * **data-sources/`full data source name`/data-source.tf** example file for the named data source page | ||
| * **resources/`full resource name`/resource.tf** example file for the named data source page |
This file contains 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,15 @@ | ||
| terraform { | ||
| required_providers { | ||
| monte_carlo = { | ||
| source = "kiwicom/montecarlo" | ||
| version = "~> 0.0.1" | ||
| } | ||
| } | ||
| } | ||
|
|
||
| provider "monte_carlo" { | ||
| account_service_key = { | ||
| id = "montecarlo" | ||
| token = "montecarlo" | ||
| } | ||
| } |
This file contains 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,6 @@ | ||
| resource "montecarlo_bigquery_warehouse" "example" { | ||
| name = "name" | ||
| data_collector_uuid = "uuid" | ||
| service_account_key = "{}" | ||
| deletion_protection = false | ||
| } |
This file contains 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 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 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 |
|---|---|---|
|
|
@@ -5,11 +5,21 @@ import ( | |
| "flag" | ||
| "log" | ||
|
|
||
| "github.com/kiwicom/terraform-provider-monte-carlo/monte_carlo/provider" | ||
| "github.com/kiwicom/terraform-provider-montecarlo/monte_carlo/provider" | ||
|
|
||
| "github.com/hashicorp/terraform-plugin-framework/providerserver" | ||
| ) | ||
|
|
||
| // Run "go generate" to format example terraform files and generate the docs for the registry/website | ||
|
|
||
| // If you do not have terraform installed, you can remove the formatting command, but its suggested to | ||
| // ensure the documentation is formatted properly. | ||
| //go:generate terraform fmt -recursive ./examples/ | ||
|
|
||
| // Run the docs generation tool, check its repository for more information on how it works and how docs | ||
| // can be customized. | ||
| //go:generate go run github.com/hashicorp/terraform-plugin-docs/cmd/[email protected] | ||
|
|
||
| var ( | ||
| // these will be set by the goreleaser configuration | ||
| // to appropriate values for the compiled binary. | ||
|
|
@@ -18,7 +28,7 @@ var ( | |
|
|
||
| func main() { | ||
| flag.Parse() | ||
| opts := providerserver.ServeOpts{Address: "registry.terraform.io/kiwicom/data-platform", Debug: false} | ||
| opts := providerserver.ServeOpts{Address: "registry.terraform.io/kiwicom/montecarlo", Debug: false} | ||
| if err := providerserver.Serve(context.Background(), provider.New(version), opts); err != nil { | ||
| log.Fatal(err.Error()) | ||
| } | ||
|
|
||
This file contains 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 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 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