Deploying TIBCO Foresight REST API Component’s Docker Image

To deploy the standaloneForesight REST API component's docker image on the Docker or Kubernetes platform, perform the following steps.

    Procedure
  1. Navigate to the <folder>/fsrest_1.2.0/standalone-deployment/config directory.
  2. Open the deployment.properties file and configure the properties listed in the following table.
    3. Property Description
    docker_repository=<docker_registry_ip>:<docker_registry_port> <docker_registry_ip> is the IP address and <docker_registry_port> is the port of the machine from which you want to pull the Docker images.
    docker_username Specify the username required to log in to Docker.
    host_ip=<host_ip> <host_ip> is the IP address of the host machine, host name, or Kubernetes cluster.
    mount_path

    Specifies the external directory to be used as the parent for the FS Rest data store directories. Note that the following directory structure must be created under the mount_path directory:

    • controlfiles

    • datafiles

    • guidelines

      • Database

      • Static

    • maps

    Note: Copying data files, control files, guidelines, map files from container to mount_path is not supported during the deployment process in this release. But the copy operation can be done while building the Foresight REST API image. For more Information, see TIBCO Foresight® REST API Installation.
    fsr_port Port of the Foresight REST API.
    fsrest_loglevel A number specifying the detail of the Foresight REST API log messages from 0 (minimal log messages) through 5 (lots of log messages, typically used for debugging).
    k8s_namespace Namespace of Kubernetes. The namespace used by FSRest and other applications must be the same one.
    file_request_callback_addr URL of file request Callback address.
    val_callback_addr URL of validation guidelines Callback address.
    trans_callback_addr URL of translation in Callback address.
    message_post_addr URL of message posting Callback address.
    notify_post_addr URL of notification Callback address.
    fsrest_replicas Replicas of Foresight REST API microservice.
    enableSsl To enable SSL and support HTTPS for Foresight REST API.
  3. Save and close the deployment.properties file.

  4. To deploy the Foresight REST API component’s Docker images, run one of the following commands depending on the platform.

    • Kubernetes: Navigate to the <folder>/fsrest-1.2.0/standalone-deployment/scripts directory and run the following command. 
      ./deploy-fsrest.sh

    • Docker: Navigate to the <folder>/fsrest-1.2.0/standalone-deployment/samples/docker-scripts directory and run the following command. 
      ./docker-run-fsrest.sh

  5. Follow the command-line interface instructions, review the license agreement, and enter y to accept it.

  6. This step is applicable only if you want to deploy the Foresight REST API service on Kubernetes, otherwise skip this step.

    When prompted:

    Which Kubernetes environment do you want to deploy TIBCO Foresight REST API service?
    1. Native Kubernetes
    q. Quit

    Enter 1, or q.

ResultYou have deployed the Foresight REST API application.
What to do nextCheck the product-specific documentation for further steps.