Skip to content

Commit

Permalink
Document how to install nmc or nmstatectl (#411)
Browse files Browse the repository at this point in the history
* Document how to install nmc or nmstatectl

Signed-off-by: Andrea Mazzotti <[email protected]>
  • Loading branch information
anmazzotti authored Oct 8, 2024
1 parent 174d609 commit 48df9ce
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions docs/networking.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,39 @@ The [MachineRegistration](machineregistration-reference) supports Declarative Ne

- (optionally) [nmstatectl](https://github.com/nmstate/nmstate/releases) can be used with `nmstate` network [configurator](#configurators).

#### Installing nmc or nmstatectl on OS images

When using the `nmc` or `nmstate` configurators, the [nmc](https://github.com/suse-edge/nm-configurator/releases) or [nmstatectl](https://github.com/nmstate/nmstate/releases) tools need to be installed on the machine.

Currently this can be achieved by [customizing an Elemental OS image](./custom-images.md#remastering-an-os-image-with-a-custom-dockerfile) with a custom command:

<Tabs>

<TabItem value="nmc" label="nmc" default>

```yaml
# Install nmc
RUN wget https://github.com/suse-edge/nm-configurator/releases/download/v0.3.1/nmc-linux-x86_64 -O /usr/sbin/nmc && \
chmod +x /usr/sbin/nmc
```

</TabItem>

<TabItem value="nmstatectl" label="nmstatectl" default>

```yaml
# Install nmstatectl
RUN wget https://github.com/nmstate/nmstate/releases/download/v2.2.37/nmstatectl-linux-x64.zip && \
unzip nmstatectl-linux-x64.zip && \
chmod +x nmstatectl && \
mv ./nmstatectl /usr/sbin/nmstatectl && \
rm nmstatectl-linux-x64.zip
```

</TabItem>

</Tabs>

### How to install the CAPI IPAM Provider

The recommended way to install any CAPI Provider into Rancher is to use [Rancher Turtles](https://turtles.docs.rancher.com).
Expand Down

0 comments on commit 48df9ce

Please sign in to comment.