Example shcm-service-config.yaml

# Service configuration for the Sh Cache Microservice
deployment-config:shcm-service-config:

    ##
    ## SAS Configuration
    ##
    sas-configuration:

        # Whether SAS is enabled ('true') or disabled ('false')
        enabled: false

#        # Parameters for connecting to SAS
#        sas-connection:
#            # List of SAS servers. Needs to be specified in a non-MDM deployment.
#            servers:
#                - 127.0.0.1
#
#            # SAS system type
#            system-type: ShCM


    ##
    ## Diameter Sh Configuration
    ##
    diameter-sh:

        # The origin realm to use when sending messages.
        origin-realm: opencloud.com

        # The value to use as the destination realm.
        destination-realm: opencloud

        # The HSS destination peers.
        destination-peers:
            - destination-hostname: hss.opencloud.com
              port: 3868
              protocol: aaa


    # The user identity that is put in the diameter message to the HSS when a health check is performed
    health-check.user-identity: sip:shcm-health-check@example.com

    ##
    ## Advanced settings - don't change unless specifically instructed
    ## by a Metaswitch engineer
    ##

    # The request timeout (ms) the Sh RA should use
    diameter.request-timeout: 5000

    ##
    ## Cassandra locking configuration
    ##
    cassandra-locking-configuration:

        # The time in milliseconds to wait before retrying to acquire the cassandra lock. Limited to 50-5000.
        backoff-time: 200

        # The number of times to retry to acquire the cassandra lock. Limited to 1-10.
        backoff-limit: 5

        # The time in milliseconds to hold the cassandra lock. Limited to 1000-30000.
        hold-time: 12000


    ##
    ## Caching strategy
    ## Every setting has both no-cache or simple-cache options, and for most settings
    ##   subscription-cache is also available.
    ##
    ##   no-cache:
    ##      The cache functionality will not be used; every read and write will
    ##      always query the HSS for the requested information. Subscription is
    ##      not applicable.
    ##   simple-cache:
    ##      Results from HSS queries will be cached. Updates will always write
    ##      through to the HSS. The cache will not receive updates from the HSS.
    ##   subscription-cache:
    ##      Results from HSS queries will be cached. Updates will always write
    ##      through to the HSS. ShCM will subscribe to data changes in the HSS and
    ##      cache entries will be updated if the data is modified in the HSS.
    ##
    ## Recommendation:
    ##   Don't change the default settings below.
    ##   However, some HSS's don't support subscriptions and for these simple-cache
    ##   should be used.
    ##
    ##   If a Cassandra database isn't available for caching then no-cache can be
    ##   used for test purposes.
    ##
    caching-configuration:

        ##
        ## Caching strategy: one of `no-cache, simple-cache, subscription-cache`
        ##
        service-indications:
            # Caching configuration for MMTel-Services
            - service-indication: mmtel-services
              cache-strategy: simple-cache
              cache-parameters:
                  cache-validity-time-seconds: 86400

            # Caching configuration for ims-odb-information
            - service-indication: ims-odb-information
              cache-strategy: subscription-cache
              cache-parameters:
                  cache-validity-time-seconds: 86400

            # Caching configuration for opencloud-3rd-party-registrar
            - service-indication: opencloud-3rd-party-registrar
              cache-strategy: subscription-cache
              cache-parameters:
                  cache-validity-time-seconds: 86400

            # Caching configuration for metaswitch-tas-services
            - service-indication: metaswitch-tas-services
              cache-strategy: subscription-cache
              cache-parameters:
                  cache-validity-time-seconds: 86400

        data-references-subscription-allowed:
            # Caching configuration for ims-public-identity
            -  data-reference: ims-public-identity
               cache-strategy: subscription-cache
               cache-parameters:
                   cache-validity-time-seconds: 86400

            # Caching configuration for s-cscfname
            -  data-reference: s-cscfname
               cache-strategy: subscription-cache
               cache-parameters:
                   cache-validity-time-seconds: 86400

            # Caching configuration for initial-filter-criteria
            -  data-reference: initial-filter-criteria
               cache-strategy: subscription-cache
               cache-parameters:
                   cache-validity-time-seconds: 86400

            # Caching configuration for service-level-trace-info
            -  data-reference: service-level-trace-info
               cache-strategy: subscription-cache
               cache-parameters:
                   cache-validity-time-seconds: 86400

            # Caching configuration for ip-address-secure-binding-information
            -  data-reference: ip-address-secure-binding-information
               cache-strategy: subscription-cache
               cache-parameters:
                   cache-validity-time-seconds: 86400

            # Caching configuration for service-priority-level
            -  data-reference: service-priority-level
               cache-strategy: subscription-cache
               cache-parameters:
                   cache-validity-time-seconds: 86400

            # Caching configuration for extended-priority
            -  data-reference: extended-priority
               cache-strategy: subscription-cache
               cache-parameters:
                   cache-validity-time-seconds: 86400


        ##
        ## Caching strategy: one of `no-cache, simple-cache`
        ##
        data-references-subscription-not-allowed:
            # Caching configuration for charging-information
            -  data-reference: charging-information
               cache-strategy: simple-cache
               cache-parameters:
                   cache-validity-time-seconds: 3600

            # Caching configuration for msisdn
            -  data-reference: msisdn
               cache-strategy: simple-cache
               cache-parameters:
                   cache-validity-time-seconds: 3600

            # Caching configuration for psi-activation
            -  data-reference: psiactivation
               cache-strategy: simple-cache
               cache-parameters:
                   cache-validity-time-seconds: 3600

            # Caching configuration for dsai
            -  data-reference: dsai
               cache-strategy: simple-cache
               cache-parameters:
                   cache-validity-time-seconds: 3600

            # Caching configuration for sms-registration-info
            -  data-reference: sms-registration-info
               cache-strategy: simple-cache
               cache-parameters:
                   cache-validity-time-seconds: 3600

            # Caching configuration for tads-information
            -  data-reference: tads-information
               cache-strategy: simple-cache
               cache-parameters:
                   cache-validity-time-seconds: 3600

            # Caching configuration for stn-sr
            -  data-reference: stn-sr
               cache-strategy: simple-cache
               cache-parameters:
                   cache-validity-time-seconds: 3600

            # Caching configuration for ue-srvcc-capability
            -  data-reference: ue-srvcc-capability
               cache-strategy: simple-cache
               cache-parameters:
                   cache-validity-time-seconds: 3600

            # Caching configuration for csrn
            -  data-reference: csrn
               cache-strategy: simple-cache
               cache-parameters:
                   cache-validity-time-seconds: 3600

            # Caching configuration for reference-location-information
            -  data-reference: reference-location-information
               cache-strategy: simple-cache
               cache-parameters:
                   cache-validity-time-seconds: 3600