Provisioning the TIBCO Enterprise Message Service Capability

You can provision the TIBCO Enterprise Message Service™ (EMS) capability from TIBCO Control Plane. To provision the Enterprise Message Service™ capability, ensure that you have a registered data plane in your TIBCO Control Plane. For more details, see Registering a Data Plane.

Provisioning an EMS capability to your registered data plane creates a running EMS Fault Tolerant (FT) server-group using FTL Stores and is supplied with a default configuration designed to simplify initial access and setup.

Note: The default configuration admin user has no password. Therefore, you have to proceed with the server administrative setup before exposing the servers to the external clients. In addition to the EMS specified "admin" user, the default configuration automatically adds the control plane OAuth2 public key and the user who provisioned EMS as an additional admin user. If not desired, this can be changed using EMS administration. For more details, see the Creating Users with the EMS Administration Tool section in the TIBCO Enterprise Message Service™ User Guide.
Before you begin

  • You must have a Kubernetes cluster with one or more appropriate storage classes with required performance characteristics.

  • Ask your Team admin to assign you the data plane Manager permission and the Capability Manager permission.

Note: The backing storage of the EMS capability cannot be changed after the server-group is running. You have to delete and provision the capability again.
    Procedure

  1. On the TIBCO Control Plane home page, in the left navigation pane, click Data Planes.

  2. On the Data Planes page, navigate to the desired data plane card and click Go to Data Plane.

  3. On the Capabilities page, click Provision a capability.

  4. To begin the provisioning process of a new EMS capability, on the Provision TIBCO Enterprise Message Service™ card, click Start.

  5. (Optional) On the Resources tab, select the Message Storage storage class and a separate Log Storage storage class and click Next.
    For more information about resources, see Provisioning Considerations.

  6. Click I agree after you have read and accepted the EUA.

  7. Set the fields on the Configuration tab as described in the following table:

    Configuration

    Field Description
    Server Configuration
    Server Name Enter a unique EMS server name.
    This name is used for constructing Kubernetes resource names and the EMS_TCP_URL for in-cluster client connections.
    Server Environment Enter a label based on the type of server that you want to use.
    This label, displayed on the EMS capability card, helps you easily understand the use of the instance. For example, dev, prod, or qa. For a large organization, this label can be an orgname.
    Activation Server URL

    The default value is https://tib-activate:7070.

    You must check with your network administrator to get the proper URL for a given data plane.
    Server Sizing Select the sizing of your EMS server-group from the dropdown list: small, medium, or large.
    This field is used to set Kubernetes resource allocations for the server-group.
    Capability is for production (if checked, must also set storage class for data) (Optional) Select this checkbox if you want to deploy the EMS server with extra production appropriate restrictions.
    Enabling this checkbox results in more precise (and larger) Kubernetes resource allocations appropriate for production usage.
    Note: Ensure that the appropriate node resources are available or else your server pods get stuck in the Pending state.
    If you enable production, you must select the message storage class in Step 5.
    Advanced
    Selected Storage Class for Data The name of the storage class that you want to use to provision EMS message storage.
    This field displays the storage class selected in Step 5.
    If you proceed without selecting the storage class, EmptyDir is set as the default value.
    Note: Ensure that you do not set this field to the default value for production, as it disables some important FT functionality.
    Selected Storage Class for Logs The name of the storage class that you want to use to provision EMS log storage.
    This field displays the storage class selected in Step 5.
    If you proceed without selecting the storage class for logs, the message storage volumes are used as the default storage class for logs.
    Logs storage is shared (it is limited to only sharable classes, e.g., NFS, EFS, or SMB2) Select this checkbox for the appropriate storage class.
    Selecting this checkbox requires the underlying storage class to support multiple pods mounting the same PersistentVolume. Using the shared log storage simplifies operational and support activities as well as offers potential cost savings.
    Note: If you select a storage class that does not support multi-pod usage like Solid State Drives (SSDs) or Elastic Block Storage (EBS), EMS fails to start with pods stuck in Pending state.
    If you do not provide a log storage class name, the Logs storage is shared checkbox is ignored.
    I have read and accepted the TIBCO End User Agreement (EUA) The checkbox is selected after you have read and accepted the EUA in Step 6.
    Use Custom Config Select the checkbox if you want to use the Custom Configuration tab.
    The Custom Configuration tab is optional. It is available for advanced use cases that require access to advanced chart features using a custom values YAML file.
    Note: Using the Custom Configuration tab requires detailed knowledge of Kubernetes StatefulSets and the msg-ems-tp Helm chart features, and is best used in consultation with TIBCO Support or professional services.

  8. On the Confirmation tab, verify the information in all the fields and click Next.

  9. On the Provisioning tab, click Next to start the provisioning process. After provisioning the EMS capability, click Go back to Data Plane.

What to do next
  • After completing the provisioning process, you can view the EMS capability card on the Capabilities page. You can see all the available instances of the EMS capability on this page.
  • On the Capabilities page, click the provisioned EMS instance to navigate through different tabs for the users. For more information, see Navigating EMS Capability Tabs for Users.
  • Upgrade your capability to use the latest features. When a new version of a capability is available, you can see the Upgrade available message on the capability card. For more information, see Upgrading a Capability.