AtlasProject 사용자 지정 리소스

예시

다음 예는 AtlasProject 사용자 지정 리소스 사양을 보여줍니다.

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
 name: my-project
spec:
 name: Test project
 connectionSecretRef:
   name: my-atlas-key
 projectIpAccessList:
   - cidrBlock: "203.0.113.0/24"
     comment: "CIDR block for Application Server B - D"

Prometheus 예제

다음 예는 Prometheus와 통합되는 AtlasProject 사용자 지정 리소스 사양을 보여줍니다.

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
  name: my-project
spec:
  name: TestPrometheusIntegration
  connectionSecretRef:
    name: my-atlas-key
  projectIpAccessList:
    - cidrBlock: "0.0.0.0/1"
      comment: "Everyone has access. For test purposes only."
    - cidrBlock: "128.0.0.0/1"
      comment: "Everyone has access. For test purposes only."
  integrations:
    - type: "PROMETHEUS"
      enabled: "true"
      username: "prometheus-user"
      passwordRef:
        name: "password-name"
        namespace: "password-namespace"
      scheme: "http"
      serviceDiscovery: "http"

자세한 내용은 타사 서비스와 통합을 참조하세요.

팀 예제

The following example shows an AtlasProject custom resource specification that gives the green-leaf-team the Organization Owner role for this project. The team members are defined in the AtlasTeam custom resource.

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
  name: my-project
spec:
  name: Test project
  teams:
    - teamRef:
        name: green-leaf-team
      roles:
      - ORGANIZATION_OWNER

자세한 내용은 팀 구성을 참조하세요.

유지 관리 기간 예시

다음 예제에서는 유지 관리 기간을 매주 화요일 오전 5시로 설정하고 자동 지연을 비활성화하는 AtlasProject 사용자 지정 리소스 사양을 보여줍니다.

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
 name: my-project
spec:
 name: Test project
 projectIpAccessList:
   - ipAddress: "192.0.2.15"
     comment: "IP address for Application Server A"
maintenanceWindow:
 dayOfWeek: 3
 hourOfDay: 5
 autoDefer: false

프로젝트 설정 예시

The following example shows an AtlasProject custom resource specification that disables the collection of database statistics in cluster metrics, data explorer, Performance Advisor, Realtime Performance Panel, and Schema Advisor.

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
 name: my-project
spec:
 name: Test project
 projectIpAccessList:
   - ipAddress: "192.0.2.15"
     comment: "IP address for Application Server A"
 settings:
   isCollectDatabaseSpecificsStatisticsEnabled: false
   isDataExplorerEnabled: false
   isExtendedStorageSizesEnabled: false
   isPerformanceAdvisorEnabled: false
   isRealtimePerformancePanelEnabled: false
   isSchemaAdvisorEnabled: false

경고 구성 예제

다음 예제는 oplog window가 1시간 미만에 도달하는 경우 트리거되는 경고를 구성하는 AtlasProject 사용자 지정 리소스 사양을 보여줍니다.

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
  name: my-project
spec:
  name: Test Atlas Operator Project
  connectionSecretRef:
    name: my-atlas-key
  alertConfigurations:
    - eventTypeName: "REPLICATION_OPLOG_WINDOW_RUNNING_OUT",
      enabled: true,
      notifications:
      -  delayMin: 0
         emailEnabled: true
         intervalMin: 60
         roles: [ "GROUP_OWNER" ]
         smsEnabled: false
         typeName: "GROUP"
      threshold:
         operator: "LESS_THAN",
         threshold: "1",
         units: "HOURS"
  alertConfigurationSyncEnabled: true
  withDefaultAlertsSettings: false

타사 경고 구성 예제

다음 예제에서는 Slack을 통해 알림을 전송하는 경고를 구성하는 AtlasProject 사용자 지정 리소스 사양을 보여줍니다.

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
  name: my-project
spec:
  name: Test Atlas Operator Project
  connectionSecretRef:
    name: my-atlas-key
  alertConfigurations:
    - eventTypeName: "REPLICATION_OPLOG_WINDOW_RUNNING_OUT"
      enabled: true
      notifications:
      -  delayMin: 0
         emailEnabled: true
         intervalMin: 60
         roles: [ "GROUP_OWNER" ]
         smsEnabled: false
         - typeName: "SLACK"
           apiTokenRef:
             name: key-name
             namespace: key-namespace
      threshold:
         operator: "LESS_THAN"
         threshold: "1"
         units: "HOURS"
  alertConfigurationSyncEnabled: true
  withDefaultAlertsSettings: false

매개변수

이 섹션에서는 AtlasProject 사용자 지정 리소스 매개변수에 대해 설명합니다.

spec.name

유형: 문자열

필수 사항

Atlas 에서 만들거나 업데이트한 프로젝트 의 이름입니다. 이름 길이는 64 자를 초과할 수 없습니다. 이름에는 문자, 숫자, 공백, 대시, 밑줄만 포함할 수 있습니다. 프로젝트 생성 후에는 수정할 수 없습니다.

spec.alertConfigurations

유형: 객체 배열

옵션

List that contains alert configurations for this project.

If you use this setting, you must also set spec.alertConfigurationSyncEnabled to true for Atlas Kubernetes Operator to modify project alert configurations.

이 설정을 생략하거나 비워 두면 Atlas Kubernetes Operator는 프로젝트의 경고 구성을 변경하지 않습니다. 프로젝트를 생성하는 경우 Atlas는 기본 프로젝트 경고 구성을 적용합니다.

spec.alertConfigurations.eventTypeName

유형: 문자열

필수 사항

이 경고 구성이 설명하는 경고를 트리거하는 이벤트입니다.

Atlas Kubernetes Operator가 허용하는 값에 대해 자세히 알아보려면 MongoDB Atlas 관리 API 문서 에서 1개의 프로젝트에서 1개의 경고 구성 엔드포인트에 대한 요청 본문 스키마를 참조하세요.

spec.alertConfigurations.enabled

유형: 부울

옵션

기본값: false

이 경고 구성의 활성화 여부를 나타내는 플래그입니다. 생략하면 기본값은 false 입니다.

spec.alertConfigurations.matchers

유형: 객체 배열

조건부

List of rules that determine whether Atlas checks an object for the alert configuration. You can filter using the matchers array if spec.alertConfigurations.eventTypeName specifies an event for a host, replica set, or sharded cluster.

spec.alertConfigurations.matchers.fieldName

유형: 문자열

조건부

Atlas가 검사하는 대상 객체의 매개변수를 식별하는 사람이 읽을 수 있는 레이블입니다. 매개변수는 Atlas가 경고 구성을 확인할 수 있도록 모든 규칙과 일치해야 합니다.

Atlas Kubernetes Operator에서는 다음 값을 허용합니다.

• CLUSTER_NAME

• HOSTNAME

• HOSTNAME_AND_PORT

• PORT

• REPLICA_SET_NAME

• SHARD_NAME

• TYPE_NAME

Atlas Kubernetes Operator requires this setting if you include an object in the spec.alertConfigurations.matchers array.

spec.alertConfigurations.matchers.operator

유형: 문자열

조건부

Comparison operator to apply when checking the current metric value against spec.alertConfigurations.matchers.value.

Atlas Kubernetes Operator에서는 다음 값을 허용합니다.

• EQUALS

• CONTAINS

• STARTS_WITH

• ENDS_WITH

• NOT_EQUALS

• NOT_CONTAINS

• REGEX

Atlas Kubernetes Operator requires this setting if you include an object in the spec.alertConfigurations.matchers array.

spec.alertConfigurations.matchers.value

유형: 문자열

조건부

Value to match or exceed using the specified spec.alertConfigurations.matchers.operator.

Atlas Kubernetes Operator requires this setting if you include an object in the spec.alertConfigurations.matchers array.

spec.alertConfigurations.metricThreshold

유형: 객체

조건부

초과 시 경고를 트리거하는 지표의 임계값입니다.

Atlas Kubernetes Operator requires this setting when spec.alertConfigurations.eventTypeName is OUTSIDE_METRIC_THRESHOLD.

spec.alertConfigurations.metricThreshold.metricName

유형: 문자열

조건부

Human-readable label that identifies the metric against which Atlas checks the configured spec.alertConfigurations.metricThreshold.threshold.

Atlas Kubernetes Operator가 허용하는 값에 대해 자세히 알아보려면 MongoDB Atlas 관리 API 문서 에서 1개의 프로젝트에서 1개의 경고 구성 엔드포인트에 대한 요청 본문 스키마를 참조하세요.

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.metricThreshold object.

spec.alertConfigurations.metricThreshold.mode

유형: 문자열

옵션

기본값: AVERAGE

Atlas는 현재 지표 값을 평균으로 계산합니다.

Atlas Kubernetes Operator는 AVERAGE 값만 허용합니다.

spec.alertConfigurations.metricThreshold.operator

유형: 문자열

조건부

현재 지표 값을 확인할 때 적용할 비교 연산자입니다.

Atlas Kubernetes Operator에서는 다음 값을 허용합니다.

• GREATER_THAN

• LESS_THAN

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.metricThreshold object.

spec.alertConfigurations.metricThreshold.threshold

유형: 정수

조건부

초과 시 경고를 트리거하는 지표의 값입니다.

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.metricThreshold object.

spec.alertConfigurations.metricThreshold.units

유형: 문자열

조건부

수량을 표현하는 데 사용되는 요소입니다. 이 값은 시간, 저장 용량 등의 요소일 수 있습니다.

Atlas Kubernetes Operator에서는 다음 값을 허용합니다.

• BITS

• BYTES

• DAYS

• GIGABITS

• GIGABYTES

• HOURS

• KILOBITS

• KILOBYTES

• MEGABITS

• MEGABYTES

• MILLISECONDS

• MINUTES

• PETABYTES

• RAW

• SECONDS

• TERABYTES

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.metricThreshold object.

spec.alertConfigurations.notifications

유형: 배열

조건부

이 경고 구성에서 설명하는 경고에 대해 Atlas가 보내는 경고를 설명하는 목록입니다.

spec.alertConfigurations.notifications.apiTokenRef.name

유형: 문자열

조건부

Slack 용 API 토큰이 포함된 단일 필드 포함하는 불투명 시크릿의 이름입니다.password

Atlas Kubernetes Operator atlas.mongodb.com/type=credentials 불필요한 시크릿을 감시하지 않기 위해 레이블이 있는 시크릿만 감시합니다.

다음 예시에서는 시크릿에 레이블을 지정합니다.

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

Slack을 통해 알림을 받으려면 이 설정을 지정해야 합니다.

spec.alertConfigurations.notifications.apiTokenRef.namespace

유형: 문자열

조건부

Slack용 API 토큰이 포함된 네임스페이스입니다. Slack을 통해 알림을 받으려면 이 설정을 지정해야 합니다.

spec.alertConfigurations.notifications.channelName

유형: 문자열

조건부

Atlas가 경고 알림을 전송하는 Slack 채널을 식별하는 인간 판독 가능 레이블.

Atlas Kubernetes Operator requires this setting when you set spec.alertConfigurations.notifications.typeName to SLACK.

spec.alertConfigurations.notifications.datadogApiKeyRef.name

유형: 문자열

조건부

DataDog 용 API 키가 있는 단일 password 필드 포함하는 불투명 시크릿의 이름입니다. DataDog를 통해 알림 받으려면 이 설정을 지정해야 합니다.

