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

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

При создании сетевых модулей для новой платформы или изменении подключений, предоставляемых существующей сетевой платформой (например, 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.