Helix Cloud Integration - helixml/apps-client

The @helixml/apps-client is a TypeScript client library for interacting with the Helix Cloud platform. Helix Cloud provides a variety of services, including serverless workflow execution, secret management, and monitoring. The @helixml/apps-client library allows developers to easily access these services in their applications.

Here are some of the services available on Helix Cloud that the @helixml/apps-client library interacts with:

1. Serverless Workflow Execution: Helix Cloud allows developers to execute serverless workflows using tools like Kogito. The @helixml/apps-client library provides functions for deploying and managing these workflows on the Helix Cloud platform.

Example:

import { AppsClient } from '@helixml/apps-client';

const client = new AppsClient({
// configuration options here
});

const workflowId = 'my-workflow';
const inputData = { /* workflow input data */ };

client.startWorkflow(workflowId, inputData);

Source: Build a Kogito Serverless Workflow using Serverless Framework | Red Hat Developer

2. Secret Management: Helix Cloud provides a secret management service that allows developers to securely store and retrieve sensitive information. The @helixml/apps-client library provides functions for interacting with this service.

Example:

import { AppsClient } from '@helixml/apps-client';

const client = new AppsClient({
// configuration options here
});

const secretName = 'my-secret';

client.getSecret(secretName)
.then(secretValue => {
// use secretValue here
})
.catch(error => {
// handle error here
});

Source: Azure secrets engine | Vault | HashiCorp Developer

3. Monitoring: Helix Cloud provides monitoring services that allow developers to track key metrics and visitor demographics. The @helixml/apps-client library provides functions for interacting with these services.

Example:

import { AppsClient } from '@helixml/apps-client';

const client = new AppsClient({
// configuration options here
});

const metricName = 'my-metric';

client.recordMetric(metricName, 42)
.then(() => {
// metric recorded
})
.catch(error => {
// handle error here
});

Source: Monitor key metrics and visitor demographics in NGINX with the new Grafana Cloud integration | Grafana Labs

For more information on the @helixml/apps-client library and Helix Cloud, please refer to the official documentation.

Example:

import { AppsClient } from '@helixml/apps-client';

const client = new AppsClient({
// configuration options here
});

// use client functions here

Source: Adding an application | PipeCD