vid/src/main/swm/notes.txt

   1 This package will install the Virtual Infrastructure Deployment (VID) war to the local tomcat server.
   2 The Tomcat server is marked as a dependency of this package and will be installed automatically on the
   3 target server if it has not already been installed.  The current version of Tomcat used by VID
   4 is 8.0.36.  MariaDB is also necessary for VID and can be installed by whichever method you choose.
   5
   6 The following are variables that can be set to customize your installation of VID:
   7
   8 Variable                        Default                 Description
   9
  10 ASDC_CLIENT_REST_AUTH           unset                   Basic authentication header value (e.g. Basic asdfoijwelkjsg=)
  11 ASDC_CLIENT_REST_HOST           unset                   Host where the ASDC Catalog Service is running
  12 ASDC_CLIENT_REST_PORT           8080                    Port where the ASDC Catalog Service is running
  13 ASDC_CLIENT_TYPE                REST                    Set to IN_MEMORY for testing, REST for connecting with an actual ASDC Catalog Service
  14
  15 MSO_DME2_CLIENT_READ_TIMEOUT    unset                   Time in ms before DME2 MSO read requests timeout
  16 MSO_DME2_CLIENT_TIMEOUT         unset                   Time in ms before DME2 MSO requests timeout
  17 MSO_DME2_ENABLED                unset                   Whether the enable the MSO DME2 client or not
  18 MSO_DME2_SERVER_URL             unset                   The server URL for connecting to the MSO service
  19 MSO_POLLING_INTERVAL_MSECS      10000                   The interval at which to poll MSO for orchestration requests
  20 VID_MSO_PASS                    unset                   The password for connecting with the MSO service
  21 VID_MSO_SERVER_URL              unset                   The server URL for connecting with the MSO service
  22 VID_MSO_USER                    unset                   The user name for connecting with the MSO service
  23
  24 VID_LOG_DIR                     ${ROOT_DIR}/logs        The directory to store log files in
  25 VID_LOG_LEVEL                   INFO                    The level at which to log (follows logback logging levels)
  26 VID_ECOMP_REDIRECT_URL          https://portal.openecomp.org/ecompportal/ecompportal/process_csp                See ECOMP SDK Documentation
  27 VID_ECOMP_REST_URL              https://portal.openecomp.org/ecompportal/auxapi         See ECOMP SDK Documentation
  28 VID_ENDPOINT_NAME               vid                     http://{host}:{port}/{VID_ENDPOINT_NAME}
  29
  30 VID_MYSQL_HOST                  unset                   The host where the VID MariaDB instance is running
  31 VID_MYSQL_MAXCONNECTIONS        5                       The maximum connections to use to connect to the MariaDB instance
  32 VID_MYSQL_PORT                  3306                    The port where the VID MariaDB instance is running
  33 VID_MYSQL_DBNAME                vid_portal              The database name (i.e. CREATE DATABASE ${VID_MYSQL_DBNAME}
  34 VID_MYSQL_USER                  vidadmin                The user to connect as to the MariaDB instance
  35 VID_MYSQL_PASS                  unset                   The password for the ${VID_MYSQL_USER} @ ${VID_MYSQL_HOST}
  36
  37 VID_AAI_HOST                    unset                   The host where the A&AI service is running
  38 VID_AAI_PORT                    8443                    The port where the A&AI service is running
  39 VID_TRUSTSTORE_PASS             unset                   The password for the VID truststore (A&AI client)
  40 VID_TRUSTSTORE_FILE             unset                   The location on the file system of the truststore (A&AI client)
  41 AAI_TRUSTSTORE_FILENAME         tomcat_keystore         A file name
  42 AAI_TRUSTSTORE_PASSWD_X         (dev env creds)         A password
  43 AAI_KEYSTORE_FILENAME           aai-client-cert.p12     A file name
  44 AAI_KEYSTORE_PASSWD_X           (dev env creds)         A password
  45
  46 VID_UEB_URL_LIST                ueb.openecomp.org               The hosts where UEB is running
  47 VID_UEB_CONSUMER_GROUP          VID                     The UEB consumer group name to use
  48 VID_ECOMP_PORTAL_INBOX_NAME     ECOMP-PORTAL-INBOX-DEV-LOCAL            A UEB Topic to send messages to the ECOMP portal on
  49 VID_UEB_APP_KEY                 sYH0NJnsKmJC1B2A                        The UEB App Key (mandatory)
  50 VID_UEB_APP_SECRET              YOtknsT2wVFz9WISlSPDaAtd                The UEB App Secret
  51 VID_UEB_APP_MAILBOX_NAME        ECOMP-PORTAL-OUTBOX-90                  A UEB Topic to listen for messages from the ECOMP portal on
  52 VID_UEB_LISTENERS_ENABLE        false                   Enable the UEB listeners for the specified mailboxes (In 1610, this should always be false)