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