Parameters for CreateEnvironment API

Creation of a new environment at the platform can be automated in a variety of different ways, e.g. with the help of platform CLI, through the direct API request or by declaring the appropriate parameters via JPS manifest. Herewith, though representing a rather simple operation, it can include a bunch of different parameters for the precise topology definition.

Thus, below we provide the description for all of such settings with the examples on their usage via CLI. They are divided into 3 major sections as arrays of the ~/jelastic/environment/control/createenvironment method, being named according to the appropriate arrays' denominations - two common ones and listing of the specialized parameters for the Docker containers' creation:

• env
• nodes
• docker

Common Environment Configurations

The parameters below are to be specified within the env array (of either CLI command or JSON file) and define the most common environment configurations, like programming language, name, region and others:

Example:

1

env '{"region": "default_hn_group", "ishaenabled": "false", "engine": "java7", "displayName": "my-env-alias", "sslstate": "true", "shortdomain": "my-cli-env"}'

Nodes Configurations

Within the nodes section, more subtle adjustment can be set to define the comprised servers' parameters, like their type, amount, number of allocated reserved/dynamic cloudlets and more:

Example:

1

nodes '[{"extip": "true", "count": "2", "fixedCloudlets": "16", "flexibleCloudlets": "32", "displayName": "my-node-alias", "nodeType": "docker", "docker": {...}}]'

Docker-Based Environment Configurations

The docker subsection is intended to state the specialized Docker container parameters, required for its deployment.

Example:

1

"docker": {"cmd": "run.sh", "image": "jelastic/tomcat8:latest", "nodeGroup": "cp", "links": [...], "env": {...}, "registry": {...}, "volumes": [...], "volumeMounts": {...}, "volumesFrom": [{...}]}

• linking configuration - for establishing connection between Docker containers in confines of a single environment

  Name	Description	Type	Example Value	Mandatory
  -	defines the layer/node the current instance should be linked with and sets an alias for this bundle	string	sqldb:DB, cp:alias	no

  Example:

  1	"links": ["cp:alias", "sqldb:DB"]

• environment variables configuration - for stating environment variables in Docker containers

  Name	Description	Type	Example Value	Mandatory
  custom_variable_name	Sets the environment variables	string	var1 value1 (the entire string after first space will be treated as the value, including spaces and quotes) var2=value1 \value2 \value3 (for setting multiple values at a time, i.e. to create an array; here, quotes and backslashes are used as separators)	no

  Example:

  1	"env": {"var1": "value1", "var2": "value1 \value2 \value3"}

• registry configuration - for connection to private registry

  Name	Description	Type	Example Value	Mandatory
  password	Password to a private registry	string	passw0rd	only if you are using private registry
  user	Name of the user of a private registry	string	admin	only if you are using private registry
  url	URL to a private registry	string	http://example.com/private-registry	only if you are using private registry

  Example:

  1	"registry": {"password": "passw0rd", "user": "admin", "url": "http://example.com/private-registry"}

• local volumes - list of volumes to be created within local file system of Docker container

  Name	Description	Type	Example Value	Mandatory
  custom_path	Local volume path	string	/my_custom_volume	no

  Example:

  1	"volumes": ["/volume1", "/volume2", "/volume3"]

• mount points - set of parameters that define folder(s) with required data to be attached from other servers

  Name	Description	Type	Example Value	Mandatory
  local_path	Local path the mounted data will refer to	array	/mounted_data	yes
  sourcePath	Path to the required data directory on the remote server	string	/required_data if not defined, is stated equal to local_path (for remote storage server)	no
  sourceNodeId	Node ID of storage container	integer	459315	yes in case neither sourceNodeGroup, nor sourceHost is specified
  sourceNodeGroup	Particular environment layer within current environment	string	cp - application server bl - load balancer nosqldb - noSQL database sqldb - SQl database cache - cache node storage - storage node	yes in case neither sourceNodeId, nor sourceHost is specified
  sourceHost	Public IP or domain of the external Data Storage server	string	195.67.231.39	yes in case neither sourceNodeGroup, nor sourceNodeId is specified
  readOnly	Defines read only or read & write rights for client node	boolean	true is false by default	no

  Example:

  1	"volumeMaunts": {"/data": {"sourcePath": "/exported", "sourceNodeId": "693215", "readOnly": "true"}}

• account volumes - list of nodes at the current account for the volumes to be imported from

  Name	Description	Type	Example Value	Mandatory
  sourceNodeId	ID of storage container	integer	81725	yes, if sourceNodeGroup is not specified
  sourceNodeGroup	Particular environment layer within current environment	string	cp - application server bl - load balancer nosqldb - noSQL database sqldb - SQl database cache - cache node storage - storage node	yes, if sourceNodeId is not specified
  volumes	List of volumes to export	string	/volume If not specified, all volumes on a node will be exported	no
  readOnly	Defines read only or read & write rights for client node	boolean	true(states in false by default)	no

  Example:

  1	"volumesFrom": [{"sourceNodeGroup": "cp", "volumes": ["/master", "/local"], "readOnly": "true"}]

What’s next?

• API Overview
• API Methods
• Platform CLI