新しいネットワークプラットフォームのドキュメント化

新しいプラットフォーム用のネットワークモジュールを作成する場合や、既存のネットワークプラットフォーム (network_cli、httpapi など) が提供する接続を変更する場合には、プラットフォーム別の設定 テーブルを更新して、プラットフォームの Platform Options ファイルを追加または変更することも必要です。

各モジュールは、「モジュールの形式およびドキュメント」で説明されているように、各モジュールがすでに文書化されている必要があります。

プラットフォームオプションテーブルの変更

プラットフォーム別の設定 テーブルは、Ansible にモジュールがある各ネットワークプラットフォームが提供する接続オプションの概要です。この表に、プラットフォームの行をアルファベット順に追加します。 例:

+-------------------+-------------------------+-------------+---------+---------+----------+
| My OS             | ``myos``                | ✓           | ✓       |         | ✓        |

テーブルの形式が正しく維持されていることを確認します。つまり、以下のようになります。

• 各行はアルファベット順に挿入されます。
• セル分割マーカー | は、+ マーカの位置に並んでいます。
• このチェックマークは、ネットワークモジュールが提供する接続タイプについてのみ表示されます。

プラットフォーム固有のオプションセクションの追加

プラットフォーム固有のセクションは、ネットワークプラットフォームモジュールのユーザーの詳細情報を提供する個々の .rst ファイルです。 新しいファイルの platform_<name>.rst (たとえば platform_myos.rst) に名前を付けます。 プラットフォーム名は、モジュールの接頭辞と一致する必要があります。プラットフォーム固有のオプションセクションで指定する必要のある詳細の例は、platform_eos.rst および EOS プラットフォームのオプション を参照してください。

プラットフォーム固有のセクションには、以下のセクションが含まれている必要があります。

• 接続可能なテーブル - 認証情報、間接アクセス、接続設定、および有効化モードの詳細など、各接続タイプのより深い側面があります。
• 各接続タイプの使用方法 - 各接続タイプの作業例あり

ネットワークプラットフォームが SSH 接続に対応している場合は、.rst ファイルの下部に以下も追加します。

.. include:: shared_snippets/SSH_warning.txt

新規ファイルのコンテンツの表への追加

最後のステップとして、platform_index.rst ファイルに新規ファイルをアルファベット順に追加します。次に、追加内容を確認するためにドキュメントを構築する必要があります。詳細は、Ansible ドキュメントへの貢献 を参照してください。