Merge pull request #944 from jared-bloomer/netbox-slurpit

feat(Install Slurpit Plugin for netbox)
This commit is contained in:
aptalca
2024-08-27 11:16:59 -04:00
committed by GitHub
22 changed files with 26 additions and 106 deletions
+3 -3
View File
@@ -5,9 +5,9 @@ on: [push, pull_request_target, workflow_dispatch]
env:
GITHUB_REPO: "linuxserver/docker-mods" #don't modify
ENDPOINT: "linuxserver/mods" #don't modify
BASEIMAGE: "replace_baseimage" #replace
MODNAME: "replace_modname" #replace
MULTI_ARCH: "true" #set to false if not needed
BASEIMAGE: "netbox" #replace
MODNAME: "slurpit" #replace
MULTI_ARCH: "false" #set to false if not needed
jobs:
set-vars:
+1 -1
View File
@@ -2,7 +2,7 @@
FROM scratch
LABEL maintainer="username"
LABEL maintainer="jared-bloomer"
# copy local files
COPY root/ /
-33
View File
@@ -1,33 +0,0 @@
# syntax=docker/dockerfile:1
## Buildstage ##
FROM ghcr.io/linuxserver/baseimage-alpine:3.20 AS buildstage
RUN \
echo "**** install packages ****" && \
apk add --no-cache \
curl && \
echo "**** grab rclone ****" && \
mkdir -p /root-layer && \
if [ $(uname -m) = "x86_64" ]; then \
echo "Downloading x86_64 tarball" && \
curl -o \
/root-layer/rclone.deb -L \
"https://downloads.rclone.org/v1.47.0/rclone-v1.47.0-linux-amd64.deb"; \
elif [ $(uname -m) = "aarch64" ]; then \
echo "Downloading aarch64 tarball" && \
curl -o \
/root-layer/rclone.deb -L \
"https://downloads.rclone.org/v1.47.0/rclone-v1.47.0-linux-arm64.deb"; \
fi && \
# copy local files
COPY root/ /root-layer/
## Single layer deployed image ##
FROM scratch
LABEL maintainer="username"
# Add files from buildstage
COPY --from=buildstage /root-layer/ /
+10 -20
View File
@@ -1,25 +1,15 @@
# Rsync - Docker mod for openssh-server
# SlurpIT - Docker mod for installing the SlurpIT plugin for netbox
This mod adds rsync to openssh-server, to be installed/updated during container start.
This mod adds the slurpit plugin to a netbox container.
In openssh-server docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:openssh-server-rsync`
In netbox docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:netbox-slurpit`
If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:openssh-server-rsync|linuxserver/mods:openssh-server-mod2`
Update your `configuration.py` to include the plugin
# Mod creation instructions
```
...
# Enable installed plugins. Add the name of each plugin to the list.
PLUGINS = ['slurpit_netbox']
* Fork the repo, create a new branch based on the branch `template`.
* Edit the `Dockerfile` for the mod. `Dockerfile.complex` is only an example and included for reference; it should be deleted when done.
* Inspect the `root` folder contents. Edit, add and remove as necessary.
* After all init scripts and services are created, run `find ./ -path "./.git" -prune -o \( -name "run" -o -name "finish" -o -name "check" \) -not -perm -u=x,g=x,o=x -print -exec chmod +x {} +` to fix permissions.
* Edit this readme with pertinent info, delete these instructions.
* Finally edit the `.github/workflows/BuildImage.yml`. Customize the vars for `BASEIMAGE` and `MODNAME`. Set the versioning logic and `MULTI_ARCH` if needed.
* Ask the team to create a new branch named `<baseimagename>-<modname>`. Baseimage should be the name of the image the mod will be applied to. The new branch will be based on the `template` branch.
* Submit PR against the branch created by the team.
## Tips and tricks
* Some images have helpers built in, these images are currently:
* [Openvscode-server](https://github.com/linuxserver/docker-openvscode-server/pull/10/files)
* [Code-server](https://github.com/linuxserver/docker-code-server/pull/95)
...
```
@@ -1,30 +0,0 @@
#!/usr/bin/with-contenv bash
# This is the init file used for adding os or pip packages to install lists.
# It takes advantage of the built-in init-mods-package-install init script that comes with the baseimages.
# If using this, we need to make sure we set this init as a dependency of init-mods-package-install so this one runs first
if ! command -v apprise; then
echo "**** Adding apprise and its deps to package install lists ****"
echo "apprise" >> /mod-pip-packages-to-install.list
## Ubuntu
if [ -f /usr/bin/apt ]; then
echo "\
python3 \
python3-pip \
runc" >> /mod-repo-packages-to-install.list
fi
# Alpine
if [ -f /sbin/apk ]; then
echo "\
cargo \
libffi-dev \
openssl-dev \
python3 \
python3-dev \
python3 \
py3-pip" >> /mod-repo-packages-to-install.list
fi
else
echo "**** apprise already installed, skipping ****"
fi
@@ -1 +0,0 @@
/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-add-package/run
@@ -1,8 +0,0 @@
#!/usr/bin/with-contenv bash
# This is an install script that is designed to run after init-mods-package-install
# so it can take advantage of packages installed
# init-mods-end depends on this script so that later init and services wait until this script exits
echo "**** Setting up apprise ****"
apprise blah blah
@@ -1 +0,0 @@
oneshot
@@ -1 +0,0 @@
/etc/s6-overlay/s6-rc.d/init-mod-imagename-modname-install/run
@@ -0,0 +1,11 @@
#!/usr/bin/with-contenv bash
echo '**** Checking if slurpit_netbox is already installed ****'
if ! pip list 2>&1 | grep -q "slurpit_netbox"; then
echo "**** Adding slurpit_netbox and their deps to package install lists ****"
echo "\
setuptools \
slurpit_netbox" >> /mod-pip-packages-to-install.list
else
echo "**** slurpit_netbox already installed, skipping ****"
fi
@@ -0,0 +1 @@
/etc/s6-overlay/s6-rc.d/init-mod-netbox-slurpit-install/run
@@ -1,7 +0,0 @@
#!/usr/bin/with-contenv bash
# This is an example service that would run for the mod
# It depends on init-services, the baseimage hook for start of all longrun services
exec \
s6-setuidgid abc run my app
@@ -1 +0,0 @@
longrun