Atlas Kubernetes Operator를 사용하면 Kubernetes를 종료하지 않고도 Atlas로 리소스를 관리할 수 있습니다. 이 튜토리얼에서는 Atlas Kubernetes Operator를 사용하여 Kubernetes 구성 파일로부터 Atlas의 첫 클러스터를 생성하는 방법을 설명합니다.
경고
다중 테넌시 보안 지침
다른 네임스페이스를 사용하더라도 여러 테넌트에 걸쳐 단일 Atlas Kubernetes Operator 설치를 공유하지 마십시오. 연산자를 공유하는 테넌트는 교차 네임스페이스 참조를 사용하여 다른 네임스페이스의 리소스에 액세스할 수 있습니다. 이는 다른 테넌트의 Atlas 구성 또는 다른 클라우드 리소스에 대한 액세스를 제공하는 시크릿을 포함합니다. 테넌트를 각리하려면 각 테넌트별로 별도의 Atlas Kubernetes Operator 인스턴스를 배포합니다.
참고
Helm으로 시작하는 것을 선호하시나요?
Atlas Kubernetes Operator를 사용하여 Atlas Charts에서 Atlas의 첫 번째 cluster를 생성하려면 Helm 차트 빠른 시작을 참조하세요.
전제 조건
이 튜토리얼에는 다음이 필요합니다.
Atlas 계정.계정을 만들려면 Atlas 계정 만들기를 참조하세요.
Atlas 조직 및 프로젝트. 이를 생성하려면 프로젝트 생성을 참조하세요.
실행 중인 Kubernetes 클러스터의 x86노드에서 -64, AMD64 또는 ARM64 아키텍처 내장 프로세서를 구동합니다.
kubectlKubernetes 클러스터 와 통신하도록 설치 및 구성됩니다.jq1.6 이상입니다.GitHub에서 Atlas Kubernetes Operator 프로젝트 에 액세스: https://github.com/mongodb/mongodb-atlas-kubernetes
네트워킹 요구 사항:
Atlas Kubernetes Operator 리소스를 생성하고 관리 하려면 Kubernetes 노드가 포트 443 (HTTPS)에서 Atlas 에 도달해야 합니다.
다중 노드 복제본 세트 배포 경우 모든 Kubernetes Pod 간에 포트 27017 ( 기본값 )이 열려 있어야 합니다.
절차
중요
Custom Resource(사용자 정의 리소스)는 더 이상 기본적으로 객체를 삭제하지 않음
Atlas Kubernetes Operator 사용자 지정 리소스 구성 파일을 사용하여 Atlas 구성을 관리 하지만, Atlas Kubernetes Operator 부터는 Kubernetes 에서 삭제 사용자 지정 2.0 리소스가 더 이상 ( 기본값) Atlas 에서 삭제되지 않습니다. 대신 Atlas Kubernetes Operator Atlas 에서 해당 리소스 관리를 중지할 뿐입니다. 예시 들어, Kubernetes 에서 Custom Resource(사용자
AtlasProject지정 리소스)를 삭제 하면 기본값 으로 Atlas Kubernetes Operator 더 이상 Atlas 에서 해당 프로젝트 자동으로 삭제하지 않습니다. 이러한 동작 변경은 우발적이거나 예기치 않은 삭제를 방지하기 위한 것입니다. 이 동작을 Atlas Kubernetes Operator 이전에 사용된 기본값 으로 되돌리는 2 방법0 등 자세한 학습 새 기본값: Atlas Kubernetes Operator 2 의 삭제0 보호 기능을 참조하세요.마찬가지로, Atlas Kubernetes Operator 를 사용하여 Kubernetes 의 Atlas 프로젝트 에서 팀을 제거 하는 경우 Atlas Kubernetes Atlas Kubernetes Operator 는 Atlas 에서 팀을 삭제 하지 않습니다.
기본값 Atlas 구성 값을 암시적으로 사용하지 않으려면 원하는 구성 세부 정보를 명시적으로 정의하세요. 경우에 따라 Atlas 기본값을 상속하면 조정 루프가 발생하여 사용자 지정 리소스
READY상태 달성하지 못할 수 있습니다. 예시 들어AtlasDeployment사용자 지정 리소스 에 원하는 자동 확장 동작을 명시적으로 정의하면 포함된 예시 와 같이 사용자 지정 리소스 의 정적 인스턴스 크기가 자동 확장이 활성화된 Atlas 배포서버 에 반복적으로 적용되지 않도록 할 수 있습니다.autoScaling: diskGB: enabled: true compute: enabled: true scaleDownEnabled: true minInstanceSize: M30 maxInstanceSize: M40
Atlas Kubernetes Operator 설치합니다.
다음 방법 중 하나를 선택하여 Atlas Kubernetes Operator 설치합니다.
Atlas CLI 사용하여 Atlas Kubernetes Operator 설치하려면 다음 명령을 실행 .
중요
Atlas CLI API 키를 생성하지만 클러스터의 아웃바운드 IP 감지할 수 없습니다. --ipAccessList 플래그를 사용하여 Atlas Kubernetes Operator Atlas 와 통신할 수 있도록 Kubernetes 클러스터의 IP 또는 CIDR 차단 허용 목록에 추가합니다.
atlas kubernetes operator install --ipAccessList <IP_OR_CIDR> [options]
참고
Atlas for Government에 Atlas Kubernetes Operator를 설치하려면 이전 명령에 --atlasGov 플래그를 추가합니다.
이 명령은 자동으로 다음을 수행합니다.
Atlas 조직 에 새 API 키를 생성합니다.
제공된 IP/CIDR을 API 키의 IP 액세스 목록에 추가합니다.
GitHub에서 매니페스트를 가져와서 현재
kubectl컨텍스트에 구성된 Kubernetes 클러스터 에 Atlas Kubernetes Operator 설치합니다.
명령을 실행 전에 활성 컨텍스트를 확인하려면 kubectl config current-context를 실행 . 다른 클러스터 로 전환하려면 kubectl config use-context <context-name>를 실행 .
명령 구문 및 매개변수에 관한 자세한 사항은 Atlas Kubernetes Operator 설치에 대한 Atlas CLI 문서를 참조하십시오.
kubectl을(를) 사용하여 Atlas Kubernetes Operator 설치하려면 다음 단계를 따르세요.
<VERSION>를 최신 릴리스 번호 로 바꾸고 다음 명령 중 하나를 실행 .If you want Atlas Kubernetes Operator to watch all the 네임스페이스 Kubernetes 클러스터 의 모든 네임스페이스를 감시하도록 하려면 실행.
kubectl apply -f https://raw.githubusercontent.com/mongodb/mongodb-atlas-kubernetes/refs/heads/main/releases/v<VERSION>/deploy/all-in-one.yaml If you want Atlas Kubernetes Operator 해당 네임스페이스 만 감시하도록 하려면 namespace,
deploy/namespaced디렉토리 에서 설정 파일을 설치합니다.kubectl apply -f https://raw.githubusercontent.com/mongodb/mongodb-atlas-kubernetes/v<VERSION>/deploy/namespaced/crds.yaml kubectl apply -f https://raw.githubusercontent.com/mongodb/mongodb-atlas-kubernetes/v<VERSION>/deploy/namespaced/namespaced-config.yaml
Atlas Kubernetes Operator가 Atlas에서 인증할 수 있도록 Atlas Kubernetes Operator에 대한 자격 증명을 생성합니다. 다음 중 하나를 선택합니다:
API 키: 조직에 프로그래밍 방식 액세스 권한 부여
Organization Project Creator의 절차에Project Owner따라 또는 권한이 있는 API 키를 생성합니다.서비스 계정: Atlas 조직 또는 프로젝트에서 적절한 역할을 가진 서비스 계정을 만듭니다. 자세한 내용은 서비스 계정 개요를 참조하세요.
자격 증명을 사용하여 연결 시크릿을 생성합니다.
Atlas Kubernetes Operator가 Atlas에 대해 인증하는 데 사용하는 시크릿 을 만들고 레이블을 지정합니다. 원하는 인증 방법에 해당하는 탭을 선택하세요.
API 키와 조직 ID를 사용하여 다음 명령을 실행합니다.
kubectl create secret generic mongodb-atlas-operator-api-key \ --from-literal="orgId=<atlas_organization_id>" \ --from-literal="publicApiKey=<atlas_api_public_key>" \ --from-literal="privateApiKey=<atlas_api_private_key>" \ -n mongodb-atlas-system
kubectl label secret mongodb-atlas-operator-api-key atlas.mongodb.com/type=credentials -n mongodb-atlas-system
서비스 계정 자격 증명과 조직 ID로 다음 명령을 실행합니다.
kubectl create secret generic mongodb-atlas-operator-service-account \ --from-literal="orgId=<atlas_organization_id>" \ --from-literal="clientId=<service_account_client_id>" \ --from-literal="clientSecret=<service_account_client_secret>" \ -n mongodb-atlas-system
kubectl label secret mongodb-atlas-operator-service-account atlas.mongodb.com/type=credentials -n mongodb-atlas-system
서비스 계정 생성에 대한 자세한 내용은 서비스 계정을 사용하여 Atlas 에 대한 액세스 구성을 참조하십시오.
외부 시크릿 저장 사용하는 경우 외부 시크릿 관리자가 Kubernetes 시크릿을 생성하고 관리합니다. 자세한 학습은 시크릿 스토리지 구성을 참조하세요.
AtlasProject 사용자 지정 리소스 만듭니다.
다음 명령을 실행하여 AtlasProject 사용자 지정 리소스를 생성합니다.
참고
다음 예시에서는 spec.connectionSecretRef.name을(를) 지정하지 않습니다. 지정하지 않은 경우 Atlas Kubernetes Operator는 이전에 자격 증명과 조직 ID로 설정한 기본 연결 비밀을 사용합니다.
Atlas Kubernetes Operator 사용자 지정 리소스 를 배포합니다.
cat <<EOF | kubectl apply -f - apiVersion: atlas.mongodb.com/v1 kind: AtlasProject metadata: name: my-project spec: name: Test Atlas Operator Project projectIpAccessList: - ipAddress: <your-ip-address-range> comment: "Adding your IP to Atlas access list" EOF
AtlasDeployment 사용자 지정 리소스 만듭니다.
다음 명령 중 하나를 실행하여 AtlasDeployment 사용자 지정 리소스 를 생성하고 클러스터 를 생성합니다.
유료 계층:
cat <<EOF | kubectl apply -f - apiVersion: atlas.mongodb.com/v1 kind: AtlasDeployment metadata: name: my-atlas-cluster spec: projectRef: name: my-project deploymentSpec: clusterType: REPLICASET name: "Test-cluster" tags: - key: "environment" value: "production" replicationSpecs: - zoneName: US-Zone regionConfigs: - electableSpecs: instanceSize: M10 nodeCount: 3 providerName: AWS regionName: US_EAST_1 priority: 7 EOF
무료 계층:
cat <<EOF | kubectl apply -f - apiVersion: atlas.mongodb.com/v1 kind: AtlasDeployment metadata: name: my-atlas-cluster spec: projectRef: name: my-project deploymentSpec: clusterType: REPLICASET name: "Test-cluster" replicationSpecs: - regionConfigs: - regionName: US_EAST_1 providerName: TENANT backingProviderName: AWS electableSpecs: instanceSize: M0 nodeCount: 3 EOF
서버리스 인스턴스 만들려면 서버리스 인스턴스 예시 참조하세요.
비밀번호를 사용하여 Kubernetes 시크릿을 생성하여 Atlas cluster 데이터베이스 에 로그 .
P@@ssword% 을(를) 비밀번호로 바꾸고 다음 명령을 실행합니다.
kubectl create secret generic the-user-password --from-literal="password=P@@sword%"
kubectl label secret the-user-password atlas.mongodb.com/type=credentials
외부 시크릿 저장 사용하는 경우 외부 시크릿 관리자가 Kubernetes 시크릿을 생성하고 관리합니다. 자세한 학습은 시크릿 스토리지 구성을 참조하세요.
AtlasDatabaseUser 사용자 지정 리소스 만듭니다.
다음 명령을 실행하여 AtlasDatabaseUser 사용자 지정 리소스를 생성합니다.
참고
spec.passwordSecretRef 는 이전에 생성한 비밀번호를 참조해야 합니다.
cat <<EOF | kubectl apply -f - apiVersion: atlas.mongodb.com/v1 kind: AtlasDatabaseUser metadata: name: my-database-user spec: roles: - roleName: "readWriteAnyDatabase" databaseName: "admin" projectRef: name: my-project username: theuser passwordSecretRef: name: the-user-password EOF
데이터베이스 사용자의 상태를 확인합니다.
데이터베이스 사용자가 준비되었음을 나타내는 True 응답을 받을 때까지 다음 명령을 실행합니다.
참고
AtlasDatabaseUser Custom Resource (사용자 지정 리소스)는 클러스터 준비될 때까지 기다립니다. 새 프리 티어 Atlas 클러스터 만드는 데 15 초도 걸리지 않습니다. 새 Flex 또는 전용 클러스터 만드는 데 최대 10 분이 걸릴 수 있습니다.
kubectl get atlasdatabaseusers my-database-user -o=jsonpath='{.status.conditions[?(@.type=="Ready")].status}'
Atlas Kubernetes Operator가 클러스터에 연결하기 위해 생성한 비밀을 조회하세요.
다음 명령을 복사합니다.
중요
다음 명령을 실행하려면
jq1.6 이상이 필요합니다.kubectl get secret {my-project}-{my-atlas-cluster}-{my-database-user} -o json | jq -r '.data | with_entries(.value |= @base64d)'; 다음 자리 표시자를 원하는 사용자 지정 리소스의 세부 정보로 바꾸세요.
my-projectAtlasProject사용자 지정 리소스의metadata필드 값을 지정합니다.my-atlas-clusterAtlasDeployment사용자 지정 리소스의metadata필드 값을 지정합니다.my-database-userAtlasDatabaseUser사용자 지정 리소스의metadata필드 값을 지정합니다.명령을 실행합니다.
참고
연결 문자열은 다음 예제와 다를 수 있습니다.
{ "connectionStringStandard": "mongodb://theuser:P%40%40sword%25@test-cluster-shard-00-00.peqtm.mongodb.net:27017,test-cluster-shard-00-01.peqtm.mongodb.net:27017,test-cluster-shard-00-02.peqtm.mongodb.net:27017/?ssl=true&authSource=admin&replicaSet=atlas-pk82fl-shard-0", "connectionStringStandardSrv": "mongodb+srv://theuser:P%40%40sword%25@test-cluster.peqtm.mongodb.net", "password": "P@@sword%", "username": "theuser" } 애플리케이션 에서 이 Kubernetes 시크릿을 사용할 수 있습니다.
containers: - name: test-app env: - name: "CONNECTION_STRING" valueFrom: secretKeyRef: name: test-atlas-operator-project-test-cluster-theuser key: connectionStringStandardSrv
배포서버 확인
절차가 완료되면 연결하기 전에 클러스터 준비되었는지 확인합니다.
체크포인트 | 확인 단계 |
|---|---|
사용자 지정 리소스 준비 |
|
Atlas 의 클러스터 정상 | Atlas UI 에서 프로젝트 에 클러스터 |
연결 성공 | Atlas 의 연결 문자열 사용하여 에 |
다음 단계
클러스터 를 확인한 후에는 다음을 수행할 수 있습니다.
액세스 제어 구성: 데이터베이스 사용자 및 네트워크 액세스 설정합니다.방법을 학습 Atlas Kubernetes Operator 시작하기 를 참조하세요.
백업 설정: 클러스터 에 대한 클라우드 백업을 구성합니다.방법을 학습 절차를 참조하세요.
Atlas Search 인덱스 생성: 데이터에 대한 전체 텍스트 검색 활성화합니다. 방법을 학습 Kubernetes 로 Atlas Search 인덱스 생성하기를 참조하세요.
Helm 기반 빠른 시작: 구성 파일 대신 Helm Charts 에서 클러스터 배포를 시도합니다. 방법을 학습 Helm Charts 빠른 시작을 참조하세요.