oxidized 0.32.1 → 0.34.0

data/Dockerfile

@@ -1,61 +1,27 @@
-###################
-# Stage 1: Prebuild to save space in the final image.
-
-FROM docker.io/phusion/baseimage:noble-1.0.0 AS prebuilder
-
-# install necessary packages for building gems
-RUN apt-get update && apt-get install -y \
-    build-essential \
-    git \
-    ruby-dev \
-    && rm -rf /var/lib/apt/lists/*
-
-# create bundle directory
-RUN mkdir -p /usr/local/bundle
-ENV GEM_HOME=/usr/local/bundle
-
-###################
-# Install the x25519 gem
-RUN gem install x25519 --no-document
-
-
-###################
-# build oxidized
-COPY . /tmp/oxidized/
-WORKDIR /tmp/oxidized
-
-# docker automated build gets shallow copy, but non-shallow copy cannot be unshallowed
-RUN git fetch --unshallow || true
-
-# Remove any older gems of oxidized if they exist
-RUN rm pkg/* || true
-
-# Ensure rugged is built with ssh support
-RUN rake build
-
-
-###################
-# Stage2: build an oxidized container from phusion/baseimage-docker and install x25519 from stage1
-FROM docker.io/phusion/baseimage:noble-1.0.0
+FROM docker.io/phusion/baseimage:noble-1.0.2
 
 ENV DEBIAN_FRONTEND=noninteractive
 
 ##### Place "static" commands at the beginning to optimize image size and build speed
+# remove default ubuntu user
+RUN userdel -r ubuntu
+
 # add non-privileged user
 ARG UID=30000
 ARG GID=$UID
 RUN groupadd -g "${GID}" -r oxidized && useradd -u "${UID}" -r -m -d /home/oxidized -g oxidized oxidized
 
-# link config for msmtp for easier use.
-RUN ln -s /home/oxidized/.config/oxidized/.msmtprc /home/oxidized/
-
-# create parent directory & touch required file
-RUN mkdir -p /home/oxidized/.config/oxidized/
-RUN touch /home/oxidized/.config/oxidized/.msmtprc
 
-# setup the access to the file
-RUN chmod 600 /home/oxidized/.msmtprc
-RUN chown oxidized:oxidized /home/oxidized/.msmtprc
+##### MSMTP - Sending emails
+# link config for msmtp for easier use.
+# /home/oxidized/.msmtprc is a symbolic link to /home/oxidized/.config/oxidized/.msmtprc
+# Create the files as the user oxidized
+RUN mkdir -p /home/oxidized/.config/oxidized/ && \
+    chmod -R ug=rwX,o= /home/oxidized/.config/ && \
+    touch /home/oxidized/.config/oxidized/.msmtprc && \
+    chmod -R u=rw,go= /home/oxidized/.config/oxidized/.msmtprc && \
+    ln -s /home/oxidized/.config/oxidized/.msmtprc /home/oxidized/ && \
+    chown -R oxidized:oxidized /home/oxidized/.config /home/oxidized/.msmtprc
 
 # add runit services
 COPY extra/oxidized.runit /etc/service/oxidized/run
@@ -63,10 +29,10 @@ COPY extra/auto-reload-config.runit /etc/service/auto-reload-config/run
 COPY extra/update-ca-certificates.runit /etc/service/update-ca-certificates/run
 
 # set up dependencies for the build process
-RUN apt-get -yq update \
-    && apt-get -yq upgrade \
-    && apt-get -yq --no-install-recommends install ruby \
-    # Build process of oxidized from git (beloww)
+RUN apt-get -qy update \
+    && apt-get -qy upgrade \
+    && apt-get -qy --no-install-recommends install ruby \
+    # Build process of oxidized from git and git-tools in the container
     git \
     # Allow git send-email from docker image
     git-email libmailtools-perl \
@@ -90,13 +56,6 @@ RUN apt-get -yq update \
     && apt-get clean \
     && rm -rf /var/lib/apt/lists/*
 
-# copy the compiled gem from the builder stage
-COPY --from=prebuilder /usr/local/bundle /usr/local/bundle
-
-# Set environment variables for bundler
-ENV GEM_HOME="/usr/local/bundle"
-ENV PATH="$GEM_HOME/bin:$PATH"
-
 # gems not available in ubuntu noble
 RUN gem install --no-document \
     # dependencies for hooks
@@ -106,11 +65,25 @@ RUN gem install --no-document \
     # Net scp is needed in Version >= 4.1.0, which is not available in ubuntu
     net-scp
 
-# install oxidized from prebuilder
-# The Dockerfile ist version-independent, so use oxidized-*.gem to cach the gem
-RUN mkdir -p /tmp/oxidized
-COPY --from=prebuilder /tmp/oxidized/pkg/oxidized-*.gem /tmp/oxidized/
-RUN gem install /tmp/oxidized/oxidized-*.gem
+# Prepare the build of oxidized, copy our workig directory in the container
+COPY . /tmp/oxidized/
+WORKDIR /tmp/oxidized
+
+# Install gems which needs a build environment
+RUN apt-get -qy update && \
+    apt-get -qy install --no-install-recommends \
+                        build-essential ruby-dev && \
+    ##### X25519 (a.k.a. Curve25519) Elliptic Curve Diffie-Hellman
+    gem install x25519 && \
+    ##### build & install oxidized from the working repository
+    # docker automated build gets shallow copy, but non-shallow copy cannot be unshallowed
+    git fetch --unshallow || true && \
+    rake install && \
+    # remove the packages we do not need.
+    apt-get -qy remove build-essential ruby-dev && \
+    apt-get -qy autoremove && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*
 
 # install oxidized-web
 RUN gem install oxidized-web --no-document

data/README.md

@@ -1,9 +1,6 @@
 # Oxidized
 
 [![Build Status](https://github.com/ytti/oxidized/actions/workflows/ruby.yml/badge.svg)](https://github.com/ytti/oxidized/actions/workflows/ruby.yml)
-[![codecov.io](https://codecov.io/gh/ytti/oxidized/coverage.svg?branch=master)](https://codecov.io/gh/ytti/oxidized?branch=master)
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/5a90cb22db6a4d5ea23ad0dfb53fe03a)](https://www.codacy.com/app/ytti/oxidized?utm_source=github.com&utm_medium=referral&utm_content=ytti/oxidized&utm_campaign=Badge_Grade)
-[![Code Climate](https://codeclimate.com/github/ytti/oxidized/badges/gpa.svg)](https://codeclimate.com/github/ytti/oxidized)
 [![Gem Version](https://badge.fury.io/rb/oxidized.svg)](http://badge.fury.io/rb/oxidized)
 [![Join the chat at https://gitter.im/oxidized/Lobby](https://badges.gitter.im/oxidized/Lobby.svg)](https://gitter.im/oxidized/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
@@ -14,7 +11,7 @@ It is light and extensible and supports over 130 operating system types.
 Feature highlights:
 
 * Automatically adds/removes threads to meet configured retrieval interval
-* Restful API to a move node immediately to head-of-queue (GET/POST /node/next/[NODE])
+* Restful API to a move node immediately to head-of-queue (GET/PUT /node/next/[NODE])
 * Syslog udp+file example to catch config change events (IOS/JunOS) and trigger a config fetch
   * Will signal which IOS/JunOS user made the change, can then be used by output modules (via POST)
   * The `git` output module uses this info - 'git blame' will show who changed each line
@@ -34,12 +31,10 @@ Check out the [Oxidized TREX 2014 presentation](http://youtu.be/kBQ_CTUuqeU?t=3h
 1. [Supported OS Types](docs/Supported-OS-Types.md)
 2. [Installation](#installation)
     * [Debian and Ubuntu](#debian-and-ubuntu)
-    * [CentOS, Oracle Linux, Red Hat Linux](#centos-oracle-linux-red-hat-linux)
+    * [Rocky Linux, Red Hat Enterprise Linux](#rocky-linux-red-hat-enterprise-linux)
     * [FreeBSD](#freebsd)
     * [Build from Git](#build-from-git)
-    * [Docker](#running-with-docker)
-    * [Podman-Compose](#running-with-podman-compose)
-    * [Installing Ruby 2.3 using RVM](#installing-ruby-23-using-rvm)
+    * [Docker & Podman](docs/Docker.md)
 3. [Initial Configuration](#configuration)
 4. [Configuration](docs/Configuration.md)
     * [Debugging](docs/Configuration.md#debugging)
@@ -89,185 +84,96 @@ add-apt-repository universe
 Install the dependencies:
 
 ```shell
-apt-get install ruby ruby-dev libsqlite3-dev libssl-dev pkg-config cmake libssh2-1-dev libicu-dev zlib1g-dev g++ libyaml-dev
+apt install ruby ruby-dev libsqlite3-dev libssl-dev pkg-config cmake libssh2-1-dev libicu-dev zlib1g-dev g++ libyaml-dev
 ```
 
-Finally, install the gems:
+Finally, install Oxidized:
 
 ```shell
 gem install oxidized
-gem install oxidized-script oxidized-web # If you don't install oxidized-web, ensure "rest" is removed from your Oxidized config.
 ```
 
-### CentOS, Oracle Linux, Red Hat Linux
-
-On CentOS 6 and 7 / RHEL 6 and 7, begin by installing Ruby 3.1 via RVM by following the instructions:
-
-Make sure you dont have any leftover ruby:
-```yum erase ruby```
-
-Then, install gpg key and rvm
-
-```shell
-sudo gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
-curl -sSL https://get.rvm.io | bash -s stable
-source /etc/profile.d/rvm.sh
-rvm requirements run
-rvm install 3.1
-rvm use 3.1
-```
-
-Install oxidized requirements:
-```yum install make cmake which sqlite-devel openssl-devel libssh2-devel gcc libicu-devel gcc-c++```
-
-Install the gems:
-```gem install oxidized oxidized-web```
-
-You need to wrap the gem and reference the wrap in the systemctl service file:
-```rvm wrapper oxidized```
-
-You can see where the wrapped gem is via
-```rvm wrapper show oxidized```
-Use that path in the oxidized.service file, restart the systemctl daemon, run oxidized by hand once, edit config file, start service.
-
-### FreeBSD
-
-[Use RVM to install Ruby v2.3](#installing-ruby-23-using-rvm), then install all required packages and gems:
-
+You can also install one or both of the optional gems. They are not required
+to run Oxidized:
 ```shell
-pkg install cmake pkgconf
-gem install oxidized
-gem install oxidized-script oxidized-web
-```
-
-Oxidized is also available via [FreeBSD ports](https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=203374):
-
-```shell
-pkg install rubygem-oxidized rubygem-oxidized-script rubygem-oxidized-web
-```
-
-### Build from Git
-
-```shell
-git clone https://github.com/ytti/oxidized.git
-cd oxidized/
-gem install bundler
-rake install
+gem install oxidized-web    # Web interface and rest API
+gem install oxidized-script # Script-based input/output extensions
 ```
 
-### Running with Docker
-
-Currently, Docker Hub automatically builds the master branch for linux/amd64 and linux/arm64 platforms as [oxidized/oxidized](https://hub.docker.com/r/oxidized/oxidized/), you can make use of this container or build your own.
-
-To build your own, clone git repo:
+### Rocky Linux, Red Hat Enterprise Linux
+These instructions has been verified on Rocky Linux 9.3 and Fedora.
 
+On Rocky Linux 9, you need to install/enable EPEL, CRB and Ruby 3.1:
 ```shell
-git clone https://github.com/ytti/oxidized
+dnf install epel-release
+dnf config-manager --set-enabled crb
+dnf module enable ruby:3.1
 ```
 
-Then, build the container locally (requires docker 17.05.0-ce or higher):
-
+Then you need the required packages for oxidized:
 ```shell
-docker build -q -t oxidized/oxidized:latest oxidized/
+dnf -y install ruby ruby-devel sqlite-devel openssl-devel pkgconf-pkg-config  cmake libssh-devel libicu-devel zlib-devel gcc-c++ libyaml-devel which
 ```
 
-Once you've built the container (or chosen to make use of the automatically built container in Docker Hub, which will be downloaded for you by docker on the first `run` command had you not built it), proceed as follows:
-
-Create a configuration directory in the host system:
+Finally, install Oxidized:
 
 ```shell
-mkdir /etc/oxidized
+gem install oxidized
 ```
 
-Run the container for the first time to initialize the config:
-
-_Note: this step in only required for creating the Oxidized configuration file and can be skipped if you already have one._
-
+You can also install one or both of the optional gems. They are not required
+to run Oxidized:
 ```shell
-docker run --rm -v /etc/oxidized:/home/oxidized/.config/oxidized -p 8888:8888/tcp --user oxidized -t oxidized/oxidized:latest oxidized
+gem install oxidized-web    # Web interface and rest API
+gem install oxidized-script # Script-based input/output extensions
 ```
 
-If the RESTful API and Web Interface are enabled, on the docker host running the container
-edit `/etc/oxidized/config` and modify `rest: 127.0.0.1:8888` to `rest: 0.0.0.0:8888`. This will bind port 8888 to all interfaces, and expose the port so that it could be accessed externally. [(Issue #445)](https://github.com/ytti/oxidized/issues/445)
-
-Alternatively, you can use docker-compose to launch the oxidized container:
-
-```yaml
-# docker-compose.yml
-# docker-compose file example for oxidized that will start along with docker daemon
----
-version: "3"
-services:
-  oxidized:
-    restart: always
-    image: oxidized/oxidized:latest
-    ports:
-      - 8888:8888/tcp
-    environment:
-      CONFIG_RELOAD_INTERVAL: 600
-    volumes:
-       - config:/home/oxidized/.config/oxidized/
-volumes:
-  config:
-```
-
-Create the `/etc/oxidized/router.db` (see [CSV Source](docs/Sources.md#source-csv) for further info):
+### FreeBSD
+These installation instructions have been tested on FreeBSD 14.2, but
+oxidized itself has not been tested on it.
 
+First install ruby and rubyXX-gems (Find out the name of the package with `pkg search gems`):
 ```shell
-vim /etc/oxidized/router.db
+pkg instal ruby
+pkg instal ruby32-gems
 ```
 
-Run container again to start oxidized with your configuration:
-
+Then install the dependencies of oxidized an oxidized-web:
 ```shell
-docker run -v /etc/oxidized:/home/oxidized/.config/oxidized -p 8888:8888/tcp -t oxidized/oxidized:latest
-oxidized[1]: Oxidized starting, running as pid 1
-oxidized[1]: Loaded 1 nodes
-Puma 2.13.4 starting...
-* Min threads: 0, max threads: 16
-* Environment: development
-* Listening on tcp://0.0.0.0:8888
+pkg install ruby ruby-gems git sqlite3 libssh2 cmake pkgconf gmake
+pkg install libyaml icu   # Dependencies for oxidized-web
 ```
 
-If you want to have the config automatically reloaded (e.g. when using a http source that changes):
+Finally, install Oxidized:
 
 ```shell
-docker run -v /etc/oxidized:/home/oxidized/.config/oxidized -p 8888:8888/tcp -e CONFIG_RELOAD_INTERVAL=3600 -t oxidized/oxidized:latest
+gem install oxidized
 ```
 
-If you need to use an internal CA (e.g. to connect to an private github instance):
-
+You can also install one or both of the optional gems. They are not required
+to run Oxidized:
 ```shell
-docker run -v /etc/oxidized:/home/oxidized/.config/oxidized -v /path/to/MY-CA.crt:/usr/local/share/ca-certificates/MY-CA.crt -p 8888:8888/tcp -e UPDATE_CA_CERTIFICATES=true -t oxidized/oxidized:latest
+gem install oxidized-web    # Web interface and rest API
+gem install oxidized-script # Script-based input/output extensions
 ```
 
-### Running with podman-compose
-Under [examples/podman-compose](examples/podman-compose), you will find a complete
-example of how to integrate the container into a docker-compose.yml file.
-
-### Installing Ruby 2.3 using RVM
-
-Install Ruby 2.3 build dependencies
+Oxidized is also available via [FreeBSD ports](https://ports.freebsd.org/cgi/ports.cgi?query=oxidized):
 
 ```shell
-yum install curl gcc-c++ patch readline readline-devel zlib zlib-devel
-yum install libyaml-devel libffi-devel openssl-devel make cmake
-yum install bzip2 autoconf automake libtool bison iconv-devel libssh2-devel libicu-devel
+pkg install rubygem-oxidized rubygem-oxidized-script rubygem-oxidized-web
 ```
 
-Install RVM
+### Build from Git
 
 ```shell
-curl -L get.rvm.io | bash -s stable
+git clone https://github.com/ytti/oxidized.git
+cd oxidized/
+gem install bundler
+rake install
 ```
 
-Setup RVM environment and compile and install Ruby 2.3 and set it as default
-
-```shell
-source /etc/profile.d/rvm.sh
-rvm install 2.3
-rvm use --default 2.3
-```
+### Running with Docker or Podman
+See [docs/Docker.md](docs/Docker.md)
 
 ## Configuration
 

data/Rakefile

@@ -2,7 +2,7 @@ require 'bundler/gem_tasks'
 require 'rake/testtask'
 require_relative 'lib/oxidized/version'
 
-gemspec = eval(File.read(Dir['*.gemspec'].first))
+gemspec = Gem::Specification.load(Dir['*.gemspec'].first)
 gemfile = [gemspec.name, gemspec.version].join('-') + '.gem'
 
 # Integrate Rubocop if available
@@ -10,7 +10,6 @@ begin
   require 'rubocop/rake_task'
 
   RuboCop::RakeTask.new
-  task(:default).prerequisites << task(:rubocop)
 rescue LoadError
   task :rubocop do
     puts 'Install rubocop to run its rake tasks'
@@ -41,11 +40,6 @@ task :version_set do
   Bundler::GemHelper.instance.gemspec.version = Oxidized::VERSION
 end
 
-# desc 'Install gem'
-# task install: :build do
-#    system "sudo -Es sh -c \'umask 022; gem install gems/#{gemfile}\'"
-# end
-
 desc 'Remove gems'
 task :clean do
   FileUtils.rm_rf 'pkg'
@@ -95,15 +89,19 @@ end
 
 desc 'Build the container image with docker or podman'
 task :build_container do
+  branch_name = %x(git rev-parse --abbrev-ref HEAD).chop.gsub '/', '_'
+  sha_hash = %x(git rev-parse --short HEAD).chop
+  image_tag = "#{branch_name}-#{sha_hash}"
+
   # Prefer podman if available as it runs rootless
   if command_available?('podman')
-    sh 'podman build -t oxidized:`git describe --tags` -t oxidized:latest .'
+    sh "podman build -t oxidized:#{image_tag} -t oxidized:latest ."
   elsif command_available?('docker')
     if docker_needs_root?
       puts 'docker needs root to build the image. Using sudo...'
-      sh 'sudo docker build -t oxidized:`git describe --tags` -t oxidized:latest .'
+      sh "sudo docker build -t oxidized:#{image_tag} -t oxidized:latest ."
     else
-      sh 'docker build -t oxidized:`git describe --tags` -t oxidized:latest .'
+      sh "docker build -t oxidized:#{image_tag} -t oxidized:latest ."
     end
   else
     puts 'You need Podman or Docker to build the container image.'
@@ -111,4 +109,4 @@ task :build_container do
   end
 end
 
-task default: :test
+task default: %i[rubocop test]