Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the doc content for edpm_network_config #832

Merged
merged 1 commit into from
Dec 4, 2024
+32 −7
Merged

Update the doc content for edpm_network_config #832

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 32 additions & 7 deletions docs/source/roles/role-edpm_network_config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,35 @@
=============================
============================
Role - edpm_network_config
=============================
============================

.. note::
When the `edpm_network_config_tool` is set to `'os-net-config'`, the `ctlplane_gateway_ip` and `ctlplane_ip`
variables must be set on the host.
Usage
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this no longer true?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True - but it will be applicable to both "tools" I guess.
Also, this param was originally part of undercloud.conf - now it is defined as part of network definition. For rhoso, still not sure if user will use same control plane for ocp/edpm nodes. Removed it to avoid confusion.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that makes sense, thank you

~~~~~

.. include::
../collections/osp/edpm/edpm_network_config_role.rst
This Ansible role does the following tasks:

* Read the configured edpm_network_config_tool
The following choices can be used to configure the host network:
- nmstate, i.e based on systemroles.network
- os-net-config, i.e based on custom tasks
os-net-config is the default tool for this role
vcandapp marked this conversation as resolved.
Show resolved Hide resolved

* For os-net-config option, this role prepares the host by
- creating necessary folders and files for rendering network
templates and NIC mappings (optional)
- Checks for the presence of required RPMS
- Uses "provider" ifcfg/nmstate based on flag "edpm_network_config_nmstate"

Here is an example playbook to run os-net-config tool:

.. code-block:: YAML

- name: Apply network_config
block:
- name: Configure host network with edpm-ansible
include_role:
name: edpm_network_config
vars:
edpm_network_config_template: "{{ nic_config_file }}"

.. literalinclude:: ../../../roles/edpm_network_config/tasks/os_net_config.yml
:language: YAML
Loading