docs/configuration.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 =============
   5 Configuration
   6 =============
   7
   8 .. contents::
   9    :depth: 3
  10 ..
  11
  12 Global Configuration
  13 ====================
  14
  15 environment.json
  16 ----------------
  17
  18 ::
  19
  20     {
  21         # Environment name
  22         "name": "xxx",
  23
  24         # Environment description
  25         "description": "OpenSource-xxx",
  26
  27         # Chef properties
  28         "cookbook_versions": {
  29             "Deploy-SDandC": "= 1.0.0"
  30         },
  31         "json_class": "Chef::Environment",
  32         "chef_type": "environment",
  33
  34         "default_attributes": {
  35             "disableHttp": false,
  36             # IPs used for docker configuration
  37             "CS_VIP": "yyy",
  38             "BE_VIP": "yyy",
  39             "ONBOARDING_BE_VIP": "yyy",
  40             "FE_VIP": "yyy",
  41             "ES_VIP": "yyy",
  42             "KB_VIP": "yyy",
  43             "DCAE_BE_VIP": "yyy",
  44             "DCAE_FE_VIP": "yyy",
  45             "interfaces": {
  46                 "application": "eth0",
  47                 "private": "eth1"
  48             },
  49
  50             # Configuration parameters used in portal properties
  51             "ECompP": {
  52                 "ecomp_rest_url": "http://portal.api.simpledemo.onap.org:8989/ONAPPORTAL/auxapi",
  53                 "ueb_url_list": "10.0.11.1,10.0.11.1",
  54                 "app_secret": "XftIATw9Jr3VzAcPqt3NnJOu",
  55                 "app_key": "x9UfO7JsDn8BESVX",
  56                 "inbox_name": "ECOMP-PORTAL-INBOX",
  57                 "ecomp_redirect_url": "http://portal.api.simpledemo.openecomp.org:8989/ECOMPPORTAL/login.htm",
  58                 "app_topic_name": "ECOMP-PORTAL-OUTBOX-SDC1",
  59                 "decryption_key": "AGLDdG4D04BKm2IxIWEr8o=="
  60             },
  61
  62             # Configuration parameters used by SDC to work with Dmaap
  63             "UEB": {
  64                 "PublicKey": "iPIxkpAMI8qTcQj8",
  65                 "SecretKey": "Ehq3WyT4bkif4zwgEbvshGal",
  66                 "fqdn": ["10.0.11.1", "10.0.11.1"]
  67             },
  68
  69             # IPs used for docker configuration
  70             "Nodes": {
  71                 "CS": ["yyy"],
  72                 "BE": "yyy",
  73                 "ONBOARDING_BE": "yyy",
  74                 "FE": "yyy",
  75                 "ES": ["yyy"],
  76                 "KB":  "yyy"
  77             },
  78             "Plugins": {
  79                "DCAE": {
  80                   "dcae_discovery_url": "yyy",
  81                   "dcae_source_url": "yyy"
  82                },
  83                "WORKFLOW": {
  84                   "workflow_discovery_url": "yyy",
  85                   "workflow_source_url": "yyy"
  86                }
  87             },
  88             "VnfRepo": {
  89                 "vnfRepoPort": "8702",
  90                 "vnfRepoHost": "10.0.14.1"
  91             }
  92         },
  93         "override_attributes": {
  94
  95             # FE and BE listening ports
  96             "FE": {
  97                 "http_port": "8181",
  98                 "https_port": "9443"
  99             },
 100             "BE": {
 101                 "http_port": "8080",
 102                 "https_port": "8443"
 103             },
 104             "ONBOARDING_BE": {
 105                "http_port": "8081",
 106                "https_port": "8445"
 107             },
 108
 109             # Elasticsearch configuration
 110             "elasticsearch": {
 111                 "cluster_name": "SDC-ES-",
 112                 "ES_path_home": "/usr/share/elasticsearch",
 113                 "ES_path_data": "/usr/share/elasticsearch/data",
 114                 "num_of_replicas": "0",
 115                 "num_of_shards": "1"
 116             },
 117
 118             # Cassandra configuration
 119             "cassandra": {
 120                 "concurrent_reads": "32",
 121                 "num_tokens": "256",
 122                 "data_dir": "/var/lib/cassandra/data",
 123                 "hinted_handoff_enabled": "true",
 124                 "cassandra_user": "asdc_user",
 125                 "cassandra_password": "Aa1234%^!",
 126                 "concurrent_writes": "32",
 127                 "cluster_name": "SDC-CS-",
 128                 "multithreaded_compaction": "false",
 129                 "cache_dir": "/var/lib/cassandra/saved_caches",
 130                 "log_file": "/var/lib/cassandra/log/system.log",
 131                 "phi_convict_threshold": "8",
 132                 "commitlog_dir": "/var/lib/cassandra/commitlog",
 133                 "socket_read_timeout": "20000",
 134                 "socket_connect_timeout": "20000",
 135                 "titan_connection_timeout": "10000"
 136             }
 137         }
 138     }
 139
 140
 141
 142 Backend Configurations
 143 ======================
 144
 145 Catalog Configurations
 146 ----------------------
 147
 148 BE-configuration.yaml
 149 **********************
 150
 151
 152
 153 ::
 154
 155     # Request headers for identification of the user that made the request
 156     identificationHeaderFields:
 157     - HTTP_IV_USER
 158     - HTTP_CSP_FIRSTNAME
 159     - HTTP_CSP_LASTNAME
 160     - HTTP_IV_REMOTE_ADDRESS
 161     - HTTP_CSP_WSTYPE
 162
 163     # Catalog backend hostname
 164     beFqdn: <%= @catalog_ip %>
 165
 166     # Catalog backend http port
 167     beHttpPort: <%= @catalog_port %>
 168
 169     # Catalog backend http context
 170     beContext: /sdc/rest/config/get
 171
 172     # Catalog backend protocol
 173     beProtocol: http
 174
 175     # Catalog backend ssl port
 176     beSslPort: <%= @ssl_port %>
 177
 178     # Catalog backend configuration version
 179     version: 1.1.0
 180
 181     # Catalog backend configuration release date
 182     released: 2012-11-30
 183
 184     # Catalog tosca current conformance version
 185     toscaConformanceLevel: 5.0
 186
 187     # Catalog minimum tosca conformance version
 188     minToscaConformanceLevel: 3.0
 189
 190     # Titan configuration file location
 191     titanCfgFile: /var/lib/jetty/config/catalog-be/titan.properties
 192
 193     # Does titan holds the persistence data in memory
 194     titanInMemoryGraph: false
 195
 196     # The timeout for titan to lock on an object in a transaction
 197     titanLockTimeout: 1800
 198
 199     # The interval to try and reconnect to titan DB when it is down during SDC startup
 200     titanReconnectIntervalInSeconds: 3
 201
 202     # The read timeout towards Titan DB when health check is invoked
 203     titanHealthCheckReadTimeout: 1
 204
 205     # The interval to try and reconnect to Elasticsearch when it is down during SDC startup
 206     esReconnectIntervalInSeconds: 3
 207
 208     # The interval to try and reconnect to UEB health check when it is down during SDC startup
 209     uebHealthCheckReconnectIntervalInSeconds: 15
 210
 211     # The read timeout towards UEB when health check is invoked
 212     uebHealthCheckReadTimeout: 4
 213
 214     # Protocols being used in SDC
 215     protocols:
 216         - http
 217         - https
 218
 219     # Default imports
 220     # Under each import there is the file the data will be imported from
 221     defaultImports:
 222         - nodes:
 223             file: nodes.yml
 224         - datatypes:
 225             file: data.yml
 226         - capabilities:
 227             file: capabilities.yml
 228         - relationships:
 229             file: relationships.yml
 230         - groups:
 231             file: groups.yml
 232         - policies:
 233             file: policies.yml
 234
 235     # Users
 236     # Deprecated. Will be removed in future releases
 237     users:
 238         tom: passwd
 239         bob: passwd
 240
 241     cassandraConfig:
 242         # Cassandra hostname
 243         cassandraHosts: <%= @cassandra_ip %>
 244
 245         # Cassandra local data center name
 246         localDataCenter: <%= @DC_NAME %>
 247
 248         # The read timeout towards Cassandra when health check is invoked
 249         reconnectTimeout : 30000
 250         # The amount of time the Cassandra client will wait for a socket
 251         socketReadTimeout: <%= @socket_read_timeout %>
 252         # The amount of time the Cassandra client will wait for a response
 253         socketConnectTimeout: <%= @socket_connect_timeout %>
 254
 255         # Should an authentication be used when accessing Cassandra
 256         authenticate: true
 257
 258         # Username for accessing Cassandra
 259         username: asdc_user
 260
 261         # Password for accessing Cassandra
 262         password: {{cassandra_password}}
 263
 264         # Does an ssl should be used
 265         ssl: false
 266
 267         # Location of .truststore file
 268         truststorePath : /config/.truststore
 269
 270         # The .truststore file password
 271         truststorePassword : Aa123456
 272
 273         # Keyspaces configuration for Cassandra
 274         keySpaces:
 275             - { name: dox, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
 276             - { name: sdcaudit, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
 277             - { name: sdcartifact, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
 278             - { name: sdccomponent, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
 279             - { name: sdcrepository, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
 280
 281     # Application-specific settings of ES
 282     elasticSearch:
 283
 284         # Mapping of index prefix to time-based frame. For example, if below is configured:
 285         #
 286         # - indexPrefix: auditing events
 287         #    creationPeriod: minute
 288         #
 289         # then ES object of type which is mapped to "auditingevents-*" template, and created on 2015-12-23 13:24:54, will enter "auditingevents-2015-12-23-13-24" index.
 290         # Another object created on 2015-12-23 13:25:54, will enter "auditingevents-2015-12-23-13-25" index.
 291         # If creationPeriod: month, both of the above will enter "auditingevents-2015-12" index.
 292         #
 293         # PLEASE NOTE: the timestamps are created in UTC/GMT timezone! This is needed so that timestamps will be correctly presented in Kibana.
 294         #
 295         # Legal values for creationPeriod - year, month, day, hour, minute, none (meaning no time-based behaviour).
 296         #
 297         # If no creationPeriod is configured for indexPrefix, default behavour is creationPeriod: month.
 298         indicesTimeFrequency:
 299             - indexPrefix: auditingevents
 300               creationPeriod: month
 301             - indexPrefix: monitoring_events
 302               creationPeriod: month
 303
 304     # Artifact types placeholder
 305     artifactTypes:
 306         - CHEF
 307         - PUPPET
 308         - SHELL
 309         - YANG
 310         - YANG_XML
 311         - HEAT
 312         - BPEL
 313         - DG_XML
 314         - MURANO_PKG
 315         - WORKFLOW
 316         - NETWORK_CALL_FLOW
 317         - TOSCA_TEMPLATE
 318         - TOSCA_CSAR
 319         - AAI_SERVICE_MODEL
 320         - AAI_VF_MODEL
 321         - AAI_VF_MODULE_MODEL
 322         - AAI_VF_INSTANCE_MODEL
 323         - OTHER
 324         - SNMP_POLL
 325         - SNMP_TRAP
 326         - GUIDE
 327         - PLAN
 328
 329     # License types placeholder
 330     licenseTypes:
 331         - User
 332         - Installation
 333         - CPU
 334
 335     # Resource types placeholder
 336     resourceTypes: &allResourceTypes
 337         - VFC
 338         - CP
 339         - VL
 340         - VF
 341         - VFCMT
 342         - Abstract
 343         - CVFC
 344
 345     #Deployment resource artifacts placeHolder
 346     deploymentResourceArtifacts:
 347
 348     # Deployment resource instance artifacts placeholders
 349     # For each artifact the following properties exists:
 350     #
 351     # displayName - The display name of the artifact
 352     # type - The type of the artifact
 353     # description - The description of the artifact
 354     # fileExtension - The file extension of the artifact file for uploading
 355     deploymentResourceInstanceArtifacts:
 356         heatEnv:
 357             displayName: "HEAT ENV"
 358             type: HEAT_ENV
 359             description: "Auto-generated HEAT Environment deployment artifact"
 360             fileExtension: "env"
 361         VfHeatEnv:
 362             displayName: "VF HEAT ENV"
 363             type: HEAT_ENV
 364             description: "VF Auto-generated HEAT Environment deployment artifact"
 365             fileExtension: "env"
 366
 367     # Tosca artifacts placeholders
 368     # For each artifact there is a template and a scar.
 369     # For each one the following properties exists:
 370     #
 371     # artifactName - The suffix of the artifact file
 372     # displayName - The display name of the artifact
 373     # type - The type of the artifact
 374     # description - The description of the artifact
 375     toscaArtifacts:
 376         assetToscaTemplate:
 377             artifactName: -template.yml
 378             displayName: Tosca Template
 379             type: TOSCA_TEMPLATE
 380             description: TOSCA representation of the asset
 381         assetToscaCsar:
 382             artifactName: -csar.csar
 383             displayName: Tosca Model
 384             type: TOSCA_CSAR
 385             description: TOSCA definition package of the asset
 386
 387     # Resource category to exclude
 388     excludeResourceCategory:
 389         - Generic
 390
 391     # Resource type to exclude
 392     excludeResourceType:
 393         - PNF
 394
 395     # Informational resource artifacts placeHolder
 396     # For each artifact the following properties exists:
 397     #
 398     # displayName - The display name of the artifact
 399     # type - The type of the artifact
 400     informationalResourceArtifacts:
 401         features:
 402             displayName: Features
 403             type: OTHER
 404     capacity:
 405         displayName: Capacity
 406         type: OTHER
 407     vendorTestResult:
 408         displayName: Vendor Test Result
 409         type: OTHER
 410     testScripts:
 411         displayName: Test Scripts
 412         type: OTHER
 413     CloudQuestionnaire:
 414         displayName: Cloud Questionnaire (completed)
 415         type: OTHER
 416     HEATTemplateFromVendor:
 417         displayName: HEAT Template from Vendor
 418         type: HEAT
 419     resourceSecurityTemplate:
 420         displayName: Resource Security Template
 421         type: OTHER
 422
 423     # Service category to exclude
 424     excludeServiceCategory:
 425
 426     # Informational service artifacts placeHolder
 427     # For each artifact the following properties exists:
 428     #
 429     # displayName - The display name of the artifact
 430     # type - The type of the artifact
 431     informationalServiceArtifacts:
 432         serviceArtifactPlan:
 433             displayName: Service Artifact Plan
 434             type: OTHER
 435         summaryOfImpactsToECOMPElements:
 436             displayName: Summary of impacts to ECOMP elements,OSSs, BSSs
 437             type: OTHER
 438         controlLoopFunctions:
 439             displayName: Control Loop Functions
 440             type: OTHER
 441         dimensioningInfo:
 442             displayName: Dimensioning Info
 443             type: OTHER
 444         affinityRules:
 445             displayName: Affinity Rules
 446             type: OTHER
 447         operationalPolicies:
 448             displayName: Operational Policies
 449             type: OTHER
 450         serviceSpecificPolicies:
 451             displayName: Service-specific Policies
 452             type: OTHER
 453         engineeringRules:
 454             displayName: Engineering Rules (ERD)
 455             type: OTHER
 456         distributionInstructions:
 457             displayName: Distribution Instructions
 458             type: OTHER
 459         certificationTestResults:
 460             displayName: TD Certification Test Results
 461             type: OTHER
 462         deploymentVotingRecord:
 463             displayName: Deployment Voting Record
 464             type: OTHER
 465         serviceQuestionnaire:
 466             displayName: Service Questionnaire
 467             type: OTHER
 468         serviceSecurityTemplate:
 469             displayName: Service Security Template
 470             type: OTHER
 471
 472     # Service api artifacts placeHolder
 473     # For each artifact the following properties exists:
 474     #
 475     # displayName - The display name of the artifact
 476     # type - The type of the artifact
 477     serviceApiArtifacts:
 478         configuration:
 479             displayName: Configuration
 480             type: OTHER
 481         instantiation:
 482             displayName: Instantiation
 483             type: OTHER
 484         monitoring:
 485             displayName: Monitoring
 486             type: OTHER
 487         reporting:
 488             displayName: Reporting
 489             type: OTHER
 490         logging:
 491             displayName: Logging
 492             type: OTHER
 493         testing:
 494             displayName: Testing
 495             type: OTHER
 496
 497     # The maximum number of keys permitted for additional information on service
 498     additionalInformationMaxNumberOfKeys: 50
 499
 500     # Collect process statistics
 501     systemMonitoring:
 502
 503         # Should monitoring be enabled
 504         enabled: false
 505
 506         # In case of going through the FE server proxy the information to the BE
 507         isProxy: false
 508
 509         # What is the interval of the statistics collection
 510         probeIntervalInSeconds: 15
 511
 512     defaultHeatArtifactTimeoutMinutes: 60
 513
 514     # Service deployment artifacts placeHolder
 515     # For each artifact the following properties exists:
 516     #
 517     # acceptedTypes - File types that can be uploaded as each artifact
 518     serviceDeploymentArtifacts:
 519         YANG_XML:
 520             acceptedTypes:
 521                 - xml
 522         VNF_CATALOG:
 523             acceptedTypes:
 524                 - xml
 525         MODEL_INVENTORY_PROFILE:
 526             acceptedTypes:
 527                 - xml
 528         MODEL_QUERY_SPEC:
 529             acceptedTypes:
 530                 - xml
 531
 532     #AAI Artifacts
 533         AAI_SERVICE_MODEL:
 534             acceptedTypes:
 535                 - xml
 536         AAI_VF_MODULE_MODEL:
 537             acceptedTypes:
 538                 - xml
 539         AAI_VF_INSTANCE_MODEL:
 540             acceptedTypes:
 541                 - xml
 542         OTHER:
 543             acceptedTypes:
 544
 545     #PLAN
 546         PLAN:
 547             acceptedTypes:
 548                 - xml
 549
 550     # Resource deployment artifacts placeHolder
 551     # For each artifact the following properties exists:
 552     #
 553     # acceptedTypes - File types that can be uploaded as each artifact
 554     # validForRespurceTypes - Resource types that support each artifact.
 555     # If left empty it means all resource types are valid
 556     resourceDeploymentArtifacts:
 557         HEAT:
 558             acceptedTypes:
 559                 - yaml
 560                 - yml
 561             validForResourceTypes: *allResourceTypes
 562         HEAT_VOL:
 563             acceptedTypes:
 564                 - yaml
 565                 - yml
 566             validForResourceTypes: *allResourceTypes
 567         HEAT_NET:
 568             acceptedTypes:
 569                 - yaml
 570                 - yml
 571             validForResourceTypes: *allResourceTypes
 572         HEAT_NESTED:
 573             acceptedTypes:
 574                 - yaml
 575                 - yml
 576             validForResourceTypes: *allResourceTypes
 577         HEAT_ARTIFACT:
 578             acceptedTypes:
 579             validForResourceTypes: *allResourceTypes
 580         YANG_XML:
 581             acceptedTypes:
 582                 - xml
 583             validForResourceTypes: *allResourceTypes
 584         VNF_CATALOG:
 585             acceptedTypes:
 586                 - xml
 587             validForResourceTypes: *allResourceTypes
 588         VF_LICENSE:
 589             acceptedTypes:
 590                 - xml
 591             validForResourceTypes: *allResourceTypes
 592         VENDOR_LICENSE:
 593             acceptedTypes:
 594                 - xml
 595             validForResourceTypes: *allResourceTypes
 596         MODEL_INVENTORY_PROFILE:
 597             acceptedTypes:
 598                 - xml
 599             validForResourceTypes: *allResourceTypes
 600         MODEL_QUERY_SPEC:
 601             acceptedTypes:
 602                 - xml
 603             validForResourceTypes: *allResourceTypes
 604         LIFECYCLE_OPERATIONS:
 605             acceptedTypes:
 606                 - yaml
 607                 - yml
 608             validForResourceTypes:
 609                 - VF
 610                 - VFC
 611         VES_EVENTS:
 612             acceptedTypes:
 613                 - yaml
 614                 - yml
 615             validForResourceTypes: *allResourceTypes
 616         PERFORMANCE_COUNTER:
 617             acceptedTypes:
 618                 - csv
 619             validForResourceTypes: *allResourceTypes
 620         APPC_CONFIG:
 621             acceptedTypes:
 622             validForResourceTypes:
 623                 - VF
 624         DCAE_TOSCA:
 625             acceptedTypes:
 626                 - yml
 627                 - yaml
 628             validForResourceTypes:
 629                 - VF
 630                 - VFCMT
 631         DCAE_JSON:
 632             acceptedTypes:
 633                 - json
 634             validForResourceTypes:
 635                 - VF
 636                 - VFCMT
 637         DCAE_POLICY:
 638             acceptedTypes:
 639                 - emf
 640             validForResourceTypes:
 641                 - VF
 642                 - VFCMT
 643         DCAE_DOC:
 644             acceptedTypes:
 645             validForResourceTypes:
 646                 - VF
 647                 - VFCMT
 648         DCAE_EVENT:
 649             acceptedTypes:
 650             validForResourceTypes:
 651                 - VF
 652                 - VFCMT
 653         AAI_VF_MODEL:
 654             acceptedTypes:
 655                 - xml
 656             validForResourceTypes:
 657                 - VF
 658         AAI_VF_MODULE_MODEL:
 659             acceptedTypes:
 660                 - xml
 661             validForResourceTypes:
 662                 - VF
 663         OTHER:
 664             acceptedTypes:
 665             validForResourceTypes: *allResourceTypes
 666         SNMP_POLL:
 667             acceptedTypes:
 668             validForResourceTypes: *allResourceTypes
 669         SNMP_TRAP:
 670             acceptedTypes:
 671             validForResourceTypes: *allResourceTypes
 672
 673     #PLAN
 674         PLAN:
 675             acceptedTypes:
 676                 - xml
 677             validForResourceTypes:
 678                 - VF
 679                 - VFC
 680
 681     # Resource instance deployment artifacts placeHolder
 682     # For each artifact the following properties exists:
 683     #
 684     # acceptedTypes - File types that can be uploaded as each artifact
 685     # validForRespurceTypes - Resource types that support each artifact.
 686     # If left empty it means all resource types are valid
 687     resourceInstanceDeploymentArtifacts:
 688         HEAT_ENV:
 689             acceptedTypes:
 690                 - env
 691         VF_MODULES_METADATA:
 692             acceptedTypes:
 693                 - json
 694         VES_EVENTS:
 695             acceptedTypes:
 696                 - yaml
 697                 - yml
 698         PERFORMANCE_COUNTER:
 699             acceptedTypes:
 700                 - csv
 701         DCAE_INVENTORY_TOSCA:
 702             acceptedTypes:
 703                 - yml
 704                 - yaml
 705         DCAE_INVENTORY_JSON:
 706             acceptedTypes:
 707                 - json
 708         DCAE_INVENTORY_POLICY:
 709           acceptedTypes:
 710                 - emf
 711         DCAE_INVENTORY_DOC:
 712           acceptedTypes:
 713         DCAE_INVENTORY_BLUEPRINT:
 714           acceptedTypes:
 715         DCAE_INVENTORY_EVENT:
 716           acceptedTypes:
 717         SNMP_POLL:
 718             acceptedTypes:
 719             validForResourceTypes: *allResourceTypes
 720         SNMP_TRAP:
 721             acceptedTypes:
 722             validForResourceTypes: *allResourceTypes
 723
 724     #PLAN
 725         PLAN:
 726             acceptedTypes:
 727                 - xml
 728
 729     # Resource informational artifacts placeHolder
 730     # For each artifact the following properties exists:
 731     #
 732     # acceptedTypes - File types that can be uploaded as each artifact
 733     # validForRespurceTypes - Resource types that support each artifact.
 734     # If left empty it means all resource types are valid
 735     resourceInformationalArtifacts:
 736         CHEF:
 737             acceptedTypes:
 738             validForResourceTypes: *allResourceTypes
 739         PUPPET:
 740             acceptedTypes:
 741             validForResourceTypes: *allResourceTypes
 742         SHELL:
 743             acceptedTypes:
 744             validForResourceTypes: *allResourceTypes
 745         YANG:
 746             acceptedTypes:
 747             validForResourceTypes: *allResourceTypes
 748         YANG_XML:
 749             acceptedTypes:
 750             validForResourceTypes: *allResourceTypes
 751         HEAT:
 752             acceptedTypes:
 753             validForResourceTypes: *allResourceTypes
 754         BPEL:
 755             acceptedTypes:
 756             validForResourceTypes: *allResourceTypes
 757         DG_XML:
 758             acceptedTypes:
 759             validForResourceTypes: *allResourceTypes
 760         MURANO_PKG:
 761             acceptedTypes:
 762             validForResourceTypes: *allResourceTypes
 763         OTHER:
 764             acceptedTypes:
 765             validForResourceTypes:
 766                 - VFC
 767                 - CVFC
 768                 - CP
 769                 - VL
 770                 - VF
 771                 - VFCMT
 772                 - Abstract
 773                 - PNF
 774         SNMP_POLL:
 775             acceptedTypes:
 776             validForResourceTypes: *allResourceTypes
 777         SNMP_TRAP:
 778             acceptedTypes:
 779             validForResourceTypes: *allResourceTypes
 780         GUIDE:
 781             acceptedTypes:
 782             validForResourceTypes:
 783                 - VF
 784                 - VFC
 785                 - CVFC
 786
 787     # Resource informational deployment artifact placeholder
 788     resourceInformationalDeployedArtifacts:
 789
 790     # Requirements needed to be fulfilled before certification
 791     requirementsToFulfillBeforeCert:
 792
 793     # Capabilities needed to be fulfilled before certification
 794     capabilitiesToConsumeBeforeCert:
 795
 796     # Urls that should not be logged
 797     unLoggedUrls:
 798        - /sdc2/rest/healthCheck
 799
 800     # When component is being set as deleted those are the clean configurations
 801     cleanComponentsConfiguration:
 802
 803         # The interval to check for deleted components to clean
 804         cleanIntervalInMinutes: 1440
 805
 806         # The components types to delete
 807         componentsToClean:
 808            - Resource
 809            - Service
 810
 811     # Deprecated. Will be removed in future releases
 812     artifactsIndex: resources
 813
 814     # Used to add header and footer to heatENV files generated by SDC
 815     heatEnvArtifactHeader: ""
 816     heatEnvArtifactFooter: ""
 817
 818     onboarding:
 819
 820         # Onboarding protocol
 821         protocol: http
 822
 823         # Onboarding backend hostname
 824         host: <%= @host_ip %>
 825
 826         # Onboarding backend http port
 827         port: <%= @catalog_port %>
 828
 829         # The url that being used when downloading CSARs
 830         downloadCsarUri: "/onboarding-api/v1.0/vendor-software-products/packages"
 831
 832         # Url for onboarding health check
 833         healthCheckUri: "/onboarding-api/v1.0/healthcheck"
 834
 835     dcae:
 836         # The ip of the onboarding docker
 837         host: <%= @dcae_be_vip %>
 838         # The protocol to use
 839         protocol: <https/http>
 840         # The port the docker is listening on
 841         port: <port>
 842         # The url of the health check to use
 843         healthCheckUri: "/dcae/healthCheck"
 844
 845
 846     #GSS IDNS
 847     # Switchover configuration is used for Geo redundancy to provide automatic failovers
 848     switchoverDetector:
 849         gBeFqdn:
 850         gFeFqdn:
 851         beVip: 1.2.3.4
 852         feVip: 1.2.3.4
 853         beResolveAttempts: 3
 854         feResolveAttempts: 3
 855         enabled: false
 856         interval: 60
 857         changePriorityUser: ecompasdc
 858         changePriorityPassword: ecompasdc123
 859         publishNetworkUrl:
 860         publishNetworkBody: '{"note":"comment"}'
 861         groups:
 862           beSet: { changePriorityUrl: "", changePriorityBody: '{"name":"","uri":"","no_ad_redirection":false,"v4groups":{"failover_groups":["","","failover_policy":["FAILALL"]},"comment":"","intended_app_proto":"DNS"}'}
 863           feSet: { changePriorityUrl: "", changePriorityBody: '{"name":"","uri":"","no_ad_redirection":false,"v4groups":{"failover_groups":["",""],"failover_policy":["FAILALL"]},"comment":"","intended_app_proto":"DNS"}'}
 864
 865     # Cache for datatypes. Improving run times for data type search
 866     applicationL1Cache:
 867         datatypes:
 868             enabled: true
 869             firstRunDelay: 10
 870             pollIntervalInSec: 60
 871
 872     # Deprecated. Will be removed in future releases
 873     applicationL2Cache:
 874         enabled: false
 875         catalogL1Cache:
 876             enabled: false
 877             resourcesSizeInCache: 300
 878             servicesSizeInCache: 200
 879             productsSizeInCache: 100
 880         queue:
 881             syncIntervalInSecondes: 43200
 882             waitOnShutDownInMinutes: 10
 883             numberOfCacheWorkers: 4
 884
 885     # Validators for Tosca properties
 886     toscaValidators:
 887         stringMaxLength: 2500
 888
 889     # Should audit be disabled
 890     disableAudit: false
 891
 892     # VF module validations properties
 893     vfModuleProperties:
 894         min_vf_module_instances:
 895             forBaseModule: 1
 896             forNonBaseModule: 0
 897         max_vf_module_instances:
 898             forBaseModule: 1
 899             forNonBaseModule:
 900         initial_count:
 901             forBaseModule: 1
 902             forNonBaseModule: 0
 903         vf_module_type:
 904             forBaseModule: Base
 905             forNonBaseModule: Expansion
 906
 907     # For each generic node type defining it's corresponding class
 908     genericAssetNodeTypes:
 909         VFC: org.openecomp.resource.abstract.nodes.VFC
 910         CVFC: org.openecomp.resource.abstract.nodes.VFC
 911         VF : org.openecomp.resource.abstract.nodes.VF
 912         PNF: org.openecomp.resource.abstract.nodes.PNF
 913         Service: org.openecomp.resource.abstract.nodes.service
 914     # tenant isolation configuration
 915     workloadContext: Production
 916     # tenant isolation configuration
 917     environmentContext:
 918         defaultValue: General_Revenue-Bearing
 919         validValues:
 920            - Critical_Revenue-Bearing
 921            - Vital_Revenue-Bearing
 922            - Essential_Revenue-Bearing
 923            - Important_Revenue-Bearing
 924            - Needed_Revenue-Bearing
 925            - Useful_Revenue-Bearing
 926            - General_Revenue-Bearing
 927            - Critical_Non-Revenue
 928            - Vital_Non-Revenue
 929            - Essential_Non-Revenue
 930            - Important_Non-Revenue
 931            - Needed_Non-Revenue
 932            - Useful_Non-Revenue
 933            - General_Non-Revenue
 934     # tenant isolation configuration
 935     dmaapConsumerConfiguration:
 936         hosts: localhost:3905
 937         consumerGroup: sdc
 938         consumerId: mama
 939         timeoutMs: 15000
 940         limit: 1
 941         pollingInterval: 2
 942         topic: topic
 943         latitude: 32.109333
 944         longitude: 34.855499
 945         version: 1.0
 946         serviceName: localhost/events
 947         environment: TEST
 948         partner: BOT_R
 949         routeOffer: MR1
 950         protocol: https
 951         contenttype: application/json
 952         dme2TraceOn: true
 953         aftEnvironment: AFTUAT
 954         aftDme2ConnectionTimeoutMs: 15000
 955         aftDme2RoundtripTimeoutMs: 240000
 956         aftDme2ReadTimeoutMs: 50000
 957         dme2preferredRouterFilePath: DME2preferredRouter.txt
 958         timeLimitForNotificationHandleMs: 120000
 959         credential:
 960             username: user
 961             password:
 962     # tenant isolation configuration
 963     dmeConfiguration:
 964         dme2Search: DME2SEARCH
 965         dme2Resolve: DME2RESOLVE
 966     # definition for policies types that cannot by created by api
 967     excludedPolicyTypesMapping:
 968        # VF:
 969         #  - a.b.c
 970         #  - c.d.e
 971         #CR:
 972         #  - x.y.z
 973     # defanition for group types that cannot by created by api
 974     excludedGroupTypesMapping:
 975         CR:
 976            - org.openecomp.groups.VfModule
 977            - org.openecomp.groups.heat.HeatStack
 978            - tosca.groups.Root
 979         VF:
 980            - org.openecomp.groups.VfModule
 981            - org.openecomp.groups.heat.HeatStack
 982            - tosca.groups.Root
 983         Service:
 984            - org.openecomp.groups.VfModule
 985            - org.openecomp.groups.heat.HeatStack
 986            - tosca.groups.Root
 987
 988     healthStatusExclude:
 989        - DE
 990        - DMAPP
 991        - DCAE
 992
 993
 994 BE-distribution-engine-configuration.yaml
 995 *****************************************
 996
 997 ::
 998
 999     # UEB servers list
1000     uebServers:
1001         <% node['UEB']['fqdn'].each do |conn| -%>
1002             - <%= conn %>
1003         <% end -%>
1004
1005     # UEB public key
1006     uebPublicKey: <%= node['UEB']['PublicKey'] %>
1007
1008     # UEB secret key
1009     uebSecretKey: <%= node['UEB']['SecretKey'] %>
1010
1011     # Topic name for receiving distribution notification
1012     distributionNotifTopicName:  SDC-DISTR-NOTIF-TOPIC
1013
1014     # Topic name for distribution status
1015     distributionStatusTopicName: SDC-DISTR-STATUS-TOPIC
1016
1017     # Distribution initialization retry interval time
1018     initRetryIntervalSec: 5
1019
1020     # Distribution initialization maximum interval time
1021     initMaxIntervalSec: 60
1022
1023     # Deprecated. Will be removed in future releases
1024     distribNotifServiceArtifactTypes:
1025         info:
1026             - MURANO-PKG
1027
1028     # Deprecated. Will be removed in future releases
1029     distribNotifResourceArtifactTypes:
1030         lifecycle:
1031             - HEAT
1032             - DG-XML
1033
1034     # Distribution environments
1035     environments:
1036         - <%= node.chef_environment %>
1037
1038     distributionStatusTopic:
1039
1040         # Distribution status polling interval
1041         pollingIntervalSec: 60
1042
1043         # Distribution status fetch time
1044         fetchTimeSec: 15
1045
1046         # Distribution status consumer group
1047         consumerGroup: sdc-<%= node.chef_environment %>
1048
1049         # Distribution status consumer id
1050         consumerId: sdc-<%= node.chef_environment %>1
1051
1052     distributionNotificationTopic:
1053
1054         # Minimum pool size for distribution notifications
1055         minThreadPoolSize: 0
1056
1057         # Maximum pool size for distribution notifications
1058         maxThreadPoolSize: 10
1059
1060         # Maximum waiting time after sending a notification
1061         maxWaitingAfterSendingSeconds: 5
1062
1063     # Deprecated. Will be removed in future releases
1064     createTopic:
1065         partitionCount: 1
1066         replicationCount: 1
1067
1068     # STarting the distribution engine
1069     startDistributionEngine: true
1070
1071     #This is false by default, since ONAP Dmaap currently doesn't support https
1072     # Does https should be used with Dmaap
1073     useHttpsWithDmaap: false
1074     opEnvRecoveryIntervalSec: 180
1075     allowedTimeBeforeStaleSec: 300
1076     # aai configuration for tenant isolation
1077     aaiConfig:
1078        httpRequestConfig:
1079           serverRootUrl: https://aai-uint3.test.att.com:8443
1080           resourceNamespaces:
1081              operationalEnvironments: /aai/v12/cloud-infrastructure/operational-environments
1082
1083        httpClientConfig:
1084           timeouts:
1085              readTimeoutMs: 5000
1086              connectTimeoutMs: 1000
1087           clientCertificate:
1088              keyStore: /opt/app/jetty/base/be/etc/non-prod.jks
1089              keyStorePassword: hmXYcznAljMSisdy8zgcag==
1090           headers:
1091              X-FromAppId: asdc
1092           numOfRetries: 3
1093     # mso configuration for tenant isolation
1094     msoConfig:
1095        httpRequestConfig:
1096           serverRootUrl: http://127.0.0.1:8080/onap/mso/infra/modelDistributions/v1
1097           resourceNamespaces:
1098              distributions: /distributions
1099
1100        httpClientConfig:
1101            timeouts:
1102               readTimeoutMs: 2000
1103               connectTimeoutMs: 500
1104            basicAuthorization:
1105               userName: asdc
1106               password: OTLEp5lfVhYdyw5EAtTUBQ==
1107            numOfRetries: 3
1108
1109     currentArtifactInstallationTimeout: 120
1110
1111 BE-titan.properties
1112 *******************
1113
1114 ::
1115
1116     # Titan storage backend
1117     storage.backend=cassandra
1118
1119     # Titan storage hostname
1120     storage.hostname=<%= @CASSANDRA_IP %>
1121
1122     # Titan storage port]
1123     storage.port=9160
1124
1125     # Titan storage username
1126     storage.username=<%= @CASSANDRA_USR %>
1127
1128     # Titan storage password
1129     storage.password=<%= @CASSANDRA_PWD %>
1130
1131     # Titan storage connection timeout
1132     storage.connection-timeout=10000
1133
1134     # Titan cassandra keyspace name
1135     storage.cassandra.keyspace=sdctitan
1136
1137     # Is Titan cassandra ssl is enabled
1138     storage.cassandra.ssl.enabled=false
1139
1140     # Titan cassandra ssl truststore file location
1141     storage.cassandra.ssl.truststore.location=/var/lib/jetty/config/.truststore
1142
1143     # Titan cassandra ssl truststore file password
1144     storage.cassandra.ssl.truststore.password=Aa123456
1145
1146     # Does titan should use cache
1147     cache.db-cache = false
1148
1149     # How long in milliseconds should the cache keep entries before flushing them
1150     cache.db-cache-clean-wait = 20
1151
1152     # Default expiration time in milliseconds for entries in the cache
1153     cache.db-cache-time = 180000
1154
1155     # Size of titan database cache
1156     cache.db-cache-size = 0.5
1157
1158     # Titan cassandra read consistency level
1159     storage.cassandra.read-consistency-level=LOCAL_QUORUM
1160
1161     # Titan cassandra write consistency level
1162     storage.cassandra.write-consistency-level=LOCAL_QUORUM
1163
1164     # Titan cassandra replication strategy class name
1165     storage.cassandra.replication-strategy-class=org.apache.cassandra.locator.NetworkTopologyStrategy
1166
1167     # Titan cassandra replication startegy options
1168     storage.cassandra.replication-strategy-options=<%= @DC_NAME %>,<%= @rep_factor %>
1169
1170     # Titan cassandra local data center name
1171     storage.cassandra.astyanax.local-datacenter=<%= @DC_NAME %>
1172
1173     # Number of times the system attempts to acquire a lock before giving up and throwing an exception
1174     storage.lock.retries=5
1175
1176     # Number of milliseconds the system waits for a lock application to be acknowledged by the storage backend
1177     storage.lock.wait-time=500
1178
1179
1180 Onboarding configuration
1181 ------------------------
1182
1183 BE-onboarding-configuration.yaml
1184 ********************************
1185
1186 ::
1187
1188     notifications:
1189
1190         # Backend onboarding notifications polling interval in milliseconds
1191         pollingIntervalMsec: 2000
1192
1193         # Backend onboarding notifications selection size
1194         selectionSize: 100
1195
1196         # Backend onboarding notifications backend hostname
1197         beHost: <%= @catalog_ip %>
1198
1199         # Backend onboarding notifications backend http port
1200         beHttpPort: <%= @catalog_port %>
1201     # Casandra configuration
1202     cassandraConfig:
1203         cassandraHosts: [<%= @cassandra_ip %>]
1204         localDataCenter: <%= @DC_NAME %>
1205         reconnectTimeout : 30000
1206         socketReadTimeout: <%= @socket_read_timeout %>
1207         socketConnectTimeout: <%= @socket_connect_timeout %>
1208         authenticate: true
1209         username: <%= @cassandra_usr %>
1210         password: <%= @cassandra_pwd %>
1211         ssl: <%= @cassandra_ssl_enabled %>
1212         truststorePath: /config/truststore
1213         truststorePassword: <%= @cassandra_truststore_password %>
1214
1215
1216 vnfrepo-configuration.yaml
1217 **************************
1218
1219 ::
1220
1221     # The port on which the vnfsdk is licensing on
1222     vnfRepoPort: <port>
1223     # The ip where vnfdk is deployed
1224     vnfRepoHost: <ip>
1225     # The url used for querying the vnf sdk for available CSARS
1226     getVnfUri: /onapapi/vnfsdk-marketplace/v1/PackageResource/csars
1227     # The url used for downloading the the CSAR from vnf sdk
1228     downloadVnfUri: /onapapi/vnfsdk-marketplace/v1/PackageResource/csars/%s/files
1229
1230
1231
1232 Frontend Configuration
1233 ======================
1234 Catalog configuration
1235 ---------------------
1236
1237 FE-configuration.yaml
1238 *********************
1239
1240 ::
1241
1242     # Catalog frontend hostname
1243     feFqdn: <%= @fe_host_ip %>
1244
1245     # Catalog backend hostname
1246     beHost: <%= @be_host_ip %>
1247
1248     # Catalog backend http port
1249     beHttpPort: <%= @catalog_port %>
1250
1251     # Catalog backend http context
1252     beContext: /sdc2/rest/v1/catalog/upload/resources
1253
1254     # Catalog backend protocol
1255     beProtocol: http
1256
1257     # Catalog backend ssl port
1258     beSslPort: <%= @ssl_port %>
1259
1260     # Threadpool size for handling requests
1261     threadpoolSize: 50
1262
1263     # Request processing timeout (seconds)
1264     requestTimeout: 10
1265
1266     # Health check timeout in milliseconds
1267     healthCheckSocketTimeoutInMs: 5000
1268
1269     # Health check inteval in seconds
1270     healthCheckIntervalInSeconds: 5
1271
1272     onboarding:
1273
1274         # Onboarding protocol
1275         protocol: http
1276
1277         # Onboarding frontend hostname
1278         host: <%= @fe_host_ip %>
1279
1280         # Onboarding frontend port
1281         port: 8181
1282
1283         # Onboarding frontend health check url
1284         healthCheckUri: "/onboarding/v1.0/healthcheck"
1285
1286     # Request headers for identification of the user that made the request
1287     identificationHeaderFields:
1288         -
1289             - &HTTP_IV_USER HTTP_IV_USER
1290             - &iv-user iv-user
1291         -
1292             - &USER_ID USER_ID
1293             - &user-id user-id
1294         -
1295             - &HTTP_CSP_ATTUID HTTP_CSP_ATTUID
1296             - &csp-attuid csp-attuid
1297         -
1298             - &HTTP_CSP_WSTYPE HTTP_CSP_WSTYPE
1299             - &csp-wstype csp-wstype
1300
1301     # Optional request headers
1302     optionalHeaderFields:
1303         -
1304             - &HTTP_CSP_FIRSTNAME HTTP_CSP_FIRSTNAME
1305             - &csp-firstname csp-firstname
1306         -
1307             - &HTTP_CSP_LASTNAME HTTP_CSP_LASTNAME
1308             - &csp-lastname csp-lastname
1309         -
1310             - &HTTP_IV_REMOTE_ADDRESS HTTP_IV_REMOTE_ADDRESS
1311             - &iv-remote-address iv-remote-address
1312         -
1313             - &HTTP_CSP_EMAIL HTTP_CSP_EMAIL
1314             - &csp-email csp-email
1315
1316     # Frontend configuration version
1317     version: 1.0
1318
1319     # Frontend configuration release date
1320     released: 2012-11-30
1321
1322     # Connection parameters
1323     connection:
1324         url: jdbc:mysql://localhost:3306/db
1325         poolSize: 17
1326
1327     # Protocols being used in SDC
1328     protocols:
1329         - http
1330         - https
1331
1332     # Collect process statistics
1333     systemMonitoring:
1334
1335         # Should monitoring be enabled
1336         enabled: false
1337
1338         # In case of going through the FE server proxy the information to the BE
1339         isProxy: true
1340
1341         # What is the interval of the statistics collection
1342         probeIntervalInSeconds: 15
1343
1344     # Kibana hostname
1345     kibanaHost: localhost
1346
1347     # Kibana http port
1348     kibanaPort: 5601
1349
1350     # Kibana usage protocol
1351     kibanaProtocol: http
1352
1353 Onboarding configuration
1354 ------------------------
1355
1356 FE-onboarding-configuration.yaml
1357 ********************************
1358
1359 ::
1360
1361     notifications:
1362
1363         # Frontend onboarding notifications polling interval in milliseconds
1364         pollingIntervalMsec: 2000
1365
1366         # Frontend onboarding notifications selection size
1367         selectionSize: 100
1368
1369         # Frontend onboarding notifications backend hostname
1370         beHost: <%= @catalog_ip %>
1371
1372         # Frontend onboarding notifications backend http port
1373         beHttpPort: <%= @catalog_port %>
1374
1375