Pulling the Agent Image

...

docker image pull sosberlin/js7:agent-2-0-0-SNAPSHOT

Alternatively, "plus" images are available that 'plus' images which include a recent PowerShell environment and the the JS7 - PowerShell Module are available, for example:

docker image pull sosberlin/js7:agent-2-05-0-SNAPSHOT-plus

Running the Agent Container

After pulling the Agent image you can run the container with a number of options like this:

#!/bin/sh

docker run -dit --rm \
      --user="$(id -u $USER):$(id -g $USER)" \
      --hostname=js7-agent-primary \
      --network=js7 \
      --publish=16445:4445 \
      --env="RUN_JS_JAVA_OPTIONS=-Xmx256m" \
      --mount="type=volume,src=js7-agent-primary-var,dst=/var/sos-berlin.com/js7/agent/var_4445" \
      --name js7-agent-primary \
      sosberlin/js7:agent-2-0-0-SNAPSHOT

Explanation:

...

• config: The configuration folder allows specification of individual settings for Agent operation, see the chapters below and the JS7 - Agent Configuration Items article. Default settings are available on initial operation.
• logs: In order to have Agent log files persisted they have to be written to a volume that is mounted for the container. Feel free to adjust the volume name from the src attribute, however, the value of the dst attribute should not be changed as it reflects the directory hierarchy inside the container.
• state: The Agent requires a directory for journal information that should be persisted. The journal is required to restore the state of orders when restarting the Agent.

...

# example to map volumes to directories on the Docker host prior to running the Agent container
mkdir -p /home/sos/js7/js7-agent-primary/var
docker volume create --driver local --opt o=bind --opt type=none --opt device="/home/sos/js7/js7-agent-primary/var" js7-agent-primary-var

...

Note: A current release should be applied as available from https://hub.docker.com/r/sosberlin/js7

Running the Agent Container from a

...

'plus

...

' Image

Image names suffixed with "plus" include a recent PowerShell environment and the JS7 - PowerShell Module. This fact increases the image size and not all users might feel the need to use PowerShell. At the same time the JS7 PowerShell Module allows simplified use of the JS7 - REST Web Service API.

PowerShell Profile

By default the "'plus" ' Agent image creates the following PowerShell profile inside the container with the path /home/jobscheduler/.config/powershell/Microsoft.PowerShell_profile.ps1:

...

• Readline options specify colors used for better visibility of the prompt when directly invoking PowerShell inside a container.
• A profile assumed inside the Agent's config directory is executed if applicable.

Running PowerShell Commands inside the Container

To try out a "'plus" ' Agent container you can use the following sequence of commands:

# From the Docker host invoke a PowerShell session within the Agent container
docker exec -ti js7-agent-primary pwsh

# Receive a PowerShell prompt like this
#   PowerShell 7.1.3
#   Copyright (c) Microsoft Corporation.
#   https://aka.ms/powershell
#   Type 'help' to get help.
#   PS />

# Load the JS7 PowerShell module
PS />Import-Module JS7

# Connect to the JOC Cockpit container specifying account ("root") and password ("root") with the JOC Cockpit URL like this:
PS />Connect-JS7 -Url http://root:root@js7-joc-primary:4446 -Id jobscheduler

# An alternative way is to create a credential object like this
#   PS />$credentials = ( New-Object -typename System.Management.Automation.PSCredential -ArgumentList "root", ( "root" | ConvertTo-SecureString -AsPlainText -Force) )
#   PS />Connect-JS7 -Url http://js7-joc-primary:4446 -Id jobscheduler -Credentials $credentials

# The recommended way is to login to the JOC Cockpit REST API by use of a certificate should JOC Cockpit be configured for HTTPS and certificate based authentication
#   PS />$credentials = ( New-Object -typename System.Management.Automation.PSCredential -ArgumentList "certs", ( "jobscheduler" | ConvertTo-SecureString -AsPlainText -Force) )
#   PS />Connect-JS7 -Url https://js7-joc-primary:4443 -id jobscheduler -KeyStorePath /var/sos-berlin.com/js7/agent/var_4445/config/private/https-keystore.p12 -KeyStoreCredentials $credentials -RootCertificatePath /var/sos-berlin.com/js7/agent/var_4445/config/private/https-truststore.p12 -RootCertificateCredentials $credentials

# Display Controller status
PS />Get-JS7ControllerStatus -display

# The command should return the following output:
#   ________________________________________________________________________
#   ....... Controller ID: jobscheduler
#   ............. version: 2.05.0-alpha.20210511
#   ................. URL: http://controller-2-02-primary:44464444
#   ................ role: PRIMARY
#   ............... title: PRIMARY CONTROLLER
#   ....... running since: 04/3020/20212022 15:00:34
#   ...... security level: MEDIUM
#   ..... cluster coupled: True
#   .. cluster node state: active
#   .... component status: operational
#   ... connection status: established
#   ________________________________________________________________________

Running PowerShell Jobs

To execute PowerShell code from a job running inside a "'plus" ' Agent container you can use the following a sequence of commands for the job script such as:

pwsh -NoLogo -NonInteractive -Command '& {
    Import-Module JS7
    Connect-JS7 -Url http://root:root@js7-joc-primary:4446 -Id jobscheduler

    Get-JS7ControllerStatus -display
}'

Further Resources

Configure the Agent

Note that it is not necessary to configure the Agent - it runs out-of-the-box. The default configuration specifies that

• deployment of objects, e.g. workflows and jobs, is not subject to compliance requirements such as non-repudiation.
• HTTP connections are used that expose unencrypted communication between Controller instances and Agent. Authentication is performed by hashed passwords.

Users who intend to operate a compliant and secure job scheduling environment are suggested the JS7 - Agent Configuration for Docker Containers article series.

Build the Agent Image

...