Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

...

The JS7 - Deployment Packaging makes use of the Deployment Descriptor to install and to package JS7 componentsproducts.

Deployment Descriptor

Deployment Descriptors are specified from .json files.

  • Users are strongly encouraged to validate their .json files against the Deployment Descriptor Schema: , see JS7 _- Deployment _Descriptor_v1.0.jsonDescriptor JSON Schema.
  • The basic structure includes to specify an array of Agent objects.

...

Status
colourYellow
titleTODO

Examples

Agents using HTTP Connections

...

  • Host centostest-primary and centostest-secondary each operate an Agent.
  • The Controller to which the Agents are registered is using the testsuite Controller controller Controller ID.
  • Agents make use of HTTP connections.

Download example: standalone-agent-http-2022-12-04.descriptor.json


Code Block
titleExample for Deployment Descriptor
linenumberstrue
collapsetrue
{
    "descriptor": {
        "descriptorId": "standalone-agent-http-2022-12-04",
        "title": "Install or update AgentsAgent Standalone instance using HTTP connections",
        "account": "sos",
        "scheduled": "2022-12-02T0602T05:19:12.000+0100:00",
        "created": "2022-11-30T2330T22:19:12.000+0100:00"
    },
    "agents": [{
        {"controllerRefs": [
            "agent_001{
                "controllerId": {"controller",
                "targetmembers": {[
                    "connection": {
                        "hostagentId": "centostest-primaryagent_001",
                        "porttarget": 22{
                    },
           "connection": {
         "authentication": {
                        "methodhost": "publickeycentostest-primary",
                        "user": "sos",        "port": 22
                        "keyFile": "/home/sos/.ssh/sos_rsa"    },
                    },
        "authentication": {
           "packageLocation": "/tmp",
                    "execPremethod": "StopServicepublickey",
                         "execPost       "user": "StartServicesos",
                     "makeService           "keyFile": true
"/home/sos/.ssh/sos_rsa"
                            },
                    "media        "packageLocation": {
"/tmp",
                            "releaseexecPre": "2.5.0StopService",
                    "tarball        "execPost": "/mnt/releases/scheduler_setups/2.5.0/js7_agent_unix.2.5.0.tar.gz"
 StartService",
               },
                "installationmakeService": {true
                    "home": "/opt/sos-berlin.com/js7/agent-primary",
       },
             "data": "/var/sos-berlin.com/js7/agent-primary",
                    "httpPortmedia": "31445"{
                }
            }"release": "2.5.3",
        },
        {
            "agent_002tarball": {
 "2.5.3/js7_agent_unix.2.5.3.tar.gz"
                    "target": {
    },
                        "connectioninstallation": {
                            "hosthome": "centostest-secondary/opt/sos-berlin.com/js7/agent-primary",
                        "port": 22
          "data": "/var/sos-berlin.com/js7/agent-primary",
          },
                    "authenticationhttpPort": {"31445",
                            "methodjavaHome": "publickey/opt/java/jdk8u202-b08",
                            "userjavaOptions": "sos",-Xmx125m -Djava.security.egd=file:///dev/urandom"
                        "keyFile": "/home/sos/.ssh/sos_rsa"
 }
                    },
                     "packageLocation": "/tmp",
{
                        "execPreagentId": "StopServiceagent_002",
                        "execPosttarget": "StartService",
{
                            "makeServiceconnection": true{
                   },
                "media     "host": {"centostest-secondary",
                    "release": "2.5.0",
            "port": 22
           "tarball": "/mnt/releases/scheduler_setups/2.5.0/js7_agent_unix.2.5.0.tar.gz"
                },
                 "installation": {
          "authentication": {
         "home": "/opt/sos-berlin.com/js7/agent-secondary",
                       "datamethod": "/var/sos-berlin.com/js7/agent-secondarypublickey",
                    "httpPort": "32445"
            "user": "sos",
     }
            }
        }
    ],
   "keyFile": "controllers": [],
/home/sos/.ssh/sos_rsa"
                            },
           "joc": []
}

Agents using HTTPS Connections

The Deployment Descriptor specifies two Agents to be installed on two hosts:

  • Host centostest-primary and centostest-secondary each operate an Agent.
  • The Controller to which the Agents are registered is using the testsuite Controller ID.
  • Agents use HTTPS connections and are equipped with certificates.

Download example: agent-https-2022-12-04.json

                 "packageLocation": "/tmp",
                            "execPre": "StopService",
                            "execPost": "StartService",
                            "makeService": true
                        },
                        "media": {
                            "release": "2.5.3",
                            "tarball": "2.5.3/js7_agent_unix.2.5.3.tar.gz"
                        },
                        "installation": {
                            "home": "/opt/sos-berlin.com/js7/agent-secondary",
                            "data": "/var/sos-berlin.com/js7/agent-secondary",
                            "httpPort": "32445",
                            "javaHome": "/opt/java/jdk8u202-b08",
                            "javaOptions": "-Xmx125m -Djava.security.egd=file:///dev/urandom"
                        }
                    }
                ]
            }
        ]
    },
    "version": "1.5.3"
} 

