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

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

Таблица Настройки по платформам — это удобная сводка параметров подключений, предоставляемых каждой сетевой платформой, для которой в Ansible есть модули. Добавьте строку для своей платформы в эту таблицу в алфавитном порядке. Например:

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

Убедитесь, что форматирование таблицы сохранено. То есть:

• Каждая строка добавлена в алфавитном порядке.
• Маркеры разделения ячеек | выровнены по маркерам +.
• Галочки стоят только для типов подключений, предоставляемых сетевыми модулями.

Добавление раздела с параметрами для конкретной платформы

Разделы для конкретных платформ — это отдельные файлы .rst, содержащие более подробную информацию для пользователей модулей вашей сетевой платформы. Назовите новый файл platform_<name>.rst (например, platform_myos.rst). Название платформы должно совпадать с префиксом модуля. Примеры сведений, которые следует указать в разделе с параметрами для конкретной платформы, см. в файле platform_eos.rst и разделе Параметры платформы EOS.

Раздел для конкретной платформы должен включать следующее:

• Таблица доступных подключений — подробное описание каждого типа подключения, включая сведения об учетных данных, косвенном доступе, настройках подключений и режиме enable.
• Инструкции по использованию каждого типа подключения — с рабочими примерами каждого типа подключения.

Если ваша сетевая платформа поддерживает подключения по SSH, добавьте также следующий раздел в конец файла .rst:

.. include:: shared_snippets/SSH_warning.txt

Добавление нового файла в оглавление

В завершение добавьте новый файл в алфавитном порядке в файл platform_index.rst. Затем соберите документацию, чтобы проверить внесенные изменения. Подробнее см. в разделе Участие в работе над документацией Ansible.