Atlas Kubernetes Operator atlas.mongodb.com/type=credentials 불필요한 시크릿을 감시하지 않기 위해 레이블이 있는 시크릿만 감시합니다.

다음 예시에서는 시크릿에 레이블을 지정합니다.

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.alertConfigurations.notifications.datadogApiKeyRef.namespace

유형: 문자열

조건부

Datadog용 API 키가 포함된 네임스페이스입니다. Datadog을 통해 알림을 받으려면 이 설정을 지정해야 합니다.

spec.alertConfigurations.notifications.datadogRegion

유형: 문자열

옵션

기본값: US

사용할 API URL(Uniform Resource Locator)을 나타내는 Datadog 리전입니다.

Atlas Kubernetes Operator에서는 다음 값을 허용합니다.

• US

• EU

spec.alertConfigurations.notifications.delayMins

유형: 정수

옵션

기본값: 0

경고 조건을 감지한 후 첫 번째 알림을 보내기 전에 Atlas가 기다리는 시간(분)입니다.

spec.alertConfigurations.notifications.emailAddress

유형: 문자열

조건부

Atlas에서 경고 알림을 보낼 이메일 주소입니다.

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to EMAIL.

Atlas Kubernetes Operator doesn't require this setting to send email notifications when you set spec.alertConfigurations.notifications.typeName to one of the following values:

• GROUP

• ORG

• TEAM

• USERS

To send emails to one Atlas user or group of users, set the spec.alertConfigurations.notifications.emailEnabled parameter.

spec.alertConfigurations.notifications.emailEnabled

유형: 부울

조건부

Atlas가 이메일 알림을 보낼지 여부를 나타내는 플래그입니다.

Atlas Kubernetes Operator requires this setting when you set spec.alertConfigurations.notifications.typeName to one of the following values:

• GROUP

• ORG

• TEAM

spec.alertConfigurations.notifications.intervalMin

유형: 정수

옵션

연속 알림 사이에 대기할 시간(분)입니다. Atlas는 승인되지 않은 경고를 승인할 때까지 알림을 보냅니다. Atlas Kubernetes Operator는 5 이상의 값을 허용합니다.

PagerDuty, VictorOps 및 OpsGenie 알림은 이 필드를 사용하지 않습니다. 해당 각 서비스 내에서 알림 간격을 구성하고 managed합니다.

spec.alertConfigurations.notifications.microsoftTeamsWebhookUrl

유형: 문자열

조건부

Atlas가 Microsoft Teams를 통해 이 알림을 전송하는 데 필요한 Microsoft Teams Webhook URL(Uniform Resource Locator)입니다. 나중에 URL이 유효하지 않게 되면 Atlas에서 프로젝트 소유자에게 이메일을 보냅니다. 키가 유효하지 않은 상태로 유지되면 Atlas에서 제거합니다.

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to MICROSOFT_TEAMS.

spec.alertConfigurations.notifications.mobileNumber

유형: 문자열

조건부

Atlas에서 경고 알림을 보낼 휴대폰 번호입니다.

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to SMS.

spec.alertConfigurations.notifications.opsGenieApiKeyRef.name

유형: 문자열

조건부

Opsgenie용 API 키가 있는 단일 password 필드 포함하는 불투명 시크릿 의 이름입니다. Opsgenie를 통해 알림 받으려면 이 설정을 지정해야 합니다.

Atlas Kubernetes Operator atlas.mongodb.com/type=credentials 불필요한 시크릿을 감시하지 않기 위해 레이블이 있는 시크릿만 감시합니다.

다음 예시에서는 시크릿에 레이블을 지정합니다.

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.alertConfigurations.notifications.opsGenieApiKeyRef.namespace

유형: 문자열

조건부

Opsgenie용 API 키가 포함된 네임스페이스입니다. Opsgenie를 통해 알림을 받으려면 이 설정을 지정해야 합니다.

spec.alertConfigurations.notifications.opsGenieRegion

유형: 문자열

옵션

기본값: US

사용할 API URL(Uniform Resource Locator)을 나타내는 Opsgenie 리전입니다.

Atlas Kubernetes Operator에서는 다음 값을 허용합니다.

• US

• EU

Atlas Kubernetes Operator applies this setting if you set spec.alertConfigurations.notifications.typeName to OPS_GENIE.

spec.alertConfigurations.notifications.roles

유형: 배열

옵션

구성된 경고를 수신하는 하나 이상의 조직 또는 프로젝트 역할이 포함된 목록입니다. 이 매개변수를 포함하면 Atlas는 목록에서 지정한 역할이 할당된 사용자에게만 경고를 보냅니다. 이 매개변수를 생략하면 Atlas는 역할이 할당된 사용자에게 경고를 보냅니다.

Atlas Kubernetes Operator에서는 다음 값을 허용합니다.

• GROUP_CLUSTER_MANAGER

• GROUP_DATA_ACCESS_ADMIN

• GROUP_DATA_ACCESS_READ_ONLY

• GROUP_DATA_ACCESS_READ_WRITE

• GROUP_OWNER

• GROUP_READ_WRITE

• ORG_OWNER

• ORG_MEMBER

• ORG_GROUP_CREATOR

• ORG_BILLING_ADMIN

• ORG_READ_ONLY

Atlas Kubernetes Operator applies this setting when you set spec.alertConfigurations.notifications.typeName to one of the following values:

• GROUP

• ORG

spec.alertConfigurations.notifications.serviceKeyRef.name

유형: 문자열

조건부

PagerDuty용 API 키가 있는 단일 필드 포함하는 불투명 시크릿의 이름입니다.password PagerDuty를 통해 알림 받으려면 이 설정을 지정해야 합니다.

