Managing Apps with Helm Chart

This section describes all the APIs to manage the app by using Helm Charts for the TIBCO BusinessWorks Container Edition Capability.

API for generating yaml from an App Build

Use the GET /v2/dp/builds/{buildId}/values API to generate values.yaml from an app build for the provided Build Id.

To generate the yaml file, you need the Build Id parameter

Build Id: The applications Build Id. This can be retrieved using the GET /v2/dp/builds method.

METHOD Path Parameters
GET

  • Parameters: buildId (required)

  • Type: String

API for Deploying an Application Helm Chart using yaml file

Use the POST /v2/dp/deploy/release API to deploy or upgrade a TIBCO BusinessWorks Container Edition application Helm chart using the values.yaml file. An AppId inside values.yaml is mandatory for upgrading an existing application.

To deploy the app, you need the following parameters:

  • Namespace: The namespace where the application is deployed.

  • Chart Name: (Optional) The TIBCO BusinessWorks Container Edition application Helm Chart name.

  • Chart Version: (Optional) The TIBCO BusinessWorks Container Edition application Helm Chart version.

  • EULA: The End User License Agreement for the TIBCO BusinessWorks Container Edition application.

METHOD Path Parameters
POST

  • Parameters: namespace

  • Type: String

  • Parameters: chartName

  • Type: String

  • Parameters: chartVersion

  • Type: String

  • Parameters: eula

  • Type: Boolean

API for Viewing Helm Chart Values

Use the GET /v2/dp/apps/{appId}/release/values API to return a list of helm chart values from the TIBCO BusinessWorks Container Edition app deployment.

To view the helm chart values, 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.

  • All values: All the required computed values. By default, it is false.

METHOD Path Parameters
GET

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

  • Parameters: allValues

  • Type: Boolean

API for Updating Helm Chart values

Use the PUT /v2/dp/apps/{appId}/release/values API to update the Helm chart values for the TIBCO BusinessWorks Container Edition application chart. The values can be provided in the values.yaml payload.

To update the helm chart values, 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. Namespace is required when the application is not deployed in the default namespace.

METHOD Path Parameters
PUT

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

API for Viewing status of an Application Chart Deployment Chart Values

Use the GET /v2/dp/apps/{appId}/release/status API to return a list of the status of an application deployed for an app Id.

To view the status of an application chart, 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
GET

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

API for Rollback an Application Helm chart Release

Use the PUT /v2/dp/apps/{appId}/release/rollback API to rollback an application Helm chart release for a App Id with a specified version

To view the status of an application chart, 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.

  • Revision:

  • Force:

METHOD Path Parameters
GET

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

  • Parameters: revision

  • Type: Integer

  • Parameters: force

  • Type: Boolean

API for Renaming an Application chart Deployment

Use the PUT /v2/dp/apps/{appId}/rename API to rename an application deployment.

Warning: This uninstalls the existing release and reinstalls it with a new name. This may cause service outage for clients.

To view the status of an application chart, you need the following parameters:

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

  • App Name: The new application name.

  • Namespace: The namespace where the application is deployed.

  • Revision:

  • Force:

METHOD Path Parameters
GET

  • Parameters: appId (required)

  • Type: String

  • Parameters: appName (required)

  • Type: String

  • Parameters: namespace

  • Type: String

  • Parameters: revision

  • Type: Integer

  • Parameters: force

  • Type: Boolean

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

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 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