Skip to content

Commit

Permalink
README.md: include augeas plugin info and update build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
zinccyy committed Feb 9, 2023
1 parent 0b407f4 commit ad7da1c
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,17 +63,20 @@ $ cmake -DSYSTEMD_IFINDEX=1 ..
```
note: SYSTEMD_IFINDEX cmake flag is the index of the interface you wish to configure DNS on (to get a list of indexes for all interfaces, use: `ip link`)

The default configuration builds the plugin as a stand-alone foreground application. To build the plugin as a shared object file for use with `sysrepo-plugind`, run the following instead:

If augeas/augyang configuration is needed (only supported for `ntp` container and the `hostname` leaf node), the augeas specific plugin can be built by providing the CMake option:
```
$ cmake -DPLUGIN=ON ..
$ mkdir build
$ cd build
$ cmake -DSYSTEMD_IFINDEX=1 -DENABLE_AUGEAS_PLUGIN=ON ..
```

Lastly, invoke the build and install using `make`:
### Build artifacts

```
$ make -j$(nproc) install
```
Plugin will be built as a standalone application and also as a `sysrepo-plugind` module. For example, for the main ietf-system plugin there are two build artifacts:
- **ietf-system-plugin**: standalone application
- **libsrplg-ietf-system.so**: `sysrepo-plugind` module which exposes the plugin init and cleanup callbacks and can be installed by invoking the following command: `sysrepo-plugind -P libsrplg-ietf-system.so`

### Sysrepo/YANG requirements

The plugin requires the `iana-crypt-hash` and `ietf-system` YANG modules to be loaded into the Sysrepo datastore. This can be achieved by invoking the following commands:

Expand Down

0 comments on commit ad7da1c

Please sign in to comment.