8.3. ロールのコレクションをスキャフォールディングする
VS Code の Ansible 拡張機能からロールのコレクションをスキャフォールディングできます。
手順
- VS Code を開きます。
- ロールのコレクションを作成するディレクトリーに移動します。
- VS Code アクティビティーバーの Ansible アイコンをクリックして、Ansible 拡張機能を開きます。
Ansible content creator セクションで Get started を選択します。
Ansible content creator タブが開きます。
Create セクションで、Ansible collection project をクリックします。
Create new Ansible project タブが開きます。
Create Ansible project タブのフォームに、以下を入力します。
-
Namespace: 名前空間の名前を入力します (例:
company_namespace)。 -
Collection: コレクションの名前を入力します (例:
myapp_network)。 Init path: 新しいコレクションをスキャフォールディングするディレクトリーへのパスを入力します。
既存のディレクトリー名を入力すると、スキャフォールディングプロセスによってそのディレクトリーの内容が上書きされます。スキャフォールディングプロセスでは、Force オプションを有効にした場合にのみ、既存のディレクトリーを使用できます。
-
コンテナー化されたバージョンの Ansible 開発ツールを使用している場合、宛先ディレクトリーのパスは、コンテナーを基準とした相対パスであり、ローカルシステム内のパスではありません。コンテナー内の現在のディレクトリー名を確認するには、VS Code のターミナルで pwd コマンドを実行します。コンテナー内のカレントディレクトリーが
workspacesの場合は、workspaces/<current_project>/collectionsと入力します。 -
ローカルにインストールされたバージョンの Ansible Dev ツールを使用している場合は、ディレクトリーへのフルパスを入力します (例:
/user/<username>/path/to/<collection_directory>)。
-
コンテナー化されたバージョンの Ansible 開発ツールを使用している場合、宛先ディレクトリーのパスは、コンテナーを基準とした相対パスであり、ローカルシステム内のパスではありません。コンテナー内の現在のディレクトリー名を確認するには、VS Code のターミナルで pwd コマンドを実行します。コンテナー内のカレントディレクトリーが
-
Namespace: 名前空間の名前を入力します (例:
- をクリックします。
検証
Create Ansible collection タブの Logs ペインに次のメッセージが表示されます。
--------------------- ansible-creator logs ---------------------
Note: collection company_namespace.myapp_network created at /path/to/collections/directory
collections/ ディレクトリーに、次のディレクトリーとファイルが作成されます。
├── .devcontainer
├── .github
├── .gitignore
├── .isort.cfg
├── .pre-commit-config.yaml
├── .prettierignore
├── .vscode
├── CHANGELOG.rst
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING
├── LICENSE
├── MAINTAINERS
├── README.md
├── changelogs
├── devfile.yaml
├── docs
├── extensions
├── galaxy.yml
├── meta
├── plugins
├── pyproject.toml
├── requirements.txt
├── roles
├── test-requirements.txt
├── tests
└── tox-ansible.ini