Provisioning the TIBCO Messaging Quasar Capability

You can provision the TIBCO Messaging Quasar capability from TIBCO Control Plane. To provision the TIBCO Messaging Quasar capability, ensure that you have a registered data plane in TIBCO Control Plane. For more information, see Registering a Data Plane.

Provisioning a TIBCO Messaging Quasar capability to your registered data plane creates a running TIBCO Messaging Quasar Fault Tolerant (FT) server group and is supplied with a default configuration designed to simplify initial access and setup. The Pulsar server group (referred to as Pulsar instance in the Apache Pulsar documentation) is structured based on the Apache Pulsar official helm chart. Administration of the server group is easiest by using the preconfigured toolset pod that is accessed inside the data plane by using the kubectl exec command.

Note: The default configuration has only one preconfigured admin user with the credentials mounted on the toolset pod. For more information, see the Apache Pulsar documentation.
Before you begin

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

  • Create storage class options. For more information, see Managing Resources.

  • Ask your administrator to assign you the Manage Dataplanes (Register, De-register) permissions and the Manage Capabilities (Provision, De-provision) permissions.

Note: The backing storage of the TIBCO Messaging Quasar capability cannot be changed after the server group is running. You have to delete and reprovision the capability.
    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 TIBCO Messaging Quasar capability, on the Provision TIBCO® Messaging Quasar - Powered by Apache Pulsar™ card, click Start.

  5. On the Resources tab, select the Message Storage storage class.

  6. Optional Select the Journal Storage storage class.
    For more information about resources, see Provisioning Considerations.

  7. Optional Select the Log Storage storage class.

    For more information about resources, see Provisioning Considerations.

  8. Click Next.

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

    Configuration

    Field Description
    Server Configuration
    Server Name Enter a unique TIBCO Messaging Quasar server name.
    This name is used for constructing Kubernetes resource names and the Client 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 TIBCO Messaging Quasar capability card, helps you understand the use of the instance. For example, dev, prod, or qa. For a large organization, this label can be orgname.
    Server Sizing Select the size of your TIBCO Messaging Quasar 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 selected, must also set storage class for data) (Optional) Select this checkbox if you want to deploy the TIBCO Messaging Quasar 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 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 TIBCO Messaging Quasar message storage.
    This field displays the storage class selected in Step 5.
    Selected Storage Class for Logs The name of the storage class that you want to use to provision TIBCO Messaging Quasar log storage.
    This field displays the storage class selected in Step 7.
    If you proceed without selecting the storage class for logs, the message storage volumes are used as the default storage class for logs.
    Selected Storage Class for Journal

    The name of the storage class that you want to use to provision TIBCO Messaging Quasar journal storage.

    This field displays the storage class selected in Step 6.
    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 shared log storage simplifies operational and support activities and offers potential cost savings. When you use shared logs, all logs are available in one place from the toolset pod under /logs/<release>/.

    Note: If you select a storage class that does not support multi-pod usage, such as Solid State Drives (SSDs) or Elastic Block Storage (EBS), TIBCO Messaging Quasar 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.
    Use Custom Config Select the checkbox if you want to use the Custom Config tab.
    This 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 Config tab requires detailed knowledge of Kubernetes StatefulSets and the msg-pulsar-tp Helm chart features, and is best used in consultation with TIBCO Support or professional services.
    I have read and accepted the TIBCO End User Agreement (EUA) Select the checkbox after you have read and accepted the EUA.

  10. Click Next.

  11. On the Confirmation tab, verify the information in all the fields and click Provision TIBCO® Messaging Quasar - Powered by Apache Pulsar™.

    When the provisioning of the TIBCO Messaging Quasar capability is complete, on the Provisioning tab, click Go back to Data Plane.

What to do nextAfter completing the provisioning process, you can view the TIBCO Messaging Quasar capability card on the Capabilities page. You can see all the available instances of the TIBCO Messaging Quasar capability on this page. On the Capabilities page, click the provisioned TIBCO Messaging Quasar instance to see the details, such as server name and client TCP URL. The TIBCO® Messaging Quasar - Powered by Apache Pulsar™ Instance Details page includes the following options:

  • Redeploy: Use this button to restart all the TIBCO Messaging Quasar pods safely in the correct order, minimizing the downtime and client reconnects. For more information, see Kubernetes Maintenance Support.

  • Admin CLI: Use this button to open an in-browser, interactive bash shell session to the capability toolset pod, pre-configured with pulsar-admin and bookkeeper for your Apache Pulsar server group administration.