Upgrading

To upgrade a previous installment of the Dockerized pipeline, perform the following steps.

Shut things down

cd {netsage-pipeline directory}

docker-compose down

This will stop and remove all the docker containers, including the importer, logstash, and any collectors. Note that incoming flow data will not be saved during the time the collectors are down.

Update Source Code

To upgrade to a new release, pull new tags/code from github and docker images from dockerhub. Your customized .env and override files will not be overwritten, nor will data files, cache files, or downloaded support files.

git reset --hard

git fetch

warning

git reset --hard will obliterate any changes you have made to non-override files, eg, logstash conf files. If necessary, please make sure you commit and save to a feature branch before continuing.

Run these commands to upgrade to the current announced version. While older versions of the pipeline are available, they are not recommended or supported for daily use. If in doubt, the Master branch contains the latest version. The documentation version at the top of this page is also the current pipeline version number.

git switch {tag}

git pull

./Upgrade_x_x_x.sh (where x_x_x is the current version you are upgrading to)

The docker-compose.yml and docker-compose.override.yml should both now have the version number you selected for pipeline_importer and pipeline_logstash.

Check/Update Customization Files

Occasionally, something may change which will necessitate editing your override and/or env file.

• Compare the new docker-compose.override_example.yml file to your docker-compose.override.yml. Be sure to check to see if the version of nfdump has changed. Look for lines like image: netsage/nfdump-collector:. Make sure the version in your override file matches what is the example file. (You do not need to actually perform any upgrade yourself. This will ensure the correct version is pulled from Docker Hub.)

• Also, look forversion: "x.x" at the top. If the version number is different, change it in your docker-compose.override.yml file. (This is the Compose file format version.)

• Compare your .env file with the new env.example file to see if any new lines or sections have been added. If there have been any changes relevant to your deployment, eg, new options you want to use, copy the changes into your .env file.

• If you used the Docker Advanced guide to make a netsage_override.xml file, compare it to netsage_shared.xml to see if there are any changes. This is unlikely.

Update Docker Containers

This should be done automatically when you start up the containers, but you can also pull new images from Docker Hub now.

docker-compose pull

Restart all the Docker Containers

docker-compose up -d

This will start all the services/containers listed in the docker-compose.yml and docker-compose.override.yml files, including the importer, logstash pipeline, and collectors.

Delete old images and containers

To keep things tidy, delete any old images and containers that are not being used.

docker image prune -a

docker container prune

To check which images you have

docker image ls