...

{
    "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
    • • Deployment Package will be deployed to
    the 
    • • host centostest-primary using SSH with the sos account
    with
    • • and a private key file for
    SSH
    • • authentication. The
    deployment package
    • • Deployment Package will be stored to the /tmp directory.
      • Before extraction of the
    deployment package
    • • Deployment Package the Agent will be stopped and after extraction it will be started
    using 
    • • 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.
    • 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.
      • The Agent will make use of HTTP connections and will listen to port 31445.
• 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

• JS7 - Deployment
• JS7 - Deployment Packaging Script

...