...
In the JS7 - Deployment process a Deployment Descriptor specifies
- which JS7 components products of JOC Cockpit, Controller instances and Agents should be installed,
- where to install each JS7 componentproduct,
- which installation options to use, for example the installation directory,
- which configuration options to use, for example port usage.
...
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. Any relative paths specified are prepended the config directory of the Deployment Area. licenseKeyFile : string, requiredlicenseBinFile : string, required- Path to the Java .jar file that holds binary code for clustering of JS7 componentsproducts.
|
Expand |
---|
|
agents: optionalAn array of Agent configuration objects is specified. controllerRefs[] : object, required- Agents are dedicated to a Controller. The element specifies a reference to a Controller.
controllerId : object, required- The unique identifier of the Controller to which Agents are dedicated.
members[] : object, required- The list of Agents that should be used with the given Controller.
agentId : 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.controllerRefs[].members[].target: optionaltarget : object, optionalconnection : object, requiredhost : string, required- The hostname/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, requiredkeyFile : string, optional- The path to the private key file of the user account connecting to the target host, for example
/home/sos/.ssh/id_rsa .
forceSudo : boolean, optionalpackagingLocation : string, required- The path to a directory on the target host to which the deployment tarballs will be stored during rollout.
execPre : string, optional- Holds a command that will be executed on the target host before extraction of deployment tarballs has been 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. Users are free to specify commands at their will.
execPost : string, optional
- Holds a command that will be executed on the target host after extraction of deployment tarballs has been 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. Users are free to specify commands at their will.
makeService : boolean, optional- Specifies that a systemd service should be created or renewed for JS7 components products such as the Agent. This includes that a service file will be created and will be stored to the relevant systemd service file directory. In addition, the service will be enabled for automated start-up and shutdown of the JS7 componentproduct.
serviceName : string, optional- Specifies the name of the systemd service and its corresponding service file that will be created if the
makeService setting is active. - The Agent's systemd service file is created in the Agent's
<home>/bin directory with the file name agent_<http-port>.service . By default the file will be copied to the systemd's /usr/lib/systemd/system directory with the file name js7_agent_<http-port>.service which results in the corresponding systemd service name. Users who wish to use a different service name can use this setting. If the indicated service name does not include the .service extension then it will be added.
serviceDir : string, optional- Specifies the location of the systemd directory for service files. By default the
/usr/lib/systemd/system directory will be used. An alternative location is the /etc/systemd/system directory. Users are free to specify the systemd directory that is in place on the target host.
|
...