Downloading, Configuring, and Running the Hybrid Agent

This topic details how to download, configure, and run the TIBCO Cloud™ Integration - Hybrid Agent.

Step 1: Download the Hybrid Agent

  1. Ensure you meet all of the requirements in TIBCO Cloud™ Integration - Hybrid Agent Requirements.
  2. Log in to TIBCO Cloud™ Integration.
  3. Click the Environment & Tools tab.
  4. Under Environment Settings, click Agents to display the Agents page.
  5. Click New Agent and choose Hybrid.
  6. A download dialog opens. Choose your platform from the list to download the agent binary.
  7. There is no further installation procedure, except that you may want to move the binary to another directory in your path. On Linux or macOS, to run the Hybrid Agent binary from your current directory, you must precede the command with a ./. Example: ./tibagent start agent agent1
  8. To use the Hybrid Agent for Hybrid Connectivity to establish a tunnel, log in to TIBCO Cloud™ and get an access key. Access keys are created and managed at https://account.cloud.tibco.com/manage/settings/advanced. Remember to save the access key and secret. For step-by-step instructions see Generating or Revoking Access Keys.

Step 2: Configure the Hybrid Agent

After downloading the Hybrid Agent, you must log in and then configure it. Configuration is a one-time process that registers the TIBCO Cloud Integration - Hybrid Agent with TIBCO Cloud Integration. Hybrid Agent configuration varies depending on how you plan to use it. You can configure agents to manage and monitor remote apps or for Hybrid Connectivity to establish a tunnel connection between remote apps and on-premises resources. You cannot use a single agent to do both. Configure a dedicated agent for each one. These agents can run on the same machine.

See the Hybrid Agent Command Reference for all command options.

Configure a Hybrid Agent to Manage Apps

You must be connected to a hosted or private Kubernetes cluster before configuring the Hybrid Agent for remote app management.

Assuming the following:

  1. Log in and configure an agent with either your user credentials or an OAuth token.

    User Credentials login

    tibagent login --username jsmith --password pass123
    tibagent configure agent -p 5150 --config-dir my-directory agent37

    OAuth token login

    tibagent authorize --token CIC~qAcgYVobxgxxsKKvXxwmPo8f
    tibagent configure agent -p 5150 --config-dir my-directory agent37
  2. Create agent configuration files for running in a Kubernetes environment. 
    tibagent configure manage --config-dir my-directory agent37
    Note: Review the template script and configuration files created in the configuration directory my-directory/agents/agent37. See the configure manage section of the Hybrid Agent Command Reference page for a list of the generated files.
  3. Apply agent configuration files for running in a Kubernetes environment. 
    tibagent apply manage --config-dir my-directory agent37

Configure a Hybrid Agent for Hybrid Connectivity

Assuming the following:

  1. Log in and configure an agent with either your user credentials or an OAuth token.

    User Credentials login

    tibagent login --username jsmith --password pass123
    tibagent configure agent -p 5150 agent37

    OAuth token login

    tibagent authorize --token CIC~qAcgYVobxgxxsKKvXxwmPo8f
    tibagent configure agent -p 5150 agent37
  2. Create agent configuration files for Hybrid Connectivity.

    The Hybrid Connectivity configuration allows the agent to create new tunnels for any app using the specified access key. You can also configure an agent without an access key and give specific app names that will have tunnels.

    With an access key

    tibagent configure connect --accessSecret c4sW+S0etc --accessKey my-key agent37

    Without an access key

    tibagent configure connect --app MyApp1 --app MyApp2 agent37

Configuring Multiple Hybrid Agents

Multiple Hybrid Agents optionally can be configured and run for the same Organization to allow grouping of your remote apps for management and monitoring. For example, you could run different Hybrid Agents for each department or subnet in your Organization. You can also run multiple Hybrid Agents on different machines to provide high availability for tunnel connections to on-premises resources if a Hybrid Agent fails. See Hybrid Connectivity for more information on redundancy and high availability.

You can configure and run multiple Hybrid Agents on the same machine. Configure each Hybrid Agent by specifying different ports with the --port option, and optionally with different configuration directories with the --config-dir <dir> option.

Step 3: Run the Hybrid Agent

After configuring a Hybrid Agent in the above example, use the following command to run it:

tibagent start agent agent37

For Hybrid Connectivity, see Using the Agent for Hybrid Connectivity for complete details on using the --spec option.

Note: If you have configured your agent to run in Kubernetes using the configure manage command, the start agent command starts the agent in a Kubernetes pod. If the agent is not configured to run in Kubernetes, the start agent command starts the agent as a stand alone agent that is not reliant on Kubernetes.

Role Requirements