Configuring SystemOptions

These options are used to control system behavior per service-wide. The user can configure SystemOptions by using the operations GET, and PUT.

Note:

Default systemOptions are provided during the installation of Service Communication Proxy through helm.

Table 3-9 provides SystemOptions for PUT operation.

Table 3-9 Configuring Parameters for SystemOptions

Operation Parameter Value Description Example
GET - - -
curl -X GET http://<Soothsayerfqdn>:8081/soothsayer/v1/systemoptions/{instanceId}
 
Response:
{
    "instanceId": "e33ac015-081a-4e25-99c1-d1d6c332246e",
    "cb_and_od_enabled": true,
    "trafficPolicy": {
      "connectionPool": {
        "http": {
          "http2MaxRequests": 1000
        }
      },
      "outlierDetection": {
        "consecutiveErrors": 5,
        "interval": "10s",
        "baseEjectionTime": "30s",
        "maxEjectionPercent": 100
      }
   }
}
PUT instanceId String Unique ID that represents SystemOption record Set the value of instanceId field in the curl command below instanceId UPDATE Command
curl -X PUT \
 http://<Soothsayerfqdn>:8081/soothsayer/v1/systemoptions \
 -H 'Content-Type: application/json' \
 -d '{
    "instanceId": "e33ac015-081a-4e25-99c1-d1d6c332246e",
    "cb_and_od_enabled": true,
    "trafficPolicy": {
      "connectionPool": {
        "http": {
          "http2MaxRequests": 1000
        }
      },
      "outlierDetection": {
        "consecutiveErrors": 5,
        "interval": "10s",
        "baseEjectionTime": "30s",
        "maxEjectionPercent": 100
      }
    }
  }'
cb_and_od_enabled Boolean Provides information whether the Circuit-Breaking and Outlier-Detection is enabled or not. Set the value of cb_and_od_enabled field in the curl command below cd_and_od_enabled UPDATE Command
curl -X PUT \
 http://<Soothsayerfqdn>:8081/soothsayer/v1/systemoptions \
 -H 'Content-Type: application/json' \
 -d '{
    "instanceId": "e33ac015-081a-4e25-99c1-d1d6c332246e",
    "cb_and_od_enabled": true,
    "trafficPolicy": {
      "connectionPool": {
        "http": {
          "http2MaxRequests": 1000
        }
      },
      "outlierDetection": {
        "consecutiveErrors": 5,
        "interval": "10s",
        "baseEjectionTime": "30s",
        "maxEjectionPercent": 100
      }
    }
  }'
trafficPolicy.connectionPool.http.http2MaxRequests Integer Maximum number of requests to a backend. Default is 1024. Set the value of http2MaxRequests field under trafficPolicy.connectionPool.http in the curl command. http2MaxRequests UPDATE Command
curl -X PUT \
 http://<Soothsayerfqdn>:8081/soothsayer/v1/systemoptions \
 -H 'Content-Type: application/json' \
 -d '{
    "instanceId": "e33ac015-081a-4e25-99c1-d1d6c332246e",
    "cb_and_od_enabled": true,
    "trafficPolicy": {
      "connectionPool": {
        "http": {
          "http2MaxRequests": 1000
        }
      },
      "outlierDetection": {
        "consecutiveErrors": 5,
        "interval": "10s",
        "baseEjectionTime": "30s",
        "maxEjectionPercent": 100
      }
    }
  }'