4.1.0 Configuring setup.conf

The properties in the <STRATOS_SOURCE_HOME>/tools/stratos-installer/conf/setup.sh file have been explained as follows:

General property definitions

export setup_path= #Folder path containing stratos_setup
export stratos_packs= #Folder path containing stratos package and other third party packs and jars 
export stratos_path= #Folder which stratos will be installed
export JAVA_HOME= #Java home path
export log_path=/var/log/apache-stratos
export host_user="" #A host user account for the machine which run Stratos component(s)
export stratos_domain="stratos.apache.org"
export host_ip="127.0.0.1" # Machine ip on host machine
export offset=0
export puppet_ip="127.0.0.1" 	# Machine ip on which puppet master run
export puppet_hostname="puppet-hostname" # Host name given to identify the puppet master
export puppet_environment="puppet_environment" # Name of puppet environment
export mb_ip="127.0.0.1" # Machine ip on which mb run
export mb_port=61616 #default port which the message broker service runs
 
export stratos_extract_path=$stratos_path/"apache-stratos"
export stratos_pack_zip_name="apache-stratos-4.1.0-SNAPSHOT.zip"
export stratos_pack_zip=$stratos_packs/$stratos_pack_zip_name
export activemq_pack=$stratos_packs/"apache-activemq-5.9.1-bin.tar.gz"
export activemq_path=$stratos_path/"apache-activemq-5.9.1"
export jndi_template_path=$setup_path/"config/all/repository/conf/activemq/jndi.properties"
export resource_path=$setup_path/resources

Property	Description
setup_path	Enter the folder path of the `<stratos-installer>` folder that contains the Stratos installer.
stratos_packs	Enter the folder path of the `<stratos_packs>` folder that contains the Stratos packages and other third-party packs and JARs.
stratos_path	Enter the folder path of the `<stratos>` folder where Stratos will be installed.
JAVA_HOME	Enter the path where the Java Development Kit (JDK) is installed.
log_path	Enter the folder path to the Stratos logs.
host_user	Enter the host user account for the machine that runs the Stratos component(s).
stratos_domain	Enter the domain of Stratos. The default value is as follows: stratos.apache.org
host_ip	Enter the machine IP address of the host machine.
offset	Enter the port offset of the machine.
puppet_ip	Enter the IP address of the machine or node on which Puppet Master will be run.
puppet_hostname	Enter the hostname that is given to identify the Puppet Master.
puppet_environment	If you wish to use the same Puppet Master with multiple Stratos runtimes, enter the name of the Puppet environment; otherwise, enter a dummy value for this configuration.
mb_ip	Enter the IP address of the machine or node on which Message Broker service runs.
mb_port	Enter the default port on which the Message Broker service runs.
stratos_extract_path	The path to the folder that contains the extracted Stratos binary package.
stratos_pack_zip_name	The name of the zipped Stratos binary package.
stratos_pack_zip	The path to the zipped Stratos binary package.
activemq_pack	The path to the Apache ActiveMQ TAR file. The default TAR file name is `apache-activemq-5.9.1-bin.tar.gz.` Update the name of this file based on the version that you are using.
activemq_path	The path to the unzipped apache ActiveMQ binary distribution. Update the version of the ActiveMQ file based on the version that you are using.
jndi_template_path	The path to the `jndi.properties` file.
resource_path	The path to the resources directory.

IaaS provider property definitions

The properties that need to be provided when installing Stratos with an IaaS will vary based on the IaaS. The following are the various IaaS specific properties that are in the <stratos-installer>/conf/setup.conf

# IaaS Providers
# ----------------------------------------------------------------------------
# Set <iaas-name>_provider_enabled parameter to true to enable desired IaaS. A hybrid cloud could be
# created using multiple IaaSs.
# EC2
export ec2_provider_enabled=true
export ec2_identity="<ec2_identity>"
export ec2_credential="<ec2_credential>"
export ec2_keypair_name="<ec2_keypair_name>"
export ec2_owner_id="<ec2_owner_id>"
export ec2_availability_zone="<ec2_availability_zone>"
export ec2_security_groups="<ec2_security_groups>"

