All Products
Search
Document Center

Alibaba Cloud Service Mesh:UpdateNamespaceScopeSidecarConfig

Last Updated:Apr 03, 2024

Updates the configurations of sidecar proxies at the namespace level.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ServiceMeshIdstringYes

The ID of the ASM instance.

ca04bc38979214bf2882be79d39b4****
NamespacestringNo

The namespace for which you want to update the sidecar proxy configurations.

default
IncludeIPRangesstringNo

The range of IP addresses that are denied to access external services. (global.proxy.includelPRanges)

*
ExcludeIPRangesstringNo

The range of IP addresses that are allowed to access external services. (global.proxy.excludelPRanges)

172.16.0.0/12
IncludeInboundPortsstringNo

The port that the inbound traffic of the sidecar proxy passes through.

83
ExcludeOutboundPortsstringNo

The port that the outbound traffic of the sidecar proxy does not pass through.

81
ExcludeInboundPortsstringNo

The port that the inbound traffic of the sidecar proxy does not pass through.

82
IncludeOutboundPortsstringNo

The port that the outbound traffic of the sidecar proxy passes through.

84
TerminationDrainDurationstringNo

The maximum period of time that the sidecar proxy waits for a request to end.

6s
ProxyInitCPUResourceLimitstringNo

The maximum number of CPU cores that are available to the sidecar proxy init container.

2000 m
ProxyInitMemoryResourceLimitstringNo

The maximum size of memory that is available to the sidecar proxy init container.

50 Mi
ProxyInitCPUResourceRequeststringNo

The minimum number of CPU cores that are requested by the sidecar proxy init container.

60 m
ProxyInitMemoryResourceRequeststringNo

The minimum size of memory that is requested by the sidecar proxy init container.

30 Mi
SidecarProxyCPUResourceLimitstringNo

The maximum number of CPU cores that are available to the sidecar proxy container.

2000 m
SidecarProxyMemoryResourceLimitstringNo

The maximum size of memory that is available to the sidecar proxy container.

50 Mi
SidecarProxyCPUResourceRequeststringNo

The minimum number of CPU cores that are requested by the sidecar proxy container.

60 m
SidecarProxyMemoryResourceRequeststringNo

The minimum size of memory that is requested by the sidecar proxy container.

30 Mi
LifecyclestringNo

The lifecycle of the sidecar proxy.

{"postStart":{"exec":{"command":["pilot-agent","wait"]}},"preStop":{"exec":{"command":["/bin/sh","-c","sleep 15"]}}}
IstioDNSProxyEnabledbooleanNo

Specifies whether to enable the Domain Name System (DNS) proxy feature. Valid values:

  • true: The DNS proxy feature is enabled.
  • false: The DNS proxy feature is disabled.
true
PostStartstringNo

The post-start parameters of Istio Proxy.

{"exec":{"command":["pilot-agent","wait"]}}
PreStopstringNo

The pre-close parameters of Istio Proxy.

{"exec":{"command":["/bin/sh","-c","sleep 15"]}}
ConcurrencyintegerNo

The number of worker threads to run in Istio Proxy.

2
ProxyStatsMatcherstringNo

The monitoring metrics for data collected by Envoy proxies. The value is in the JSON format.

{ "inclusionPrefixes": [ "cluster.outbound", "cluster_manager", "listener_manager", "server", "cluster.xds-grpc" ], "inclusionRegexps": [ "listener.*.downstream_cx_total", "listener.*.downstream_cx_active" ] }
HoldApplicationUntilProxyStartsbooleanNo

Specifies whether applications can be started only after Istio Proxy starts. Valid values:

  • true: Applications can be started only after Istio Proxy starts.
  • false: Applications can be started before Istio Proxy starts.
true
LogLevelstringNo

The log level. Valid values: info, debug, tracing, and error.

info
TracingstringNo

The custom configurations of Tracing Analysis. The configurations must be serialized into JSON strings. The configurations contain the following parameters:

  • sampling: The sampling rate, which is of the DOUBLE type.

  • custom_tags: The custom tags added to reported spans, which are of the MAP type. The key of a tag is of the string type. The value of a tag is in the JSON format. A custom tag can belong to one of the following types:

    • literal: The tag value is a fixed value in the JSON format. This tag must contain the value field that specifies a literal. Example: {"value":"test"}.
    • header: The tag value is a request header in the JSON format. This tag must contain the name field and defaultValue field.The name field indicates the name of the request header. The defaultValue field indicates the default value that is used when no request header is available. Example: {"name":"test","defaultValue":"test"}.
    • environment: The tag value is an environment variable in the JSON format. This tag must contain the name field and defaultValue field. The name field indicates the name of the environment variable. The defaultValue field indicates the environment variable that is used when no environment variable is available. Example: {"name":"test","defaultValue":"test"}.
{"sampling":99.8,"custom_tags":{"test":{"literal":{"value":"testnamespace"}}}}
InterceptionModestringNo

