-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #443 from instaclustr/terraform-jenkins-branch-202…
…4-06-28T102405Z terraform-jenkins-branch-2024-06-28T102405Z
- Loading branch information
Showing
5 changed files
with
240 additions
and
1 deletion.
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,54 @@ | ||
| --- | ||
| page_title: "instaclustr_kafka_user_v2_instance Data Source - terraform-provider-instaclustr" | ||
| subcategory: "" | ||
| description: |- | ||
| --- | ||
|
|
||
| # instaclustr_kafka_user_v2_instance (Data Source) | ||
| Deprecated. Use <a href="https://registry.terraform.io/providers/instaclustr/instaclustr/latest/docs/resources/kafka_user_v4"> instaclustr_kafka_user_v4</a> instead. | ||
|
|
||
| Definition of a Kafka User to be applied to a Kafka cluster. | ||
| ## Example Usage | ||
| ``` | ||
| data "instaclustr_kafka_user_v2_instance" "example" { | ||
| id = "<id>" // the value of the `id` attribute defined in the root schema below | ||
| } | ||
| ``` | ||
| ## Glossary | ||
| The following terms are used to describe attributes in the schema of this data source: | ||
| - **_read-only_** - These are attributes that can only be read and not provided as an input to the data source. | ||
| - **_required_** - These attributes must be provided for the data source's information to be queried. | ||
| - **_nested block_** - These attributes use the [Terraform block syntax](https://www.terraform.io/language/attr-as-blocks) when defined as an input in the Terraform code. Attributes with the type **_repeatable nested block_** are the same except that the nested block can be defined multiple times with varying nested attributes. When reading nested block attributes, an index must be provided when accessing the contents of the nested block, example - `my_resource.nested_block_attribute[0].nested_attribute`. | ||
| ## Root Level Schema | ||
| ### Read-only attributes | ||
| *___auth_mechanism___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <ins>Constraints</ins>: allowed values: [ `MTLS`, `SASL` ]<br><br>Authentication mechanisms supported for KafkaClusters.<br><br> | ||
| *___options___*<br> | ||
| <ins>Type</ins>: nested object, read-only, see [options](#nested--options) for nested schema<br> | ||
| <br>Initial options used when creating Kafka user<br><br> | ||
| *___username___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <ins>Constraints</ins>: pattern: `^(?![zZ][oO][oO][kK][eE][eE][pP][eE][rR]$)[a-zA-Z0-9][a-zA-Z0-9_-]*$`<br><br>Username of the Kafka user.<br><br> | ||
| *___id___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <br>Instaclustr identifier for the Kafka user. The value of this property has the form: [cluster-id]_[kafka-username]<br><br> | ||
| *___cluster_id___*<br> | ||
| <ins>Type</ins>: string (uuid), read-only<br> | ||
| <br>ID of the Kafka cluster.<br><br> | ||
| *___password___*<br> | ||
| <ins>Type</ins>: string (password), read-only<br> | ||
| <br>Password for the Kafka user.<br><br> | ||
| *___initial_permissions___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <ins>Constraints</ins>: allowed values: [ `standard`, `read-only`, `none` ]<br><br>Permissions initially granted to Kafka user upon creation.<br><br> | ||
| <a id="nested--options"></a> | ||
| ## Nested schema for `options` | ||
| Initial options used when creating Kafka user<br> | ||
| ### Read-only attributes | ||
| *___override_existing_user___*<br> | ||
| <ins>Type</ins>: boolean, read-only<br> | ||
| <br>Overwrite user if already exists.<br><br> | ||
| *___sasl_scram_mechanism___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <br>Scram Mechanism for SASL authentication. Valid values: SCRAM-SHA-256, SCRAM-SHA-512<br><br> |
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,47 @@ | ||
| --- | ||
| page_title: "instaclustr_kafka_user_v3_instance Data Source - terraform-provider-instaclustr" | ||
| subcategory: "" | ||
| description: |- | ||
| --- | ||
|
|
||
| # instaclustr_kafka_user_v3_instance (Data Source) | ||
| Deprecated. Use <a href="https://registry.terraform.io/providers/instaclustr/instaclustr/latest/docs/resources/kafka_user_v4"> instaclustr_kafka_user_v4</a> instead. | ||
|
|
||
| Definition of a Kafka User to be applied to a Kafka cluster. | ||
| ## Example Usage | ||
| ``` | ||
| data "instaclustr_kafka_user_v3_instance" "example" { | ||
| id = "<id>" // the value of the `id` attribute defined in the root schema below | ||
| } | ||
| ``` | ||
| ## Glossary | ||
| The following terms are used to describe attributes in the schema of this data source: | ||
| - **_read-only_** - These are attributes that can only be read and not provided as an input to the data source. | ||
| - **_required_** - These attributes must be provided for the data source's information to be queried. | ||
| - **_nested block_** - These attributes use the [Terraform block syntax](https://www.terraform.io/language/attr-as-blocks) when defined as an input in the Terraform code. Attributes with the type **_repeatable nested block_** are the same except that the nested block can be defined multiple times with varying nested attributes. When reading nested block attributes, an index must be provided when accessing the contents of the nested block, example - `my_resource.nested_block_attribute[0].nested_attribute`. | ||
| ## Root Level Schema | ||
| ### Read-only attributes | ||
| *___auth_mechanism___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <ins>Constraints</ins>: allowed values: [ `MTLS`, `SASL` ]<br><br>Authentication mechanisms supported for KafkaClusters.<br><br> | ||
| *___override_existing_user___*<br> | ||
| <ins>Type</ins>: boolean, read-only<br> | ||
| <br>Overwrite user if already exists.<br><br> | ||
| *___username___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <ins>Constraints</ins>: pattern: `^(?![zZ][oO][oO][kK][eE][eE][pP][eE][rR]$)[a-zA-Z0-9][a-zA-Z0-9_-]*$`<br><br>Username of the Kafka user.<br><br> | ||
| *___id___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <br>Instaclustr identifier for the Kafka user. The value of this property has the form: [cluster-id]_[kafka-username]<br><br> | ||
| *___cluster_id___*<br> | ||
| <ins>Type</ins>: string (uuid), read-only<br> | ||
| <br>ID of the Kafka cluster.<br><br> | ||
| *___sasl_scram_mechanism___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <br>Scram Mechanism for SASL authentication. Valid values: SCRAM-SHA-256, SCRAM-SHA-512<br><br> | ||
| *___password___*<br> | ||
| <ins>Type</ins>: string (password), read-only<br> | ||
| <br>Password for the Kafka user.<br><br> | ||
| *___initial_permissions___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <ins>Constraints</ins>: allowed values: [ `standard`, `read-only`, `none` ]<br><br>Permissions initially granted to Kafka user upon creation.<br><br> |
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,74 @@ | ||
| --- | ||
| page_title: "instaclustr_kafka_user_v2 Resource - terraform-provider-instaclustr" | ||
| subcategory: "" | ||
| description: |- | ||
| --- | ||
|
|
||
| # instaclustr_kafka_user_v2 (Resource) | ||
| Deprecated. Use <a href="https://registry.terraform.io/providers/instaclustr/instaclustr/latest/docs/resources/kafka_user_v4"> instaclustr_kafka_user_v4</a> instead. | ||
|
|
||
| Definition of a Kafka User to be applied to a Kafka cluster. | ||
| ## Example Usage | ||
| ``` | ||
| resource "instaclustr_kafka_user_v2" "example" { | ||
| password = "myPassword1." | ||
| options { | ||
| override_existing_user = false | ||
| sasl_scram_mechanism = "SCRAM-SHA-256" | ||
| } | ||
| cluster_id = "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37" | ||
| initial_permissions = "standard" | ||
| username = "myKafkaUser" | ||
| } | ||
| ``` | ||
| ## Glossary | ||
| The following terms are used to describe attributes in the schema of this resource: | ||
| - **_read-only_** - These are attributes that can only be read and not provided as an input to the resource. | ||
| - **_required_** - These attributes must be provided for the resource to be created. | ||
| - **_optional_** - These input attributes can be omitted, and doing so may result in a default value being used. | ||
| - **_immutable_** - These are input attributes that cannot be changed after the resource is created. | ||
| - **_updatable_** - These input attributes can be updated to a different value if needed, and doing so will trigger an update operation. | ||
| - **_nested block_** - These attributes use the [Terraform block syntax](https://www.terraform.io/language/attr-as-blocks) when defined as an input in the Terraform code. Attributes with the type **_repeatable nested block_** are the same except that the nested block can be defined multiple times with varying nested attributes. When reading nested block attributes, an index must be provided when accessing the contents of the nested block, example - `my_resource.nested_block_attribute[0].nested_attribute`. | ||
| ## Root Level Schema | ||
| ### Input attributes - Required | ||
| *___options___*<br> | ||
| <ins>Type</ins>: nested object, required, immutable, see [options](#nested--options) for nested schema<br> | ||
| <br>Initial options used when creating Kafka user<br><br> | ||
| *___username___*<br> | ||
| <ins>Type</ins>: string, required, immutable<br> | ||
| <ins>Constraints</ins>: pattern: `^(?![zZ][oO][oO][kK][eE][eE][pP][eE][rR]$)[a-zA-Z0-9][a-zA-Z0-9_-]*$`<br><br>Username of the Kafka user.<br><br> | ||
| *___cluster_id___*<br> | ||
| <ins>Type</ins>: string (uuid), required, immutable<br> | ||
| <br>ID of the Kafka cluster.<br><br> | ||
| *___password___*<br> | ||
| <ins>Type</ins>: string (password), required, updatable<br> | ||
| <br>Password for the Kafka user.<br><br> | ||
| *___initial_permissions___*<br> | ||
| <ins>Type</ins>: string, required, immutable<br> | ||
| <ins>Constraints</ins>: allowed values: [ `standard`, `read-only`, `none` ]<br><br>Permissions initially granted to Kafka user upon creation.<br><br> | ||
| ### Input attributes - Optional | ||
| *___auth_mechanism___*<br> | ||
| <ins>Type</ins>: string, optional, updatable<br> | ||
| <ins>Constraints</ins>: allowed values: [ `MTLS`, `SASL` ]<br><br>Authentication mechanisms supported for KafkaClusters.<br><br> | ||
| ### Read-only attributes | ||
| *___id___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <br>Instaclustr identifier for the Kafka user. The value of this property has the form: [cluster-id]_[kafka-username]<br><br> | ||
| <a id="nested--options"></a> | ||
| ## Nested schema for `options` | ||
| Initial options used when creating Kafka user<br> | ||
| ### Input attributes - Required | ||
| *___sasl_scram_mechanism___*<br> | ||
| <ins>Type</ins>: string, required, updatable<br> | ||
| <br>Scram Mechanism for SASL authentication. Valid values: SCRAM-SHA-256, SCRAM-SHA-512<br><br> | ||
| ### Input attributes - Optional | ||
| *___override_existing_user___*<br> | ||
| <ins>Type</ins>: boolean, optional, immutable<br> | ||
| <br>Overwrite user if already exists.<br><br> | ||
| ## Import | ||
| This resource can be imported using the `terraform import` command as follows: | ||
| ``` | ||
| terraform import instaclustr_kafka_user_v2.[resource-name] "[resource-id]" | ||
| ``` | ||
| `[resource-id]` is the unique identifier for this resource matching the value of the `id` attribute defined in the root schema above. |
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,64 @@ | ||
| --- | ||
| page_title: "instaclustr_kafka_user_v3 Resource - terraform-provider-instaclustr" | ||
| subcategory: "" | ||
| description: |- | ||
| --- | ||
|
|
||
| # instaclustr_kafka_user_v3 (Resource) | ||
| Deprecated. Use <a href="https://registry.terraform.io/providers/instaclustr/instaclustr/latest/docs/resources/kafka_user_v4"> instaclustr_kafka_user_v4</a> instead. | ||
|
|
||
| Definition of a Kafka User to be applied to a Kafka cluster. | ||
| ## Example Usage | ||
| ``` | ||
| resource "instaclustr_kafka_user_v3" "example" { | ||
| password = "myPassword1." | ||
| override_existing_user = false | ||
| sasl_scram_mechanism = "SCRAM-SHA-256" | ||
| auth_mechanism = "SASL" | ||
| cluster_id = "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37" | ||
| initial_permissions = "standard" | ||
| username = "myKafkaUser" | ||
| } | ||
| ``` | ||
| ## Glossary | ||
| The following terms are used to describe attributes in the schema of this resource: | ||
| - **_read-only_** - These are attributes that can only be read and not provided as an input to the resource. | ||
| - **_required_** - These attributes must be provided for the resource to be created. | ||
| - **_optional_** - These input attributes can be omitted, and doing so may result in a default value being used. | ||
| - **_immutable_** - These are input attributes that cannot be changed after the resource is created. | ||
| - **_updatable_** - These input attributes can be updated to a different value if needed, and doing so will trigger an update operation. | ||
| - **_nested block_** - These attributes use the [Terraform block syntax](https://www.terraform.io/language/attr-as-blocks) when defined as an input in the Terraform code. Attributes with the type **_repeatable nested block_** are the same except that the nested block can be defined multiple times with varying nested attributes. When reading nested block attributes, an index must be provided when accessing the contents of the nested block, example - `my_resource.nested_block_attribute[0].nested_attribute`. | ||
| ## Root Level Schema | ||
| ### Input attributes - Required | ||
| *___auth_mechanism___*<br> | ||
| <ins>Type</ins>: string, required, updatable<br> | ||
| <ins>Constraints</ins>: allowed values: [ `MTLS`, `SASL` ]<br><br>Authentication mechanisms supported for KafkaClusters.<br><br> | ||
| *___username___*<br> | ||
| <ins>Type</ins>: string, required, immutable<br> | ||
| <ins>Constraints</ins>: pattern: `^(?![zZ][oO][oO][kK][eE][eE][pP][eE][rR]$)[a-zA-Z0-9][a-zA-Z0-9_-]*$`<br><br>Username of the Kafka user.<br><br> | ||
| *___cluster_id___*<br> | ||
| <ins>Type</ins>: string (uuid), required, immutable<br> | ||
| <br>ID of the Kafka cluster.<br><br> | ||
| *___initial_permissions___*<br> | ||
| <ins>Type</ins>: string, required, immutable<br> | ||
| <ins>Constraints</ins>: allowed values: [ `standard`, `read-only`, `none` ]<br><br>Permissions initially granted to Kafka user upon creation.<br><br> | ||
| ### Input attributes - Optional | ||
| *___override_existing_user___*<br> | ||
| <ins>Type</ins>: boolean, optional, immutable<br> | ||
| <br>Overwrite user if already exists.<br><br> | ||
| *___sasl_scram_mechanism___*<br> | ||
| <ins>Type</ins>: string, optional, updatable<br> | ||
| <br>Scram Mechanism for SASL authentication. Valid values: SCRAM-SHA-256, SCRAM-SHA-512<br><br> | ||
| *___password___*<br> | ||
| <ins>Type</ins>: string (password), optional, updatable<br> | ||
| <br>Password for the Kafka user.<br><br> | ||
| ### Read-only attributes | ||
| *___id___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <br>Instaclustr identifier for the Kafka user. The value of this property has the form: [cluster-id]_[kafka-username]<br><br> | ||
| ## Import | ||
| This resource can be imported using the `terraform import` command as follows: | ||
| ``` | ||
| terraform import instaclustr_kafka_user_v3.[resource-name] "[resource-id]" | ||
| ``` | ||
| `[resource-id]` is the unique identifier for this resource matching the value of the `id` attribute defined in the root schema above. |