# Openstack
export openstack_provider_enabled=false
export openstack_identity="stratos:stratos" # Openstack project name:Openstack login user
export openstack_credential="password" # Openstack login password
export openstack_jclouds_endpoint="http://hostname:5000/v2.0"
export openstack_keypair_name=""
export openstack_security_groups=""
# default to nova. If you have neutron networking environment, set it to neutron
export openstack_networking_provider="nova"

# GCE
export gce_provider_enabled=false
export gce_identity="<gce_identity>"
export gce_credential="<gce_credential>"

# kubernetes
export kubernetes_provider_enabled=false
export kubernetes_identity="<kubernetes_identity>"
export kubernetes_credential="<kubernetes_credential>"

Property	Example Property	Description	Example
<IAAS_NAME>_provider_enabled	`ec2_provider_enabled`	Enables or disables the specific IaaS as the IaaS provider. The possible values are `true` and `false`.	true
`<IAAS_NAME>_identity`	ec2_identity	IaaS provider's identity number. The IaaS provider's identity number will appear in the following format `<IAAS_PROJECT_NAME>:<IAAS_LOGIN_USERNAME>` Example: The value for `ec2_identity` is found in the AWS management console Security Credentials section, when you create a new access key. This value refers to the new key's access key ID.	stratos:stratos
<IAAS_NAME>_credential	ec2_credential	IaaS provider's password to login. Example: The value for `ec2_credential` is found in the AWS management console Security Credentials section, when you create a new access key. This value refers to the new key's secret access key.	pwd123
<IAAS_NAME>_jclouds_endpoint	openstack_jclouds_endpoint		http://hostname:5000/v2.0
`<IAAS_NAME>_keypair_name`	ec2_keypair_name	The name of the private key that corresponds to the key pair used to connect to the instance. Example: The value for `ec2_keypair_name` is the value that is set to the name of a keypair that you created in the EC2 section of the AWS management console.	apache-stratos-key1
<IAAS_NAME>_owner_id	`ec2_owner_id`	The owner ID (also referred to as the account ID) that corresponds to the respective IaaS. This is found by querying a security group for it's OwnerId. Example: The value for `ec2_owner_id` is found in the AWS management console, in the Account Management section, labelled as Account Number.
<IAAS_NAME>_availability_zone	ec2_availability_zone	The name of the availability zone. If you are using more than one partition, define the availability zone only in the cartridge definition and make sure not to define the availability zone in the `cloud-controller.xml` or the `setup.conf`. This will enable the Auto-scaler to dynamically select availability zone based on the partition.	ap-southeast-1a
<IAAS_NAME>_security_groups	ec2_security_groups	The name of the security group that is used to define the IP filter rules for the instance. Example: If you are unsure as to what value to use for ec2_security_groups, set it to `default`.	sg-c999f7a6
<IAAS_NAME>_networking_provider	openstack_networking_provider	The networking provider that is used. This is specific to OpenStack. The default value is nova; however, if you have a neutron networking environment, this can be set to neutron.	nova

Database property definitions

export mysql_connector_jar=$stratos_packs/"mysql-connector-java-5.1.29-bin.jar" #mysql connector jar file name
export userstore_db_hostname="localhost"
export userstore_db_schema="userstore"
export userstore_db_port="3306"
export userstore_db_user="root"
export userstore_db_pass="root"

Property	Description
mysql_connector_jar	The path to the MySQL connector JAR. Update the value of the parameter `mysql_connector_jar` with the relevant JAR file name. The default JAR file name is `mysql-connector-java-5.1.25.jar.`
userstore_db_hostname	Host of the MySQL server.
userstore_db_schema	Schema of the MySQL server.
userstore_db_port	Port of the MySQL server.
userstore_db_user	Username of the MySQL server.
userstore_db_pass	Password of the MySQL server.

Child pages

4.1.0 Configuring setup.conf

General property definitions

IaaS provider property definitions

Database property definitions