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 vesrion
 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 persistency 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 helath 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 Cassnadra
 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: auditingevents
 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 permited 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 certificattion
 791     requirementsToFulfillBeforeCert:
 792
 793     # Capabillities needed to be fulfilled before certificattion
 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     dcae:
 835         # The ip of the onboarding docker
 836         host: <%= @dcae_be_vip %>
 837         # The protocol to use
 838         protocol: <https/http>
 839         # The port the docker is listening on
 840         port: <port>
 841         # The url of the health check to use
 842         healthCheckUri: "/dcae/healthCheck"
 843
 844
 845     #GSS IDNS
 846     # Switchover configuration is used for geo redundency to provide automatic failovers
 847     switchoverDetector:
 848         gBeFqdn:
 849         gFeFqdn:
 850         beVip: 1.2.3.4
 851         feVip: 1.2.3.4
 852         beResolveAttempts: 3
 853         feResolveAttempts: 3
 854         enabled: false
 855         interval: 60
 856         changePriorityUser: ecompasdc
 857         changePriorityPassword: ecompasdc123
 858         publishNetworkUrl:
 859         publishNetworkBody: '{"note":"comment"}'
 860         groups:
 861           beSet: { changePriorityUrl: "", changePriorityBody: '{"name":"","uri":"","no_ad_redirection":false,"v4groups":{"failover_groups":["","","failover_policy":["FAILALL"]},"comment":"","intended_app_proto":"DNS"}'}
 862           feSet: { changePriorityUrl: "", changePriorityBody: '{"name":"","uri":"","no_ad_redirection":false,"v4groups":{"failover_groups":["",""],"failover_policy":["FAILALL"]},"comment":"","intended_app_proto":"DNS"}'}
 863
 864     # Cache for datatypes. Improving run times for data type search
 865     applicationL1Cache:
 866         datatypes:
 867             enabled: true
 868             firstRunDelay: 10
 869             pollIntervalInSec: 60
 870
 871     # Deprecated. Will be removed in future releases
 872     applicationL2Cache:
 873         enabled: false
 874         catalogL1Cache:
 875             enabled: false
 876             resourcesSizeInCache: 300
 877             servicesSizeInCache: 200
 878             productsSizeInCache: 100
 879         queue:
 880             syncIntervalInSecondes: 43200
 881             waitOnShutDownInMinutes: 10
 882             numberOfCacheWorkers: 4
 883
 884     # Validators for tosca properties
 885     toscaValidators:
 886         stringMaxLength: 2500
 887
 888     # Should audit be disabled
 889     disableAudit: false
 890
 891     # VF module validations properties
 892     vfModuleProperties:
 893         min_vf_module_instances:
 894             forBaseModule: 1
 895             forNonBaseModule: 0
 896         max_vf_module_instances:
 897             forBaseModule: 1
 898             forNonBaseModule:
 899         initial_count:
 900             forBaseModule: 1
 901             forNonBaseModule: 0
 902         vf_module_type:
 903             forBaseModule: Base
 904             forNonBaseModule: Expansion
 905
 906     # For each generic node type defining it's coresponding class
 907     genericAssetNodeTypes:
 908         VFC: org.openecomp.resource.abstract.nodes.VFC
 909         CVFC: org.openecomp.resource.abstract.nodes.VFC
 910         VF : org.openecomp.resource.abstract.nodes.VF
 911         PNF: org.openecomp.resource.abstract.nodes.PNF
 912         Service: org.openecomp.resource.abstract.nodes.service
 913     # tenant isolation configuration
 914     workloadContext: Production
 915     # tenant isolation configuration
 916     environmentContext:
 917         defaultValue: General_Revenue-Bearing
 918         validValues:
 919            - Critical_Revenue-Bearing
 920            - Vital_Revenue-Bearing
 921            - Essential_Revenue-Bearing
 922            - Important_Revenue-Bearing
 923            - Needed_Revenue-Bearing
 924            - Useful_Revenue-Bearing
 925            - General_Revenue-Bearing
 926            - Critical_Non-Revenue
 927            - Vital_Non-Revenue
 928            - Essential_Non-Revenue
 929            - Important_Non-Revenue
 930            - Needed_Non-Revenue
 931            - Useful_Non-Revenue
 932            - General_Non-Revenue
 933     # tenant isolation configuration
 934     dmaapConsumerConfiguration:
 935         hosts: localhost:3905
 936         consumerGroup: sdc
 937         consumerId: mama
 938         timeoutMs: 15000
 939         limit: 1
 940         pollingInterval: 2
 941         topic: topic
 942         latitude: 32.109333
 943         longitude: 34.855499
 944         version: 1.0
 945         serviceName: localhost/events
 946         environment: TEST
 947         partner: BOT_R
 948         routeOffer: MR1
 949         protocol: https
 950         contenttype: application/json
 951         dme2TraceOn: true
 952         aftEnvironment: AFTUAT
 953         aftDme2ConnectionTimeoutMs: 15000
 954         aftDme2RoundtripTimeoutMs: 240000
 955         aftDme2ReadTimeoutMs: 50000
 956         dme2preferredRouterFilePath: DME2preferredRouter.txt
 957         timeLimitForNotificationHandleMs: 120000
 958         credential:
 959             username: user
 960             password:
 961     # tenant isolation configuration
 962     dmeConfiguration:
 963         dme2Search: DME2SEARCH
 964         dme2Resolve: DME2RESOLVE
 965     # definition for policys types that cannot by created by api
 966     excludedPolicyTypesMapping:
 967        # VF:
 968         #  - a.b.c
 969         #  - c.d.e
 970         #CR:
 971         #  - x.y.z
 972     # defanition for group types that cannot by created by api
 973     excludedGroupTypesMapping:
 974         CR:
 975            - org.openecomp.groups.VfModule
 976            - org.openecomp.groups.heat.HeatStack
 977            - tosca.groups.Root
 978         VF:
 979            - org.openecomp.groups.VfModule
 980            - org.openecomp.groups.heat.HeatStack
 981            - tosca.groups.Root
 982         Service:
 983            - org.openecomp.groups.VfModule
 984            - org.openecomp.groups.heat.HeatStack
 985            - tosca.groups.Root
 986
 987     healthStatusExclude:
 988        - DE
 989        - DMAPP
 990        - DCAE
 991
 992
 993 BE-distribution-engine-configuration.yaml
 994 *****************************************
 995
 996 ::
 997
 998     # UEB servers list
 999     uebServers:
1000         <% node['UEB']['fqdn'].each do |conn| -%>
1001             - <%= conn %>
1002         <% end -%>
1003
1004     # UEB public key
1005     uebPublicKey: <%= node['UEB']['PublicKey'] %>
1006
1007     # UEB secret key
1008     uebSecretKey: <%= node['UEB']['SecretKey'] %>
1009
1010     # Topic name for receiving distribution notification
1011     distributionNotifTopicName:  SDC-DISTR-NOTIF-TOPIC
1012
1013     # Topic name for distribution status
1014     distributionStatusTopicName: SDC-DISTR-STATUS-TOPIC
1015
1016     # Distibution initializtion retry interval time
1017     initRetryIntervalSec: 5
1018
1019     # Distribution initializtion maximum interval time
1020     initMaxIntervalSec: 60
1021
1022     # Deprecated. Will be removed in future releases
1023     distribNotifServiceArtifactTypes:
1024         info:
1025             - MURANO-PKG
1026
1027     # Deprecated. Will be removed in future releases
1028     distribNotifResourceArtifactTypes:
1029         lifecycle:
1030             - HEAT
1031             - DG-XML
1032
1033     # Distribution environments
1034     environments:
1035         - <%= node.chef_environment %>
1036
1037     distributionStatusTopic:
1038
1039         # Distribution status polling interval
1040         pollingIntervalSec: 60
1041
1042         # Distribution status fetch time
1043         fetchTimeSec: 15
1044
1045         # Distribution status consumer group
1046         consumerGroup: sdc-<%= node.chef_environment %>
1047
1048         # Distribution status consumer id
1049         consumerId: sdc-<%= node.chef_environment %>1
1050
1051     distributionNotificationTopic:
1052
1053         # Minimum pool size for distribution notifications
1054         minThreadPoolSize: 0
1055
1056         # Maximum pool size for distribution notifications
1057         maxThreadPoolSize: 10
1058
1059         # Maximum waiting time after sending a notification
1060         maxWaitingAfterSendingSeconds: 5
1061
1062     # Deprecated. Will be removed in future releases
1063     createTopic:
1064         partitionCount: 1
1065         replicationCount: 1
1066
1067     # STarting the distribution engine
1068     startDistributionEngine: true
1069
1070     #This is false by default, since ONAP Dmaap currently doesn't support https
1071     # Does https should be used with Dmaap
1072     useHttpsWithDmaap: false
1073     opEnvRecoveryIntervalSec: 180
1074     allowedTimeBeforeStaleSec: 300
1075     # aai configuration for tenant isolation
1076     aaiConfig:
1077        httpRequestConfig:
1078           serverRootUrl: https://aai-uint3.test.att.com:8443
1079           resourceNamespaces:
1080              operationalEnvironments: /aai/v12/cloud-infrastructure/operational-environments
1081
1082        httpClientConfig:
1083           timeouts:
1084              readTimeoutMs: 5000
1085              connectTimeoutMs: 1000
1086           clientCertificate:
1087              keyStore: /opt/app/jetty/base/be/etc/non-prod.jks
1088              keyStorePassword: hmXYcznAljMSisdy8zgcag==
1089           headers:
1090              X-FromAppId: asdc
1091           numOfRetries: 3
1092     # mso configuration for tenant isolation
1093     msoConfig:
1094        httpRequestConfig:
1095           serverRootUrl: http://127.0.0.1:8080/onap/mso/infra/modelDistributions/v1
1096           resourceNamespaces:
1097              distributions: /distributions
1098
1099        httpClientConfig:
1100            timeouts:
1101               readTimeoutMs: 2000
1102               connectTimeoutMs: 500
1103            basicAuthorization:
1104               userName: asdc
1105               password: OTLEp5lfVhYdyw5EAtTUBQ==
1106            numOfRetries: 3
1107
1108     currentArtifactInstallationTimeout: 120
1109
1110 BE-titan.properties
1111 *******************
1112
1113 ::
1114
1115     # Titan storage backend
1116     storage.backend=cassandra
1117
1118     # Titan storage hostname
1119     storage.hostname=<%= @CASSANDRA_IP %>
1120
1121     # Titan storage port]
1122     storage.port=9160
1123
1124     # Titan storage username
1125     storage.username=<%= @CASSANDRA_USR %>
1126
1127     # Titan storage password
1128     storage.password=<%= @CASSANDRA_PWD %>
1129
1130     # Titan storage connection timeout
1131     storage.connection-timeout=10000
1132
1133     # Titan cassandra keyspace name
1134     storage.cassandra.keyspace=sdctitan
1135
1136     # Is Titan cassandra ssl is enabled
1137     storage.cassandra.ssl.enabled=false
1138
1139     # Titan cassandra ssl truststore file location
1140     storage.cassandra.ssl.truststore.location=/var/lib/jetty/config/.truststore
1141
1142     # Titan cassandra ssl truststore file password
1143     storage.cassandra.ssl.truststore.password=Aa123456
1144
1145     # Does titan should use cache
1146     cache.db-cache = false
1147
1148     # How long in milliseconds should the cache keep entries before flushing them
1149     cache.db-cache-clean-wait = 20
1150
1151     # Default experation time in milliseconds for entries in the cache
1152     cache.db-cache-time = 180000
1153
1154     # Size of titan database cache
1155     cache.db-cache-size = 0.5
1156
1157     # Titan cassandra read consistency level
1158     storage.cassandra.read-consistency-level=LOCAL_QUORUM
1159
1160     # Titan cassandra write consistency level
1161     storage.cassandra.write-consistency-level=LOCAL_QUORUM
1162
1163     # Titan cassandra replication strategy class name
1164     storage.cassandra.replication-strategy-class=org.apache.cassandra.locator.NetworkTopologyStrategy
1165
1166     # Titan cassandra replication startegy options
1167     storage.cassandra.replication-strategy-options=<%= @DC_NAME %>,<%= @rep_factor %>
1168
1169     # Titan cassandra local data center name
1170     storage.cassandra.astyanax.local-datacenter=<%= @DC_NAME %>
1171
1172     # Number of times the system attempts to acquire a lock before giving up and throwing an exception
1173     storage.lock.retries=5
1174
1175     # Number of milliseconds the system waits for a lock application to be acknowledged by the storage backend
1176     storage.lock.wait-time=500
1177
1178
1179 Onboarding configuration
1180 ------------------------
1181
1182 BE-onboarding-configuration.yaml
1183 ********************************
1184
1185 ::
1186
1187     notifications:
1188
1189         # Backend onboarding notifications polling interval in milliseconds
1190         pollingIntervalMsec: 2000
1191
1192         # Backend onboarding notifications selection size
1193         selectionSize: 100
1194
1195         # Backend onboarding norifications backend hostname
1196         beHost: <%= @catalog_ip %>
1197
1198         # Backend onboarding notifications backend http port
1199         beHttpPort: <%= @catalog_port %>
1200     # Casandra configuration
1201     cassandraConfig:
1202         cassandraHosts: [<%= @cassandra_ip %>]
1203         localDataCenter: <%= @DC_NAME %>
1204         reconnectTimeout : 30000
1205         socketReadTimeout: <%= @socket_read_timeout %>
1206         socketConnectTimeout: <%= @socket_connect_timeout %>
1207         authenticate: true
1208         username: <%= @cassandra_usr %>
1209         password: <%= @cassandra_pwd %>
1210         ssl: <%= @cassandra_ssl_enabled %>
1211         truststorePath: /config/truststore
1212         truststorePassword: <%= @cassandra_truststore_password %>
1213
1214
1215 vnfrepo-configuration.yaml
1216 **************************
1217
1218 ::
1219
1220     # The port on which the vnfsdk is lisening on
1221     vnfRepoPort: <port>
1222     # The ip where vnfdk is deployed
1223     vnfRepoHost: <ip>
1224     # The url used for querying the vnf sdk for available CSARS
1225     getVnfUri: /onapapi/vnfsdk-marketplace/v1/PackageResource/csars
1226     # The url used for downloading the the CSAR from vnf sdk
1227     downloadVnfUri: /onapapi/vnfsdk-marketplace/v1/PackageResource/csars/%s/files
1228
1229
1230
1231 Frontend Configuration
1232 ======================
1233 Catalog configuration
1234 ---------------------
1235
1236 FE-configuration.yaml
1237 *********************
1238
1239 ::
1240
1241     # Catalog frontend hostname
1242     feFqdn: <%= @fe_host_ip %>
1243
1244     # Catalog backend hostname
1245     beHost: <%= @be_host_ip %>
1246
1247     # Catalog backend http port
1248     beHttpPort: <%= @catalog_port %>
1249
1250     # Catalog backend http context
1251     beContext: /sdc2/rest/v1/catalog/upload/resources
1252
1253     # Catalog backend protocol
1254     beProtocol: http
1255
1256     # Catalog backend ssl port
1257     beSslPort: <%= @ssl_port %>
1258
1259     # Threadpool size for handling requests
1260     threadpoolSize: 50
1261
1262     # Request processing timeout (seconds)
1263     requestTimeout: 10
1264
1265     # Health check timeout in milliseconds
1266     healthCheckSocketTimeoutInMs: 5000
1267
1268     # Health check inteval in seconds
1269     healthCheckIntervalInSeconds: 5
1270
1271     onboarding:
1272
1273         # Onboarding protocol
1274         protocol: http
1275
1276         # Onboarding frontend hostname
1277         host: <%= @fe_host_ip %>
1278
1279         # Onboarding frontend port
1280         port: 8181
1281
1282         # Onboarding frontend health check url
1283         healthCheckUri: "/onboarding/v1.0/healthcheck"
1284
1285     # Request headers for identification of the user that made the request
1286     identificationHeaderFields:
1287         -
1288             - &HTTP_IV_USER HTTP_IV_USER
1289             - &iv-user iv-user
1290         -
1291             - &USER_ID USER_ID
1292             - &user-id user-id
1293         -
1294             - &HTTP_CSP_ATTUID HTTP_CSP_ATTUID
1295             - &csp-attuid csp-attuid
1296         -
1297             - &HTTP_CSP_WSTYPE HTTP_CSP_WSTYPE
1298             - &csp-wstype csp-wstype
1299
1300     # Optional request headers
1301     optionalHeaderFields:
1302         -
1303             - &HTTP_CSP_FIRSTNAME HTTP_CSP_FIRSTNAME
1304             - &csp-firstname csp-firstname
1305         -
1306             - &HTTP_CSP_LASTNAME HTTP_CSP_LASTNAME
1307             - &csp-lastname csp-lastname
1308         -
1309             - &HTTP_IV_REMOTE_ADDRESS HTTP_IV_REMOTE_ADDRESS
1310             - &iv-remote-address iv-remote-address
1311         -
1312             - &HTTP_CSP_EMAIL HTTP_CSP_EMAIL
1313             - &csp-email csp-email
1314
1315     # Frontend configuration version
1316     version: 1.0
1317
1318     # Frontend configuration release date
1319     released: 2012-11-30
1320
1321     # Connection parameters
1322     connection:
1323         url: jdbc:mysql://localhost:3306/db
1324         poolSize: 17
1325
1326     # Protocols being used in SDC
1327     protocols:
1328         - http
1329         - https
1330
1331     # Collect process statistics
1332     systemMonitoring:
1333
1334         # Should monitoring be enabled
1335         enabled: false
1336
1337         # In case of going through the FE server proxy the information to the BE
1338         isProxy: true
1339
1340         # What is the interval of the statistics collection
1341         probeIntervalInSeconds: 15
1342
1343     # Kibana hostname
1344     kibanaHost: localhost
1345
1346     # Kibana http port
1347     kibanaPort: 5601
1348
1349     # Kibana usage protocol
1350     kibanaProtocol: http
1351
1352 Onboarding configuration
1353 ------------------------
1354
1355 FE-onboarding-configuration.yaml
1356 ********************************
1357
1358 ::
1359
1360     notifications:
1361
1362         # Frontend onboarding notifications polling interval in milliseconds
1363         pollingIntervalMsec: 2000
1364
1365         # Frontend onboarding notifications selection size
1366         selectionSize: 100
1367
1368         # Frontend onboarding norifications backend hostname
1369         beHost: <%= @catalog_ip %>
1370
1371         # Frontend onboarding notifications backend http port
1372         beHttpPort: <%= @catalog_port %>
1373
1374