Firestore 데이터베이스에 연결

미리보기 — Using the Cloud Run integrations

이 기능에는 서비스별 약관의 일반 서비스 약관 섹션에 있는 'GA 이전 제공 서비스 약관'이 적용됩니다. GA 이전 기능은 '있는 그대로' 제공되며 지원이 제한될 수 있습니다. 자세한 내용은 출시 단계 설명을 참조하세요.

Firestore를 사용해서 Cloud Run 서비스에 대해 확장 가능한 NoSQL 클라우드 데이터베이스를 설정할 수 있습니다. Firestore는 모바일, 웹, 서버 개발을 위한 유연하고 확장 가능한 NoSQL 데이터베이스입니다.

이 페이지에서 설명하는 Cloud Run 통합을 사용하면 Cloud Run 서비스를 새로운 Firestore 데이터베이스에 빠르게 연결할 수 있습니다.

시작하기 전에

• 통합하려는 Cloud Run 서비스가 이미 배포되었는지 확인합니다.
• Firestore 가격 책정 페이지를 검토하세요. 통합에 사용되는 개별 리소스에 대해 요금이 청구됩니다.

필요한 역할

Cloud Run 통합을 사용하려면 사용자 또는 관리자가 두 가지 서로 다른 주 구성원에 IAM 역할을 부여해야 합니다.

Google 계정에 필요한 역할을 보려면 클릭하세요.

Cloud Run 통합을 사용하는 데 필요한 권한을 얻으려면 관리자에게 Google 계정에 프로젝트에 대한 다음 IAM 역할을 부여해 달라고 요청하세요.

• Cloud Run 개발자(roles/run.developer)
• Compute 뷰어(roles/compute.viewer)
• 서버리스 통합 개발자(roles/runapps.developer)
• 서버리스 통합 작업자(roles/runapps.operator)
• 서비스 계정 사용자(roles/iam.serviceAccountUser)

서비스 계정의 필수 역할을 보려면 클릭합니다.

Cloud Run 서비스를 배포하려면 자동 생성된 Compute Engine 기본 서비스 계정을 사용하거나 사용자 관리형 서비스 계정을 지정하면 됩니다. 서비스 계정에는 다음 역할이 있어야 합니다.

• Cloud Run 개발자(roles/run.developer)
• 로그 버킷 작성자(roles/logging.bucketWriter)
• 서비스 계정 사용자(roles/iam.serviceAccountUser)
• 스토리지 관리자(roles/storage.admin)
• Firebase 관리자(roles/firebase.admin)
• 프로젝트 IAM 관리자(roles/projectIAM.admin)

새 Firestore 데이터베이스에 서비스 연결

구성을 변경하면 새 버전이 생성됩니다. 이를 변경하는 명시적 업데이트가 없으면 이후 버전에도 이 구성 설정이 자동으로 적용됩니다.

콘솔 또는 명령줄을 사용해서 Firestore 데이터베이스에 Cloud Run 서비스를 연결할 수 있습니다.

Console

1. Google Cloud 콘솔에서 Cloud Run 페이지로 이동합니다.

   Cloud Run으로 이동

2. 서비스 목록에서 이 통합에서 사용할 서비스를 클릭합니다.

3. Integrations 탭을 클릭합니다.

4. 통합 추가를 클릭합니다.

5. Firestore 데이터베이스를 클릭합니다.

6. 기본 이름을 사용하거나 사용하려는 값으로 이름을 변경합니다.

   

7. API 목록을 사용 설정하라는 메시지가 표시되면 사용 설정을 클릭하고 API가 사용 설정될 때까지 기다립니다.

8. 리소스에서 이 통합으로 인해 생성되는 새 리소스를 확인합니다.

9. 제출을 클릭하고 통합 및 리소스가 생성될 때까지 기다립니다. 최대 15분이 걸릴 수 있습니다.

gcloud

1. 최신 Google Cloud CLI로 업데이트합니다.

   gcloud components update
   

2. 통합을 만듭니다.

   gcloud beta run integrations create \
   --type=firestore \
   --service=SERVICE \
   --region REGION
   

   다음과 같이 바꿉니다.

   • SERVICE를 Cloud Run 서비스 이름으로 바꿉니다.

   원하는 경우 --service-account=SERVICE_ACCOUNT_EMAIL 플래그를 포함합니다.

   • SERVICE_ACCOUNT_EMAIL을 서비스를 배포하는 데 사용되는 사용자 관리 서비스 계정 이메일 주소([e-mail])로 바꿉니다. 기본 컴퓨팅 서비스 계정(SERVICE_ACCOUNT_ID@PROJECT_ID.iam.gserviceaccount.com)을 사용하려면 이 플래그를 생략합니다.

     Cloud Run 통합을 배포할 때 지정된 서비스 계정을 계속 사용하려면 다음 명령어를 실행합니다.

     gcloud config set runapps/deployment-service-account
     

