`AtlasTeam` Custom Resource

On this page

Example

Parameters

The AtlasTeam custom resource defines a team of Atlas users. To give this team access to one or more projects, you must reference the AtlasTeam custom resource from the AtlasProject Custom Resource and configure access roles for the team.

Important

Custom Resources No Longer Delete Objects by Default

Atlas Kubernetes Operator uses custom resource configuration files to manage your Atlas configuration, but as of Atlas Kubernetes Operator 2.0, custom resources you delete in Kubernetes are no longer (by default) deleted in Atlas. Instead, Atlas Kubernetes Operator simply stops managing those resources in Atlas. For example, if you delete an AtlasProject Custom Resource in Kubernetes, by default the Atlas Kubernetes Operator no longer automatically deletes the corresponding project from Atlas. This change in behavior is intended to help prevent accidental or unexpected deletions. To learn more, including how to revert this behavior to the default used prior to Atlas Kubernetes Operator 2.0, see New Default: Deletion Protection in Atlas Kubernetes Operator 2.0.
Similarly, Atlas Kubernetes Operator does not delete teams from Atlas if you remove them from an Atlas project in Kubernetes with the Atlas Kubernetes Operator.

Explicitly define your desired configuration details in order to avoid implicitly using default Atlas configuration values. In some cases, inheriting Atlas defaults may result in a reconciliation loop which can prevent your custom resource from achieving a READY state. For example, explicitly defining your desired autoscaling behavior in your AtlasDeployment custom resource, as shown in the included example, ensures that a static instance size in your custom resource is not being repeatedly applied to an Atlas deployment which has autoscaling enabled.

autoScaling:
  diskGB:
    enabled: true
  compute:
    enabled: true
    scaleDownEnabled: true
    minInstanceSize: M30
    maxInstanceSize: M40

Atlas Kubernetes Operator does one of the following actions using the Atlas Teams API Resource:

Creates a new team.
Updates an existing team.

Example

The following example shows an AtlasTeam custom resource that defines the green-leaf-team, comprised of four users. This custom resource must be referenced from the AtlasProject Custom Resource before this team can access an Atlas project:

apiVersion: atlas.mongodb.com/v1
kind: AtlasTeam
metadata:
  name: green-leaf-team
spec:
  name: "greenLeafTeam"
  usernames:
    - "atlas.user1@example.com"
    - "atlas.user2@example.com"
    - "atlas.user3@example.com"
    - "atlas.user4@example.com"

Parameters

This section describes the AtlasTeam custom resource parameters available.

metadata.name

Type: string

Required

Name that the AtlasProject Custom Resource uses to add this team to a project.

metadata.namespace

Type: string

Optional

Namespace other than default that you want to contain the atlasTeam custom resource. If you define a custom namespace, you must add it to the AtlasProject Custom Resource in the spec.teams.teamRef.namespace field.

spec.name

Type: string

Required

Human-readable label that identifies your team. This name appears wherever you view, add, or edit teams to help you differentiate between multiple teams.

spec.usernames

Type: string

Required

List that contains the Atlas usernames for the members of this team.

Back

AtlasPrivateEndpoint

AtlasDataFederation