Home
Guardian
Learn how Guardian provides comprehensive asset inventory and network visibility for OT and IoT environments.
Installation Guide
Information and resources on how to install Guardian, and the different options and settings that are available.
Container installation
Build a Docker image
Build a Docker image for your sensor.

Guardian
Learn how Guardian provides comprehensive asset inventory and network visibility for OT and IoT environments.
- Introduction
  An overview of Guardian.
- Installation Guide
  Information and resources on how to install Guardian, and the different options and settings that are available.
  - Introduction
  - Physical installation
  - Virtual installation
  - Container installation
    - Docker installation
      A Docker installation is a deployment of a sensor inside of an existing network component that supports Docker containers. If you want to take advantage of Nozomi Networks sensors can be installed in a Docker container.
    - Docker prerequisites
      These are the prerequisites for a Docker installation.
    - Build a Docker image
      Build a Docker image for your sensor.
    - Install a sensor in a Docker container
      Docker is the approved software for a container installation on Nozomi Networks Operating System (N2OS). Do this procedure to run a Nozomi Networks sensor in a Docker environment.
    - Update a Docker container
      You can update the Docker container to a newer release of the Nozomi Networks Operating System (N2OS).
  - Basic configuration
  - Additional settings
  - Compatibility Reference
  - Federal Information Processing Standards
- Administrator Guide
  Information and resources about the Administration section of Guardian, and the tasks that you can do in this part of the software.
- User Guide
  Information and resources about the main features of Guardian, and the tasks that you can do from the user interface (UI).
- Maintenance Guide
  Information about the maintenance tasks of Guardian, to help you administer and maintain the solution in a production environment.
- Print format documentation
  A list of all the print-format documentation that is available for Guardian.

Build a Docker image

Build a Docker image for your sensor.

Before you begin

Make sure that:

Docker is installed. (Nozomi Networks has tested Docker versions 18.09 and 20.10.)
BuildKit is installed. (Docker 18.09 or higher is required. To activate BuildKit, refer to the Docker BuildKit documentation.)

About this task

You can use variables to customize the container version build. Use the --build-arg command line switch to pass the variables to the Docker build command.

Procedure

To build the image, from the directory containing the artifacts, enter this command:

docker build -t n2os .

An example of a customization:

docker build --build-arg APT_PROXY=10.0.0.17:5843 -t n2os

To customize the method the sensor uses to communicate, these parameters can be given in the build command:


Parameter	Default value	Description
APT_PROXY	None	Proxy to be used to download container packages
N2OS_HTTP_PORT	80	Specify custom hypertext transfer protocol (HTTP) web port
N2OS_HTTPS_PORT	443	Specify custom hypertext transfer protocol secure (HTTPS) web port

The image is created.