ENG-13977: Add deprecation message in existing ELK Terraform (#540)

* deprecation message * update example to splunk
cyralinc · May 31, 2024 · 3262b93 · 3262b93
1 parent baf65ec
commit 3262b93
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 23 deletions.
diff --git a/cyral/internal/integration/logging/model.go b/cyral/internal/integration/logging/model.go
@@ -318,6 +318,7 @@ func getIntegrationLogsSchema() map[string]*schema.Schema {
 			Type:          schema.TypeSet,
 			ConflictsWith: []string{CloudWatchKey, DatadogKey, SplunkKey, SumoLogicKey, FluentbitKey},
 			MaxItems:      1,
+			Deprecated:    "Use `Fluentbit` (custom) integration instead. This will be removed in the next major version of the provider.",
 			Elem: &schema.Resource{
 				Schema: map[string]*schema.Schema{
 					"es_url": {

diff --git a/docs/resources/integration_logging.md b/docs/resources/integration_logging.md
@@ -82,17 +82,13 @@ resource "cyral_integration_logging" "s3" {
   }
 }
 
-# Configures a raw Elk integration with no sidecar associated.
-resource "cyral_integration_logging" "elk_integration" {
-  name = "my-elk-integration"
-  elk {
-    es_url     = "http://es.com"
-    kibana_url = "http://kibana.com"
-    # `es_credentials` can omitted for unprotected instances.
-    es_credentials {
-      username = "another-user"
-      password = "123"
-    }
+# Configures a raw Splunk integration with no sidecar associated.
+resource "cyral_integration_logging" "splunk_integration" {
+  name = "my-splunk-integration"
+  splunk {
+    hostname = "http://splunk.com"
+    hec_port = "8088"
+    access_token = "XXXXXXXXXXX"
   }
 }
 ```
@@ -109,7 +105,7 @@ resource "cyral_integration_logging" "elk_integration" {
 
 -   `cloudwatch` (Block Set, Max: 1) Represents the configuration data required for the `AWS` CloudWatch log management system. (see [below for nested schema](#nestedblock--cloudwatch))
 -   `datadog` (Block Set, Max: 1) Represents the configuration data required for the Datadog's log management system. (see [below for nested schema](#nestedblock--datadog))
--   `elk` (Block Set, Max: 1) Represents the configuration data required for the ELK stack log management system. (see [below for nested schema](#nestedblock--elk))
+-   `elk` (Block Set, Max: 1, Deprecated) Represents the configuration data required for the ELK stack log management system. (see [below for nested schema](#nestedblock--elk))
 -   `fluent_bit` (Block Set, Max: 1) Represents a custom Fluent Bit configuration which will be utilized by the sidecar's log shipper. (see [below for nested schema](#nestedblock--fluent_bit))
 -   `receive_audit_logs` (Boolean) Whether or not Cyral audit logs should be forwarded to this logging integration. Declaration not supported in conjunction with `fluent_bit` block.
 -   `splunk` (Block Set, Max: 1) Represents the configuration data required for the Splunk log management system. (see [below for nested schema](#nestedblock--splunk))

diff --git a/examples/resources/cyral_integration_logging/fluent-bit.tf b/examples/resources/cyral_integration_logging/fluent-bit.tf
@@ -20,16 +20,12 @@ resource "cyral_integration_logging" "s3" {
   }
 }
 
-# Configures a raw Elk integration with no sidecar associated.
-resource "cyral_integration_logging" "elk_integration" {
-  name = "my-elk-integration"
-  elk {
-    es_url     = "http://es.com"
-    kibana_url = "http://kibana.com"
-    # `es_credentials` can omitted for unprotected instances.
-    es_credentials {
-      username = "another-user"
-      password = "123"
-    }
+# Configures a raw Splunk integration with no sidecar associated.
+resource "cyral_integration_logging" "splunk_integration" {
+  name = "my-splunk-integration"
+  splunk {
+    hostname = "http://splunk.com"
+    hec_port = "8088"
+    access_token = "XXXXXXXXXXX"
   }
 }