3.1.3.1 General Properties

Set the following properties in install.xml:

PropertyDescription

install.str.container-type

Default value: platform

This property determines the type of installation that is to be performed:

  • platform - All the files required to run the Platform and any other pico process are installed.
  • execution - Only the files required to run EC/ECSAs and/or SCs are installed.

Set the value of install.str.container-type to platform.

install.str.config-script

Default value: -

This property specifies the path and name of a shell script that you may run after the installation of the Platform Container:

The following script is available in the release content directory:

  • scripts/str-templates/basic.sh - Adds an EC (ec1) and an ECSA (ecsa1) and SCs for Couchbase and Zookeper services (sc1-sc3 and zk1-zk3).

When you use the default value (-), the installation will only include the Platform.

install.str.mz_platform

Default value: ""

This property specifies a URL, which contains the IP address or hostname of the Platform Container and the Web Interface port. The URL must be accessible from all Execution Containers in your system. The port that you configure for this property, is the port you must use if you choose to use the desktop launcher. For further information on the Desktop Launcher, see /wiki/spaces/MD82/pages/3782694.

<protocol>://<hostname or ip address>:<port>

Example - install.str.mz_platform

http://platform:9000 

When you have entered a hostname and failover occurs, the hostname is retrieved from the DNS enabling reconnection. If you have entered a static IP address as the value of this property reconnection issues may occur if the IP address changes.

The port must be unique for each system.

Set the protocol to https if you have install.security set to true.

install.str.remote.enabled

Default value:  true

This property enables remote execution, e g you can use the mzsh command system to start and stop pico instances on remote container hosts.

By default, this will perform the following steps:

  1. Add the Platform's public key to ~/.ssh/authorized_keys

     This allows the holder of the platform key to log in to this host via SSH

  2. Add SSH connection information for this host to the STR, including: 
    1. ssh-address: The hostname of this host (e.g. $(hostname))
    2. ssh-port: 22: Default SSH port
    3. hostkeys: Discovered SSH public keys for this host in known file locations

If this is not desired, or if the default values are not suitable, set this value to false.

It's still possible to enable remote execution after the installation by using the mzsh command topo setupremote.

mz.home

Default value: /opt/mz

This property specifies the target directory for the installed container. This value must be identical to the environment variable MZ_HOME, described in 3.1.1 Environment Variables.

mz.container

Default value: " "

Example value: platform1

This property specifies an identifier for the installed container. Each container in your system must have a unique identifier.

Typical values for mz.container is the hostname or a descriptive value for the purpose of the container.

The permitted characters for the container identifier are 'a-z','0-9' and '-'.

install.security

Default value: true

This property determines if the platform container should be installed with network security enabled. A valid certificate in a keystore is required for the installation, if one is not available, the installation will create one when prompted. More information on network security can be found in 4. Network Security in the System Administrator's Guide.

mz.name

Default value: MZ

Example value: MZ8

This property specifies the name of the system that the container belongs to.