Managing Apps with BW Provisioner

This section describes all the APIs to manage the app builds using the BW Provisioner for the TIBCO BusinessWorks Container Edition Capability.

API for Deploying Apps

Use the POST /v1/dp/deploy API to deploy or upgrade a TIBCO BusinessWorks Container Edition application using the Build Id. You can override app properties, profile, engine variables, resource limits for the pod, replicas or autoscaling configuration, and network policy configurations when deploying or upgrading the app.

Note: To upgrade an existing application, the App Id is mandatory.
Caution: If you want to change one application property for an app, you need to provide all existing app properties along with their values for that app.

To deploy an app you need the namespace parameter

Namespace: The namespace where the application is deployed.

METHOD Path Parameters
POST

  • Parameters: namespace

  • Type: String

API for Changing the Application Endpoint to Private

Use the DELETE /v1/dp/apps/{appId}/endpoints/public API to change the applications endpoint to private. This API removes the Ingress resource from the application to make the endpoint private.

To view the appbendpoint details, you need the following parameters:

  • App Id: The application Id. This can be retrieved using the GET /v1/dp/apps method.

  • Namespace: The namespace where the application is deployed.

METHOD Path Parameters
DELETE

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

API for Changing the Application Endpoint to Public

Use the POST /v1/dp/apps/{appId}/endpoints/public API to change the applications endpoint to public. This API creates the Ingress resource with inputs such as class name, FQDN, and path prefix.

To view the app endpoint details, you need the following parameters:

  • App Id: The application Id. This can be retrieved using the GET /v1/dp/apps method.

  • Namespace: The namespace where the application is deployed.

METHOD Path Parameters
POST

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

API for Updating Application Configurations

Use the PUT /v1/dp/apps/{appId} API to update the application configuration from the data plane. When you apply the configuration, the application restarts.

Caution: If you want to change one application property for an app, you need to provide all existing app properties along with their values for that app.

To update the app configuration, you need the following parameters:

  • App Id: The application Id. This can be retrieved using the GET /v1/dp/apps method.

  • Namespace: The namespace where the application is deployed.

METHOD Path Parameters
PUT

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

API for Updating or Creating Autoscaling Configuration for an Application

Use the PUT /v1/dp/apps/{appId}/autoscaling API to modify or create the autoscaling configuration instance for an application. You can provide the minimum and maximum replicas of the application, the CPU threshold, and memory threshold for the resource configuration.

To update or create autoscaling configuration for an app, you need the following parameters:

  • App Id: The application Id. This can be retrieved using the GET /v1/dp/apps method.

  • Namespace: The namespace where the application is deployed.

METHOD Path Parameters
PUT

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

API for Deleting Autoscaling for an Application

Use the DELETE /v1/dp/apps/{appId}/autoscaling API to delete autoscaling configuration for an application from the data plane.

To delete an app, you need the following parameters:

  • App Id: The application Id. This can be retrieved using the GET /v1/dp/apps method.

  • Namespace: The namespace where the application is deployed.

METHOD Path Parameters
DELETE

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

API for Enabling or Disabling Service Mesh for an Application

Use the PUT /v1/dp/apps/{appId}/servicemesh API to enable or disable service mesh sidecar of a specified App Id.

To enable or disable service mesh for an app, you need the following parameters:

  • App Id: The application Id. This can be retrieved using the GET /v1/dp/apps method.

  • Namespace: The namespace where the application is deployed.

  • Enable: You can enable or disable service mesh using the True or False options.

METHOD Path Parameters
PUT

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

  • Parameters: enable (required)

  • Type: Boolean

API for Enabling or Disabling Execution History for an Application

Use the PUT /v1/dp/apps/{appId}/exechist API to enable or disable execution history of a specified App Id.

To enable or disable execution history for an app, you need the following parameters:

  • App Id: The application Id. This can be retrieved using the GET /v1/dp/apps method.

  • Namespace: The namespace where the application is deployed.

  • Enable: You can enable or disable service mesh using the True or False options.

METHOD Path Parameters
PUT

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

  • Parameters: enable (required)

  • Type: Boolean