Skip to content
PDF

Provisioning a CODESYS workload

Before a CODESYS workload can be provisioned, a CODESYS application has to be loaded into the CODESYS runtime first. Refer to First steps with CODESYS first before continuing.

Once a CODESYS application has been loaded into the CODESYS runtime, the following steps have to be taken before the workload can be provisioned:

  1. Creating the ZIP file of the CODESYS application
  2. Transferring the ZIP file to a local workstation

Also the workstation needs to be connected to the physical port of the Nerve Device associated with host access, and the network adapter IP address of the workstation needs to be configured in the correct range. This information is device specific. Refer to the device guide for information on the Nerve Device.

Creating the ZIP file on the Nerve Device

First, the CODESYS project needs to be zipped on the Nerve Device before it can be copied from the CODESYS runtime. This is done through the Local UI.

  1. Follow the link to the Local UI of the used Nerve Device. Refer to the device guide for more information.
  2. Select Workload management in the navigation on the left.

  3. Click Download CODESYS app archive.

    !Download CODESYS Archive

  4. Select YES in the pop-up. Note that the CODESYS application will be stopped.

The ZIP file is automatically downloaded to the workstation and a CODESYS workload can now be provisioned in the Management System.

Provisioning a CODESYS workload

The following instructions cover the basic requirements for provisioning a CODESYS workload. Optional settings will be left out. Extended options are addressed in the last section of this chapter.
There are two further types of workloads that can be provisioned: Virtual Machine workloads and Docker workloads. The process for each workload is highlighted in its respective chapter.

  1. Log in to the Management System.
  2. Select Workloads in the left-hand menu.
  3. Select the plus symbol in the upper-right corner.

  4. Select the CODESYS symbol (CODESYS workload) on the left of the three symbols that expanded.

    !CODESYS Workload

  5. In the new window, enter a name for the workload.

  6. Select the plus symbol next to Create versions to add a new version of the workload.

    !New Version

  7. In the new window, enter the following information:

    Setting Description
    Version name Enter a name for the version of this workload.
    Release name Enter a Release name for the version of this workload.
    CODESYS project file Click the upward arrow symbol to add the CODESYS application ZIP file.
    This is the ZIP file that was created above.

    !Version Settings

  8. Click Save.

The workload has now been provisioned and is ready to be deployed in the Deploy menu.

Settings for CODESYS workloads

In the instructions above, optional settings have been left out. Below is an overview of all options with an explanation to each option.

Basic tab

Category Settings and descriptions
VERSION SPECIFIC INFO Version name
A name for the workload version. Choose a precise name to make the workload version unambiguous.

SELECTOR
If labels have been defined and assigned to nodes, add them as selectors to the workload. When deploying a workload, the list of nodes will be filtered automatically to the specified label. Select the Insert label field to see a list of available labels.

Release name
A release name for the workload version. This could be a version number or any string. Example: 1.0.1

Mark as released
Tick this checkbox to mark this workload as released. Once marked as released, the workload cannot be edited anymore.
CODESYS FILES TO UPLOAD Upload the CODESYS project file here. This is a ZIP file that has to be generated from a CODESYS project running in the CODESYS runtime. Upload it here by selecting the upward arrow symbol to open the file browser.

Remote connections tab

Category Settings and descriptions
REMOTE CONNECTIONS Select the Remote connections tab to configure a remote connection to the workload. Note that CODESYS workloads can only be reached with remote tunnels. Refer to Remote connections for more information and instructions for all remote connection types.