Skip to content

Deploy Workload

When you deploy a workload, you can choose whether to deploy immediately or to stage the workload at the edge and apply it at a later time.

Field Option Description
Standard None This will use the standard Kubernetes deployment process for workload containers and the workload will be automatically started after downloaded to the edge.
Staged Stage Only This will download the workload to the edge but will not start the workload. You will need to send an additional command to start the workload either through the Kelvin API or locally in the terminal of the edge computer
Staged Instant Apply This will use Kelvin's deployment process for workload containers and the workload will be automatically started after downloaded to the edge.

The difference to the Kubernetes deployment process is that Kelvin will download all workloads and stage them first. Only when all workloads have been successfully downloaded will the start command be given to all the workloads.

Default Settings

To simplify the deployment process, you can set default settings that will be automatically chosen when deploying.

Note

The default settings can overwritten during each deploy if special conditions are required.

When completing the deployment of a Workload there is an option to update the default settings with the current deploy selections.

Deploy Standard Workload

On this page we will show you how to deploy a standard workload.

There are different options available depending on the type of SmartApp that is being deployed.

To start, go to Applications, select a Kelvin SmartApp™ under the SmartApps group, click on the Workloads tab then click on the Deploy Workload button;

Select the Kelvin SmartApp™ App version, then click Next to go to Step 2.

In Step 2 select the Assets you want to add to the Kelvin SmartApp™ then click the Next button.

In Step 3 you have a range of options available.

Note

You will only be able to deploy your workload once all options have a green check .

Cluster

Choose a cluster to run your application on.

Parameters

Select the Parameter values that each Asset should start using for this Kelvin SmartApp™ when deployed.

Note

When there are many Assets or Asset Parameters to set, you can download a blank csv file with the headers preset with the parameter names.

You only need to add the Assets names and the parameter values you want to overwrite the default values for.

Any blank spaces will be automatically filled with the default Asset Parameter values.

Configuration

Add any configuration information that is required by the Kelvin SmartApp™.

Inputs/Outputs

Link the Asset's Data Streams to the Kelvin SmartApp™ input/output variables.

Note

Asset's Data Streams are declared as pairs in any Connection that is deployed.

Kelvin SmartApp™ input/output variables are defined by the Developers in the app.yaml file.

Deployment

Settings tab : Here you can add additional features for your Docker Container. Check out the full documentation on options in the Developer Tools section.

Type tab : Choose Standard option for a normal deploy managed by Kelvin.

Warning

If you use a Health check option, make sure you add code to respond to the liveness probe requests.

Health Check tab : Implement a health check service for your application. These are Kubernetes liveness probes and detailed information can be found on the Kubernetes Website.

Assets per Workload : Define how many Assets are controlled by each Workload that is deployed.

Success

Allowing each Workload to handle more Assets is more efficient in your edge hardware memory and runtime resource usage.

Be aware that when deploying a workload, checks are made on sufficient memory available and the deploy will fail if there is not enough memory.

However no runtime resource usage is calculated at deployment, so excessive asset allocation can impact SmartApp performance due to CPU and memory constraints.

When you are ready and you have a green check on all options, you will see the Deploy button turn blue.

You can then see the status of the Workload in the Workloads list going from Pending, Deploying to Running.

You can even deploy the app if the Cluster is offline. It will be placed in a queue with a status of Pending and will be automatically deployed when the Cluster comes back online.

To start, go to Applications, select an application under the Docker Apps group, click on the Workloads tab then click on the Deploy Workload button;

Select the Docker App version and give it a name. When ready click Next to go to Step 2.

Note

The ID will be filled in automatically when you type a name. Normally you can accept the default, though you have the option to create you own custom name ID.

In Step 2 you have a range of options available.

Note

You will only be able to deploy your workload once all options have a green check .

Cluster

Choose a cluster to run your application on.

Configuration

Add any configuration information that is required by the Docker App.

Deployment

Settings tab : Here you can add additional features for your Docker Container. Check out the full documentation on options in the Developer Tools section.

Type tab : Choose Standard option for a normal deploy managed by Kelvin.

Health Check tab : Implement a health check service for your application. These are Kubernetes liveness probes and detailed information can be found on the Kubernetes Website.

Warning

If you use a Health check option, make sure you add code to respond to the liveness probe requests.

When you are ready and all mandatory areas are filled in, you will see the Deploy button turn blue.

You can then see the status of the Workload in the Workloads list going from Pending, Deploying to Running.

You can even deploy the app if the Cluster is offline. It will be placed in a queue with a status of Pending and will be automatically deployed when the Cluster comes back online.