From 25cb5a399a31870d69c6c4b7bfa4df8a862a1a00 Mon Sep 17 00:00:00 2001 From: Paul Wright Date: Fri, 15 Nov 2024 09:02:59 +0000 Subject: [PATCH 1/3] networkBackend --- cli/networkBackend.adoc | 35 +++++++++++++++++++++++++++++++++++ cli/podman.adoc | 23 ++--------------------- 2 files changed, 37 insertions(+), 21 deletions(-) create mode 100644 cli/networkBackend.adoc diff --git a/cli/networkBackend.adoc b/cli/networkBackend.adoc new file mode 100644 index 0000000..f4c0f26 --- /dev/null +++ b/cli/networkBackend.adoc @@ -0,0 +1,35 @@ +include::../partials/attributes.adoc[] +// Category: skupper-cli +// Type: procedure +[id='podman-networkbackend'] += Configuring Podman networkBackend for {skupper-name} + +By default, Podman v4 and later use Netavark which works with {skupper-name}. +However, if you upgraded from an earlier version of Podman, you might need to configure Podman to use Netavark. + +If you are using CNI, for example, if you upgrade from Podman v3, you must also install the `podman-plugins` package. +For example, `dnf install podman-plugins` for RPM based distributions. + +NOTE: CNI will be deprecated in the future in preference of Netavark. + +.Procedure + +. To install `netavark` on rpm based Linux, for example, RHEL8: ++ +---- +$ sudo dnf install netavark +---- + +. Configure podman to use `netavark` by making sure the following lines exist in the `/etc/containers/containers.conf` file: ++ +---- +[network] +network_backend = "netavark" +---- + +. Confirm that `netavark` is configured as the podman network backend: ++ +---- +$ podman info --format {{.Host.NetworkBackend}} +---- + diff --git a/cli/podman.adoc b/cli/podman.adoc index 5bd51ef..9f9fe16 100644 --- a/cli/podman.adoc +++ b/cli/podman.adoc @@ -68,32 +68,13 @@ See link:{cli-link} for information about using the Skupper CLI to create Podman * `netavark` is configured as the podman network backend. + -- -By default, Podman v4 uses Netavark which works with Skupper. - -If you are using CNI, for example, if you upgrade from Podman v3, you must also install the `podman-plugins` package. -For example, `dnf install podman-plugins` for RPM based distributions. - -NOTE: CNI will be deprecated in the future in preference of Netavark. - To check if `netavark` is configured as the podman network backend: ---- -$ podman info | grep networkBackend ----- - -To install `netavark` on rpm based Linux, eg RHEL8: - ----- -$ sudo dnf install netavark ----- - -Configure podman to use `netavark` by making sure the following lines exist in the `/etc/containers/containers.conf` file: - ----- -[network] -network_backend = "netavark" +$ podman info --format {{.Host.NetworkBackend}} ---- +If the output is something other than `netavark`, see link:networkBackend.adoc[Configuring Podman networkBackend for {skupper-name}]. -- From d3b678bb92e6c380e1846a4d97d7e86490b436ca Mon Sep 17 00:00:00 2001 From: Paul Wright Date: Fri, 15 Nov 2024 09:08:29 +0000 Subject: [PATCH 2/3] links --- cli/networkBackend.adoc | 3 +++ cli/podman.adoc | 2 +- partials/attributes.adoc | 1 + 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/cli/networkBackend.adoc b/cli/networkBackend.adoc index f4c0f26..0c84dd1 100644 --- a/cli/networkBackend.adoc +++ b/cli/networkBackend.adoc @@ -33,3 +33,6 @@ network_backend = "netavark" $ podman info --format {{.Host.NetworkBackend}} ---- +.Additional information + +See link:{podman-link}[Using Skupper Podman]. diff --git a/cli/podman.adoc b/cli/podman.adoc index 9f9fe16..4f2cd8c 100644 --- a/cli/podman.adoc +++ b/cli/podman.adoc @@ -74,7 +74,7 @@ To check if `netavark` is configured as the podman network backend: $ podman info --format {{.Host.NetworkBackend}} ---- -If the output is something other than `netavark`, see link:networkBackend.adoc[Configuring Podman networkBackend for {skupper-name}]. +If the output is something other than `netavark`, see link:{networkbackend-link}. -- diff --git a/partials/attributes.adoc b/partials/attributes.adoc index fd9a998..cf015a2 100644 --- a/partials/attributes.adoc +++ b/partials/attributes.adoc @@ -7,6 +7,7 @@ :console-link: ../console/index.html[Using the Skupper console] :cli-link: ../cli/index.html[Using the Skupper CLI] :podman-link: ../cli/podman.html[Using Skupper Podman] +:networkbackend-link: ../cli/networkBackend.html[Configuring Podman networkBackend for {skupper-name}] :tokens-link: ../cli/tokens.html[Using Skupper tokens] :overview-link: ../overview/index.html[Overview] :security-link: ../overview/security.html[Security] From 2f2c1ae834c7c5ea0795df01cb4783ca90b5baf1 Mon Sep 17 00:00:00 2001 From: Paul Wright Date: Mon, 18 Nov 2024 13:59:05 +0000 Subject: [PATCH 3/3] correct build --- README.adoc | 3 +-- cli/index.adoc | 2 -- published-adoc.txt | 1 + 3 files changed, 2 insertions(+), 4 deletions(-) diff --git a/README.adoc b/README.adoc index 7798429..497ea7a 100644 --- a/README.adoc +++ b/README.adoc @@ -22,8 +22,7 @@ If you want to preview changes for more complex contributions, follow this proce . Start the build: + ---- -$ python scripts/convert-all.py ./scripts/convert --adoc.sh .github/workflows/asciidoc-convert-check.yml +$ python scripts/convert-all.py ./scripts/convert-adoc.sh published-adoc.txt ---- * `convert-adoc.sh` converts each adoc to HTML diff --git a/cli/index.adoc b/cli/index.adoc index 21c7184..b4f63b4 100644 --- a/cli/index.adoc +++ b/cli/index.adoc @@ -454,8 +454,6 @@ include::./single-logical-service.adoc[leveloffset=0] include::./protocols.adoc[leveloffset=0] -include::../kubernetes/ingress.adoc[leveloffset=1] - // Type: reference [id="cli-global-options"] == CLI options diff --git a/published-adoc.txt b/published-adoc.txt index a402a78..4989ad0 100644 --- a/published-adoc.txt +++ b/published-adoc.txt @@ -1,6 +1,7 @@ cli/index.adoc cli/tokens.adoc cli/podman.adoc +cli/networkBackend.adoc cli/native-security-options.adoc yaml/index.adoc operator/index.adoc