Introduction

In the JS7 - Deployment process a Deployment Descriptor specifies

  • which JS7 products of JOC Cockpit, Controller instances and Agents should be installed,
  • where to install each JS7 product,
  • 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 makes use of the Deployment Descriptor to install and to package JS7 products.

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 JSON Schema.
  • The basic structure includes to specify an array of JOC Cockpit objects.

Examples

Standalone JOC Cockpit using HTTP Connections

The Deployment Descriptor specifies a Standalone JOC Cockpit instance:

  • Host centostest-primary operates the JOC Cockpit instance.
  • JOC Cockpit makes use of HTTP connections.

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


Example for Deployment Descriptor
{
  "descriptor": {
    "descriptorId": "standalone-joc-http-2022-12-04",
    "title": "Install or update JOC Cockpit Standalone instance using HTTP connections",
    "account": "sosap",
    "scheduled": "2022-12-02T05:19:12.000+00:00",
    "created": "2022-11-30T22:19:12.000+00:00"
  },
  "joc": [
    {
      "members": {
        "clusterId": "joc",
        "instances": [
          {
            "instanceId": 1,
            "target": {
              "packageLocation": "/tmp",
              "execPre": "StopService",
              "execPost": "StartService",
              "makeService": true,
              "connection": {
                "host": "centostest-primary",
                "port": 22
              },
              "authentication": {
                "method": "publickey",
                "user": "sos",
                "keyFile": "/home/sos/.ssh/sos_rsa"
              }
            },
            "media": {
              "release": "2.5.3",
              "tarball": "2.5.3/js7_joc_linux.2.5.3.tar.gz"
            },
            "installation": {
              "setupDir": "/tmp/sos-berlin.com/js7/joc-standalone.setup",
              "isUser": true,
              "isPreserveEnv": true,
              "home": "/opt/sos-berlin.com/js7/joc-standalone",
              "data": "/var/sos-berlin.com/js7/joc-standalone",
              "httpPort": "11446",
              "dbmsConfig": "joc/templates/dbms/h2/response/hibernate.cfg.xml",
              "dbmsDriver": "joc/templates/dbms/h2/response/h2-1.4.200.jar",
              "javaHome": "/opt/java/jdk-11.0.2+9",
              "javaOptions": "-Xmx256m -Djava.security.egd=file:///dev/urandom"
            },
            "configuration": {
              "templates": [
                "joc/templates/http/resources"
              ]
            }
          }
        ]
      }
    }
  ]
} 

Standalone JOC Cockpit using HTTPS Connections

The Deployment Descriptor specifies a Standalone JOC Cockpit instance:

  • Host centostest-primary operates the JOC Cockpit instance.
  • JOC Cockpit makes use of HTTPS connections.

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


Example for Deployment Descriptor
{
  "descriptor": {
    "descriptorId": "standalone-joc-https-2022-12-04",
    "title": "Install or update JOC Cockpit Standalone instance using HTTPS connections",
    "account": "sosap",
    "scheduled": "2022-12-02T05:19:12.000+00:00",
    "created": "2022-11-30T22:19:12.000+00:00"
  },
  "joc": [
    {
      "members": {
        "clusterId": "joc",
        "instances": [
          {
            "instanceId": 1,
            "target": {
              "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.3",
              "tarball": "2.5.3/js7_joc_linux.2.5.3.tar.gz"
            },
            "installation": {
              "setupDir": "/tmp/sos-berlin.com/js7/joc-standalone.setup",
              "isUser": true,
              "isPreserveEnv": true,
              "home": "/opt/sos-berlin.com/js7/joc-standalone",
              "data": "/var/sos-berlin.com/js7/joc-standalone",
              "httpPort": "localhost:11446",
              "httpsPort": "centostest-primary.sos:11443",
              "dbmsConfig": "joc/templates/dbms/h2/response/hibernate.cfg.xml",
              "dbmsDriver": "joc/templates/dbms/h2/response/h2-1.4.200.jar",
              "javaHome": "/opt/java/jdk-11.0.2+9",
              "javaOptions": "-Xmx256m -Djava.security.egd=file:///dev/urandom"
            },
            "configuration": {
              "certificates": {
                "cert": "joc/instances/joc.standalone/resources/centostest-primary.crt",
                "keyStore": "joc/instances/joc.standalone/resources/https-keystore.p12",
                "keyStorePassword": "jobscheduler",
                "keyPassword": "jobscheduler",
                "keyAlias": "centostest-primary",
                "trustStore": "joc/instances/joc.standalone/resources/https-truststore.p12",
                "trustStorePassword": "jobscheduler"
              },
              "templates": [
                "joc/templates/https/resources"
              ],
              "startFiles": {
                "httpIni": "joc/templates/https/start.d/http.ini",
                "httpsIni": "joc/templates/https/start.d/https.ini",
                "sslIni": "joc/templates/https/start.d/ssl.ini"
              }
            }
          }
        ]
      }
    }
  ],
  "version": "1.5.3"
}

Resources



  • No labels