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

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

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