doc: Referenced correct stream security protocol (#3304)

Calvinnix · web-flow · commit 190f3bfcdb63 · 2025-05-13T09:52:12.000+02:00
* STREAMS-1730: reference correct stream security protocols

* more PLAINTEXT and SSL references
diff --git a/docs/data-sources/stream_connection.md b/docs/data-sources/stream_connection.md
@@ -30,7 +30,7 @@ If `type` is of value `Kafka` the following additional attributes are defined:
 * `authentication` - User credentials required to connect to a Kafka cluster. Includes the authentication type, as well as the parameters for that authentication mode. See [authentication](#authentication).
 * `bootstrap_servers` - Comma separated list of server addresses.
 * `config` - A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
-* `security` - Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. See [security](#security).
+* `security` - Properties for the secure transport connection to Kafka. For SASL_SSL, this can include the trusted certificate to use. See [security](#security).
 * `networking` - Networking Access Type can either be `PUBLIC` (default) or `VPC`. See [networking](#networking).
 
 If `type` is of value `AWSLambda` the following additional attributes are defined:
@@ -49,7 +49,7 @@ If `type` is of value `Https` the following additional attributes are defined:
 ### Security
 
 * `broker_public_certificate` - A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
-* `protocol` - Describes the transport type. Can be either `PLAINTEXT` or `SSL`.
+* `protocol` - Describes the transport type. Can be either `SASL_PLAINTEXT` or `SASL_SSL`.
 
 ### DBRoleToExecute
 
diff --git a/docs/data-sources/stream_connections.md b/docs/data-sources/stream_connections.md
@@ -42,7 +42,7 @@ If `type` is of value `Kafka` the following additional attributes are defined:
 * `authentication` - User credentials required to connect to a Kafka cluster. Includes the authentication type, as well as the parameters for that authentication mode. See [authentication](#authentication).
 * `bootstrap_servers` - Comma separated list of server addresses.
 * `config` - A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
-* `security` - Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. See [security](#security).
+* `security` - Properties for the secure transport connection to Kafka. For SASL_SSL, this can include the trusted certificate to use. See [security](#security).
 * `networking` - Networking Access Type can either be `PUBLIC` (default) or `VPC`. See [networking](#networking).
 
 If `type` is of value `AWSLambda` the following additional attributes are defined::
@@ -61,7 +61,7 @@ If `type` is of value `Https` the following additional attributes are defined:
 ### Security
 
 * `broker_public_certificate` - A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
-* `protocol` - Describes the transport type. Can be either `PLAINTEXT` or `SSL`.
+* `protocol` - Describes the transport type. Can be either `SASL_PLAINTEXT` or `SASL_SSL`.
 
 ### DBRoleToExecute
 
diff --git a/docs/data-sources/stream_processor.md b/docs/data-sources/stream_processor.md
@@ -47,7 +47,7 @@ resource "mongodbatlas_stream_connection" "example-kafka" {
     "auto.offset.reset" : "earliest"
   }
   security = {
-    protocol = "PLAINTEXT"
+    protocol = "SASL_PLAINTEXT"
   }
 }
 
diff --git a/docs/data-sources/stream_processors.md b/docs/data-sources/stream_processors.md
@@ -47,7 +47,7 @@ resource "mongodbatlas_stream_connection" "example-kafka" {
     "auto.offset.reset" : "earliest"
   }
   security = {
-    protocol = "PLAINTEXT"
+    protocol = "SASL_PLAINTEXT"
   }
 }
 
diff --git a/docs/resources/stream_connection.md b/docs/resources/stream_connection.md
@@ -19,7 +19,7 @@ resource "mongodbatlas_stream_connection" "test" {
 }
 ```
 
-### Example Kafka Plaintext Connection
+### Example Kafka SASL Plaintext Connection
 
 ```terraform
 resource "mongodbatlas_stream_connection" "test" {
@@ -33,7 +33,7 @@ resource "mongodbatlas_stream_connection" "test" {
         password = "somepassword"
     }
     security = {
-        protocol = "PLAINTEXT"
+        protocol = "SASL_PLAINTEXT"
     }
     config = {
         "auto.offset.reset": "latest"
@@ -42,7 +42,7 @@ resource "mongodbatlas_stream_connection" "test" {
 }    
 ```
 
-### Example Kafka SSL Connection
+### Example Kafka SASL SSL Connection
 
 ```terraform
 resource "mongodbatlas_stream_connection" "test" {
@@ -56,7 +56,7 @@ resource "mongodbatlas_stream_connection" "test" {
         password = "somepassword"
     }
     security = {
-        protocol = "SSL"
+        protocol = "SASL_SSL"
         broker_public_certificate = "-----BEGIN CERTIFICATE-----<CONTENT>-----END CERTIFICATE-----"
     }
     config = {
@@ -112,7 +112,7 @@ If `type` is of value `Kafka` the following additional arguments are defined:
 * `authentication` - User credentials required to connect to a Kafka cluster. Includes the authentication type, as well as the parameters for that authentication mode. See [authentication](#authentication).
 * `bootstrap_servers` - Comma separated list of server addresses.
 * `config` - A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.
-* `security` - Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use. See [security](#security).
+* `security` - Properties for the secure transport connection to Kafka. For SASL_SSL, this can include the trusted certificate to use. See [security](#security).
 * `networking` - Networking Access Type can either be `PUBLIC` (default) or `VPC`. See [networking](#networking).
 
 If `type` is of value `AWSLambda` the following additional arguments are defined:
@@ -131,7 +131,7 @@ If `type` is of value `Https` the following additional attributes are defined:
 ### Security
 
 * `broker_public_certificate` - A trusted, public x509 certificate for connecting to Kafka over SSL. String value of the certificate must be defined in the attribute.
-* `protocol` - Describes the transport type. Can be either `PLAINTEXT` or `SSL`.
+* `protocol` - Describes the transport type. Can be either `SASL_PLAINTEXT` or `SASL_SSL`.
 
 ### DBRoleToExecute
 
diff --git a/docs/resources/stream_processor.md b/docs/resources/stream_processor.md
@@ -53,7 +53,7 @@ resource "mongodbatlas_stream_connection" "example-kafka" {
     "auto.offset.reset" : "earliest"
   }
   security = {
-    protocol = "PLAINTEXT"
+    protocol = "SASL_PLAINTEXT"
   }
 }
 
diff --git a/examples/mongodbatlas_stream_connection/main.tf b/examples/mongodbatlas_stream_connection/main.tf
@@ -34,7 +34,7 @@ resource "mongodbatlas_stream_connection" "example-kafka-plaintext" {
     "auto.offset.reset" : "earliest"
   }
   security = {
-    protocol = "PLAINTEXT"
+    protocol = "SASL_PLAINTEXT"
   }
   networking = {
     access = {
@@ -59,7 +59,7 @@ resource "mongodbatlas_stream_connection" "example-kafka-ssl" {
   }
   security = {
     broker_public_certificate = var.kafka_ssl_cert
-    protocol                  = "SSL"
+    protocol                  = "SASL_SSL"
   }
 }
 
diff --git a/examples/mongodbatlas_stream_connection/variables.tf b/examples/mongodbatlas_stream_connection/variables.tf
@@ -22,7 +22,7 @@ variable "kafka_password" {
 }
 
 variable "kafka_ssl_cert" {
-  description = "Public certificate used for SSL configuration to connect to your Kafka cluster"
+  description = "Public certificate used for SASL_SSL configuration to connect to your Kafka cluster"
   type        = string
 }
 
diff --git a/examples/mongodbatlas_stream_processor/main.tf b/examples/mongodbatlas_stream_processor/main.tf
@@ -41,7 +41,7 @@ resource "mongodbatlas_stream_connection" "example-kafka" {
     "auto.offset.reset" : "earliest"
   }
   security = {
-    protocol = "PLAINTEXT"
+    protocol = "SASL_PLAINTEXT"
   }
 }
 
diff --git a/internal/service/streamconnection/model_stream_connection_test.go b/internal/service/streamconnection/model_stream_connection_test.go
@@ -18,7 +18,7 @@ const (
 	instanceName              = "InstanceName"
 	authMechanism             = "PLAIN"
 	authUsername              = "user1"
-	securityProtocol          = "SSL"
+	securityProtocol          = "SASL_SSL"
 	bootstrapServers          = "localhost:9092,another.host:9092"
 	dbRole                    = "customRole"
 	dbRoleType                = "CUSTOM"
diff --git a/internal/service/streamconnection/resource_stream_connection_test.go b/internal/service/streamconnection/resource_stream_connection_test.go
@@ -316,14 +316,14 @@ func configureKafka(projectID, instanceName, username, password, bootstrapServer
 	projectAndStreamInstanceConfig := acc.StreamInstanceConfig(projectID, instanceName, "VIRGINIA_USA", "AWS")
 	securityConfig := `
 		security = {
-			protocol = "PLAINTEXT"
+			protocol = "SASL_PLAINTEXT"
 		}`
 
 	if useSSL {
 		securityConfig = fmt.Sprintf(`
 		security = {
 		    broker_public_certificate = %q
-		    protocol = "SSL"
+		    protocol = "SASL_SSL"
 		}`, DummyCACert)
 	}
 	return fmt.Sprintf(`
@@ -408,10 +408,10 @@ func checkKafkaAttributes(
 		resourceChecks = append(resourceChecks, resource.TestCheckResourceAttr(resourceName, "authentication.password", password))
 	}
 	if !usesSSL {
-		resourceChecks = append(resourceChecks, resource.TestCheckResourceAttr(resourceName, "security.protocol", "PLAINTEXT"))
+		resourceChecks = append(resourceChecks, resource.TestCheckResourceAttr(resourceName, "security.protocol", "SASL_PLAINTEXT"))
 	} else {
 		resourceChecks = append(resourceChecks,
-			resource.TestCheckResourceAttr(resourceName, "security.protocol", "SSL"),
+			resource.TestCheckResourceAttr(resourceName, "security.protocol", "SASL_SSL"),
 			resource.TestCheckResourceAttrSet(resourceName, "security.broker_public_certificate"),
 		)
 	}
diff --git a/internal/service/streamprocessor/resource_test.go b/internal/service/streamprocessor/resource_test.go
@@ -657,7 +657,7 @@ func configConnection(t *testing.T, projectID string, config connectionConfig) (
                     "auto.offset.reset" : "earliest"
                 }
                 security = {
-                    protocol = "PLAINTEXT"
+                    protocol = "SASL_PLAINTEXT"
                 }
                 depends_on = [mongodbatlas_stream_instance.instance] 
             }

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ resource "mongodbatlas_stream_connection" "example-kafka" {`
`47`	`47`	`"auto.offset.reset" : "earliest"`
`48`	`48`	`}`
`49`	`49`	`security = {`
`50`		`- protocol = "PLAINTEXT"`
	`50`	`+ protocol = "SASL_PLAINTEXT"`
`51`	`51`	`}`
`52`	`52`	`}`
`53`	`53`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ resource "mongodbatlas_stream_connection" "example-kafka" {`
`53`	`53`	`"auto.offset.reset" : "earliest"`
`54`	`54`	`}`
`55`	`55`	`security = {`
`56`		`- protocol = "PLAINTEXT"`
	`56`	`+ protocol = "SASL_PLAINTEXT"`
`57`	`57`	`}`
`58`	`58`	`}`
`59`	`59`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ resource "mongodbatlas_stream_connection" "example-kafka-plaintext" {`
`34`	`34`	`"auto.offset.reset" : "earliest"`
`35`	`35`	`}`
`36`	`36`	`security = {`
`37`		`- protocol = "PLAINTEXT"`
	`37`	`+ protocol = "SASL_PLAINTEXT"`
`38`	`38`	`}`
`39`	`39`	`networking = {`
`40`	`40`	`access = {`
`@@ -59,7 +59,7 @@ resource "mongodbatlas_stream_connection" "example-kafka-ssl" {`
`59`	`59`	`}`
`60`	`60`	`security = {`
`61`	`61`	`broker_public_certificate = var.kafka_ssl_cert`
`62`		`- protocol = "SSL"`
	`62`	`+ protocol = "SASL_SSL"`
`63`	`63`	`}`
`64`	`64`	`}`
`65`	`65`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ variable "kafka_password" {`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`variable "kafka_ssl_cert" {`
`25`		`- description = "Public certificate used for SSL configuration to connect to your Kafka cluster"`
	`25`	`+ description = "Public certificate used for SASL_SSL configuration to connect to your Kafka cluster"`
`26`	`26`	`type = string`
`27`	`27`	`}`
`28`	`28`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ resource "mongodbatlas_stream_connection" "example-kafka" {`
`41`	`41`	`"auto.offset.reset" : "earliest"`
`42`	`42`	`}`
`43`	`43`	`security = {`
`44`		`- protocol = "PLAINTEXT"`
	`44`	`+ protocol = "SASL_PLAINTEXT"`
`45`	`45`	`}`
`46`	`46`	`}`
`47`	`47`