Automate - Examples for Running in Containers

The material in this document is for informational purposes only. This guide assumes that the most recent version of Rampiva Automate is in use unless otherwise noted in the prerequisites. The products it describes are subject to change without prior notice, due to the manufacturer’s continuous development program. Rampiva makes no representations or warranties with respect to this document or with respect to the products described herein. Rampiva shall not be liable for any damages, losses, costs or expenses, direct, indirect or incidental, consequential or special, arising out of, or related to the use of this material or the products described herein.

Introduction

This article provides example commands for running Rampiva Automate in Docker containers under Windows. These commands should be used as examples and adapted to configure and run Rampiva Automate in containers in your environment.

Prerequisites

Microsoft Windows
Docker

Instructions

A. Run Rampiva Scheduler

docker run --name rampiva-automate-scheduler -p 81:80 -e RAMPIVA_API_KEY=secretKeyGoesHere -e RAMPIVA_AUTH_INTERNAL_USERNAME=admin -e RAMPIVA_AUTH_INTERNAL_PASSWORD=pass -e RAMPIVA_AUTH_INTERNAL_ENABLED=true -v D:\data:/var/data -v D:\cases:/var/cases -v C:\Temp\logs:/var/log/rampiva -d nuix/rampiva-automate-scheduler:8.0.0-preview

	Command-line flag	Notes

	Command-line flag	Notes
1	`--name rampiva-automate-scheduler`	Name the container `rampiva-automate-scheduler`
2	`-p 81:80`	Publish container port `80` to the host port `81`
3	`-e RAMPIVA_API_KEY=secretKeyGoesHere`	Set the API key used to communicate between Rampiva components to `secretKeyGoesHere`
4	`-e RAMPIVA_AUTH_INTERNAL_USERNAME=admin`	Set the username to log in with during the initial configuration
5	`-e RAMPIVA_AUTH_INTERNAL_PASSWORD=pass`	Set the password to log in with during the initial configuration
6	`-e RAMPIVA_AUTH_INTERNAL_ENABLED=true`	Enable the logging in with the hard-coded username and password
7	`-v D:\data:/var/data`	Map the host folder `D:\data` to the container `/var/data` folder
8	`-v D:\cases:/var/cases`	Map the host folder `D:\cases` to the container `/var/cases` folder
9	`-v C:\Temp\logs:/var/log/rampiva`	Map the host folder `C:\Temp\logs` to the container `/var/log/rampiva` folder
10	`-d nuix/rampiva-automate-scheduler:8.0.0-preview`	Use the Scheduler image version `8.0.0-preview`

B. Run Rampiva Native Engine and Nuix Engine Server

docker run --name rampiva-automate-engine-server -p 8080:80 -e RAMPIVA_API_KEY=secretKeyGoesHere -v D:\data:/var/data -v D:\cases:/var/cases -v C:\Temp\logs:/var/log/rampiva --ulimit nofile=10000:10000 -d nuix/rampiva-automate-engine-server-nuix:8.0.0-preview_a.b.c.d

	Command-line flag	Notes

	Command-line flag	Notes
1	`--name rampiva-automate-engine-server`	Name the container `rampiva-automate-engine-server`
2	`-p 8080:80`	Publish container port `80` to the host port `8080` When configuring the Engine Server in Scheduler, point it to http://host.docker.internal:8080
3	`-e RAMPIVA_API_KEY=secretKeyGoesHere`	Set the API key used to communicate between Rampiva components to `secretKeyGoesHere`
4	`-v D:\data:/var/data`	Map the host folder `D:\data` to the container `/var/data` folder
5	`-v D:\cases:/var/cases`	Map the host folder `D:\cases` to the container `/var/cases` folder
6	`-v C:\Temp\logs:/var/log/rampiva`	Map the host folder `C:\Temp\logs` to the container `/var/log/rampiva` folder
7	`--ulimit nofile=10000:10000`	Increase the number of descriptors allowed per process, required for the Nuix Engine.
8	`-d nuix/rampiva-automate-engine-server-nuix:8.0.0-preview_a.b.c.d`	Use the Engine Server image version `8.0.0-preview` with the Nuix Engine version `a.b.c.d`

C. Run Rampiva Native Engine Server

docker run --name rampiva-automate-engine-server -p 8080:80 -e RAMPIVA_API_KEY=secretKeyGoesHere -v C:\Temp\logs:/var/log/rampiva -d nuix/rampiva-automate-engine-server:8.0.0-preview

	Command-line flag	Notes

	Command-line flag	Notes
