Important note

See Policy console requirements for virtual machine requirements.

Installing the policy console

This procedure is for first time installation on a virtual machine running Ubuntu. 

Before installing the policy console, make sure you have installed curl. On the virtual machine where you want to run the policy console, run these commands:

$ sudo apt-get install curl
BASH

Note: Use the sudo command to execute commands using permissions of the root user. If you choose to administer the Ubuntu system through a graphical interface to create folders and using drag and drop to move files, you may need to manually adjust ownership and permissions.

On the same VM, create a directory: /usr/local/share/policy-console/deb/ 

$ sudo mkdir -p /usr/local/share/policy-console/deb
BASH

Move the policy console files (available from Blue Cedar Support) to this new directory: 

sudo mv * /usr/local/share/policy-console/deb/ 
BASH
  • policy-console-appcontrol*.deb
  • policy-console-database-blackberry*.deb
  • policy-console-injection-engine*.deb
  • Packages.gz

Install the policy console database package. This command might fail if you don't have the required packages installed on your system, in which case, proceed to step 5.

$ sudo dpkg -i /usr/local/share/policy-console/deb/policy-console-database-blackberry_{version}.deb
BASH

Run this update, which also installs any missing packages:

$ sudo apt-get update && sudo apt-get install -f
BASH

Now install the policy console package:

$ sudo apt-get install policy-console-appcontrol
BASH

Verify the installation. The results should list three containers: injection engine, appcontrol, and database.

$ sudo docker ps
BASH

Look for lines in the output containing these containers:

bluecedar/policy-console-appcontrol:4.1.0
bluecedar/policy-console-injection-engine:4.1.0
bluecedar/policy-console-database-blackberry:4.1.0

Sample output

CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
1b9ce819d0af bluecedar/policy-console-appcontrol:4.1.0 "/bin/bash -l -c /co…" 20 seconds ago Up 19 seconds (health: started) 0.0.0.0:80->80/tcp, 0.0.0.0:443->443/tcp, 0.0.0.0:32774->8080/tcp, 0.0.0.0:32773->8443/tcp policy_console_appcontrol

a46d567feb36 bluecedar/policy-console-injection-engine:4.1.0 "/bin/bash -l -c /co…" 20 seconds ago Up 19 seconds (health: started) 0.0.0.0:32772->8080/tcp policy_console_injection_engine

125929de3c88 bluecedar/policy-console-database-blackberry:4.1.0 "/bin/bash -l -c -x …" 20 seconds ago Up 20 seconds (health: started) 0.0.0.0:32771->3306/tcp
TEXT

Upgrading the policy console

Important note

To upgrade the policy console, you need required software and files to install the new console. See Policy console requirements for virtual machine requirements.

Procedure overview:

  • To migrate your configured environment, backup the old configuration.
  • Upgrade the console with the new version.
  • Restart the new version with the (optional) saved configuration.

This procedure assumes you are installing the new version of the policy console on an existing policy console (version 3.20+). 

Optional. If you have modified your environment file and want to preserve your configuration, you need to backup the new default configuration before upgrading. If you have not modified your environment file, skip to step 2.

The upgrade process requires you to edit the environment to refer to the old console. Run this command to backup the environment file before updating the new policy console so you can easily restore after upgrading from the old console:

$ sudo cp /etc/policy-console-{old_version}.env /etc/policy-console-{old_version}.env.bak
BASH

Copy the policy console files (available from Blue Cedar Support) to this new directory: /usr/local/share/policy-console/deb/ 

  • policy-console-appcontrol*.deb
  • policy-console-database-blackberry*.deb
  • policy-console-injection-engine*.deb
  • Packages.gz

Upgrade to the new version of the policy console:

$ sudo apt-get update && sudo apt-get install policy-console-database-blackberry && sudo apt-get install policy-console-appcontrol
BASH

Optional. If you created a backup in step 1, restore the configuration from the backup file and reboot:

$ sudo cp /etc/policy-console-{old_version}.env.bak /etc/policy-console-{new_version}.env
$ sudo service policy-console reboot
BASH

Uninstalling the console files and database

To uninstall policy console files (Ubuntu), run this command on the console host:

$ sudo apt-get remove policy-console-database-blackberry
BASH

The above step removes the console files, but does not remove console data. If you are sure you want to remove the console database entirely, after running the above step you can run the below. IMPORTANT: The following command removes the entire console database, make sure you understand what you are doing.

$ sudo docker volume rm policy_console_database_data
BASH