GCP が本番環境で Python パッケージを公開する

GCP: Python パッケージを本番環境で公開する

このガイドでは、Google Artifact Registry を使用して共有 Python コードをパッケージとして管理する方法について説明します。このアプローチにより、Cloud Functions とサーバー間のコードの重複が排除されます。

ステップ 1: 共有コードを構造化する

共有ロジック (common_logic など) 用の新しい Python パッケージを作成します。

common_logic/
├── setup.py
├── common_logic/
│   ├── __init__.py

ステップ 2: setup.py を作成する

setup.py ファイルでパッケージ構成を定義します。

common_logic/
├── setup.py
├── common_logic/
│   ├── __init__.py

ステップ 3: Google Artifact Registry をセットアップする

1. Artifact Registry API を有効にします。

from setuptools import setup, find_packages

setup(
    name="common_logic",
    version="0.1.0",
    packages=find_packages(),
    install_requires=[
        "pandas>=1.3.0",
    ],
    author="Your Name",
    author_email="your.email@example.com",
    description="Common logic for app",
)

1. Python リポジトリを作成します。

   gcloud services enable artifactregistry.googleapis.com

ステップ 4: 認証を構成する

1. サービス アカウントを作成します。

   gcloud artifacts repositories create python-packages \
       --repository-format=python \
       --location=us-central1 \
       --description="Python packages repository"

1. 必要な権限を付与します。

   gcloud iam service-accounts create artifact-publisher \
       --description="Service account for publishing to Artifact Registry"

1. キーを作成してダウンロードします。

   gcloud artifacts repositories add-iam-policy-binding python-packages \
       --location=us-central1 \
       --member="serviceAccount:artifact-publisher@${PROJECT_ID}.iam.gserviceaccount.com" \
       --role="roles/artifactregistry.writer"

ステップ 5: パッケージをビルドしてアップロードする

1. ビルド ツールをインストールします。

   gcloud iam service-accounts keys create key.json \
       --iam-account=artifact-publisher@${PROJECT_ID}.iam.gserviceaccount.com

1. パッケージをビルドします:

   pip install build twine

1. Artifact Registry のより糸を構成します。

   python -m build

1. パッケージをアップロードします:

   cat > ~/.pypirc << EOL
   [distutils]
   index-servers = common-logic-repo
   [common-logic-repo]
   repository: https://us-central1-python.pkg.dev/${PROJECT_ID}/python-packages/
   username: _json_key_base64
   password: $(base64 -w0 key.json)
   EOL

ステップ 6: パッケージを使用する

クラウド機能内

1. requirements.txt ファイルを作成します。

   twine upload --repository common-logic-repo dist/*

1. Cloud Function でパッケージを使用します。

   --index-url https://pypi.org/simple
   --extra-index-url https://oauth2accesstoken:${ARTIFACT_REGISTRY_TOKEN}@us-central1-python.pkg.dev/${PROJECT_ID}/python-packages/simple/
   common-logic==0.1.0

サーバーコード内

1. サーバーのrequirements.txtに次の内容を追加します。

   from common_logic import ...

   def cloud_function(request):
       # Your cloud function code using the imported functions
       pass

1. サーバーコードで使用します。

   --index-url https://pypi.org/simple
   --extra-index-url https://oauth2accesstoken:${ARTIFACT_REGISTRY_TOKEN}@us-central1-python.pkg.dev/${PROJECT_ID}/python-packages/simple/
   common-logic==0.1.0

ステップ 7: CI/CD の統合

1. サービス アカウント キーを GitHub リポジトリにシークレットとして追加します。
2. Cloud Build 構成を更新します。

   from common_logic import ...
   # Your server code using the imported functions

ステップ 8: バージョン管理

1. setup.py のバージョンを更新します。
2. 新しいバージョンをビルドしてアップロードします。
3. Cloud Functions とサーバー コードの両方で、requirements.txt を更新します。
4. 両方のコンポーネントをデプロイします。

ベストプラクティス

• パッケージにはセマンティック バージョニングを使用します。
• requirements.txt に特定のバージョンを固定します。
• 新しいバージョンを展開する前に徹底的にテストします。
• バージョン変更の変更ログを保存します。
• PROJECT_ID と LOCATION には環境変数を使用します。
• パッケージに包括的なドキュメントを含めます。

一般的な問題と解決策

認証エラー

• サービス アカウントの権限を確認します。
• key.json が適切にエンコードされていることを確認してください。
• .pypirc 構成を確認します。

パッケージが見つかりません

• リポジトリ URL 形式を確認します。
• パッケージが正常にアップロードされたかどうかを確認します。
• requirements.txt が正しい URL 形式を使用していることを確認してください。

バージョンの競合

• 依存関係の特定のバージョンを固定します。
• テストには仮想環境を使用します。
• 依存関係の要件を明確に文書化します。

以上がGCP が本番環境で Python パッケージを公開するの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。