-
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 #459 from instaclustr/terraform-jenkins-branch-202…
…4-09-10T102406Z terraform-jenkins-branch-2024-09-10T102406Z
- Loading branch information
Showing
9 changed files
with
505 additions
and
3 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
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,62 @@ | ||
| --- | ||
| page_title: "instaclustr_kafka_acl_v3_instance Data Source - terraform-provider-instaclustr" | ||
| subcategory: "" | ||
| description: |- | ||
| --- | ||
|
|
||
| # instaclustr_kafka_acl_v3_instance (Data Source) | ||
| List of access control lists for a Kafka cluster. | ||
| ## Example Usage | ||
| ``` | ||
| data "instaclustr_kafka_acl_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 | ||
| *___id___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <br>Instaclustr identifier for the ACL list for a principal. The value of this property has the form: [clusterId]_[principalUserQuery] | ||
| The user query is the principal value without the leading `User:`.<br><br> | ||
| *___acl___*<br> | ||
| <ins>Type</ins>: repeatable nested block, read-only, see [acl](#nested--acl) for nested schema<br> | ||
| <br>List of ACLs for the given principal.<br><br> | ||
| *___current_operation_status___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <ins>Constraints</ins>: allowed values: [ `NO_OPERATION`, `OPERATION_IN_PROGRESS`, `OPERATION_FAILED` ]<br><br>Indicates if the cluster is currently performing any operation such as being created, updated, or deleted<br><br> | ||
| *___cluster_id___*<br> | ||
| <ins>Type</ins>: string (uuid), read-only<br> | ||
| <br>UUID of the Kafka cluster.<br><br> | ||
| *___user_query___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <br>This is the principal without the `User:` prefix.<br><br> | ||
| <a id="nested--acl"></a> | ||
| ## Nested schema for `acl` | ||
| List of ACLs for the given principal.<br> | ||
| ### Read-only attributes | ||
| *___principal___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <ins>Constraints</ins>: pattern: `^User:.*$`<br><br>Specifies the users(s) for which this ACL applies and can include the wildcard `*`. Valid values must start with "User:" including the wildcard.<br><br> | ||
| *___permission_type___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <ins>Constraints</ins>: allowed values: [ `ALLOW`, `DENY` ]<br><br>Specifies whether to allow or deny the operation.<br><br> | ||
| *___pattern_type___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <ins>Constraints</ins>: allowed values: [ `LITERAL`, `PREFIXED` ]<br><br>Indicates the resource-pattern-type<br><br> | ||
| *___host___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <br>The IP address to which this ACL applies. It takes any string including the wildcard `*` for all IP addresses.<br><br> | ||
| *___resource_name___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <br>Any string that fits the resource name, e.g. topic name if the resource type is TOPIC<br><br> | ||
| *___resource_type___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <ins>Constraints</ins>: allowed values: [ `CLUSTER`, `TOPIC`, `GROUP`, `DELEGATION_TOKEN`, `TRANSACTIONAL_ID` ]<br><br>Specifies the type of resource.<br><br> | ||
| *___operation___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <ins>Constraints</ins>: allowed values: [ `ALL`, `READ`, `WRITE`, `CREATE`, `DELETE`, `ALTER`, `DESCRIBE`, `CLUSTER_ACTION`, `DESCRIBE_CONFIGS`, `ALTER_CONFIGS`, `IDEMPOTENT_WRITE` ]<br><br>The operation that will be allowed or denied.<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,52 @@ | ||
| --- | ||
| page_title: "instaclustr_kafka_topic_v3_instance Data Source - terraform-provider-instaclustr" | ||
| subcategory: "" | ||
| description: |- | ||
| --- | ||
|
|
||
| # instaclustr_kafka_topic_v3_instance (Data Source) | ||
| Definition of a Kafka Topic to be applied to a Kafka cluster. | ||
| ## Example Usage | ||
| ``` | ||
| data "instaclustr_kafka_topic_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 | ||
| *___replication_factor___*<br> | ||
| <ins>Type</ins>: integer, read-only<br> | ||
| <br>Replication factor for Topic<br><br> | ||
| *___id___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <br>Instaclustr identifier for the Kafka topic. The value of this property has the form: [cluster-id]_[kafka-topic]<br><br> | ||
| *___current_operation_status___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <ins>Constraints</ins>: allowed values: [ `NO_OPERATION`, `OPERATION_IN_PROGRESS`, `OPERATION_FAILED` ]<br><br>Indicates if the cluster is currently performing any operation such as being created, updated, or deleted<br><br> | ||
| *___partitions___*<br> | ||
| <ins>Type</ins>: integer, read-only<br> | ||
| <br>Topic partition count<br><br> | ||
| *___topic___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <br>Kafka Topic name<br><br> | ||
| *___cluster_id___*<br> | ||
| <ins>Type</ins>: string (uuid), read-only<br> | ||
| <br>ID of the Kafka cluster<br><br> | ||
| *___configs___*<br> | ||
| <ins>Type</ins>: repeatable nested block, read-only, see [configs](#nested--configs) for nested schema<br> | ||
| <br>List of Kafka topic configs which have non-default values. These could be set by terraform or other methods like kafka cli etc.<br><br> | ||
| <a id="nested--configs"></a> | ||
| ## Nested schema for `configs` | ||
| List of Kafka topic configs which have non-default values. These could be set by terraform or other methods like kafka cli etc.<br> | ||
| ### Read-only attributes | ||
| *___key___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <br>Kafka Topic config key<br><br> | ||
| *___value___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <br>Kafka Topic config value<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,42 @@ | ||
| --- | ||
| page_title: "instaclustr_kafka_user_v5_instance Data Source - terraform-provider-instaclustr" | ||
| subcategory: "" | ||
| description: |- | ||
| --- | ||
|
|
||
| # instaclustr_kafka_user_v5_instance (Data Source) | ||
| Definition of a Kafka User to be applied to a Kafka cluster. | ||
| ## Example Usage | ||
| ``` | ||
| data "instaclustr_kafka_user_v5_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> | ||
| *___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> | ||
| *___current_operation_status___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <ins>Constraints</ins>: allowed values: [ `NO_OPERATION`, `OPERATION_IN_PROGRESS`, `OPERATION_FAILED` ]<br><br>Indicates if the cluster is currently performing any operation such as being created, updated, or deleted<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> |
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,93 @@ | ||
| --- | ||
| page_title: "instaclustr_kafka_acl_v3 Resource - terraform-provider-instaclustr" | ||
| subcategory: "" | ||
| description: |- | ||
| --- | ||
|
|
||
| # instaclustr_kafka_acl_v3 (Resource) | ||
| List of access control lists for a Kafka cluster. | ||
| ## Example Usage | ||
| ``` | ||
| resource "instaclustr_kafka_acl_v3" "example" { | ||
| acl { | ||
| host = "*" | ||
| operation = "DESCRIBE" | ||
| pattern_type = "LITERAL" | ||
| permission_type = "ALLOW" | ||
| principal = "User:test" | ||
| resource_name = "kafka-cluster" | ||
| resource_type = "CLUSTER" | ||
| } | ||
| acl { | ||
| host = "*" | ||
| operation = "CREATE" | ||
| pattern_type = "PREFIXED" | ||
| permission_type = "ALLOW" | ||
| principal = "User:test" | ||
| resource_name = "kafka-topic" | ||
| resource_type = "TOPIC" | ||
| } | ||
| user_query = "test" | ||
| cluster_id = "c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37" | ||
| } | ||
| ``` | ||
| ## 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 | ||
| *___acl___*<br> | ||
| <ins>Type</ins>: repeatable nested block, required, updatable, see [acl](#nested--acl) for nested schema<br> | ||
| <br>List of ACLs for the given principal.<br><br> | ||
| *___cluster_id___*<br> | ||
| <ins>Type</ins>: string (uuid), required, immutable<br> | ||
| <br>UUID of the Kafka cluster.<br><br> | ||
| *___user_query___*<br> | ||
| <ins>Type</ins>: string, required, immutable<br> | ||
| <br>This is the principal without the `User:` prefix.<br><br> | ||
| ### Read-only attributes | ||
| *___id___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <br>Instaclustr identifier for the ACL list for a principal. The value of this property has the form: [clusterId]_[principalUserQuery] | ||
| The user query is the principal value without the leading `User:`.<br><br> | ||
| *___current_operation_status___*<br> | ||
| <ins>Type</ins>: string, read-only<br> | ||
| <ins>Constraints</ins>: allowed values: [ `NO_OPERATION`, `OPERATION_IN_PROGRESS`, `OPERATION_FAILED` ]<br><br>Indicates if the cluster is currently performing any operation such as being created, updated, or deleted<br><br> | ||
| <a id="nested--acl"></a> | ||
| ## Nested schema for `acl` | ||
| List of ACLs for the given principal.<br> | ||
| ### Input attributes - Required | ||
| *___principal___*<br> | ||
| <ins>Type</ins>: string, required, updatable<br> | ||
| <ins>Constraints</ins>: pattern: `^User:.*$`<br><br>Specifies the users(s) for which this ACL applies and can include the wildcard `*`. Valid values must start with "User:" including the wildcard.<br><br> | ||
| *___permission_type___*<br> | ||
| <ins>Type</ins>: string, required, updatable<br> | ||
| <ins>Constraints</ins>: allowed values: [ `ALLOW`, `DENY` ]<br><br>Specifies whether to allow or deny the operation.<br><br> | ||
| *___pattern_type___*<br> | ||
| <ins>Type</ins>: string, required, updatable<br> | ||
| <ins>Constraints</ins>: allowed values: [ `LITERAL`, `PREFIXED` ]<br><br>Indicates the resource-pattern-type<br><br> | ||
| *___host___*<br> | ||
| <ins>Type</ins>: string, required, updatable<br> | ||
| <br>The IP address to which this ACL applies. It takes any string including the wildcard `*` for all IP addresses.<br><br> | ||
| *___resource_name___*<br> | ||
| <ins>Type</ins>: string, required, updatable<br> | ||
| <br>Any string that fits the resource name, e.g. topic name if the resource type is TOPIC<br><br> | ||
| *___resource_type___*<br> | ||
| <ins>Type</ins>: string, required, updatable<br> | ||
| <ins>Constraints</ins>: allowed values: [ `CLUSTER`, `TOPIC`, `GROUP`, `DELEGATION_TOKEN`, `TRANSACTIONAL_ID` ]<br><br>Specifies the type of resource.<br><br> | ||
| *___operation___*<br> | ||
| <ins>Type</ins>: string, required, updatable<br> | ||
| <ins>Constraints</ins>: allowed values: [ `ALL`, `READ`, `WRITE`, `CREATE`, `DELETE`, `ALTER`, `DESCRIBE`, `CLUSTER_ACTION`, `DESCRIBE_CONFIGS`, `ALTER_CONFIGS`, `IDEMPOTENT_WRITE` ]<br><br>The operation that will be allowed or denied.<br><br> | ||
| ## Import | ||
| This resource can be imported using the `terraform import` command as follows: | ||
| ``` | ||
| terraform import instaclustr_kafka_acl_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. |
Oops, something went wrong.