installation/README.md

   1 /*
   2 * ============LICENSE_START==========================================
   3 * ===================================================================
   4 * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
   5 * ===================================================================
   6 *
   7 * Unless otherwise specified, all software contained herein is licensed
   8 * under the Apache License, Version 2.0 (the "License";
   9 * you may not use this software except in compliance with the License.
  10 * You may obtain a copy of the License at
  11 *
  12 *             http://www.apache.org/licenses/LICENSE-2.0
  13 *
  14 * Unless required by applicable law or agreed to in writing, software
  15 * distributed under the License is distributed on an "AS IS" BASIS,
  16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17 * See the License for the specific language governing permissions and
  18 * limitations under the License.
  19 *
  20 *
  21 *
  22 * Unless otherwise specified, all documentation contained herein is licensed
  23 * under the Creative Commons License, Attribution 4.0 Intl. (the "License");
  24 * you may not use this documentation except in compliance with the License.
  25 * You may obtain a copy of the License at
  26 *
  27 *             https://creativecommons.org/licenses/by/4.0/
  28 *
  29 * Unless required by applicable law or agreed to in writing, documentation
  30 * distributed under the License is distributed on an "AS IS" BASIS,
  31 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  32 * See the License for the specific language governing permissions and
  33 * limitations under the License.
  34 *
  35 * ============LICENSE_END============================================
  36 *
  37 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  38 *
  39 */
  40 # ONAP APP-C - Available Properties
  41
  42 ---
  43 ---
  44
  45 # Introduction
  46
  47 The current list of properties that can be overwritten from all default.properties files to appc.properties (./src/main/appc-properties/appc.properties) are list below. Please note that some properties have default values since some code requires it to be defined as part of the building/compilation process.
  48
  49 - NOTE: The only defined property values in appc.properties are the following:
  50     - "appc.ClosedLoop1607.*" properties (needed for demo)
  51     - "appc.provider.vfodl.url" property (needed for demo)
  52     - "appc.service.logic.module.name" property (needed for demo)
  53     - "appc.topology.dg.*" properties (needed for demo)
  54
  55 # Properties List
  56 The following properties are ready to be defined based on which feature needs to be tested or used:
  57
  58 - provider1.* properties:
  59     - Applies to the following features: appc-rest-adapter-bundle, appc-chef-adapter-bundle, appc-iaas-adapter-bundle
  60     - These properties need to be defined in order to use OpenStack-based API executions. For example, the APP-C function "restart" is in charge of restarting a VM when requested. Therefore, properties such as OpenStack credentials, tenant name, VM ID, and others pre-defined in the appc.properties need to be defined with the information of the OpenStack Environment you are deploying APP-C from.
  61
  62 - dmaap.poolMembers property:
  63     - Applies to the following features: appc-command-executor-core, appc-license-manager-core, appc-lifecycle-management-core, appc-request-handler-core, and appc-workflow-management-core (all part of the appc-dispatcher package)
  64     - Defines the DMaaP IP or URL location of the DMaaP Pool Members involved in the DMaaP Communication of that feature in specific (NOTE: More than one Pool Member can be defined in the form of a comma-delimited list)
  65
  66 - appc.ClosedLoop.* properties:
  67     - Applies to the following feature: appc-event-listener-bundle (both in src/main and src/test)
  68     - These properties define in which DMaaP will the appc-event-listener feature will listen in
  69
  70 - appc.LCM.* properties:
  71     - Applies to the following feature: appc-event-listener-bundle (in src/test only)
  72     - These properties define in which DMaaP will the appc-event-listener feature will listen in. These properties are especifically used to define LCM (LifeCycle Management) actions, and are only used as part of JUnit Test Cases.
  73
  74 - test.* properties:
  75     - Applies to the following features: appc-rest-adapter-bundle, appc-chef-adapter-bundle, appc-iaas-adapter-bundle
  76     - These are properties that test OpenStack-based APP-C API requests
  77
  78 - appc.asdc.*:
  79     - Applies to the following feature: appc-asdc-listener-bundle
  80     - These properties are used to test integration between the SDC ONAP component & APP-C. Properties such as pointing to the DMaaP listener & topic, SDC credentials to authenticate into the SDC component, define the RESTCONF URL, and others are mapped here.
  81
  82 - Other properties:
  83     - poolMembers, event.pool.members, restconf.user, restconf.pass
  84         - Applies to the following features: appc-netconf-adapter-bundle, appc-dg-common, appc-dmaap-adapter-bundle
  85         - These properties can be defined to use the features defined above. They are used to point to current DMaaP listener, and to define the RESTCONF credentials needed to execute APP-C API requests from the features impacted above.