From 11875602b824d3081cf079e94ed3bb8e9d2ae8d1 Mon Sep 17 00:00:00 2001 From: Christopher Paul <110468225+derchrisp@users.noreply.github.com> Date: Tue, 28 Jan 2025 16:03:35 +0100 Subject: [PATCH] Fix/logme params and update examples in dsa service docs (#644) * APL-204: remove syslog use udp field from logme due to wrong implementation * APL-208: update examples and regenerate logs * fix linting error * remove syslog-use-udp field from test * re-generate docs * remove doc changes that were generated by make command * remove doc changes that were generated by make command * remove doc changes that were generated by make command * remove doc changes that were generated by make command * remove doc changes that were generated by make command * remove doc changes that were generated by make command * remove doc changes that were generated by make command --- docs/data-sources/logme_instance.md | 1 - docs/data-sources/resourcemanager_project.md | 2 +- docs/resources/logme_instance.md | 7 +++---- docs/resources/mariadb_instance.md | 6 +++--- docs/resources/opensearch_instance.md | 6 +++--- docs/resources/rabbitmq_instance.md | 8 ++++---- docs/resources/redis_instance.md | 8 ++++---- docs/resources/resourcemanager_project.md | 2 +- examples/resources/stackit_logme_instance/resource.tf | 6 +++--- .../resources/stackit_mariadb_instance/resource.tf | 6 +++--- .../resources/stackit_opensearch_instance/resource.tf | 6 +++--- .../resources/stackit_rabbitmq_instance/resource.tf | 8 ++++---- examples/resources/stackit_redis_instance/resource.tf | 8 ++++---- stackit/internal/services/logme/instance/datasource.go | 5 ----- stackit/internal/services/logme/instance/resource.go | 10 ---------- .../internal/services/logme/instance/resource_test.go | 3 --- 16 files changed, 36 insertions(+), 56 deletions(-) diff --git a/docs/data-sources/logme_instance.md b/docs/data-sources/logme_instance.md index 2a48bf06..bd29872c 100644 --- a/docs/data-sources/logme_instance.md +++ b/docs/data-sources/logme_instance.md @@ -68,4 +68,3 @@ Read-Only: - `opensearch_tls_protocols` (List of String) - `sgw_acl` (String) Comma separated list of IP networks in CIDR notation which are allowed to access this instance. - `syslog` (List of String) List of syslog servers to send logs to. -- `syslog_use_udp` (String) diff --git a/docs/data-sources/resourcemanager_project.md b/docs/data-sources/resourcemanager_project.md index 9fdabecd..b1db34f9 100644 --- a/docs/data-sources/resourcemanager_project.md +++ b/docs/data-sources/resourcemanager_project.md @@ -33,4 +33,4 @@ data "stackit_resourcemanager_project" "example" { - `id` (String) Terraform's internal data source. ID. It is structured as "`container_id`". - `labels` (Map of String) Labels are key-value string pairs which can be attached to a resource container. A label key must match the regex [A-ZÄÜÖa-zäüöß0-9_-]{1,64}. A label value must match the regex ^$|[A-ZÄÜÖa-zäüöß0-9_-]{1,64} - `name` (String) Project name. -- `parent_container_id` (String) Parent resource identifier. Both container ID (user-friendly) and UUID are supported +- `parent_container_id` (String) Parent resource identifier. Both container ID (user-friendly) and UUID are supported \ No newline at end of file diff --git a/docs/resources/logme_instance.md b/docs/resources/logme_instance.md index b5f9e720..b4b99ea0 100644 --- a/docs/resources/logme_instance.md +++ b/docs/resources/logme_instance.md @@ -16,10 +16,10 @@ LogMe instance resource schema. Must have a `region` specified in the provider c resource "stackit_logme_instance" "example" { project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" name = "example-instance" - version = "10" - plan_name = "example-plan-name" + version = "2" + plan_name = "stackit-logme2-1.2.50-replica" parameters = { - sgw_acl = "x.x.x.x/x,y.y.y.y/y" + sgw_acl = "193.148.160.0/19,45.129.40.0/21,45.135.244.0/22" } } ``` @@ -76,4 +76,3 @@ Optional: - `opensearch_tls_protocols` (List of String) - `sgw_acl` (String) Comma separated list of IP networks in CIDR notation which are allowed to access this instance. - `syslog` (List of String) List of syslog servers to send logs to. -- `syslog_use_udp` (String) diff --git a/docs/resources/mariadb_instance.md b/docs/resources/mariadb_instance.md index ebb71dea..6b02b09d 100644 --- a/docs/resources/mariadb_instance.md +++ b/docs/resources/mariadb_instance.md @@ -16,10 +16,10 @@ MariaDB instance resource schema. Must have a `region` specified in the provider resource "stackit_mariadb_instance" "example" { project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" name = "example-instance" - version = "10" - plan_name = "example-plan-name" + version = "10.11" + plan_name = "stackit-mariadb-1.2.10-replica" parameters = { - sgw_acl = "x.x.x.x/x,y.y.y.y/y" + sgw_acl = "193.148.160.0/19,45.129.40.0/21,45.135.244.0/22" } } ``` diff --git a/docs/resources/opensearch_instance.md b/docs/resources/opensearch_instance.md index ce10d2f5..267f005b 100644 --- a/docs/resources/opensearch_instance.md +++ b/docs/resources/opensearch_instance.md @@ -16,10 +16,10 @@ OpenSearch instance resource schema. Must have a `region` specified in the provi resource "stackit_opensearch_instance" "example" { project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" name = "example-instance" - version = "10" - plan_name = "example-plan-name" + version = "2" + plan_name = "stackit-opensearch-1.2.10-replica" parameters = { - sgw_acl = "x.x.x.x/x,y.y.y.y/y" + sgw_acl = "193.148.160.0/19,45.129.40.0/21,45.135.244.0/22" } } ``` diff --git a/docs/resources/rabbitmq_instance.md b/docs/resources/rabbitmq_instance.md index 256ff0ec..65a26ba8 100644 --- a/docs/resources/rabbitmq_instance.md +++ b/docs/resources/rabbitmq_instance.md @@ -16,13 +16,13 @@ RabbitMQ instance resource schema. Must have a `region` specified in the provide resource "stackit_rabbitmq_instance" "example" { project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" name = "example-instance" - version = "10" - plan_name = "example-plan-name" + version = "3.13" + plan_name = "stackit-rabbitmq-1.2.10-replica" parameters = { - sgw_acl = "x.x.x.x/x,y.y.y.y/y" + sgw_acl = "193.148.160.0/19,45.129.40.0/21,45.135.244.0/22" consumer_timeout = 18000000 enable_monitoring = false - plugins = ["example-plugin1", "example-plugin2"] + plugins = ["rabbitmq_consistent_hash_exchange", "rabbitmq_federation", "rabbitmq_tracing"] } } ``` diff --git a/docs/resources/redis_instance.md b/docs/resources/redis_instance.md index cad3c760..8c22b860 100644 --- a/docs/resources/redis_instance.md +++ b/docs/resources/redis_instance.md @@ -16,13 +16,13 @@ Redis instance resource schema. Must have a `region` specified in the provider c resource "stackit_redis_instance" "example" { project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" name = "example-instance" - version = "10" - plan_name = "example-plan-name" + version = "7" + plan_name = "stackit-redis-1.2.10-replica" parameters = { - sgw_acl = "x.x.x.x/x,y.y.y.y/y" + sgw_acl = "193.148.160.0/19,45.129.40.0/21,45.135.244.0/22" enable_monitoring = false down_after_milliseconds = 30000 - syslog = ["syslog.example.com:514"] + syslog = ["logs4.your-syslog-endpoint.com:54321"] } } ``` diff --git a/docs/resources/resourcemanager_project.md b/docs/resources/resourcemanager_project.md index b64b4e5f..eb9f0555 100644 --- a/docs/resources/resourcemanager_project.md +++ b/docs/resources/resourcemanager_project.md @@ -40,4 +40,4 @@ resource "stackit_resourcemanager_project" "example" { - `container_id` (String) Project container ID. Globally unique, user-friendly identifier. - `id` (String) Terraform's internal resource ID. It is structured as "`container_id`". -- `project_id` (String) Project UUID identifier. This is the ID that can be used in most of the other resources to identify the project. +- `project_id` (String) Project UUID identifier. This is the ID that can be used in most of the other resources to identify the project. \ No newline at end of file diff --git a/examples/resources/stackit_logme_instance/resource.tf b/examples/resources/stackit_logme_instance/resource.tf index cca2e065..f53f2c6a 100644 --- a/examples/resources/stackit_logme_instance/resource.tf +++ b/examples/resources/stackit_logme_instance/resource.tf @@ -1,9 +1,9 @@ resource "stackit_logme_instance" "example" { project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" name = "example-instance" - version = "10" - plan_name = "example-plan-name" + version = "2" + plan_name = "stackit-logme2-1.2.50-replica" parameters = { - sgw_acl = "x.x.x.x/x,y.y.y.y/y" + sgw_acl = "193.148.160.0/19,45.129.40.0/21,45.135.244.0/22" } } diff --git a/examples/resources/stackit_mariadb_instance/resource.tf b/examples/resources/stackit_mariadb_instance/resource.tf index b0b363f1..fe6bafd2 100644 --- a/examples/resources/stackit_mariadb_instance/resource.tf +++ b/examples/resources/stackit_mariadb_instance/resource.tf @@ -1,9 +1,9 @@ resource "stackit_mariadb_instance" "example" { project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" name = "example-instance" - version = "10" - plan_name = "example-plan-name" + version = "10.11" + plan_name = "stackit-mariadb-1.2.10-replica" parameters = { - sgw_acl = "x.x.x.x/x,y.y.y.y/y" + sgw_acl = "193.148.160.0/19,45.129.40.0/21,45.135.244.0/22" } } diff --git a/examples/resources/stackit_opensearch_instance/resource.tf b/examples/resources/stackit_opensearch_instance/resource.tf index 83217d73..85ab9273 100644 --- a/examples/resources/stackit_opensearch_instance/resource.tf +++ b/examples/resources/stackit_opensearch_instance/resource.tf @@ -1,9 +1,9 @@ resource "stackit_opensearch_instance" "example" { project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" name = "example-instance" - version = "10" - plan_name = "example-plan-name" + version = "2" + plan_name = "stackit-opensearch-1.2.10-replica" parameters = { - sgw_acl = "x.x.x.x/x,y.y.y.y/y" + sgw_acl = "193.148.160.0/19,45.129.40.0/21,45.135.244.0/22" } } diff --git a/examples/resources/stackit_rabbitmq_instance/resource.tf b/examples/resources/stackit_rabbitmq_instance/resource.tf index 82545a2d..7894f80a 100644 --- a/examples/resources/stackit_rabbitmq_instance/resource.tf +++ b/examples/resources/stackit_rabbitmq_instance/resource.tf @@ -1,12 +1,12 @@ resource "stackit_rabbitmq_instance" "example" { project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" name = "example-instance" - version = "10" - plan_name = "example-plan-name" + version = "3.13" + plan_name = "stackit-rabbitmq-1.2.10-replica" parameters = { - sgw_acl = "x.x.x.x/x,y.y.y.y/y" + sgw_acl = "193.148.160.0/19,45.129.40.0/21,45.135.244.0/22" consumer_timeout = 18000000 enable_monitoring = false - plugins = ["example-plugin1", "example-plugin2"] + plugins = ["rabbitmq_consistent_hash_exchange", "rabbitmq_federation", "rabbitmq_tracing"] } } diff --git a/examples/resources/stackit_redis_instance/resource.tf b/examples/resources/stackit_redis_instance/resource.tf index 265e3431..6fbc60b1 100644 --- a/examples/resources/stackit_redis_instance/resource.tf +++ b/examples/resources/stackit_redis_instance/resource.tf @@ -1,12 +1,12 @@ resource "stackit_redis_instance" "example" { project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" name = "example-instance" - version = "10" - plan_name = "example-plan-name" + version = "7" + plan_name = "stackit-redis-1.2.10-replica" parameters = { - sgw_acl = "x.x.x.x/x,y.y.y.y/y" + sgw_acl = "193.148.160.0/19,45.129.40.0/21,45.135.244.0/22" enable_monitoring = false down_after_milliseconds = 30000 - syslog = ["syslog.example.com:514"] + syslog = ["logs4.your-syslog-endpoint.com:54321"] } } diff --git a/stackit/internal/services/logme/instance/datasource.go b/stackit/internal/services/logme/instance/datasource.go index 7b2daf81..b7b344ea 100644 --- a/stackit/internal/services/logme/instance/datasource.go +++ b/stackit/internal/services/logme/instance/datasource.go @@ -100,7 +100,6 @@ func (r *instanceDataSource) Schema(_ context.Context, _ datasource.SchemaReques "ism_deletion_after": "Combination of an integer and a timerange when an index will be considered \"old\" and can be deleted. Possible values for the timerange are `s`, `m`, `h` and `d`.", "ism_job_interval": "Jitter of the execution time.", "syslog": "List of syslog servers to send logs to.", - "syslog-use-udp": "Defines if syslog will use UDP. Possible values: `yes`, `no`.", "opensearch-tls-ciphers": "List of ciphers to use for TLS.", } @@ -236,10 +235,6 @@ func (r *instanceDataSource) Schema(_ context.Context, _ datasource.SchemaReques ElementType: types.StringType, Computed: true, }, - "syslog_use_udp": schema.StringAttribute{ - Description: parametersDescriptions["syslog_use_udp"], - Computed: true, - }, }, Computed: true, }, diff --git a/stackit/internal/services/logme/instance/resource.go b/stackit/internal/services/logme/instance/resource.go index 3e4119c8..31e831bd 100644 --- a/stackit/internal/services/logme/instance/resource.go +++ b/stackit/internal/services/logme/instance/resource.go @@ -76,7 +76,6 @@ type parametersModel struct { OpensearchTlsCiphers types.List `tfsdk:"opensearch_tls_ciphers"` OpensearchTlsProtocols types.List `tfsdk:"opensearch_tls_protocols"` Syslog types.List `tfsdk:"syslog"` - SyslogUseUdp types.String `tfsdk:"syslog_use_udp"` // Deprecated } // Types corresponding to parametersModel @@ -103,7 +102,6 @@ var parametersTypes = map[string]attr.Type{ "opensearch_tls_ciphers": basetypes.ListType{ElemType: types.StringType}, "opensearch_tls_protocols": basetypes.ListType{ElemType: types.StringType}, "syslog": basetypes.ListType{ElemType: types.StringType}, - "syslog_use_udp": basetypes.StringType{}, // Deprecated } // NewInstanceResource is a helper function to simplify the provider implementation. @@ -184,7 +182,6 @@ func (r *instanceResource) Schema(_ context.Context, _ resource.SchemaRequest, r "ism_deletion_after": "Combination of an integer and a timerange when an index will be considered \"old\" and can be deleted. Possible values for the timerange are `s`, `m`, `h` and `d`.", "ism_job_interval": "Jitter of the execution time.", "syslog": "List of syslog servers to send logs to.", - "syslog-use-udp": "Defines if syslog will use UDP. Possible values: `yes`, `no`.", "opensearch-tls-ciphers": "List of ciphers to use for TLS.", } @@ -364,12 +361,6 @@ func (r *instanceResource) Schema(_ context.Context, _ resource.SchemaRequest, r Optional: true, Computed: true, }, - "syslog_use_udp": schema.StringAttribute{ - Description: parametersDescriptions["syslog_use_udp"], - Optional: true, - Computed: true, - DeprecationMessage: "The `syslog_use_udp` field has been deprecated because it is not required. Will be removed after July 22th 2025.", - }, }, Optional: true, Computed: true, @@ -690,7 +681,6 @@ func mapParameters(params map[string]interface{}) (types.Object, error) { "fluentd_udp", "opensearch_tls_ciphers", "opensearch_tls_protocols", - "syslog_use_udp", } if slices.Contains(hyphenAttributes, attribute) { alteredAttribute := strings.ReplaceAll(attribute, "_", "-") diff --git a/stackit/internal/services/logme/instance/resource_test.go b/stackit/internal/services/logme/instance/resource_test.go index 7f66aa77..d74d81d1 100644 --- a/stackit/internal/services/logme/instance/resource_test.go +++ b/stackit/internal/services/logme/instance/resource_test.go @@ -44,7 +44,6 @@ var fixtureModelParameters = types.ObjectValueMust(parametersTypes, map[string]a types.StringValue("syslog"), types.StringValue("syslog2"), }), - "syslog_use_udp": types.StringValue("udp"), }) var fixtureNullModelParameters = types.ObjectValueMust(parametersTypes, map[string]attr.Value{ @@ -70,7 +69,6 @@ var fixtureNullModelParameters = types.ObjectValueMust(parametersTypes, map[stri "opensearch_tls_ciphers": types.ListNull(types.StringType), "opensearch_tls_protocols": types.ListNull(types.StringType), "syslog": types.ListNull(types.StringType), - "syslog_use_udp": types.StringNull(), }) var fixtureInstanceParameters = logme.InstanceParameters{ @@ -158,7 +156,6 @@ func TestMapFields(t *testing.T) { "opensearch-tls-ciphers": []string{"ciphers", "ciphers2"}, "opensearch-tls-protocols": []string{"protocols", "protocols2"}, "syslog": []string{"syslog", "syslog2"}, - "syslog-use-udp": "udp", }, }, Model{