Документирование новых сетевых платформ

• Изменение таблицы опций платформы
• Добавление раздела опций, специфичных для платформы
• Добавление нового файла в оглавление

При создании сетевых модулей для новой платформы или изменении подключений, предоставляемых существующей сетевой платформой (например, network_cli и httpapi), необходимо также обновить таблицу Настройки по платформам и добавить или изменить файл опций платформы для вашей платформы.

Вы должны уже задокументировать каждый модуль, как описано в Формат и документация модулей.

Изменение таблицы опций платформы

Таблица Настройки по платформам — это удобный свод опций подключений, предоставляемых каждой сетевой платформой, имеющей модули в 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 для получения дополнительной информации.