Extended documentation for Euphrates

Inlcuded user guide and configuration guide that can be used to get started immediately with orchestra

Change-Id: Idec9cf8462b0497addc8419fb77744a639fd8718
Signed-off-by: Giuseppe Carella <cargius@gmail.com>
Signed-off-by: Michael Pauls <michael.pauls@fokus.fraunhofer.de>

1 files changed, 71 insertions, 0 deletions

diff --git a/bootstrap/bootstrap-config-file b/bootstrap/bootstrap-config-file
new file mode 100644
index 0000000..be34c94
--- /dev/null
+++ b/bootstrap/bootstrap-config-file
@@ -0,0 +1,71 @@
+# This is a configuration file for the Open Baton bootstrap. 
+# It allows you to specify the parameters needed during the bootstrap for the configuration of the Open Baton projects.
+#
+# Usage: sh <(curl -s http://get.openbaton.org/bootstrap) [help | clean | enable-persistence] | [[release | develop] [--openbaton-bootstrap-version=X.Y.Z (with X.Y.Z >= 3.2.0)] [--config-file=<absolute path to configuration file>]]
+#
+# IMPORTANT NOTE: Avoid spaces before and after the '=': i.e. a parameter needs to be specified as 'parameter=value'
+
+
+#################
+#### General ####
+#################
+
+#openbaton_bootstrap_version=latest                          # Deafult is 'latest' therefore if left empty ('openbaton_bootstrap_version=') or commented the bootstrap used will be the latest. Use format X.Y.Z for a specific version: the oldest VERSION installable is 3.2.0
+openbaton_installation_manner=noninteractive                # Deafult is 'interactive' therefore if left empty ('openbaton_installation_manner=') or commented the installation will be interactive. Use 'noninteractive' or 'Noninteractive' for a not interactive installation
+openbaton_component_autostart=true                          # Deafult is 'true' therefore if left empty ('openbaton_component_autostart=') or commented the debian component will start automatically at the end of the installation
+
+
+##############
+#### NFVO ####
+##############
+
+rabbitmq_broker_ip=localhost                                # Default is 'localhost' therefore if left empty ('rabbitmq_broker_ip=') or commented the 'localhost' value will be used
+rabbitmq_management_port=15672                              # Default is '15672' therefore if left empty ('rabbitmq_management_port=') or commented the '15672' value will be used
+openbaton_nfvo_ip=localhost                                 # Default is 'localhost' therefore if left empty ('openbaton_nfvo_ip=') or commented the 'localhost' value will be used
+openbaton_admin_password=openbaton                          # Default is 'openbaton' therefore if left empty ('openbaton_admin_password=') or commented the 'openbaton' value will be used
+
+https=no                                                    # Default is 'NO' therefore if left empty ('https=') or commented the HTTPS will NOT be enabled
+mysql=yes                                                   # Default is 'YES' therefore if left empty ('mysql=') or commented the MYSQL DB will be installed and the Open Baton persistence will be enabled
+mysql_root_password=root                                    # Default is 'root' therefore if left empty ('mysql_root_password=') or commented the 'root' value will be used (NOTE: you should insert here the actual mysql root password if mysql is already installed in the system)
+openbaton_nfvo_mysql_user=admin                             # Default is 'admin' therefore if left empty ('openbaton_nfvo_mysql_user=') or commented the 'admin' value will be used
+openbaton_nfvo_mysql_user_password=changeme                 # Default is 'changeme' therefore if left empty ('openbaton_nfvo_mysql_user_password=') or commented the 'changeme' value will be used
+
+
+##########################################
+#### Open Baton additional components ####
+##########################################
+
+openbaton_plugin_vimdriver_openstack=yes                    # Default is 'YES' therefore if left empty ('openbaton_plugin_vimdriver_openstack=') or commented the 'openbaton_plugin_vimdriver_openstack' debian package will be installed
+openbaton_vnfm_generic=yes                                  # Default is 'YES' therefore if left empty ('openbaton_vnfm_generic=') or commented the 'openbaton_vnfm_generic' debian package will be installed
+openbaton_fms=yes                                           # Default is 'NO' therefore if left empty ('openbaton_fms=') or commented the 'openbaton_fms' debian package will NOT be installed
+openbaton_ase=yes                                           # Default is 'NO' therefore if left empty ('openbaton_ase=') or commented the 'openbaton_ase' debian package will NOT be installed
+openbaton_nse=yes                                           # Default is 'NO' therefore if left empty ('openbaton_nse=') or commented the 'openbaton_nse' debian package will NOT be installed
+openbaton_cli=yes                                           # Default is 'NO' therefore if left empty ('openbaton_cli=') or commented the 'openbaton_cli' debian package will NOT be installed
+
+# NOTE: The VERSION is to be interptreted as "debian package version" or "source TAG" respectively for RELEASE / DEVELOP installation
+# Possible values are: 'latest' (only for RELEASE), 'develop' (only for DEVELOP), 'X.Y.Z' (for both types of installation)
+openbaton_nfvo_version=4.0.0                                # Default is 'latest' / 'develop' therefore if left empty ('openbaton_nfvo_version=') or commented the 'latest' debian version / the 'develop' TAG will be installed. NOTE: Check the list of available tags at: https://github.com/openbaton/generic-vnfm/tags - The oldest VERSION installable is 3.2.0
+openbaton_plugin_vimdriver_openstack_version=4.0.1          # Default is 'latest' / 'develop' therefore if left empty ('openbaton_nfvo_version=') or commented the 'latest' debian version / the 'develop' TAG will be installed. NOTE: Check the list of available tags at: https://github.com/openbaton/openstack4j-plugin/tags - The oldest VERSION installable is 3.2.0
+openbaton_vnfm_generic_version=4.0.0                        # Default is 'latest' / 'develop' therefore if left empty ('openbaton_vnfm_generic_version=') or commented the 'latest' debian version / the 'develop' TAG will be deployed. NOTE: Check the list of available tags at: https://github.com/openbaton/generic-vnfm/tags - The oldest VERSION installable is 3.2.0
+openbaton_fms_version=1.2.5                                 # Default is 'latest' / 'develop' therefore if left empty ('openbaton_fms_version=') or commented the 'latest' debian version / the 'develop' TAG will be deployed. NOTE: Check the list of available tags at: https://github.com/openbaton/fm-system/tags - The oldest VERSION installable is 1.2.1
+openbaton_ase_version=1.2.3                                 # Default is 'latest' / 'develop' therefore if left empty ('openbaton_ase_version=') or commented the 'latest' debian version / the 'develop' TAG will be deployed. NOTE: Check the list of available tags at: https://github.com/openbaton/autoscaling-engine/tags - The oldest VERSION installable is 1.2.2
+openbaton_nse_version=1.1.2                                 # Default is 'latest' / 'develop' therefore if left empty ('openbaton_nse_version=') or commented the 'latest' debian version / the 'develop' TAG will be deployed. NOTE: Check the list of available tags at: https://github.com/openbaton/network-slicing-engine/tags - The oldest VERSION installable is 1.1.2
+
+
+#############
+#### FMS ####
+#############
+
+openbaton_fms_mysql_user=fmsuser                            # Default is 'fmsuser' therefore if left empty ('mysql_user=') or commented the 'admin' value will be used
+openbaton_fms_mysql_user_password=changeme                  # Default is 'changeme' therefore if left empty ('mysql_user_password=') or commented the 'changeme' value will be used
+
+
+######################################################
+#### Zabbix Plugin (required by FMS, ASE and NSE) ####
+######################################################
+
+# NOTE: Currently the ZABBIX configuration parameters are supported only for the RELEASE installation 
+zabbix_plugin_ip=                                           # Default is 'localhost' therefore if left empty ('zabbix_plugin_ip=') or commented the 'admin' value will be used
+zabbix_server_ip=                                           # Default is 'localhost' therefore if left empty ('zabbix_server_ip=') or commented the 'admin' value will be used
+zabbix_user=                                                # Default is 'Admin' therefore if left empty ('zabbix_user=') or commented the 'Admin' value will be used
+zabbix_user_password=                                       # Default is 'zabbix' therefore if left empty ('zabbix_user_password=') or commented the 'zabbix' value will be used