3. 완전히 구성된 Firestore 데이터베이스가 생성되고 연결될 때까지 최대 15분까지 기다립니다. 또한 데이터베이스를 식별하는 환경 변수를 포함하여 새 Cloud Run 버전이 생성됩니다. 프로세스가 완료되면 다음 메시지가 표시됩니다.

   [firestore] integration [firestore-xxx] has been updated successfully.
   
   To connect to the Firestore database, utilize the environment variable
   `FIRESTORE_DB_NAME`. This variable is added to the Cloud Run
   service for you.

   gcloud beta run integrations describe를 실행하여 상태를 확인할 수 있습니다.

Firestore 데이터베이스 통합 보기

Cloud Run 서비스에 대한 Firestore 데이터베이스 통합의 현재 상태를 보려면 다음 안내를 따르세요.

Console

1. Google Cloud 콘솔에서 Cloud Run 페이지로 이동합니다.

   Cloud Run으로 이동

2. 서비스 목록에서 이 통합에서 사용할 서비스를 클릭합니다.

3. Integrations 탭을 클릭합니다.

4. 관심 있는 Firestore 데이터베이스 통합을 찾고 세부정보 보기를 클릭합니다.

gcloud

1. 다음 명령어를 사용하여 사용 가능한 통합 목록을 가져옵니다.

   gcloud beta run integrations list

2. 반환된 목록의 이름을 사용하여 세부정보를 표시합니다.

   gcloud beta run integrations describe INTEGRATION_NAME

   INTEGRATION_NAME을 Firestore 데이터베이스 통합의 이름으로 바꿉니다.

Firestore 데이터베이스 통합 삭제

통합을 삭제하면 해당 통합에 연결된 모든 Google Cloud 리소스도 삭제되지만 Cloud Run 서비스는 삭제되지 않습니다.

Cloud Run 서비스에서 Firestore 데이터베이스 통합을 삭제하려면 다음 안내를 따르세요.

Console

1. Google Cloud 콘솔에서 Cloud Run 페이지로 이동합니다.

   Cloud Run으로 이동

2. 통합을 삭제하려는 서비스를 클릭합니다.

3. Integrations 탭을 클릭합니다.

4. 관심 있는 Firebase 데이터베이스 통합을 찾고 통합 오른쪽에 있는 줄임표 아이콘을 클릭한 다음 삭제를 클릭합니다.

gcloud

1. 다음 명령어를 사용하여 사용 가능한 통합 목록을 가져옵니다.

   gcloud beta run integrations list

2. 반환된 목록의 이름을 사용하여 통합을 삭제합니다.

   gcloud beta run integrations delete INTEGRATION_NAME
   

   다음과 같이 바꿉니다.

   • INTEGRATION_NAME을 Firestore 데이터베이스 통합 이름으로 바꿉니다.

   원하는 경우 다음 플래그 옵션을 사용할 수 있습니다.

   옵션	설명
   --service-account	삭제 작업을 수행할 사용자 관리형 서비스 계정 이메일 주소입니다.

코드에서 Firestore 데이터베이스 액세스

통합을 완료하면 Cloud Run에서 Cloud Run 서비스 코드에 사용할 환경 변수 FIRESTORE_DB_NAME을 자동으로 추가합니다.

Firestore를 사용하는 서비스의 샘플 코드

Firestore 서버 라이브러리 코드 샘플 또는 다음 샘플에 대한 Firestore 문서를 참조하세요.

다음 안내의 Python 샘플에서는 기본 Firestore 모드로 실행되는 Cloud Run 통합을 사용하여 생성된 Firestore 데이터베이스가 필요합니다. 또한 코드를 푸시할 기존 저장소가 있어야 합니다.

1. 샘플 파일을 위한 디렉터리를 만듭니다.

   mkdir SERVICE
   

   SERVICE를 Cloud Run 서비스 이름으로 바꿉니다.

2. Docker 인증을 구성합니다.

   gcloud auth configure-docker REGION-docker.pkg.dev
   

   REGION을 서비스의 Google Cloud 리전으로 바꿉니다.

