Building and packaging the application#
The local run.sh
script that we ship with the demo greeter
app has convenience functions to build, compress and package the application. For example, to build a development package one can simply run:
This function will build, compress and package the application in a deb package in your ./build
directory. You can then copy this file over to an SR Linux container or hardware system and try it out.
Packaging with nFPM
The packaging step is explained in detail in Packaging the NDK app section.
While using the run.sh
script is fine for a quick local development, you would rather have a build pipeline that can use something like Goreleaser and build, package and push the application in a single step.
The greeter app repo uses Goreleaser to build, package and push the application to a free package repository. Checkout the GitHub actions workflow defined in the cicd.yml
file for more details as well as the goreleaser.yml
file for the Goreleaser configuration.
Postinstall script#
Packaging the application in a deb package has a benefit of having a built-in mechanism to run a post-installation script. As an app developer you can craft a script that can prepare the grounds for your application to run successfully.
It can be as complex as your application requirements dictate, or as simple as just reloading the app manager once the app is installed. The latter is the case with the greeter app.
Recall, that whenever we install a new application on SR Linux system, we need to reload the application manager. App manager is like an manager of all the applications installed on the system. It parses the configuration of each app and manages the lifecycle of each app.
Thus, with every new app onboarded on the system we require to reload the application manager in order for the new app to be recognized by the system. But it is not fun to always manually type tools system app-management application app_mgr reload
whenever you install a new app...
That's where the post-install script comes in. Consider the following postinstall.sh
script that we ship with the greeter app:
#!/bin/bash
set +e
source /etc/profile.d/sr_app_env.sh
echo "Reload appmgr"
sr_cli -e "/ tools system app-management application app_mgr reload" > /dev/null 2>&1 || true
sleep 1
It does only one thing - reload the application manager - but does it just in time when the app is installed.
To make the postinstall script part of your deb package, you add the postinstall script path in your nfpm section of the goreleaser.yml
file. The rest is done by the Apt package manager. Cool!
Try greeter#
Once the application package is published in our package repository, containerlab users can install it on their SR Linux system:
Once the package is installed, reload your app manager and try configuring the greeter app: