...
Deployment Descriptor Schema
...
Download
Download: JS7_Deployment_Descriptor_v1.0.json
Schema Sections
The JSON Schema is made up of a number of sections.
Expand |
---|
|
descriptor: requireddescriptorId : string, required- The unique identifier of a Deployment Descriptor
title : string, optional- Explains the purpose of the descriptor
account : string, optional- JOC Cockpit user account who created the descriptor
scheduled : date-time, optionalcreated : date-time, optional- Export date of the descriptor
|
Expand |
---|
|
license: optionalThis section is required if the Controller and/or JOC Cockpit are operated as a Cluster that is subject to the JS7 - License licenseKeyFile : string, requiredlicenseBinFile : string, required- Path to the Java .jar file that holds binary code for clustering for JS7 components
|
Expand |
---|
|
certificates: optionalThis section is required if the Controller and/or JOC Cockpit are operated for HTTPS connections using TLS/SSL certificates. controller : object, optionalprimaryControllerCert : string, required- Path to the certificate file (.crt, .pem) that holds the Primary Controller instance's base64 encoded certificate.
secondaryControllerCert : string, required- Path to the certificate file (.crt, .pem) that holds the Secondary Controller instance's base64 encoded certificate.
joc : object, optionalprimaryJocCert : string, required- Path to the certificate file (.crt, .pem) that holds the Primary JOC Cockpit instance's base64 encoded certificate.
secondaryJocCert : string, required- Path to the certificate file (.crt, .pem) that holds the Secondary JOC Cockpit instance's base64 encoded certificate.
|
Expand |
---|
|
agents: optionalAn array of Agent configuration objects is specified. <agent-id> : object, required- The unique identifier of an Agent is specified. The identifier is used when the Agent is registered with a Controller.
- Any number of Agent configurations using unique Agent IDs can be specified.
|
Expand |
---|
title | agents.<agent-id>.target |
---|
|
agents.<agent-id>.targettarget : object, optionalconnection : object, requiredhost : string, required- The hostname or FQDN to which the Agent should be deployed.
port : number, optional- The port number used for SSH connections, default: 22
authentication method : string, required- Supported authentication methods include public/private key. The value
publickey has to be specified.
user : string, required- The user account for SSH connection sto the target host.
keyFile : string, optional- The path to the private key file of the user account, for example
/home/sos/.ssh/id_rsa .
packagingLocation : string, required- The path to a directory on the target host to which the deployment tarballs will be stored after transfer.
execPre : string, optional- Holds a command that will be executed on the target host before extraction of deployment tarballs is performed.
- Deployment scripts provide shell functions to start and to stop the systemd service for the Agent.
- Specifying the command
StopService will stop the Agent's systemd service.
execPost : string, optional
- Holds a command that will be executed on the target host after extraction of deployment tarballs is performed.
- Deployment scripts provide shell functions to start and to stop the systemd service for the Agent.
- Specifying the command
StartService will start the Agent's systemd service.
makeService : boolean, optional- Specifies that a systemd service should be created or renewed for the Agent.
|
Expand |
---|
|
media : object, requiredrelease : object, required- The JS7 release number, for example 2.5.0
tarball : string, required- Path to the .tar.gz installation file as downloaded from the SOS Web Site.
|
Expand |
---|
|
agents.<agent-id>.installation: requiredinstallation : object, requiredhome : object, required- Path to the directory to which the Agent should be installed, for example
/opt/sos-berlin.com/js7/agent .
data : string, required- Path to the Agent's configuration directory, for example
/var/sos-berlin.com/js7/agent .
homeOwner : string, optional- The OS account that owns the Agent's installation directory.
dataOwner : string, optional- The OS account that owns the Agent's configuration directory.
runUser : string, optional- The OS account that runs the Agent daemon/service.
httpPort : number, conditional- The HTTP port that is used to control the Agent in the localhost network by its Instance Start Script.
- Use of the port can be limited by specifying
<network-interface>:<port> , for example: localhost:4445 . - One of HTTP Port and/or HTTPS Port has to be specified.
httpsPort : number, conditional- The HTTP port that is used to control the Agent in the localhost network by its Instance Start Script.
- Use of the port can be limited by specifying
<network-interface>:<port> , for example: jobs.example.com:4445 . - One of HTTP Port and/or HTTPS Port has to be specified.
javaHome : string, optional- Path to a Java JDK that is used to operate the Agent, see Which Java versions is JobScheduler available for?
- If this setting is omitted then the Agent will try to identify the location of Java from the
JAVA_HOME environment variable on the target host.
javaOptions : string, optional- Specifies the Java options used for the Agent, for example heap space settings as
-Xmx256m ., see JS7 - FAQ - Which Java Options are recommended. - If this setting is omitted then the Agent will try to identify Java options from the
JAVA_OPTIONS environment variable on the target host.
|
Expand |
---|
|
controllers: optionalAn array of Controller configuration objects is specified. <controller-id> : object, requiredtarget : see agents media : see agents installation : see agents configuration : see agents
|
Resources
...