Upgrade Splunk Enterprise Security

This topic describes how to upgrade an installed version of the Splunk Enterprise Security version 3.0 or later to the latest release.

Step 1. Review the planning topic

1. For an overview of the upgrade process and prerequisites, see "Planning an upgrade" in this manual.
2. Perform a full backup of the search head before upgrading.

Important: To back out of the upgrade, the prior version of Splunk Enterprise Security must be restored from backup.

Step 2. Download Splunk Enterprise Security

1. Browse to splunk.com and log in with your Splunk.com ID. You must be a licensed Enterprise Security customer to download the product.
2. Download the latest Splunk Enterprise Security product.
3. Choose Download, and save the Splunk Enterprise Security product file to your desktop.
4. Log in to the ES search head as an administrator.

Step 3. Install the latest Splunk Enterprise Security

1. On the Splunk Enterprise search page, browse to Apps > Manage Apps and choose Install App from File.
2. Select Upgrade app to initiate an upgrade.
3. Select Choose File and browse to the Splunk Enterprise Security product file.
4. Select Upload to begin the installation.
5. Select Set up now to begin the ES setup.

Important: If the setup procedure is not run promptly after the upload is complete, Enterprise Security will display errors.

Step 4. Set up Splunk Enterprise Security

1. Select Start.
2. The Splunk Enterprise Security Post-Install Configuration page indicates the upgrade status as it moves through the stages of installation. When the setup is done, the page will prompt you to restart Splunk platform services.
3. Select Restart Splunk to finish the installation.

Step 5. Validate the upgrade

1. The Splunk Enterprise Security upgrade process is now complete. Objects disabled during the upgrade process will automatically be enabled.
2. On the Enterprise Security menu bar, open Audit and select ES Configuration Health to view potential conflicts and changes to the default settings. For more information, see "ES Configuration Health" in the User Manual.
3. Splunk logs the installation in $SPLUNKHOME$/var/log/splunk/essinstaller2.log

Upgrade Enterprise Security on a search head cluster

Before you upgrade a Splunk Enterprise Security search head cluster, review these instructions and the order of operations.

1. Prepare a staging instance.
2. Upgrade the staging instance to the latest version.
3. Migrate the upgraded installation to the production deployer.
4. Deploy the changes to the cluster members.
5. Validate the configuration on the search head cluster.

Versions of these instructions published prior to August 15, 2017, if followed precisely, might have caused you to deploy default apps included with Splunk Enterprise to your search peers using the deployer. Deploying default apps in this way is not recommended.

If you experience problems with your deployment as a result of this misconfiguration, migrate the settings of your installation to a new deployer and search head cluster, similar to the steps for migrating a standalone search head to a search head cluster. See Migrate an existing search head to a search head cluster on this page.

Prerequisites

• Review the add-ons included in the Splunk Enterprise Security package.
• If needed, upgrade Splunk Enterprise to the latest version compatible with this version of Splunk Enterprise Security.
  • For compatible versions, see Splunk Enterprise system requirements.
  • For instructions for upgrading Splunk Enterprise, see Upgrade a search head cluster in the Splunk Enterprise Distributed Search Manual.

Prepare a staging instance

Before upgrading, you need to compare the copy of Splunk Enterprise Security on the deployer with the latest release. You can do this by performing the upgrade on a staging instance. If you have a testing or QA instance in your Splunk environment with only Splunk Enterprise installed, you can use that instance for staging.

1. Prepare a single instance of Splunk Enterprise to use for staging an upgrade. Do not connect the instance to indexers or search peers.
2. Copy the apps in the deployer instance path etc/shcluster/apps to the staging instance path etc/apps.
   For example, on the deployer type: scp -r ~/etc/shcluster/apps <staging_machine>:~/etc/
   If the deployer includes default apps, such as the search app, remove them from the deployer before copying the folder to the staging instance.

The copy of Splunk Enterprise Security on the deployer includes configuration settings that are deployed to the search head cluster. The copy does not include the runtime knowledge object changes replicated between the search head cluster nodes.

Upgrade the staging instance to the latest version

1. Follow steps one through four in the Upgrade Splunk Enterprise Security process.
2. Review the ES Configuration Health dashboard to identify changes in configurations and settings between the deployed version and the latest release of Splunk Enterprise Security.

The installer automatically disables deprecated apps or add-ons. An alert displays in Messages on the staging instance and identifies all deprecated items. You must manually remove a deprecated app or add-on from the Enterprise Security installation.

Migrate the upgraded ES install to the deployer

Move the apps that comprise Splunk Enterprise Security from the staging instance to the deployer.

1. On the staging instance, copy the apps, SAs, DAs, and TAs associated with the Splunk Enterprise Security Suite from the $SPLUNK_HOME/etc/apps directory to the $SPLUNK_HOME/etc/shcluster/apps directory on the deployer.
   1. Do not copy any of the deprecated apps or add-ons that you noted during the upgrade on staging.
   2. Do not copy any of the default apps, such as the search, launcher, or gettingstarted apps.

Do not copy all of the apps in the $SPLUNK_HOME/etc/apps directory, because you do not want to upgrade and deploy apps included with Splunk Enterprise.

Deploy the changes to the cluster members

1. On the deployer, deploy Enterprise Security with -preserve-lookups true to retain lookup file content generated on the search head cluster members. See Deploy a configuration bundle in Distributed Search.

See Maintain lookup files across app upgrades in the Splunk Enterprise Distributed Search Manual for more about using this setting.

Validate the configuration on the search cluster

After you distribute the copy of Enterprise Security on the deployer to the search head cluster members, use the ES Configuration Health dashboard to compare the cluster-replicated knowledge objects to the latest installation of Enterprise Security.

1. Log in to Splunk Web on a search head cluster member.
2. Open Enterprise Security.
3. From the Enterprise Security menu bar, select Audit > ES Configuration Health.
4. Review potential conflicts and changes to the default settings.

See ES Configuration Health in Use Splunk Enterprise Security.

Migrate an existing search head to a search cluster

You cannot add an Enterprise Security standalone search head or search head pool member directly to a search head cluster. You must implement and deploy a new search cluster with the latest version of Enterprise Security. Manually review and migrate any customized configurations from an existing ES installation to the deployer for replication to the cluster members. For more information on settings migration, see "Migrate from a standalone search head to a search head cluster" in the Splunk Enterprise Distributed Search Manual.

For assistance in planning a Splunk Enterprise Security deployment migration, contact the "Splunk Professional Services" team.