Introduction
In the JS7 - Deployment process a Deployment Descriptor specifies
- which JS7 components of JOC Cockpit, Controller instances and Agents should be installed,
- where to install each JS7 component,
- which installation options to use, for example the installation directory,
- which configuration options to use, for example port usage.
Deployment Descriptors are specified from files in JSON format and include instructions, for example to deploy a larger number of Agents on target machines.
The JS7 - Deployment Packaging Script makes use of the Deployment Descriptor to install and to package JS7 components.
Deployment Descriptor
Deployment Descriptors are specified from .json files.
- Users are strongly encouraged to validate their .json files against the Deployment Descriptor Schema: JS7_Deployment_Descriptor_v1.0.json
- A number of JSON validators are available online and for use with the command line, for example see http://json-schema.org/implementations.html
- The basic structure includes to specify an array of Agent, Controller and JOC Cockpit objects.
- A Deployment Descriptor can include Agents, Controllers and JOC Cockpit instances individually or as a combination.
Example for an Agent Deployment Descriptor:
Example for Deployment Descriptor
{ "descriptor": { "descriptorId": "agent-http-2022-12-04", "title": "Install or update Agent for HTTP connections", "account": "sos", "scheduled": "2022-12-02T06:19:12+01:00", "created": "2022-11-30T23:19:12+01:00" }, "agents": [ { "agent_001": { "target": { "connection": { "host": "centostest-primary", "port": 22 }, "authentication": { "method": "publickey", "user": "sos", "keyFile": "/home/sos/.ssh/sos_rsa" }, "packageLocation": "/tmp", "execPre": "sudo systemctl stop js7_agent.service", "execPost": "sudo systemctl start js7_agent.service" }, "media": { "release": "2.5.0", "tarball": "/mnt/releases/scheduler_setups/2.5.0/js7_agent_unix.2.5.0.tar.gz" }, "installation": { "home": "/opt/sos-berlin.com/js7/agent-primary", "data": "/var/sos-berlin.com/js7/agent-primary", "httpPort": "31445" } } }, ], "controllers": [], "joc": [] }
Explanation:
- Section
descriptor
- This section includes metadata about the Deployment Descriptor.
- Section
agents[]
- This section can hold any number of Agents that should be deployed.
- Section
agents[].<agent-id>
- This section specifies the Agent ID that will be used when registering the Agent to a Controller with JOC Cockpit. The Agent ID can be specified from mixed lowercase and uppercase letters including - minus and _ underscore characters.
- Section
agents[].<agent-id>.
target
- The information in this section is used to connect to the target host and to transfer the Deployment Package that holds the Agent installation..
- The Agent Deployment Package will be deployed to host
centostest-primary
using SSH with thesos
account and a private key file for authentication. The Deployment Package will be stored to the/tmp
directory. - Before extraction of the Deployment Package the Agent will be stopped and after extraction it will be started using JS7 - systemd Service Files for automated Startup and Shutdown with Unix Systems
- Section
agents[].<agent-id>.
media
- The Agent will be installed or updated to release
2.5.0
using a copy of the tarball as offered from the JS7 - Download page that is made available from a mount point.
- The Agent will be installed or updated to release
- Section
agents[].<agent-id>.installation
- The Agent's
- installation directory is
/opt/sos-berlin.com/js7/agent-primary
. - configuration directory is
/var/sos-berlin.com/js7/agent-primary
.
- installation directory is
- The Agent will make use of HTTP connections and will listen to port
31445
.
- The Agent's
- Section
controllers[]
- This section is empty if no Controller should be deployed.
- Section
joc[]
- This section is empty if no JOC Cockpit should be deployed.
Resources
Links
Pages
Navigation
Overview
Content Tools