1	`--name rampiva-automate-engine-server`	Name the container `rampiva-automate-engine-server`
2	`-p 8080:80`	Publish container port `80` to the host port `8080` When configuring the Engine Server in Scheduler, point it to http://host.docker.internal:8080
3	`-e RAMPIVA_API_KEY=secretKeyGoesHere`	Set the API key used to communicate between Rampiva components to `secretKeyGoesHere`
4	`-v C:\Temp\logs:/var/log/rampiva`	Map the host folder `C:\Temp\logs` to the container `/var/log/rampiva` folder
5	`-d nuix/rampiva-automate-engine-server:8.0.0-preview`	Use the Engine Server image version `8.0.0-preview`

D. Run Rampiva Scheduler the Rampiva native Engine Server in a single container

	Command-line flag	Notes

	Command-line flag	Notes
1	`--name rampiva-automate-aio`	Name the container `rampiva-automate-aio`
2	`-p 80:80`	Publish container port `80` to the host port `80`
3	`-e RAMPIVA_AUTH_INTERNAL_USERNAME=admin`	Set the username to log in with during the initial configuration
4	`-e RAMPIVA_AUTH_INTERNAL_PASSWORD=pass`	Set the password to log in with during the initial configuration
5	`-e RAMPIVA_AUTH_INTERNAL_ENABLED=true`	Enable the logging in with the hard-coded username and password
6	`-d nuix/rampiva-automate-aio:8.0.0-preview`	Use the AIO image version `8.0.0-preview`

E. Run Rampiva Scheduler with database redirection to MS SQL

	Command-line flag	Notes

	Command-line flag	Notes
1	`--name rampiva-automate-scheduler`	Name the container `rampiva-automate-scheduler`
2	`-p 81:80`	Publish container port `80` to the host port `81`
3	`-e RAMPIVA_API_KEY=secretKeyGoesHere`	Set the API key used to communicate between Rampiva components to `secretKeyGoesHere`
4	`-e RAMPIVA_AUTH_INTERNAL_USERNAME=admin`	Set the username to log in with during the initial configuration
5	`-e RAMPIVA_AUTH_INTERNAL_PASSWORD=pass`	Set the password to log in with during the initial configuration
6	`-e RAMPIVA_AUTH_INTERNAL_ENABLED=true`	Enable the logging in with the hard-coded username and password
7	`-e RAMPIVA_STORE_APPLICATION_CHARSET="UTF-8"`	Set the SQL store charset `UTF-8`
8	`-e RAMPIVA_STORE_APPLICATION_DRIVER_CLASS="net.sourceforge.jtds.jdbc.Driver"`	Set the SQL JDBC driver
9	`-e RAMPIVA_STORE_APPLICATION_USERNAME=azureAdmin`	Set the SQL store username `azureAdmin`
10	`-e RAMPIVA_STORE_APPLICATION_PASSWORD="sqlPasswordGoesHere"`	Set the SQL store password to `sqlPasswordGoesHere`
11	`-e RAMPIVA_STORE_APPLICATION_URL="jdbc:jtds:sqlserver://rampiva-sql-server.database.windows.net:1433/rampiva-db;ssl=require"`	Set the SQL JDBC URL to use the SQL server `rampiva-sql-server` and the database `rampiva-db`
12	`-e RAMPIVA_STORE_LOGGING_REDIRECT_TO_APPLICATION=true`	Use the SQL store to record the Centralized Logging records
13	`-e RAMPIVA_STORE_UTILIZATION_REDIRECT_TO_APPLICATION=true`	Use the SQL store to record Utilization records
14	`-v D:\data:/var/data`	Map the host folder `D:\data` to the container `/var/data` folder
15	`-v D:\cases:/var/cases`	Map the host folder `D:\cases` to the container `/var/cases` folder
16	`-v C:\Temp\logs:/var/log/rampiva`	Map the host folder `C:\Temp\logs` to the container `/var/log/rampiva` folder
17	`-d nuix/rampiva-automate-scheduler:8.0.0-preview`	Use the Scheduler image version `8.0.0-preview`

F. Run Rampiva Proxy

	Command-line flag	Notes

	Command-line flag	Notes
1	`--name rampiva.automate.proxy`	Name the container `rampiva.automate.proxy`
2	`-p 81:80`	Publish container port `80` to the host port `81`
3	`-v C:\Sample\config\proxy:/etc/rampiva/automate/scheduler/config:ro`	Map the host folder `C:\Sample\config\proxy` as read-only to the container `/etc/rampiva/automate/scheduler/config` folder
4	`-d nuix/rampiva-automate-core:8.0.0-preview`	Use the Core image version `8.0.0-preview`
5	`/usr/rampiva/runScheduler.sh`	Run the command `runScheduler.sh` on container startup. This command will start Rampiva Scheduler.