Skip to content
  • There are no suggestions because the search field is empty.

Orchestrator Upgrade Guide - Containerized Deployment - 7.9.x

The following article contains a summary of the NetWitness® Orchestrator 7.9 Upgrade Guide for Containerized Deployments. To see the full guide, go to Attachments on this article and download the associated PDF.

Summary of the NetWitness® Orchestrator 7.9 Upgrade Guide for Containerized Deployments

The document is a technical upgrade guide for NetWitness® Orchestrator software version 7.9, detailing the steps for upgrading a containerized deployment using Docker® or Podman.

Upgrade Process for NetWitness® Orchestrator Containerized Deployment

This guide outlines the steps necessary to upgrade NetWitness® Orchestrator in a containerized environment using Docker® or Podman. ​

  • The upgrade applies to all Docker and Podman deployments.
  • Important files to back up include nginx.conf, opensearch_internal_users.yml, postgres.conf, and redis.conf. ​
  • The upgrade process includes steps for upgrading Docker files, fixing shell scripts, restoring environment files, and updating version variables.

Steps to Upgrade Docker Files

This section details the procedure for upgrading Docker files in the NetWitness® Orchestrator deployment. ​

  • Upgrade the NetWitness® Orchestrator Docker ZIP file to the latest version. ​
  • Restore any local changes made to configuration files after the upgrade.

Fixing Shell Scripts Permissions

This section explains how to correct shell script formatting and permissions.

  • Reformat shell scripts to remove carriage return characters.
  • Change permissions to 755 for various shell scripts to ensure they are executable.

Restoring Environment Configuration

This section describes how to restore the environment configuration for NetWitness® Orchestrator. ​

  • Use SCP to restore the .env file from a secure location to the appropriate directory. ​

Updating TC_VERSION Variable

This section covers updating the TC_VERSION variable in the environment file. ​

  • Set TC_VERSION to the latest NetWitness® Orchestrator version to ensure compatibility. ​

Adding New Environment Variables

This section outlines the addition of new required environment variables. ​

  • New variables include OpenSearch credentials, logs paths, and NGINX DNS resolver settings.
  • Remove the REDIS_ARGS variable from the .env file. ​

Logging Into NetWitness® Orchestrator's ECR

This section provides instructions for logging into NetWitness® Orchestrator's Elastic® Container Registry. ​

  • Use the AWS CLI to log in, ensuring the correct region is specified based on system location.

Stopping and Removing Containers

This section explains how to stop and remove existing service containers. ​

  • Use the docker-compose down command followed by docker-compose pull to update containers. ​

Creating OpenSearch Folder Mounts

This section describes the optional step of creating folder mounts for OpenSearch. ​

  • Create directories for OpenSearch logs and snapshots. ​
  • Adjust ownership for rootless Podman deployments. ​

Starting OpenSearch Service

This section details the steps to start the OpenSearch service. ​

  • Use docker-compose up -d opensearch to start OpenSearch. ​
  • Test the installation and reset the OpenSearch password if necessary. ​

Starting NetWitness® Orchestrator Services

This section outlines the order and method for starting NetWitness® Orchestrator services.

  • Start services in the order: tc-mon, tc-app, and tc-job.
  • Verify each service starts successfully before proceeding to the next.

Monitoring NetWitness® Orchestrator Services

This section explains how to monitor NetWitness® Orchestrator containers without an .env file. ​

  • Move the .env file to a secure location and check container status using docker ps. ​
  • Restart containers individually and monitor logs for each service.

Re-creating the Search Index

This section provides instructions for re-creating the search index if upgrading from an earlier version. ​

  • Log into NetWitness® Orchestrator and navigate to System Settings to create a new search index. ​

Updating the Search Index

This section describes how to update the search index for OpenSearch.

  • Use curl commands to close, update settings, and reopen the search index.

Rotating Nginx Container Access Logs

This section explains how to set up log rotation for Nginx access logs. ​

  • Install logrotate and configure it to manage Nginx logs effectively. ​

Enabling SAML Configuration

This section outlines the steps to enable SAML configuration in NetWitness® Orchestrator. ​

  • Update SAML settings in the .env file and add necessary .pem files to the certs folder. ​

For More Information:
For Release Notes and Documentation on NetWitness® Orchestrator 7.9, please visit our NetWitness® Orchestrator page on the NetWitness® Community.
For data sheets and other similar content, visit the Security Automation and Orchestration page on NetWitness.com.



Attachments:
Orchestrator_Upgrade_Guide_Containerized_Deployment_Software_Version_7.9.pdf