...

{
    "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"
    },
   "version": "1.5.3",
   "agents": [{
    "controllerRefs": [
   {
    {
        "agent_001controllerId": {"controller",
        "members": [
        "target":  {
            "agentId": "agent_001",
            "connectiontarget": {
              "connection": {
                "host": "centostest-primary",
                        "port": 22
                    },
                    "authentication": {
                        "method": "publickey",
                        "user": "sos",
                        "keyFile": "/home/sos/.ssh/sos_rsa"
                    },
                    "packageLocation": "/tmp",
                    "execPre": "StopService",
                    "execPost": "StartService",
                    "makeService": true
                },
                "media": {
                    "release": "2.5.02",
                    "tarball": "2.5.02/js7_agent_unix.2.5.02.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.
  • The descriptorId specifies the unique identifier of the Deployment Descriptor and is determines the Deployment Package.
• Section agents[]
  •  This section can hold any number of Agents that should be deployed.
  •  Section agents.controllerRefs[].
  <agent
  • <controller-id>
    • This section specifies the
  Agent ID that
  • • list of Controllers to which related Agents are assigned. The Controller ID identifies the respective Controller.
  •  Section agents.controllerRefs[].members[]
    • This section specifies the related Agents that are identified by their respective Agent ID from the agentId property. The Agent ID 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.controllerRefs[].
  <agent-id>
  • • members[].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 the sos account and a private key file for authentication. The Deployment Package will be stored to the /tmp directory on the target host.
      • Before extraction of the Deployment Package the Agent's systemd service will be stopped and after extraction it will be started using JS7 - systemd Service Files for automated Startup and Shutdown with Unix Systems. The makeService property specifies that the systemd service will be created automatically.
    • Section agents.controllerRefs[].
  <agent-id>
  • • members[].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.
      • If a relative path is used - as in the example - then the path is prepended the js7.deploy.release directory.
      • If an absolute path is specified, for example a path to a mount point, the it will be used without changes.
    • Section agents.controllerRefs[].
  <agent-id>
  • • members[].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 use HTTP connections and will listen to port 31445
  .
• Section controllers[]
  • This section is empty should no Controller be deployed.
• Section joc[]This section is empty should no JOC Cockpit be deployed
  • • • .

Resources

Links

• JS7 - Deployment
• JS7 - Deployment Packaging

...