Skip to content

Commit

Permalink
move in some install docs from downstream (#246)
Browse files Browse the repository at this point in the history
  • Loading branch information
pwright authored Jun 17, 2024
1 parent e3e2e07 commit 259bc5b
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
12 changes: 12 additions & 0 deletions cli/gateway.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,16 @@ The URL field shows the underlying communication and can be ignored.

This section shows more advanced usage of skupper gateway.

. If you want to create a service type gateway on Linux, you need the `skrouterd` binary in your path.
+
Use the `yum` or `dnf` command to install the `skupper-router` package:
+
----
$ sudo dnf install skupper-router
----
+
For podman or docker type gateways, you can skip this step.

. Create a Skupper gateway:
+
--
Expand Down Expand Up @@ -173,6 +183,7 @@ where

// Type: procedure
[id="exporting-gateway"]

=== Creating a gateway and applying it on a different machine

If you have access to a cluster from one machine but want to create a gateway to the {service-network} from a different machine, you can create the gateway definition bundle on the first machine and later apply that definition bundle on a second machine as described in this procedure.
Expand Down Expand Up @@ -323,6 +334,7 @@ This shows that there is only one exposed service and that service is only expos

NOTE: If you need to change the gateway definition, for example to change port, you need to remove the existing gateway and repeat this procedure from the start to redefine the gateway.


// Type: procedure
[id="gateway-reference"]
=== Gateway YAML reference
Expand Down
26 changes: 26 additions & 0 deletions cli/podman.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,39 @@ See link:{cli-link} for information about using the Skupper CLI to create Podman

* The latest `skupper` CLI is installed.
* Podman is installed, see https://podman.io/

* `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 service endpoint.
+
--
Expand All @@ -82,6 +107,7 @@ Use `systemctl --user enable --now podman.socket` to start the Podman API Socke
See link:https://github.com/containers/podman/blob/main/docs/tutorials/socket_activation.md[Podman socket activation] for information about enabling this endpoint.
--

.Procedure

. Set your session to use Skupper Podman:
+
Expand Down

0 comments on commit 259bc5b

Please sign in to comment.