WANdisco Fusion Pre-deployment Tool

1. Welcome

1.1. Product overview

The Pre-deployment tool is designed to capture information about your environment relating to its current configuration and services. This information is used to start the planning and preparation of a WANdisco Fusion installation. It will help determine any prerequisites that may be required in your environment.

If your designated WANdisco Fusion node is already available, this tool can be used to gather the environment, service and node details. However, this tool will provide valuable information even if your WANdisco Fusion node is not ready.

1.2. Using this guide

This guide covers:

What you will need to use the tool.
How to install and run the tool.
What the tool will capture in terms of configuration and service information.
How to provide WANdisco with the output.
Troubleshooting any issues.

1.3. Contact and support

See our online Knowledge base which contains updates and more information.

If you need more help raise a case on our Support website.

If you find an error or if you think some information needs improving, raise a case on our support website or email docs@wandisco.com.

2. Pre-requisites

Root or sudo user access required on the server running the tool.
Java installed on the server running the tool.
Administrator credentials for the Cluster Manager (i.e. username & password).
If running remotely, connectivity to the Cluster Manager (e.g. Ambari server, Cloudera Management server).

If Kerberos is enabled on the cluster, then the following will also be required:

Ability to obtain a Kerberos ticket as a superuser.

2.1. Download the Pre-deployment tool

Please contact WANdisco support to raise or update a case if wanting to download the Pre-deployment tool.

3. Operation

3.1. Information gathered

The script will gather information from the Cluster Manager and node it is running on. This will include:

The configuration of all services from the Cluster Manager. For example, on a Hadoop cluster, this could be:
- HDFS (e.g. core-site.xml, hdfs-site.xml)
- Hive (e.g. hive-site.xml)
- Spark (e.g. spark-env.sh)
The local configuration of services on the node running the Pre-deployment tool.
The local server details, such as mount points, OS, CPU and memory information. This will be useful if the node will be used as a WANdisco Fusion server.
A summary of all the collected information.

3.2. Where to run the Pre-deployment tool

It is recommended to run the script on a potential WANdisco Fusion node as information gathered will be used to determine whether the node meets the pre-requirements for a WANdisco Fusion installation.

However, any available cluster or environment node would be suitable if your designated WANdisco Fusion is not ready.

3.3. Using the Pre-deployment tool

Once the tool is downloaded on to your node, you must run the script as root or a user with sudo privileges.

If Kerberos is enabled on your cluster, you must kinit as a superuser before running the script.

Run the script using Java.

java -jar pre-deploy-tool

The script will now output paths where it will store information. At the end, all captured information will be packaged inside a gzip file.

Paths for reporting:
/root/FusionPreDeployChecksReport2020-01-24T11_47_38_997Z
/root/FusionPreDeployChecksReport2020-01-24T11_47_38_997Z/inputs
/root/FusionPreDeployChecksReport2020-01-24T11_47_38_997Z/summary
Paths for configs:
/root/FusionPreDeployChecksReport2020-01-24T11_47_38_997Z/local_configs
/root/FusionPreDeployChecksReport2020-01-24T11_47_38_997Z/manager_configs
Directories created
Log Level: INFO
----------------------------------------
Running: Fusion PreDeployment Checker Tool
Version: 0.1
Date: 2020-01-24T11:47:39.070Z
----------------------------------------

If this node will be a WANdisco Fusion server, enter y. Otherwise, enter n.
```
Will this node be used to run Fusion (y/n) [y]:
```

Choose the Cluster Manager type by entering the corresponding number.

Please select the Cluster Manager type:
  1: CLOUDERA_MANAGER
  2: AMBARI
  3: UNMANAGED
  4: OTHER
Enter your choice:

Enter the Fully Qualified Domain Name of the Cluster Manager.
```
Host:
```
Enter the access port for the Cluster Manager, the default port is displayed for your manager type. Please adjust to the correct TLS/SSL port if enabled.
```
Port [XXXX]:
```
If the Cluster Manager is TLS/SSL enabled, enter y. Otherwise, enter n.
```
SSL (y/n) [n]:
```

Enter the Administrator username and then password for the Cluster Manager.

Username:
Password:

The script will now proceed to gather information from the Cluster manager.

Gathering configs from Manager ...
Gathering data from Manager ...

A list of ports will be presented, with information on whether they are available (or taken) on the server. This information can be disregarded if the local server is not destined to be a WANdisco Fusion node.

Based on WANdisco Fusions requirements we have tested the following ports:
  6444, 7000, 8001, 8023, 8024, 8082, 8083, 8084, 8443, 8880, 9001
Results:
    6444 = Available
    7000 = Available
    8001 = Available
    8023 = Available
    8024 = Available
    8082 = Available
    8083 = Available
    8084 = Taken [8083 = Available, 8085 = Available]
    8443 = Available
    8880 = Available
    9001 = Taken [9000 = Available, 9002 = Available]

If this is to be a WANdisco Fusion node, then enter any other alternative ports you wish to test using a comma separated list (e.g. 8085,8086,etc).
```
If there are any other ports that should be tested please enter a comma separated list here:
```
If the local system user is known and already created for Fusion, please enter it here. If not, leave blank.
```
What user will Fusion run as (If unknown hit return)?
```

The script is now complete, and the resulting gzip will have been created in your current directory.

Thank you for gathering the Fusion pre-installation information.
Please visit support.wandisco.com and attach the below file to your individual deployment case.

  /root/FusionPreDeployChecksReport2020-01-24T11_47_38_997Z.tgz

3.4. What to do next

Once the Pre-deployment tool has finised capturing all required information, the next step is to upload the compressed report (gzip) to WANdisco for analysis.

Transfer the compressed file (.tgz) to your local machine so that it is ready to be uploaded.

Visit the support website to attach the gzip to your case and inform us that you have uploaded the report.

4. Troubleshooting

In the event that you encounter any issues running the Pre-deployment tool, contact WANdisco support and update your case with a description of the error.

There is a common error that may be encountered:

Problem connecting to manager. Would you like to try again? (y/n) [y]

This error may be encountered due to the following reasons:

Incorrect Cluster Manager type
Incorrect Hostname
Incorrect Port
Incorrect choice for SSL on Manager.
Incorrect username or password for Manager.

In all cases, you can answer y to re-enter these details except for the Cluster Manager type. If you believe the Cluster Manager type was incorrectly entered, cancel out of the script, and rerun it from the beginning.