Docs Menu
Docs Home
/ /
MongoDB Atlas Kubernetes Operator
/

AtlasStreamInstance Custom Resource

On this page

  • Example
  • Parameters

The AtlasStreamInstance custom resource configures Atlas Stream Processing instances.

The following example adds a stream processing instance. To learn more, see Manage Atlas Stream Processing.

apiVersion: atlas.mongodb.com/v1
kind: AtlasStreamInstance
metadata:
name: my-stream-instance
spec:
name: my-stream-instance
clusterConfig:
provider: AWS
region: VIRGINIA_USA
tier: SP30
projectRef:
name: my-project
connectionRegistry:
- name: ref-my-connection-1
namespace: my-namespace1
- name: ref-my-connection-2
namespace: my-namespace2
- name: ref-my-connection-3
namespace: my-namespace1

Note

Currently, Atlas Kubernetes Operator supports only the AWS provider and the VIRGINIA_USA region for this custom resource.

This section describes the AtlasStreamcInstance parameters.

spec.name

Type: string

Required

Name that identifies the stream processing instance.

spec.clusterConfig

Type: object

Required

Object that contains the configuration for the stream processing instance.

spec.clusterConfig.provider

Type: string

Required

String that indicates the cloud service provider for the stream processing instance.

Note

Currently, Atlas Kubernetes Operator supports only the AWS provider and the VIRGINIA_USA region for this custom resource.

spec.clusterConfig.region

Type: string

Required

String that indicates the AWS, Azure, or Google Cloud region for the stream processing instance.

Note

Currently, Atlas Kubernetes Operator supports only the AWS provider and the VIRGINIA_USA region for this custom resource.

spec.clusterConfig.tier

Type: string

Required

String that indicates the cluster tier for the stream processing instance. Valid values include:

  • SP10

  • SP30

spec.connectionRegistry

Type: object

Optional

Object that contains the configuration for the Connection Registry. The Connection Registry contains all the connections for the stream processing instance.

spec.connectionRegistry.name

Type: string

Conditional

Name of the opaque secret that contains your stream processing connection. You must include this parameter for each connection in the Connection Registry.

spec.connectionRegistry.namespace

Type: string

Conditional

Namespace of the opaque secret that contains your stream processing connection. You must include this parameter for each connection in the Connection Registry.

spec.projectRef.name

Type:* string

Required

Name of the project to which the stream processing instance belongs. You must specify an existing AtlasProject Custom Resource.

spec.projectRef.namespace

Type:* string

Conditional

Namespace in which the AtlasProject Custom Resource specified in spec.projectRef.name exists. If the AtlasProject Custom Resource belongs to a different namespace than the stream processing instance, you must specify this setting.

Back

AtlasStreamConnection

Next

AtlasFederatedAuth

On this page