Agents using HTTPS Connections

The Deployment Descriptor specifies two Agents to be installed on two hosts:

  • Host centostest-primary and centostest-secondary each operate an Agent.
  • The Controller to which the Agents are registered is using the testsuite Controller ID.
  • Agents use HTTPS connections and are equipped with certificates.

Download example: standalone-agent-https-2022-12-04.descriptor.json


Code Block
titleExample for Deployment Descriptor
linenumberstrue
collapsetrue
{
    "descriptor": {
        "descriptorId": "standalone-agent-https-2022-12-04",
        "title": "Install or update Agent Standalone instance using HTTPS connections",
        "account": "sos",
        "scheduled": "2022-12-02T05:19:12.000+00:00",
        "created": "2022-11-30T22:19:12.000+00:00"
    },
    "certificates": {
        "controller": {
            "primaryControllerCert": "controllers/instances/controller.standalone/config/private/centostest-primary.crt"
        }
    },
    "agents": {
        "controllerRefs": [
            {
                "controllerId": "controller",
                "members": [
                    {
                        "agentId": "agent_001",
                        "target": {
                            "connection": {
                                "host": "centostest-primary",
                                "port": 22
                            },
                            "authentication": {
                                "method": "publickey",
                                "user": "sos",
                                "keyFile": "/home/sos/.ssh/sos_rsa"
                            },
                            "packageLocation": "/tmp",
                            "execPre": "StopService",
                            "execPost": "StartService",
                  
Code Block
titleExample for Deployment Descriptor
linenumberstrue
collapsetrue
{
    "descriptor": {
          "descriptorIdmakeService": "agent-https-2022-12-04",
 true
                        },
                 "title": "Install or update Agents using HTTPS connections","media": {
        "account": "sos",
           "scheduled": "2022-12-02T06:19:12+01:00",
        "createdrelease": "2022-11-30T23:19:12+01:00"
    },
2.5.3",
      "certificates": {
        "controller": {
            "primaryControllerCerttarball": "controllers/instances/testsuite.primary/config/private/centostest-primary.crt",
2.5.3/js7_agent_unix.2.5.3.tar.gz"
                        },
                "secondaryControllerCert        "installation": "controllers/instances/testsuite.secondary/config/private/centostest-secondary.crt"
{
         }
    },
    "agents": [
        {
  "home": "/opt/sos-berlin.com/js7/agent-primary",
         "agent_001": {
                   "targetdata": {"/var/sos-berlin.com/js7/agent-primary",
                    "connection        "httpPort": {
"localhost:31445",
                            "hosthttpsPort": "centostest-primary.sos:31443",
                        "port": 22
          "javaHome": "/opt/java/jdk8u202-b08",
          },
                    "authenticationjavaOptions": {"-Xmx125m -Djava.security.egd=file:///dev/urandom"
                        "method": "publickey"},
                        "userconfiguration": "sos",{
                            "keyFilecertificates": "/home/sos/.ssh/sos_rsa"
       {
             },
                    "packageLocationkeyStore": "/tmpagents/instances/agent_001/config/private/https-keystore.p12",
                    "execPre": "StopService",
                    "execPostkeyStorePassword": "StartServicejobscheduler",
                    "makeService": true
                 },
     "keyPassword": "jobscheduler",
          "media": {
                      "releasekeyAlias": "2.5.0centostest-primary",
                                "tarballtrustStore": "agents/mntinstances/releases/scheduler_setups/2.5.0/js7_agent_unix.2.5.0.tar.gz"agent_001/config/private/https-truststore.p12",
                },
                "installationtrustStorePassword": {
      "jobscheduler"
               "home": "/opt/sos-berlin.com/js7/agent-primary",
             },
       "data": "/var/sos-berlin.com/js7/agent-primary",
                    "httpPorttemplates": "localhost:31443",
[
                     "httpsPort": "centostest-primary:31443"
           "agents/templates/https/config"
        },
                 "configuration": {
  ]
                  "controller": {
     }
                   "controllerId": "testsuite" },
                    },{
                        "certificatesagentId": {
 "agent_002",
                       "keyStore": "agents/instances/agent_001/config/private/https-keystore.p12", "target": {
                            "keyStorePasswordconnection": "jobscheduler",
{
                                "keyPasswordhost": "jobschedulercentostest-secondary",
                                "trustStoreport": "agents/instances/agent_001/config/private/https-truststore.p12",
 22
                            },
        "trustStorePassword": "jobscheduler"
                    },"authentication": {
                    "templates": [
           "method": "publickey",
             "agents/templates/https/config"
                    ]
 "user": "sos",
               }
            }
        },"keyFile": "/home/sos/.ssh/sos_rsa"
        {
            "agent_002": {
        },
        "target": {
                    "connectionpackageLocation": {
"/tmp",
                            "hostexecPre": "centostest-secondaryStopService",
                            "portexecPost": 22
"StartService",
                           }, "makeService": true
                    "authentication": {    },
                        "methodmedia": "publickey",{
                            "userrelease": "sos2.5.3",
                            "keyFiletarball": "/home/sos/.ssh/sos_rsa"
2.5.3/js7_agent_unix.2.5.3.tar.gz"
                        },
                        "packagelocation": "/tmp",
installation": {
                            "execPrehome": "StopService/opt/sos-berlin.com/js7/agent-secondary",
                    "execPost        "data": "StartService/var/sos-berlin.com/js7/agent-secondary",
                    "makeService": true
                 }"httpPort": "localhost:32445",
                "media": {
           "httpsPort": "centostest-secondary.sos:32443",
        "release": "2.5.0",
                    "tarballjavaHome": "/mntopt/releases/scheduler_setups/2.5.0/js7_agent_unix.2.5.0.tar.gz"java/jdk8u202-b08",
                },
                "installationjavaOptions": {
 "-Xmx125m -Djava.security.egd=file:///dev/urandom"
                     "home": "/opt/sos-berlin.com/js7/agent-secondary"   },
                        "dataconfiguration": "/var/sos-berlin.com/js7/agent-secondary",
 {
                            "httpPortcertificates": "localhost:32443",{
                    "httpsPort": "centostest-secondary:32443"
           "keyStore": "agents/instances/agent_002/config/private/https-keystore.p12",
    },
                "configuration": {
            "keyStorePassword": "jobscheduler",
       "controller": {
                        "controllerIdkeyPassword": "testsuitejobscheduler",
                    },
            "keyAlias": "centostest-secondary",
       "certificates": {
                        "keyStoretrustStore": "agents/instances/agent_002/config/private/https-keystoretruststore.p12",
                                "keyStorePasswordtrustStorePassword": "jobscheduler",
                        "keyPassword": "jobscheduler",
   },
                     "trustStore": "agents/instances/agent_002/config/private/https-truststore.p12",
       "templates": [
                  "trustStorePassword": "jobscheduler"
             "agents/templates/https/config"
       },
                    "templates": []
                        "agents/templates/https/config"}
                    ]}
                }]
            }
        }]
    ]},
    "controllersversion": [],
    "joc": []1.5.3"
}  

Resources

...