Atlas Kubernetes Operator atlas.mongodb.com/type=credentials 불필요한 시크릿을 감시하지 않기 위해 레이블이 있는 시크릿만 감시합니다.

다음 예시에서는 시크릿에 레이블을 지정합니다.

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.alertConfigurations.notifications.serviceKeyRef.namespace

유형: 문자열

조건부

PagerDuty용 API 키가 포함된 네임스페이스입니다. PagerDuty를 통해 알림을 받으려면 이 설정을 지정해야 합니다.

spec.alertConfigurations.notifications.smsEnabled

유형: 부울

조건부

Atlas가 문자 메시지 알림을 보낼지 여부를 나타내는 플래그입니다.

Atlas Kubernetes Operator requires this setting when you set spec.alertConfigurations.notifications.typeName to one of the following values:

• GROUP

• ORG

• TEAM

spec.alertConfigurations.notifications.teamId

유형: 문자열

조건부

Atlas 팀 한 개를 식별하는 고유한 24자리 16진수 문자열입니다.

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to TEAM.

spec.alertConfigurations.notifications.teamName

유형: 문자열

조건부

이 알림을 수신하는 Atlas 팀의 이름입니다.

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to TEAM.

spec.alertConfigurations.notifications.typeName

유형: 문자열

조건부

Human-readable label that displays the alert notification type. This setting is required if you specify a value for the spec.alertConfigurations.notifications setting. Atlas supports the following values:

• DATADOG

• EMAIL

• OPS-GENIE

• ORG

• PAGER_DUTY

• PROMETHEUS

• SLACK

• SMS

• TEAM

• USER

• VICTOR_OPS

• WEBHOOK

spec.alertConfigurations.notifications.username

유형: 문자열

조건부

Atlas가 알림을 보내는 사람의 Atlas 사용자 이름입니다. 경고 구성을 소유한 프로젝트에 속한 Atlas 사용자만 지정합니다.

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to USER.

spec.alertConfigurations.notifications.victorOpsSecretRef.name

유형: 문자열

조건부

Splunk On-Call용 API 키가 포함된 단일 필드 포함하는 불투명 시크릿의 이름입니다.password Splunk On-Call을 통해 알림 받으려면 이 설정을 지정해야 합니다.

Atlas Kubernetes Operator atlas.mongodb.com/type=credentials 불필요한 시크릿을 감시하지 않기 위해 레이블이 있는 시크릿만 감시합니다.

다음 예시에서는 시크릿에 레이블을 지정합니다.

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.alertConfigurations.notifications.victorOpsSecretRef.namespace

유형: 문자열

조건부

Splunk On-Call의 API 키가 포함된 네임스페이스입니다. Splunk On-Call을 통해 알림을 받으려면 이 설정을 지정해야 합니다.

spec.alertConfigurations.notifications.victorOpsRoutingKey

유형: 문자열

조건부

Atlas가 Splunk On-Call에 경고 알림을 전송하는 데 필요한 라우팅 키입니다. 나중에 키가 유효하지 않게 되면 Atlas에서 프로젝트 소유자에게 이메일을 보냅니다. 키가 유효하지 않은 상태로 유지되면 Atlas에서 제거합니다.

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to VICTOR_OPS.

spec.alertConfigurations.notifications.webhookSecret

유형: 문자열

옵션

웹훅 기반 경고에 대한 인증 비밀입니다.

Atlas Kubernetes Operator applies this setting if you set spec.alertConfigurations.notifications.typeName to WEBHOOK.

spec.alertConfigurations.notifications.webhookUrl

유형: 문자열

조건부

웹훅 URL을 나타내는 문자열입니다.

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to WEBHOOK.

spec.alertConfigurations.severityOverride

유형: 문자열

조건부

Overrides the Atlas-assigned default severity level for a project alert.

Atlas Kubernetes Operator에서는 다음 값을 허용합니다.

• CRITICAL

• ERROR

• WARNING

• INFO

spec.alertConfigurations.threshold

유형: 객체

조건부

초과 시 Atlas Triggers 경고를 제한입니다.

Atlas Kubernetes Operator applies this setting if you set spec.alertConfigurations.eventTypeName to a value other than OUTSIDE_METRIC_THRESHOLD.

spec.alertConfigurations.threshold.operator

유형: 문자열

조건부

Atlas가 현재 지표 값을 확인할 때 적용할 비교 연산자입니다.

Atlas Kubernetes Operator에서는 다음 값을 허용합니다.

• GREATER_THAN

• LESS_THAN

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.threshold object.

spec.alertConfigurations.threshold.threshold

유형: 정수

조건부

초과 시 경고를 트리거하는 지표의 값입니다.

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.threshold object.

spec.alertConfigurations.threshold.units

유형: 문자열

조건부

수량을 Express 요소입니다. 시간 요소, 저장 용량 등을 지정할 수 있습니다.

Atlas Kubernetes Operator에서는 다음 값을 허용합니다.

• BITS

• BYTES

• DAYS

• GIGABITS

• GIGABYTES

• HOURS

• KILOBITS

• KILOBYTES

• MEGABITS

• MEGABYTES

• MILLISECONDS

• MINUTES

• PETABYTES

• RAW

• SECONDS

• TERABYTES

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.threshold object.

spec.alertConfigurationSyncEnabled

유형: 부울

옵션

기본값: false

Flag that indicates whether Atlas Kubernetes Operator applies the project alert settings defined in spec.alertConfigurations. If you omit or set to this parameter to false, Atlas Kubernetes Operator doesn't synchronize the project's alert configurations with the ones that you define in the AtlasProject custom resource.

For information on how this setting interacts with spec.withDefaultAlertsSettings, see the Considerations.

spec.auditing.auditAuthorizationSuccess

유형: 부울

옵션

기본값: false

