Poetry - プライベートパッケージ

Aikido がプライベートパッケージを含む依存関係を更新するには、正確な lockfile の更新を生成できるように、プライベートレジストリへのアクセスが必要です。Poetry では、 Google Artifact Registry の設定用サービスキーを提供するか、または 環境変数 Aikido内で。

環境変数を使って認証情報を追加する

プライベートレジストリに接続するための認証情報が静的な場合は、環境変数でそれらを提供できます。環境変数は次の形式で作成する必要があります:

• POETRY_HTTP_BASIC_[SOURCE_NAME]_USERNAME
• POETRY_HTTP_BASIC_[SOURCE_NAME]_PASSWORD

ここで [SOURCE_NAME] は、あなたが pyproject.toml ファイルで指定したデータソース名を大文字で表したものです。たとえば、次を設定します POETRY_HTTP_BASIC_ARTIFACT_USERNAME と POETRY_HTTP_BASIC_ARTIFACT_PASSWORD 次のプロジェクトファイルに対して:

[[tool.poetry.source]]
name = "artifact"
url = "https://repo-1234567890.d.codeartifact.eu-west-1.amazonaws.com/pypi/poetry/simple/"

以下の手順で、Aikido で Poetry の環境変数を設定できます:

1. Aikido の AutoFix のアカウント設定ページに移動し、 こちら.
2. 「Connect Registry」をクリックすると、設定モーダルが表示されます

1. Poetry を選択すると、次の POETRY_HTTP_BASIC_[SOURCE_NAME]_USERNAME と POETRY_HTTP_BASIC_[SOURCE_NAME]_PASSWORD 環境変数を追加できるようになります:

1. ［Connect Registry］をクリックして環境変数を保存します。

Poetry と AWS CodeArtifact を併用している場合、パスワードはその場で生成する必要があります。こちらを ページ Poetry を AWS CodeArtifact で設定する方法について参照してください。

Autofix 経由で PR を作成する際、Aikido は Poetry コマンド実行時にこれらの環境変数を含めます。

GCP Artifact Registry の認証情報を追加する

GCP Artifact Registry では、認証情報を静的に生成することはできません。この場合は、以下の手順に従ってください。

1. GCP でサービス アカウントを作成する

まず、Google Cloud プロジェクトでサービス アカウントを作成します:

1. Google Cloud コンソールに移動します。
2. 移動先: IAM & Admin > Service Accounts.
3. クリック サービス アカウントを作成.
4. 次を入力します: サービス アカウント名 たとえば Aikido Artifact Registry Reader をクリックし 作成して続行.
5. サービス アカウントに次の権限を付与します: Artifact Registry Reader のロールが付与されます。

   

   Google Cloud プロジェクト内のサービス アカウントに「Artifact Registry Reader」ロールを割り当てます。
6. クリック 続行 と 完了.

2. GCP でサービス アカウントのキーを作成する

1. のステップで、 Service Accounts ページで、先ほど作成したサービス アカウントを見つけます。
2. 右側の三点メニューをクリックして、 キーを管理.
3. クリック キーを追加 > 新しいキーを作成.
4. 選択 JSON をクリックし 作成.
5. JSON キーファイルを安全な場所に保存します。

3. Aikido での設定

前提条件が満たされたら、以下の手順に従って、依存関係を更新する際に Aikido がプライベートレジストリで認証するよう設定できます:

1. Aikido の autofixer のアカウント設定ページに移動し、 こちら.
2. 「Connect Registry」をクリックすると、設定モーダルが表示されます

1. Poetry を選択して、 GCP サービス アカウント キー セクションをモーダルの下部で見つけます:

1. 保存した JSON キー の内容を プライベートレジストリのサービス アカウント キー 欄
2. クリック レジストリに接続 に貼り付けて設定を保存します。