Install BlueXP classification on a Linux host with no internet access
Complete a few steps to install BlueXP classification on a Linux host in an on-premises site that doesn't have internet access - also known as private mode. This type of installation, which uses an installation script, has no connectivity to the BlueXP SaaS layer.
Note that you can also deploy BlueXP classification in an on-premises site that has internet access.
The BlueXP classification installation script starts by checking if the system and environment meet the required prerequisites. If the prerequisites are all met, then the installation starts. If you would like to verify the prerequisites independently of running the BlueXP classification installation, there is a separate software package you can download that only tests for the prerequisites. See how to check if your Linux host is ready to install BlueXP classification.
For legacy versions 1.30 and earlier, if you need to install BlueXP classification on multiple hosts, refer to Install BlueXP classification on multiple hosts with no internet access. |
Supported data sources
When installed private mode (sometimes called an "offline" or "dark" site), BlueXP classification can only scan data from data sources that are also local to the on-premises site. At this time, BlueXP classification can scan the following local data sources:
-
On-premises ONTAP systems
-
Database schemas
There is no support currently for scanning Cloud Volumes ONTAP, Azure NetApp Files, or FSx for ONTAP accounts when BlueXP classification is deployed in private mode.
Limitations
Most BlueXP classification features work when it is deployed in a site with no internet access. However, certain features that require internet access are not supported, for example:
-
Setting BlueXP roles for different users (for example, Account Admin or Compliance Viewer)
-
Copying and synchronizing source files using BlueXP copy and sync
-
Automated software upgrades from BlueXP
Both the BlueXP Connector and BlueXP classification will require periodic manual upgrades to enable new features. You can see the BlueXP classification version at the bottom of the BlueXP classification UI pages. Check the BlueXP classification Release Notes to see the new features in each release and whether you want those features. Then you can follow the steps to upgrade the BlueXP Connector and upgrade your BlueXP classification software.
Quick start
Get started quickly by following these steps, or scroll down to the remaining sections for full details.
If you don't already have a Connector installed in private mode, deploy the Connector on a Linux host now.
Ensure that your Linux system meets the host requirements, that it has all required software installed, and that your offline environment meets the required permissions and connectivity.
Download the BlueXP classification software from the NetApp Support Site and copy the installer file to the Linux host you plan to use. Then launch the installation wizard and follow the prompts to deploy the BlueXP classification instance.
Install the BlueXP Connector
If you don't already have a BlueXP Connector installed in private mode, deploy the Connector on a Linux host in your offline site.
Prepare the Linux host system
BlueXP classification software must run on a host that meets specific operating system requirements, RAM requirements, software requirements, and so on.
-
BlueXP classification is not supported on a host that is shared with other applications - the host must be a dedicated host.
-
When building the host system in your premises, you can choose among these system sizes depending on the size of the dataset that you plan to have BlueXP classification scan.
System size CPU RAM (swap memory must be disabled) Disk Extra Large
32 CPUs
128 GB RAM
1 TiB SSD on /, or
- 100 GiB available on /opt
- 895 GiB available on /var/lib/docker
- 5 GiB on /tmpLarge
16 CPUs
64 GB RAM
500 GiB SSD on /, or
- 100 GiB available on /opt
- 395 GiB available on /var/lib/docker or for Podman /var/lib/containers or for Podman /var/lib/containers
- 5 GiB on /tmp -
When deploying a compute instance in the cloud for your BlueXP classification installation, we recommend a system that meets the "Large" system requirements above:
-
Amazon Elastic Compute Cloud (Amazon EC2) instance type: We recommend "m6i.4xlarge". See additional AWS instance types.
-
Azure VM size: We recommend "Standard_D16s_v3". See additional Azure instance types.
-
GCP machine type: We recommend "n2-standard-16". See additional GCP instance types.
-
-
UNIX folder permissions: The following minimum UNIX permissions are required:
Folder Minimum Permissions /tmp
rwxrwxrwt
/opt
rwxr-xr-x
/var/lib/docker
rwx------
/usr/lib/systemd/system
rwxr-xr-x
-
Operating system:
-
The following operating systems require using the Docker container engine:
-
Red Hat Enterprise Linux version 7.8 and 7.9
-
Ubuntu 22.04 (requires BlueXP classification version 1.23 or greater)
-
Ubuntu 24.04 (requires BlueXP classification version 1.23 or greater)
-
-
The following operating systems require using the Podman container engine, and they require BlueXP classification version 1.30 or greater:
-
Red Hat Enterprise Linux version 8.8, 9.0, 9.1, 9.2, 9.3, 9.4
-
-
-
Red Hat Subscription Management: The host must be registered with Red Hat Subscription Management. If it's not registered, the system can't access repositories to update required 3rd-party software during installation.
-
Additional software: You must install the following software on the host before you install BlueXP classification:
-
Depending on the OS you are using, you'll need to install one of the container engines:
-
Docker Engine version 19.3.1 or greater. View installation instructions.
-
Podman version 4 or greater. To install Podman, enter (
sudo yum install podman netavark -y
).
-
-
-
Python version 3.6 or greater. View installation instructions.
-
NTP considerations: NetApp recommends configuring the BlueXP classification system to use a Network Time Protocol (NTP) service. The time must be synchronized between the BlueXP classification system and the BlueXP Connector system.
-
Firewalld considerations: If you are planning to use
firewalld
, we recommend that you enable it before installing BlueXP classification. Run the following commands to configurefirewalld
so that it is compatible with BlueXP classification:firewall-cmd --permanent --add-service=http firewall-cmd --permanent --add-service=https firewall-cmd --permanent --add-port=80/tcp firewall-cmd --permanent --add-port=8080/tcp firewall-cmd --permanent --add-port=443/tcp firewall-cmd --reload
Note that you must restart Docker or Podman whenever you enable or update
firewalld
settings.
-
The IP address of the BlueXP classification host system can't be changed after installation. |
Verify BlueXP and BlueXP classification prerequisites
Review the following prerequisites to make sure that you have a supported configuration before you deploy BlueXP classification.
-
Ensure that the Connector has permissions to deploy resources and create security groups for the BlueXP classification instance. You can find the latest BlueXP permissions in the policies provided by NetApp.
-
Ensure that you can keep BlueXP classification running. The BlueXP classification instance needs to stay on to continuously scan your data.
-
Ensure web browser connectivity to BlueXP classification. After BlueXP classification is enabled, ensure that users access the BlueXP interface from a host that has a connection to the BlueXP classification instance.
The BlueXP classification instance uses a private IP address to ensure that the indexed data isn't accessible to others. As a result, the web browser that you use to access BlueXP must have a connection to that private IP address. That connection can come from a host that's inside the same network as the BlueXP classification instance.
Verify that all required ports are enabled
You must ensure that all required ports are open for communication between the Connector, BlueXP classification, Active Directory, and your data sources.
Connection Type | Ports | Description |
---|---|---|
Connector <> BlueXP classification |
8080 (TCP), 6000 (TCP), 443 (TCP), and 80. 9000 |
The security group for the Connector must allow inbound and outbound traffic over ports 6000 and 443 to and from the BlueXP classification instance.
|
Connector <> ONTAP cluster (NAS) |
443 (TCP) |
BlueXP discovers ONTAP clusters using HTTPS. If you use custom firewall policies, they must meet the following requirements:
|
BlueXP classification <> ONTAP cluster |
|
BlueXP classification needs a network connection to each Cloud Volumes ONTAP subnet or on-prem ONTAP system. Security groups for Cloud Volumes ONTAP must allow inbound connections from the BlueXP classification instance. Make sure these ports are open to the BlueXP classification instance:
NFS volume export policies must allow access from the BlueXP classification instance. |
BlueXP classification <> Active Directory |
389 (TCP & UDP), 636 (TCP), 3268 (TCP), and 3269 (TCP) |
You must have an Active Directory already set up for the users in your company. Additionally, BlueXP classification needs Active Directory credentials to scan CIFS volumes. You must have the information for the Active Directory:
|
If a firewall used on Linux host |
9000 |
Needed for internal processes within an Ubuntu server. |
Install BlueXP classification on the on-premises Linux host
For typical configurations you'll install the software on a single host system.
Single-host installation for typical configurations
Follow these steps when installing BlueXP classification software on a single on-premises host in an offline environment.
Note that all installation activities are logged when installing BlueXP classification. If you run into any issues during installation, you can view the contents of the installation audit log. It is written to /opt/netapp/install_logs/
. See more details here.
-
Verify that your Linux system meets the host requirements.
-
Verify that you have installed the two prerequisite software packages (Docker Engine or Podman, and Python 3).
-
Make sure you have root privileges on the Linux system.
-
Verify that your offline environment meets the required permissions and connectivity.
-
On an internet-configured system, download the BlueXP classification software from the NetApp Support Site. The file you should select is named DataSense-offline-bundle-<version>.tar.gz.
-
Copy the installer bundle to the Linux host you plan to use in private mode.
-
Unzip the installer bundle on the host machine, for example:
tar -xzf DataSense-offline-bundle-v1.25.0.tar.gz
This extracts required software and the actual installation file cc_onprem_installer.tar.gz.
-
Unzip the installation file on the host machine, for example:
tar -xzf cc_onprem_installer.tar.gz
-
Launch BlueXP and select Governance > Classification.
-
Click Activate Data Sense.
-
Click Deploy to start the on-prem installation.
-
The Deploy Data Sense On Premises dialog is displayed. Copy the provided command (for example:
sudo ./install.sh -a 12345 -c 27AG75 -t 2198qq --darksite
) and paste it in a text file so you can use it later. Then click Close to dismiss the dialog. -
On the host machine, enter the command you copied and then follow a series of prompts, or you can provide the full command including all required parameters as command line arguments.
Note that the installer performs a pre-check to make sure your system and networking requirements are in place for a successful installation.
Enter parameters as prompted: Enter the full command: -
Paste the information you copied from step 8:
sudo ./install.sh -a <account_id> -c <client_id> -t <user_token> --darksite
-
Enter the IP address or host name of the BlueXP classification host machine so it can be accessed by the Connector system.
-
Enter the IP address or host name of the BlueXP Connector host machine so it can be accessed by the BlueXP classification system.
Alternatively, you can create the whole command in advance, providing the necessary host parameters:
sudo ./install.sh -a <account_id> -c <client_id> -t <user_token> --host <ds_host> --manager-host <cm_host> --no-proxy --darksite
Variable values:
-
account_id = NetApp Account ID
-
client_id = Connector Client ID (add the suffix "clients" to the client ID if it not already there)
-
user_token = JWT user access token
-
ds_host = IP address or host name of the BlueXP classification system.
-
cm_host = IP address or host name of the BlueXP Connector system.
-
The BlueXP classification installer installs packages, registers the installation, and installs BlueXP classification. Installation can take 10 to 20 minutes.
If there is connectivity over port 8080 between the host machine and the Connector instance, you'll see the installation progress in the BlueXP classification tab in BlueXP.
From the Configuration page you can select the local on-prem ONTAP clusters and databases that you want to scan.
Upgrade BlueXP classification software
Since BlueXP classification software is updated with new features on a regular basis, you should get into a routine to check for new versions periodically to make sure you're using the newest software and features. You'll need to upgrade BlueXP classification software manually because there's no internet connectivity to perform the upgrade automatically.
-
We recommend that your BlueXP Connector software is upgraded to the newest available version. See the Connector upgrade steps.
-
Starting with BlueXP classification version 1.24 you can perform upgrades to any future version of software.
If your BlueXP classification software is running a version prior to 1.24, you can upgrade only one major version at a time. For example, if you have version 1.21.x installed, you can upgrade only to 1.22.x. If you are a few major versions behind, you'll need to upgrade the software multiple times.
-
On an internet-configured system, download the BlueXP classification software from the NetApp Support Site. The file you should select is named DataSense-offline-bundle-<version>.tar.gz.
-
Copy the software bundle to the Linux host where BlueXP classification is installed in the dark site.
-
Unzip the software bundle on the host machine, for example:
tar -xvf DataSense-offline-bundle-v1.25.0.tar.gz
This extracts the installation file cc_onprem_installer.tar.gz.
-
Unzip the installation file on the host machine, for example:
tar -xzf cc_onprem_installer.tar.gz
This extracts the upgrade script start_darksite_upgrade.sh and any required third-party software.
-
Run the upgrade script on the host machine, for example:
start_darksite_upgrade.sh
The BlueXP classification software is upgraded on your host. The update can take 5 to 10 minutes.
You can verify that the software has been updated by checking the version at the bottom of the BlueXP classification UI pages.