Deploying TIBCO Foresight REST API Component’s Docker Image

To deploy the Foresight REST API component’s Docker image on Docker or Kubernetes platform, perform the following steps:

    Procedure
  1. Navigate to the <folder>/fsrest_1.2.0/bcce-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 to which you want to push 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 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
    auditsafe_ds_host IP address of the AuditSafe host.
    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).

  3. Configure additional properties that are specific to Kubernetes services: Amazon Elastic Kubernetes Service (AWS EKS), Azure Kubernetes Service (AKS), or Google Cloud Kubernetes Engine (GKE).

  4. Save and close the deployment.properties file.

  5. 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/bcce-deployment/scripts directory and run the following command: 
      ./deploy-fsrest.sh

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

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

  7. 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
    2. AWS EKS
    3. Azure AKS
    4. Google Cloud GKE
    q. Quit

    Enter 1, 2, 3, 4, or q.

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