Flag that indicates whether to direct the auditing system to capture successful authentication attempts for audit filters using the "atype" : "authCheck" auditing event. To set this parameter to true, you must set spec.auditing.enabled to true. To learn more, see auditAuthorizationSuccess.

경고: auditAuthorizationSuccess 를 활성화 하면 클러스터 성능에 심각한 영향 을 미칠 수 있습니다. 이 옵션은 주의해서 활성화하세요.

spec.auditing.auditFilter

유형: 문자열

옵션

JSON-formatted auditing filter. You might need to escape the JSON string to remove characters that could prevent parsing, such as single or double-quotes. To specify a value for this setting, you must set spec.auditing.enabled to true.

감사 필터 예시를 보려면 감사 필터 예시 를 참조하세요. MongoDB 감사 필터 구성에 대해 자세히 알아보려면 사용자 지정 감사 필터 구성을 참조하세요.

spec.auditing.enabled

유형: 부울

조건부

기본값: false

Flag that indicates whether to enable auditing for the project. To specify a value for spec.auditing.auditFilter, or to set spec.auditing.auditAuthorizationSuccess to true, you must specify this setting. To learn more, see Enable Audit Logs.

spec.backupCompliancePolicyRef

유형: 객체

조건부

AtlasBackupCompliancePolicy 사용자 지정 리소스를 참조하는 불투명 시크릿의 이름과 네임스페이스 포함된 객체입니다. 백업 컴플라이언스 정책을 활성화 경우 이 매개 변수를 지정해야 합니다.

spec.backupCompliancePolicyRef.name

유형: 문자열

조건부

AtlasBackupCompliancePolicy 사용자 지정 리소스 를 참조하는 불투명 시크릿 의 이름입니다. 백업 컴플라이언스 정책을 활성화 경우 이 매개 변수를 지정해야 합니다.

spec.backupCompliancePolicyRef.namespace

유형: 객체

조건부

AtlasBackupCompliancePolicy 사용자 지정 리소스 를 참조하는 불투명 시크릿 의 네임스페이스입니다. 백업 컴플라이언스 정책을 활성화 경우 이 매개 변수를 지정해야 합니다.

spec.connectionSecretRef.name

유형: 문자열

옵션

Atlas Kubernetes Operator Atlas 에 연결하는 데 사용하는 조직 ID 및 API 키가 포함된 단일 password 필드 포함하는 불투명 시크릿의 이름입니다. 지정하지 않으면 Atlas Kubernetes Operator 기본값 global 시크릿을 사용합니다.

Atlas Kubernetes Operator atlas.mongodb.com/type=credentials 불필요한 시크릿을 감시하지 않기 위해 레이블이 있는 시크릿만 감시합니다.

다음 예시에서는 시크릿에 레이블을 지정합니다.

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

기본값 으로 Atlas Kubernetes Operator AtlasProject Custom Resource(사용자 지정 리소스)와 동일한 네임스페이스 에 연결 비밀을 유지합니다. 다른 네임스페이스 에 시크릿을 저장 하려면 spec.connectionSecretRef.namespace 매개변수를 지정합니다.

spec.connectionSecretRef.namespace

유형: 문자열

옵션

Atlas Kubernetes Operator Atlas 에 연결하는 데 사용하는 조직 ID 및 API 키가 포함된 시크릿이 포함된 네임스페이스입니다. 지정되지 않은 경우, Atlas Kubernetes Operator AtlasProject Custom Resource(사용자 지정 리소스)와 동일한 네임스페이스 에 연결 비밀을 유지합니다.

spec.cloudProviderAccessRoles

유형: 배열

Deprecated. Use spec.cloudProviderIntegrations instead.

클라우드 공급자 액세스 설정이 포함된 목록.

spec.cloudProviderAccessRoles.iamAssumedRoleArn

유형: 문자열

Deprecated. Use spec.cloudProviderIntegrations.iamAssumedRoleArn instead.

Atlas가 맡는 IAM 액세스 역할을 식별하는 고유한 Amazon Web Services ARN . 통합 클라우드 공급자 액세스 를 설정하려면 이 설정을 지정해야 합니다.

spec.cloudProviderAccessRoles.providerName

유형: 문자열

Deprecated. Use spec.cloudProviderIntegrations.providerName instead.

Atlas가 가정하는 액세스 역할에 대한 클라우드 공급자. Atlas Kubernetes Operator는 통합 클라우드 제공자 액세스를 위해 AWS 을(를) 지원합니다. 통합 클라우드 공급자 액세스 를 설정하려면 이 설정을 지정해야 합니다.

spec.cloudProviderIntegrations

유형: 배열

옵션

통합 클라우드 제공자 통합 설정이 포함된 목록.

spec.cloudProviderIntegrations.iamAssumedRoleArn

유형: 문자열

조건부

Atlas가 맡는 IAM 액세스 역할을 식별하는 고유한 Amazon Web Services ARN . 통합 클라우드 공급자 통합 을 설정하려면 이 설정을 지정해야 합니다.

spec.cloudProviderIntegrations.providerName

유형: 문자열

조건부

Atlas가 가정하는 액세스 역할에 대한 클라우드 공급자. Atlas Kubernetes Operator는 통합 클라우드 제공자 통합을 위해 AWS 을(를) 지원합니다. 통합 클라우드 제공자 통합 을 설정하려면 이 설정을 지정해야 합니다.

spec.customRoles

유형: 객체

옵션

더 이상 사용되지 않습니다.

중요

이 매개변수는 Atlas Kubernetes Operator 2.6부터 더 이상 사용되지 않습니다. 마이그레이션 가이드 에 따라 AtlasPrivateEndpoint Custom Resource(사용자 지정 리소스)로 마이그레이션합니다.

사용자 지정 역할 사양이 포함된 객체입니다.

spec.encryptionAtRest

유형: 배열

옵션