3. SERVICE 디렉터리에 requirements.txt 파일을 만들고 다음을 추가합니다.

   flask
   google-cloud-firestore
   

4. SERVICE 디렉터리에 Dockerfile 파일을 만들고 다음을 추가합니다.

   FROM python:3.9-slim
   
   WORKDIR /app
   
   COPY requirements.txt ./
   RUN pip install -r requirements.txt
   
   COPY . .
   
   EXPOSE 8080
   
   CMD ["python", "app.py"]
   

5. SERVICE 디렉터리에 app.py 파일을 만들고 다음을 추가합니다.

   from flask import Flask, jsonify, request
   import google.cloud.firestore
   import os
   
   
   app = Flask(name)
   dbname = os.environ['FIRESTORE_DB_NAME']
   db = google.cloud.firestore.Client(database=dbname)  # Initialize Firestore client
   
   @app.route('/data', methods=['POST'])
   def add_data():
     data = request.get_json()
     db.collection('city_person').add(data)
     return jsonify({'message': 'Data added successfully!'}), 201
   
   @app.route('/data', methods=['GET'])
   def get_data():
     results = db.collection('city_person').stream()
     data_list = [doc.to_dict() for doc in results]
     return jsonify(data_list), 200
   
   if name == 'main':
     app.run(host='0.0.0.0', port=8080, debug=True)
   

6. SERVICE 디렉터리로 이동합니다.

   cd SERVICE
   

SERVICE를 Cloud Run 서비스 폴더의 이름으로 바꿉니다.

1. Docker 이미지를 빌드합니다.

   docker build -t REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/IMAGE_NAME:latest .
   

   다음과 같이 바꿉니다.

   • REGION을 서비스의 Google Cloud 리전으로 바꿉니다.
   • PROJECT_ID를 Google Cloud 프로젝트 ID로 바꿉니다.
   • REPOSITORY_NAME을 Artifact Registry 저장소 이름으로 바꿉니다.
   • IMAGE_NAME을 컨테이너 이미지에 대한 참조(예: us-docker.pkg.dev/cloudrun/container/job:latest)로 바꿉니다.

2. Docker 이미지를 푸시합니다.

   docker push REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/IMAGE_NAME:latest
   

   다음과 같이 바꿉니다.

   • REGION을 서비스의 Google Cloud 리전으로 바꿉니다.
   • PROJECT_ID를 Google Cloud 프로젝트 ID로 바꿉니다.
   • REPOSITORY_NAME을 Artifact Registry 저장소 이름으로 바꿉니다.
   • IMAGE_NAME을 컨테이너 이미지에 대한 참조(예: us-docker.pkg.dev/cloudrun/container/job:latest)로 바꿉니다.

3. Cloud Run에 서비스를 배포합니다.

   gcloud run deploy SERVICE_NAME --image REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/IMAGE_NAME:latest --allow-unauthenticated --region REGION
   

REGION을 서비스의 Google Cloud 리전으로 바꿉니다. PROJECT_ID를 Google Cloud 프로젝트 ID로 바꿉니다. REPOSITORY_NAME을 컨테이너 이미지에 대한 참조가 있는 Artifact Registry 저장소 이름(IMAGE_NAME)으로 바꿉니다(예: us-docker.pkg.dev/cloudrun/container/job:latest).

배포가 완료되면 텍스트 URL 옆에 서비스 URL이 표시됩니다.

1. Cloud Run용 Firestore 통합을 구성합니다.

   gcloud beta run integrations create \
   --type=firestore \
   --service=SERVICE_NAME \
   --region REGION
   

2. 배포가 완료되면 다음 읽기 및 쓰기 명령어에 서비스 URL을 입력합니다.

   1. 데이터 쓰기:

      curl -X POST SERVICE_URL/data -H "Content-Type: application/json" -d '{"name": "Alice", "city": "New York"}'
      

   2. 데이터 읽기:

      curl https://SERVICE_URL/data
      

데이터 읽기 명령어에 반환되는 다른 결과를 보려면 데이터 쓰기 명령어에서 이름과 도시를 변경하면 됩니다.

제한사항

• Cloud Run 통합은 특정 리전에서만 지원됩니다. Cloud Run 통합에서 지원되지 않는 리전을 사용해야 하는 경우 서버 측 클라이언트 라이브러리 사용을 참조하세요.
• Firestore 기본 데이터베이스는 지원되지 않습니다. 이 통합은 이름 지정된 Firestore 데이터베이스 만들기만 지원합니다.