開発環境用の devfile の設定 - Amazon CodeCatalyst
でサポートされている開発ファイル機能 CodeCatalyst開発環境の devfile の例リカバリモードを使用したリポジトリ devfile のトラブルシューティング

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

開発環境用の devfile の設定

devfile は、チーム全体の開発環境をカスタマイズするのに役立つオープンスタンダードです。devfile は、必要な開発ツールをコーディングするYAMLファイルです。devfile を設定することで、必要なプロジェクトツールとアプリケーションライブラリを事前に決定でき、Amazon はそれらを開発環境に CodeCatalyst インストールします。devfile は、作成されたリポジトリに固有であり、リポジトリごとに個別の devfile を作成できます。開発環境はコマンドとイベントをサポートし、デフォルトのユニバーサル devfile イメージを提供します。

空のブループリントを使用してプロジェクトを作成する場合は、devfile を手動で作成できます。別のブループリントを使用してプロジェクトを作成すると、 によって devfile が自動的に CodeCatalyst 作成されます。開発環境の/projectsディレクトリには、ソースリポジトリと devfile からプルされたファイルが保存されます。開発環境を初めて作成するときに空になる /home ディレクトリには、開発環境の使用中に作成したファイルが保存されます。開発環境の /projectsおよび /home ディレクトリのすべてのものは永続的に保存されます。

注記

/home フォルダは、devfile または devfile コンポーネント名の名前を変更する場合にのみ変更されます。devfile または devfile コンポーネント名を変更すると、/homeディレクトリの内容が置き換えられ、以前の/homeディレクトリデータは復元できません。

ルートに devfile を含まないソースリポジトリを使用して開発環境を作成する場合、またはソースリポジトリなしで開発環境を作成する場合、デフォルトのユニバーサル devfile がソースリポジトリに自動的に適用されます。すべての に同じデフォルトのユニバーサル devfile イメージが使用されますIDEs。 CodeCatalyst 現在、 は devfile バージョン 2.0.0 をサポートしています。devfile の詳細については、「Devfile スキーマ - バージョン 2.0.0」を参照してください。

注記

devfile にはパブリックコンテナイメージのみを含めることができます。

VPC接続された開発環境では、次の devfile イメージのみがサポートされることに注意してください。

  • ユニバーサルイメージ

  • リポジトリが と同じリージョンにある場合のプライベート Amazon ECRイメージ VPC

トピック

でサポートされている開発ファイル機能 CodeCatalyst

CodeCatalyst は、バージョン 2.0.0 で次の devfile 機能をサポートしています。devfile の詳細については、「Devfile スキーマ - バージョン 2.0.0」を参照してください。

機能 タイプ

exec

Command

postStart

イベント

container

コンポーネント

args

コンポーネントのプロパティ

env

コンポーネントのプロパティ

mountSources

コンポーネントのプロパティ

volumeMounts

コンポーネントのプロパティ

開発環境の devfile の例

以下は、シンプルな devfile の例です。

schemaVersion: 2.0.0
metadata:
  name: al2
components:
  - name: test
    container:
      image: public.ecr.aws/amazonlinux/amazonlinux:2
      mountSources: true
      command: ['sleep', 'infinity']
  - name: dockerstore
commands:
  - id: setupscript
    exec:
      component: test
      commandLine: "chmod +x script.sh"
      workingDir: /projects/devfiles
  - id: executescript
    exec:
      component: test
      commandLine: "/projects/devfiles/script.sh"
  - id: yumupdate
    exec:
      component: test
      commandLine: "yum -y update --security"
events:
  postStart:
    - setupscript
    - executescript
    - yumupdate

Devfile の起動、コマンド、およびイベントログはキャプチャされ、 に保存されます/aws/mde/logs。devfile の動作をデバッグするには、動作中の devfile を使用して開発環境を起動し、ログにアクセスします。

リカバリモードを使用したリポジトリ devfile のトラブルシューティング

devfile の起動に問題がある場合は、復旧モードになり、環境に接続して devfile を修正できます。復旧モードの間、 を実行する/aws/mde/mde statusと devfile の場所は含まれません。

{
            "status": "STABLE"
        }

のログでエラーを確認し/aws/mde/logs、devfile を修正して、/aws/mde/mde startもう一度実行してみてください。