oxidized 0.32.0 → 0.33.0

data/examples/podman-compose/README.md

@@ -1,94 +0,0 @@
-# Running Oxidized with podman-compose
-This example demonstrates running Oxidized within an OCI container using
-podman-compose. It’s actively used in Oxidized development to validate the
-container’s functionality and to simulate potential issues.
-
-While this example uses podman and podman-compose, it should also be compatible
-with docker, as podman supports docker’s CLI.
-
-To make this example work seamlessly, a simulated network device is included.
-The asternos model is used here for simplicity, as it requires minimal commands
-to implement. The simulated output doesn’t replicate real device responses but
-provides changing lines over time to test Oxidized’s functionality.
-
-
-The example also provides a Git server to test the interaction with it.
-
-# Run the example
-> :warning: the example builds local containers and will require at least 2 GB
-> of disk space along with some CPU and time during the first run.
-
-To start the example, simply run `make start`. Ensure you have installed the
-necessary [dependencies](#dependencies) before.
-
-To stop, press `CTRL-C` or run `make stop` in a separate shell. If you exit
-with `CTRL-C`, make sure to run `make stop` afterward to properly clean up the
-environment.
-
-## Running Environment
-This example of oxidized with podman-compose is running on Debian
-Bookworm (Version 12). It should work with few adaptations on any Linux
-box running podman, and maybe also with docker.
-
-## Dependencies
-To get started, install the required packages on your Debian system:
-```shell
-sudo apt install podman containers-storage podman-compose make
-```
-
-Ensure Podman is using the overlay driver for image storage.
-Without this driver, Podman may save every container layer separately rather
-than only the changes, which can quickly consume disk space.
-
-This issue can occur if podman was run before installing the
-`container-storage`  package.
-
-```shell
-podman info | grep graphDriverName
-```
-
-You should get this reply
-```shell
-  graphDriverName: overlay
-```
-
-If not, the quick way I found to solve it is to delete `~/.local/share/containers/`.
-Beware - this will delete **all** your containers!
-
-## Adapting to your needs
-Feel free to customize this setup as you wish! You may want to edit
-`docker-compose.yml` to remove any containers simulating specific components.
-
-## Use your own oxidized configuration in the git repository
-When developing oxidized or testing the container, you may want to use a custom
-configuration. This can be done by saving it under `oxidized-config/config.local`
-
-`make start-local` will recognize the local configuration and copy it to
-`oxidized-config/config` before starting the container.
-
-You should stop the container with `make stop-local` in order to restore the
-original configuration from the git repository.
-
-In the folder `oxidized-config/, you will also find some example configs,
-for example `config_csv-gitserver`. To use them, just copy the file to `config`.
-
-## Git server public keys
-To enable Oxidized to access the Git server, you'll need to retrieve the
-servers' public SSH keys and store them under `oxidized-ssh/known_hosts`.
-Without this, you will encounter the following error:
-
-```
-ERROR -- : Hook push_to_remote (#<GithubRepo:0x00007f4cff47d918>) failed (#<Rugged::SshError: invalid or unknown remote ssh hostkey>) for event :post_store
-```
-
-While the container environment is running (`make start`), open a separate shell
-and run:
-```
-make gitserver-getkey
-```
-
-You do not need to restart the container environment; Oxidized will
-automatically use the key the next time it pushes to the remote Git repository.
-
-
-

data/examples/podman-compose/docker-compose.yml

@@ -1,30 +0,0 @@
-services:
-  oxidized:
-    # Choose the image that you want to test
-    # image: docker.io/oxidized/oxidized:0.30.1
-    # image: docker.io/oxidized/oxidized:latest
-    # local/oxidized is build by "make oxidized-image" and "make run"
-    image: local/oxidized
-    ports:
-      - 127.0.0.1:8042:8888/tcp
-    environment:
-      # Reload hosts list once per day
-      CONFIG_RELOAD_INTERVAL: 86400
-      # Needed when you push to a remote git repository
-      OXIDIZED_SSH_PASSPHRASE: xxxxPassphasexxxx
-    volumes:
-       - ./oxidized-config:/home/oxidized/.config/oxidized
-       - ./oxidized-ssh:/home/oxidized/.ssh
-
-  # This is a simulated network device for the example to work out of the box
-  asternos-device:
-    image: localhost/local/model
-    volumes:
-      - ./model-simulation/asternos.sh:/home/oxidized/.profile
-      - ./model-simulation/asternos.sh:/home/admin/.profile
-
-  # This is a gitserver to push our configs
-  gitserver:
-    image: localhost/local/gitserver
-    volumes:
-      - ./gitserver/repo.git:/home/git/repo.git

data/examples/podman-compose/gitserver/.gitignore

@@ -1 +0,0 @@
-repo.git

data/examples/podman-compose/gitserver/Dockerfile

@@ -1,14 +0,0 @@
-FROM docker.io/phusion/baseimage:noble-1.0.0
-
-# Use baseimage-docker's init system.
-CMD ["/sbin/my_init"]
-
-# enable ssh
-RUN rm -f /etc/service/sshd/down
-RUN /etc/my_init.d/00_regen_ssh_host_keys.sh
-
-# Add user for the gitserver. The password is "git"
-RUN useradd -m git -p '$6$32WDb0LTFyQkLffy$u15COVx7CQ4tgp4JT4DO4LJ96q/jwFSpuZC3WrllNQDNa6nW1LhJKW9rLV57ak3rj9Ln./aRA85jzeof1B0Gi1' -s /bin/bash -u 30001
-
-# And install git
-RUN install_clean git

data/examples/podman-compose/model-simulation/Dockerfile-model

@@ -1,13 +0,0 @@
-FROM docker.io/phusion/baseimage:noble-1.0.0
-
-# Use baseimage-docker's init system.
-CMD ["/sbin/my_init"]
-
-# enable ssh
-RUN rm -f /etc/service/sshd/down
-RUN /etc/my_init.d/00_regen_ssh_host_keys.sh
-
-# Add users to login. The password is "oxidized"
-RUN useradd -m oxidized -p '$y$j9T$UoDYxDiE.8iBGmoaD/acn1$kVvYvoEIJdKUmIKFVBRYKLIVzmEBP1RKrCM6Vfx.V55' -s /bin/bash
-RUN useradd -m admin -p '$y$j9T$UoDYxDiE.8iBGmoaD/acn1$kVvYvoEIJdKUmIKFVBRYKLIVzmEBP1RKrCM6Vfx.V55' -s /bin/bash
-

data/examples/podman-compose/model-simulation/asternos.sh

@@ -1,36 +0,0 @@
-# if running bash
-if [ -n "$BASH_VERSION" ]; then
-    # include .bashrc if it exists
-    if [ -f "$HOME/.bashrc" ]; then
-        . "$HOME/.bashrc"
-    fi
-fi
-
-# Display a MOTD
-cat << EOF
-This is the welcome message of this device
-it is muliline
-End of the MOTD
-EOF
-
-function show() {
-  if [ "$*" == "version" ]; then
-    echo "Version 1.2.3"
-    # Make the output change over time
-    date
-  elif [ "$*" == "runningconfiguration all" ]; then
-          cat << EOF
-! begin of the configuration
-! this is the running config
-!
-I have no idea how a configuration in asternos looks like ;-)
-!
-! End of the Configuration
-EOF
-  else
-    echo "command 'show $*' not implemented"
-  fi
-}
-
-PS1="asternos$"
-

data/examples/podman-compose/oxidized-config/.gitignore

@@ -1,10 +0,0 @@
-# Ignore local configurations, which will override the git config
-config.local
-router.db.local
-
-# Ignore logs, retrieved configs...
-pid
-configs/
-crash
-logs/
-oxidized.git/

data/examples/podman-compose/oxidized-config/config

@@ -1,46 +0,0 @@
----
-username: oxidized
-password: oxidized
-resolve_dns: true
-interval: 3600
-use_syslog: false
-debug: false
-threads: 30
-use_max_threads: true
-timeout: 20
-retries: 3
-prompt: !ruby/regexp /^([\w.@-]+[#>]\s?)$/
-rest: 0.0.0.0:8888
-next_adds_job: false
-vars: {}
-groups: {}
-group_map: {}
-models: {}
-pid: "~/.config/oxidized/pid"
-crash:
-  directory: "~/.config/oxidized/crashes"
-  hostnames: false
-stats:
-  history_size: 10
-input:
-  default: ssh
-  debug: false
-  ssh:
-    secure: false
-  ftp:
-    passive: true
-  utf8_encoded: true
-output:
-  default: file
-  file:
-    directory: "~/.config/oxidized/configs/"
-source:
-  default: csv
-  csv:
-    file: "~/.config/oxidized/router.db"
-    delimiter: !ruby/regexp /:/
-    map:
-      name: 0
-      model: 1
-      ip: 2
-    gpg: false

data/examples/podman-compose/oxidized-config/config_csv-file

@@ -1,46 +0,0 @@
----
-username: oxidized
-password: oxidized
-resolve_dns: true
-interval: 3600
-use_syslog: false
-debug: false
-threads: 30
-use_max_threads: true
-timeout: 20
-retries: 3
-prompt: !ruby/regexp /^([\w.@-]+[#>]\s?)$/
-rest: 0.0.0.0:8888
-next_adds_job: false
-vars: {}
-groups: {}
-group_map: {}
-models: {}
-pid: "~/.config/oxidized/pid"
-crash:
-  directory: "~/.config/oxidized/crashes"
-  hostnames: false
-stats:
-  history_size: 10
-input:
-  default: ssh
-  debug: false
-  ssh:
-    secure: false
-  ftp:
-    passive: true
-  utf8_encoded: true
-output:
-  default: file
-  file:
-    directory: "~/.config/oxidized/configs/"
-source:
-  default: csv
-  csv:
-    file: "~/.config/oxidized/router.db"
-    delimiter: !ruby/regexp /:/
-    map:
-      name: 0
-      model: 1
-      ip: 2
-    gpg: false

data/examples/podman-compose/oxidized-config/config_csv-gitserver

@@ -1,56 +0,0 @@
----
-username: oxidized
-password: oxidized
-resolve_dns: true
-interval: 3600
-use_syslog: false
-debug: false
-threads: 30
-use_max_threads: true
-timeout: 20
-retries: 3
-prompt: !ruby/regexp /^([\w.@-]+[#>]\s?)$/
-rest: 0.0.0.0:8888
-next_adds_job: false
-vars: {}
-groups: {}
-group_map: {}
-models: {}
-pid: "~/.config/oxidized/pid"
-crash:
-  directory: "~/.config/oxidized/crashes"
-  hostnames: false
-stats:
-  history_size: 10
-input:
-  default: ssh
-  debug: false
-  ssh:
-    secure: false
-  ftp:
-    passive: true
-  utf8_encoded: true
-output:
-  default: git
-  git:
-    user: Oxidized
-    email: o@example.com
-    repo: "~/.config/oxidized/oxidized.git"
-source:
-  default: csv
-  csv:
-    file: "~/.config/oxidized/router.db"
-    delimiter: !ruby/regexp /:/
-    map:
-      name: 0
-      model: 1
-      ip: 2
-    gpg: false
-hooks:
-  push_to_remote:
-    type: githubrepo
-    events:
-    - post_store
-    remote_repo: git@gitserver:repo.git
-    username: git
-    password: git

data/examples/podman-compose/oxidized-config/router.db

@@ -1 +0,0 @@
-asternos-device:asternos

data/examples/podman-compose/oxidized-ssh/.gitignore

@@ -1 +0,0 @@
-known_hosts

data/examples/podman-compose/oxidized-ssh/README.md

@@ -1,14 +0,0 @@
-This is `~/.ssh/` of the user oxidized inside the oxidized container.
-
-## What you need here for the hook githubrepo
-You can store the SSH key needed to access a remote Git repository here. Here is
-an example how to generate this key.
-```shell
-ssh-keygen -q -t ed25519 -C "Oxidized Push Key@`hostname`" -N "YOURPASSPHRASE" -m PEM -f oxidized-key
-```
-
-You also need to store the public keys of the remote git server in known_hosts. If you do not,
-oxidized will refuse to push to the remote Git with the error `#<Rugged::SshError: invalid or unknown remote ssh hostkey>`, see Issue #2753.
-```shell
-ssh-keyscan git-server.example.com > known_hosts
-```