프로젝트의 고객 관리형 키를 사용하여 미사용 데이터를 암호화 하기 위한 구성이 포함된 목록입니다.

spec.encryptionAtRest.awsKms

유형: 객체

옵션

프로젝트 의 고객 관리형 키를 사용한 미사용 데이터 암호화 에 AWS KMS 사용하기 위한 구성이 포함된 목록입니다.

spec.encryptionAtRest.enabled

유형: 부울

옵션

이 프로젝트에서 미사용 데이터를 암호화하기 위해 Amazon Web Services KMS를 사용하는지 여부를 나타내는 플래그입니다. Amazon Web Services KMS를 사용하여 미사용 데이터 암호화를 활성화하려면 이 매개 변수를 true로 설정합니다. 미사용 데이터 암호화를 비활성화하려면 Amazon Web Services KMS를 사용하여 이 매개 변수를 false로 설정합니다. Amazon Web Services KMS를 사용하여 미사용 데이터 암호화를 사용 중지하면 Atlas Kubernetes Operator가 구성 세부 정보를 제거합니다.

spec.encryptionAtRest.awsKms.region

유형: 문자열

옵션

Label that indicates the AWS region where the customer master key exists.

spec.encryptionAtRest.awsKms.secretRef.name

유형: 문자열

옵션

Amazon Web Services 자격 증명 포함된 불투명 시크릿 의 이름입니다.

Atlas Kubernetes Operator atlas.mongodb.com/type=credentials 불필요한 시크릿을 감시하지 않기 위해 레이블이 있는 시크릿만 감시합니다.

다음 예시에서는 시크릿에 레이블을 지정합니다.

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.encryptionAtRest.awsKms.secretRef.namespace

유형: 문자열

옵션

사용자의 Amazon Web Services 자격 증명이 포함된 네임스페이스입니다. 지정하지 않으면 이 매개변수는 기본값 AtlasProject 사용자 지정 리소스의 네임스페이스로 사용됩니다.

spec.encryptionAtRest.azureKeyVault

유형: 객체

옵션

프로젝트의 managed 키를 사용하는 encryption at rest에 Azure Key Vault를 사용하기 위한 구성이 포함된 목록입니다.

spec.encryptionAtRest.azureKeyVault.azureEnvironment

유형: 문자열

옵션

Azure 계정 자격 증명이 있는 Azure 배포서버 위치입니다. 유효한 값에는 AZURE, AZURE_CHINA 및 AZURE_GERMANY가 포함됩니다.

spec.encryptionAtRest.azureKeyVault.clientID

유형: 문자열

옵션

Azure 애플리케이션 식별하는 고유한 36-16진수 string입니다.

spec.encryptionAtRest.azureKeyVault.enabled

유형: 부울

옵션

이 프로젝트가 Azure Key Vault를 사용하여 Azure 키를 사용하는지 여부를 나타내는 플래그로, Atlas Kubernetes Operator가 구성 세부 정보를 제거합니다.

spec.encryptionAtRest.azureKeyVault.resourceGroupName

유형: 문자열

옵션

사용자의 Azure Key Vault가 포함된 Azure 리소스 그룹을 식별하는 레이블입니다. Azure는 리소스 그룹의 세부 정보 페이지에 리소스 그룹 이름을 표시합니다.

spec.encryptionAtRest.azureKeyVault.secretRef.name

유형: 문자열

옵션

Azure 자격 증명이 포함된 불투명 시크릿 의 이름입니다.

Atlas Kubernetes Operator atlas.mongodb.com/type=credentials 불필요한 시크릿을 감시하지 않기 위해 레이블이 있는 시크릿만 감시합니다.

다음 예시에서는 시크릿에 레이블을 지정합니다.

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.encryptionAtRest.azureKeyVault.secretRef.namespace

유형: 문자열

옵션

Azure 자격 증명이 포함된 네임스페이스. 지정하지 않으면 이 매개변수는 기본값 AtlasProject 사용자 지정 리소스의 네임스페이스로 사용됩니다.

spec.encryptionAtRest.azureKeyVault.tenantID

유형: 문자열

옵션

고유한 36자리 16진수 string으로, Azure Active 디렉토리 테넌트를 Azure 구독 내에서 식별합니다. Azure가 테넌트 속성 페이지에서 테넌트 ID를 표시합니다.

spec.encryptionAtRest.googleCloudKms

유형: 객체

옵션

프로젝트의 고객 관리형 키를 사용한 미사용 데이터 암호화에 Google Cloud KMS 를 사용하기 위한 구성이 포함된 목록입니다.