The mode in which the sidecar proxy intercepts inbound traffic. Valid values:

  • REDIRECT: The sidecar proxy intercepts inbound traffic in the REDIRECT mode.
  • TPROXY: The sidecar proxy intercepts inbound traffic in the TPROXY mode.
TPROXY
ProxyMetadatastringNo

The environment variables that are added to a sidecar proxy. The environment variables are represented as JSON objects. The keys and values in the JSON objects represent the keys and values added to the environment variables of the sidecar proxy.

{"EXIT_ON_ZERO_ACTIVE_CONNECTIONS":"true"}
ProxyInitAckSloCPUResourceLimitstringNo

The maximum number of reclaimed CPU cores provided by Container Service for Kubernetes (ACK) that are available to the istio-init container. Reclaimed resources, including CPU cores and memory, are resources that can be dynamically overcommitted. This configuration item is used to set the maximum number of CPU cores that are available to the istio-init container in a pod labeled with koordinator.sh/qosClass. Unit: millicore.

2000
ProxyInitAckSloMemoryResourceLimitstringNo

The maximum size of reclaimed memory resources provided by ACK that are available to the istio-init container. This configuration item is used to set the maximum size of memory that is available to the istio-init container in a pod labeled with koordinator.sh/qosClass.

2048Mi
ProxyInitAckSloCPUResourceRequeststringNo

The minimum number of reclaimed CPU cores provided by ACK that the istio-init container requires at runtime. This configuration item is used to set the minimum number of reclaimed CPU cores for the istio-init container in a pod labeled with koordinator.sh/qosClass. Unit: millicore.

100
ProxyInitAckSloMemoryResourceRequeststringNo

The minimum size of reclaimed memory provided by ACK that the istio-init container requires at runtime. This configuration item is used to set the minimum size of reclaimed memory for the istio-init container in a pod labeled with koordinator.sh/qosClass.

128Mi
SidecarProxyAckSloCPUResourceLimitstringNo

The maximum number of reclaimed CPU cores provided by ACK that are available to the sidecar proxy container. This configuration item is used to set the maximum number of CPU cores that are available to the sidecar proxy container in a pod labeled with koordinator.sh/qosClass. Unit: millicore.

2000
SidecarProxyAckSloMemoryResourceLimitstringNo

The maximum size of reclaimed memory resources provided by ACK that are available to the sidecar proxy container. This configuration item is used to set the maximum size of memory that is available to the sidecar proxy container in a pod labeled with koordinator.sh/qosClass.

2048Mi
SidecarProxyAckSloCPUResourceRequeststringNo

The minimum number of reclaimed CPU cores provided by ACK that the sidecar proxy container requires at runtime. This configuration item is used to set the minimum number of reclaimed CPU cores for the sidecar proxy container in a pod labeled with koordinator.sh/qosClass. Unit: millicore.

100
SidecarProxyAckSloMemoryResourceRequeststringNo

The minimum size of reclaimed memory provided by ACK that the sidecar proxy container requires at runtime. This configuration item is used to set the minimum size of reclaimed memory for the sidecar proxy container in a pod labeled with koordinator.sh/qosClass.

128Mi
PrivilegedbooleanNo

Specifies whether to enable the privileged mode in the security context of the sidecar proxy containers. Valid values:

  • true: enables the privileged mode. This means that the sidecar proxy containers run in privileged mode.
  • false: does not enable the privileged mode.
false
EnableCoreDumpbooleanNo

Specifies whether to enable the core dump feature for the sidecar proxy containers. Valid values:

  • true
  • false
false
ReadinessInitialDelaySecondsintegerNo

The amount of time to wait before the first readiness check of a sidecar proxy container is performed. Unit: seconds.

1
ReadinessPeriodSecondsintegerNo

The interval between two readiness checks of a sidecar proxy container. Unit: seconds.

2
ReadinessFailureThresholdintegerNo

The number of readiness check failures required before marking a sidecar proxy container as not ready.

5

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

31d3a0f0-07ed-4f6e-9004-1804498c****

Examples

Sample success responses

JSONformat

{
  "RequestId": "31d3a0f0-07ed-4f6e-9004-1804498c****"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-08-31The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Privileged
    Added Input Parameters: EnableCoreDump
    Added Input Parameters: ReadinessInitialDelaySeconds
    Added Input Parameters: ReadinessPeriodSeconds
    Added Input Parameters: ReadinessFailureThreshold
2023-03-27The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ProxyInitAckSloCPUResourceLimit
    Added Input Parameters: ProxyInitAckSloMemoryResourceLimit
    Added Input Parameters: ProxyInitAckSloCPUResourceRequest
    Added Input Parameters: ProxyInitAckSloMemoryResourceRequest
    Added Input Parameters: SidecarProxyAckSloCPUResourceLimit
    Added Input Parameters: SidecarProxyAckSloMemoryResourceLimit
    Added Input Parameters: SidecarProxyAckSloCPUResourceRequest
    Added Input Parameters: SidecarProxyAckSloMemoryResourceRequest