Using Signiant Control

Signiant Control is a command line tool used to interact with Signiant applications. When deploying Flight Gateway to a server, you must activate the gateway using Signiant Control, which is included in the Flight Gateway installer package.

Once activated, you can send a test file to an endpoint to confirm the connection.

Signiant Control's install location depends on your operating system:

Linux (Amazon/CentOS/Red Hat): /usr/local/bin/
Linux (Ubuntu): /opt/signiant/flight-gateway/
Windows (Current User): C:\Users\userName\AppData\Local\Signiant\Flight Gateway\
Windows (Service): C:\Program Files\Signiant\Flight Gateway\

Command Line Options

Signiant Control uses command line options to complete its tasks. You can view the options by typing sigctl at the command line.

Job Configuration Files

Job configuration files allow you to set how Signiant Control works with your gateway and Flight server, and allows you to set your source and storage address and credentials for a specific job.

Note: Source address should be configured for a file or directory you want to copy to your cloud storage as a test transfer.

Example Job Configuration File (Microsoft Azure)

{
    "checkType": "none",
    "logLevel": "info",
    "source": {
        "address": "file://path/to/folder/",
        "partLength": "4Mi",
        "workerThreads": 1
    },
    "target": {
        "address": "https://storage-account-name.blob.core.windows.net/example-container-name",
        "credentials": {
            "accessKey": "ACCESS_KEY"
        },
        "flightGateway": "https://127.0.0.1:8443",
        "partLength": "4Mi",
        "workerThreads": 4
    }
}

Example Job Configuration File (Amazon S3)

{
    "checkType": "none",
    "logLevel": "info",
    "source": {
        "address": "file://path/to/folder/",
        "partLength": "4Mi",
        "workerThreads": 1
    },
    "target": {
        "address": "https://example-bucket.s3.us-east-1.amazonaws.com",
        "credentials": {
            "accessKey": "ACCESS_KEY",
            "secretKey": "SECRET_KEY"
        },
        "flightGateway": "https://127.0.0.1:8443",
        "partLength": "5Mi",
        "workerThreads": 4
    }
}

Example Job Configuration File (Google Cloud Storage)

To configure Google Cloud Storage, you must create a Service Account in the Google Cloud Console. Generate a JSON encoded key to use as a credentials file.

The service account must include account permissions for:

• Storage Object Admin
• Storage Object Creator
• Storage Object Viewer

{
    "checkType": "none",
    "logLevel": "info",
    "source": {
        "address": "file://path/to/folder/",
        "partLength": "8Mi",
        "workerThreads": 1
    },
    "target": {
        "address": "https://storage.cloud.google.com/example-bucket",
        "credentials": {
            "privateKey": "/path/to/service-key.json"
        },
        "flightGateway": "https://127.0.0.1:8443",
        "partLength": "8Mi",
        "workerThreads": 8
    }
}

Connecting to Unregistered Endpoints

In certain situations you may need to test connecting to a group of unregistered endpoints.

To test additional endpoints, include an object array in your configuration file:

// ...
 "Groups": [
      {
        "Name": "ExampleGroup",
        "Endpoints":
        [
          {
            "Name": "Example A",
            "Url": "https://example.com:443",
            "ExpectedStatusCode": 200
          },
          {
            "Name": "Example B",
            "Url": "https://your-domain.com:443",
            "ExpectedStatusCode": 200
          }
        ]
      }
 ]
// ...

Once you have added the group and servers to your configuration file, you can test your connectivity using the command line:

sigctl -config ./config/config.json -test ExampleGroup

You can test your connectivity to both Flight Gateway and your endpoint groups by including both options at once:

sigctl -config ./config/config.json -test flight-gateway ExampleGroup