spec.encryptionAtRest.googleCloudKms.enabled`

유형: 문자열

옵션

이 프로젝트가 미사용 데이터를 암호화하기 위해 Google Cloud Platform KMS를 사용하는지 여부를 나타내는 플래그입니다. 미사용 데이터 암호화를 Google Cloud KMS를 사용하여 활성화하려면, 이 매개변수를 true(으)로 설정합니다. Google Cloud KMS를 사용하여 미사용 데이터 암호화를 비활성화하려면 이 매개변수를 false로 설정합니다. Google Cloud Platform KMS를 사용하여 미사용 데이터 암호화를 비활성화하면 Atlas Kubernetes Operator가 구성 세부 정보를 제거합니다.

spec.encryptionAtRest.googleCloudKms.secretRef.name

유형: 문자열

옵션

Google Cloud Platform 자격 증명 포함된 불투명 시크릿의 이름입니다.

Atlas Kubernetes Operator atlas.mongodb.com/type=credentials 불필요한 시크릿을 감시하지 않기 위해 레이블이 있는 시크릿만 감시합니다.

다음 예시에서는 시크릿에 레이블을 지정합니다.

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.encryptionAtRest.googleCloudKms.secretRef.namespace

유형: 문자열

옵션

Google Cloud 자격 증명이 포함된 네임스페이스입니다. 지정하지 않으면 이 매개변수는 기본적으로 AtlasProject 사용자 지정 리소스의 네임스페이스로 사용됩니다.

spec.integrations

유형: 배열

옵션

더 이상 사용되지 않습니다.

중요

이 매개변수는 Atlas Kubernetes Operator 2.9부터 더 이상 사용되지 않습니다. 마이그레이션 가이드에 따라 AtlasThirdPartyIntegration 사용자 지정 리소스로 마이그레이션합니다.

타사 통합 설정이 포함된 목록입니다.

spec.maintenanceWindow

유형: 객체

옵션

유지 관리 기간 설정이 포함된 목록입니다. 다음과 같은 본문 매개변수를 지정할 수 있습니다.

이름	유형	필요성	설명
dayOfWeek	숫자	필수 사항	유지 관리 기간을 시작할 요일이며, 1부터 시작하는 정수로 표시됩니다. 요일 Integer Sunday 1 Monday 2 화요일 3 수요일 4 목요일 5 Friday 6 토요일 7
hourOfDay	숫자	필수 사항	유지 관리 기간을 시작할 시간입니다. 이 매개변수는 자정이 0 이고 정오가 12 인 24시간제를 사용합니다.
autoDeferOnceEnabled	부울	옵션	모든 유지 관리 기간을 트igger되는 일주일 동안 연기할지 여부를 나타내는 플래그입니다.

중요

유지 관리 기간 고려 사항

긴급 유지 관리 활동

보안 패치와 같은 긴급 유지 관리 활동은 선택한 기간을 기다릴 수 없습니다. Atlas는 필요시 이러한 유지 관리 활동을 시작하게 됩니다.

지속적인 유지 관리 작업

클러스터에 대한 유지 관리 일정을 잡은 후에는 현재 유지 관리 작업이 완료되기까지 유지 관리 기간을 변경할 수 없습니다.

유지 관리 시 복제본 세트 필요

Atlas는 MongoDB 매뉴얼에 설명된 유지 관리 절차와 동일한 방식으로 유지 관리를 수행합니다. 이 절차를 수행하려면 유지 관리 기간 동안 복제본 세트당 하나 이상의 복제본 세트 투표가 요구됩니다.

최대한 정시 유지 관리 시작

유지 관리는 항상 가급적 예정된 시간에 가깝게 시작하지만, 진행 중인 클러스터 업데이트 또는 예기치 않은 시스템 문제로 인해 시작 시간이 지연될 수 있습니다.

spec.maintenanceWindow.autoDefer

유형: 부울

조건부

Atlas가 모든 유지 관리 기간을 활성화한 후 1주일 동안 연기해야 하는지 여부를 나타내는 플래그입니다.

spec.maintenanceWindow.defer

유형: 부울

조건부

Flag that indicates whether Atlas should defer scheduled maintenance. You must schedule maintenance before you can successfully defer maintenance. spec.maintenanceWindow.defer and spec.maintenanceWindow.startASAP can't both be set to true at the same time.

중요

While spec.maintenanceWindow.defer is set to true, Atlas Kubernetes Operator defers scheduled maintenance every time you apply changes to the AtlasProject custom resource. If you set spec.maintenanceWindow.defer to true, you should change spec.maintenanceWindow.defer to false after you apply changes.

spec.maintenanceWindow.dayOfWeek

유형: 숫자

조건부

유지 관리 기간이 시작되는 요일을 나타내는 1부터 시작하는 정수입니다. 다음 표를 사용하여 각 요일에 해당하는 정수를 찾습니다.

요일	Integer
Sunday	1
Monday	2
화요일	3
수요일	4
목요일	5
Friday	6
토요일	7

프로젝트에 대한 유지 관리 기간을 구성하려면 이 설정을 지정해야 합니다.

spec.maintenanceWindow.hourOfDay

유형: 숫자

조건부

24시간제에 따라 유지 관리 기간이 시작되는 시간을 나타내는 0부터 시작하는 정수입니다. 자정에는 0 을 사용하고 정오에는 12 을 사용합니다. 프로젝트에 대한 유지 관리 기간을 구성하려면 이 설정을 지정해야 합니다.

spec.maintenanceWindow.startASAP

유형: 부울

조건부

Flag that indicates whether Atlas should immediately start maintenance. spec.maintenanceWindow.defer and spec.maintenanceWindow.startASAP can't both be set to true at the same time.

중요

While spec.maintenanceWindow.startASAP is set to true, Atlas Kubernetes Operator starts maintenance every time you apply changes to the AtlasProject custom resource. If you set spec.maintenanceWindow.startASAP to true, you should change spec.maintenanceWindow.startASAP to false after you apply changes.

spec.networkPeers

유형: 배열

옵션

더 이상 사용되지 않습니다.

중요

이 매개변수는 Atlas Kubernetes Operator 2.8부터 더 이상 사용되지 않습니다. 마이그레이션 가이드 에 따라 AtlasNetworkPeering 및 AtlasNetworkContainer 사용자 지정 리소스로 마이그레이션합니다.

프로젝트의 네트워크 피어링 구성이 포함된 목록입니다.

spec.regionUsageRestrictions

유형: 문자열

옵션

Atlas for Government 전용으로 프로젝트의 리전 지정합니다. 다음 값 중 하나를 지정할 수 있습니다.

• NONE: 프로젝트 에 리전 사용 제한이 없습니다. 이 값이 기본값 입니다.

• GOV_REGIONS_ONLY: 프로젝트 지정한 정부 cloud 리전으로 제한합니다.

• COMMERCIAL_FEDRAMP_REGIONS_ONLY: 프로젝트 Amazon Web Services FedRamp Moderate 표준 리전으로 제한되어 있음을 나타냅니다.

spec.projectIpAccessList

유형: 배열

필수 사항

더 이상 사용되지 않습니다.

중요

이 매개변수는 Atlas Kubernetes Operator 2.7부터 더 이상 사용되지 않습니다. 마이그레이션 가이드 에 따라 AtlasIPAccessList Custom Resource(사용자 지정 리소스)로 마이그레이션합니다.

프로젝트의 Atlas cluster에 대한 네트워크 액세스 권한을 부여하는 IP 액세스 목록입니다. 다음과 같은 본문 매개변수를 지정할 수 있습니다.

Parameter	유형	필요성	설명
awsSecurityGroup	문자열	조건부	액세스 목록에 추가할 Amazon Web Services 보안 그룹의 고유 식별자입니다. 액세스 목록 항목에는 awsSecurityGroup 한 개, cidrBlock 한 개 또는 ipAddress 한 개만 포함할 수 있습니다. You must configure VPC peering for your project before you can add an AWS security group to an access list.
cidrBlock	문자열	조건부	액세스 목록에 추가할 CIDR 표기법의 IP 주소 범위입니다. 액세스 목록 항목에는 awsSecurityGroup 한 개, cidrBlock 한 개 또는 ipAddress 한 개만 포함할 수 있습니다.
comment	문자열	옵션	액세스 목록 항목과 관련된 주석입니다.
deleteAfterDate	날짜	옵션	Timestamp in ISO 8601 date and time format in UTC after which Atlas removes the entry from the access list. The specified date must be in the future and within one week of the time you make the API request. 중요: Amazon Web Services 보안 그룹은 임시 액세스 목록 항목으로 설정하다 수 없습니다. 만료 날짜가 지정된 구역 의 현지 시간을 기준으로 발생하도록 ISO 구역 지정자를 포함할 수 있습니다.8601
ipAddress	문자열	조건부	Single IP address to be added to the access list. awsSecurityGroup 및 cidrBlock 과 상호 배타적입니다. 액세스 목록 항목에는 awsSecurityGroup 한 개, cidrBlock 한 개 또는 ipAddress 한 개만 포함할 수 있습니다.

spec.settings

유형: 객체

옵션

프로젝트 설정이 포함된 목록입니다.

spec.settings.isCollectDatabaseSpecificsStatisticsEnabled

유형: 부울

옵션

프로젝트에 클러스터 지표 의 데이터베이스 통계 컬렉션이 활성화되어 있는지 여부를 나타내는 플래그입니다.

spec.settings.isDataExplorerEnabled

유형: 부울

옵션

프로젝트에 데이터 탐색기 가 활성화되어 있는지 여부를 나타내는 플래그입니다.

spec.settings.isExtendedStorageSizesEnabled

유형: 부울

옵션

Flag that indicates whether to enable extended storage sizes for the specified project. To learn more about enabling extended storage, see Manage Project Settings.

spec.settings.isPerformanceAdvisorEnabled

유형: 부울

옵션

Flag that indicates whether your project has Performance Advisor enabled.

spec.settings.isRealtimePerformancePanelEnabled

유형: 부울

옵션

Flag that indicates whether your project has Realtime Performance Panel enabled.

spec.settings.isSchemaAdvisorEnabled

유형: 부울

옵션

프로젝트에 스키마 관리자 가 활성화되어 있는지 여부를 나타내는 플래그입니다.

spec.privateEndpoints

유형: 배열

옵션

더 이상 사용되지 않습니다.

중요

이 매개변수는 Atlas Kubernetes Operator 2.6부터 더 이상 사용되지 않습니다. 마이그레이션 가이드 에 따라 AtlasPrivateEndpoint Custom Resource(사용자 지정 리소스)로 마이그레이션합니다.

프로젝트에 대한 비공개 엔드포인트 구성이 포함된 목록입니다.

spec.teams

유형: 객체

옵션

팀 사양이 포함된 객체입니다. 자세한 내용은 팀 구성을 참조하세요.

spec.teams.teamRef.name

유형: 문자열

조건부

필드 에 AtlasTeam 있는 Custom Resource(사용자 지정 리소스)의 사람이 읽을 수 있는 레이블입니다.metadata.name 이 프로젝트 에 팀 할당하려면 이 설정을 지정해야 합니다.

spec.teams.teamRef.namespace

유형: 문자열

조건부

default 이외의 경우 AtlasTeam 사용자 지정 리소스 에 네임스페이스가 지정되었습니다.

spec.teams.teamRef.roles

유형: 문자열

조건부

Atlas User Roles that a team uses for this project. If you want to assign a team to this project, you must specify this setting.

spec.withDefaultAlertsSettings

유형: 부울

옵션

기본값: true

Flag that indicates whether Atlas Kubernetes Operator creates a project with the default alert configurations. If omitted, defaults to true.

If you use this setting, you must also set spec.alertConfigurationSyncEnabled to true for Atlas Kubernetes Operator to modify project alert configurations.

프로젝트를 만들 때 이 매개 변수를 false 로 설정하면 Atlas는 프로젝트에 기본 경고 구성을 추가하지 않습니다.

이 설정은 기존 프로젝트에는 영향을 주지 않습니다.

For information on how this setting interacts with spec.alertConfigurationSyncEnabled, see the Considerations.

spec.x509CertRef.name

유형: 문자열

옵션

X.kubernetes.io/tls 인증서에 대한 509 시크릿의 이름입니다.

Atlas Kubernetes Operator atlas.mongodb.com/type=credentials 불필요한 시크릿을 감시하지 않기 위해 레이블이 있는 시크릿만 감시합니다.

다음 예시에서는 시크릿에 레이블을 지정합니다.

kubectl label secret the-user-password atlas.mongodb.com/type=credentials