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
This commit is contained in:
Christopher Paul 2025-01-28 16:03:35 +01:00 committed by GitHub
parent 19fdcd5d10
commit 11875602b8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
16 changed files with 36 additions and 56 deletions

View file

@ -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,
},

View file

@ -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, "_", "-")

View file

@ -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{