Skip to content

ServiceMeshProps

Properties for defining a ServiceMesh.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-asm-servicemesh

Initializer 

import { ServiceMeshProps } from '@alicloud/ros-cdk-asm'
const serviceMeshProps: ServiceMeshProps = { ... }

Properties

Name Type Description
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The ID of the virtual private cloud (VPC).
vSwitches any[] | @alicloud/ros-cdk-core.IResolvable Property vSwitches: The ID of the vSwitch, eg: ["vsw-xzegf5dndkbf4m6eg****"].
apiServerPublicEip boolean | @alicloud/ros-cdk-core.IResolvable Property apiServerPublicEip: Specifies whether to expose the API server to the Internet.
auditProject string | @alicloud/ros-cdk-core.IResolvable Property auditProject: The name of the Log Service project that is used for mesh audit.
customizedZipkin boolean | @alicloud/ros-cdk-core.IResolvable Property customizedZipkin: Specifies whether to use a user-created Zipkin system.
enableAudit boolean | @alicloud/ros-cdk-core.IResolvable Property enableAudit: Specifies whether to enable the mesh audit feature.
includeIpRanges string | @alicloud/ros-cdk-core.IResolvable Property includeIpRanges: The Classless Inter-Domain Routing (CIDR) block in the ASM instance that are denied to access external services.
istioVersion string | @alicloud/ros-cdk-core.IResolvable Property istioVersion: The Istio version of the ASM instance.
localityLoadBalancing boolean | @alicloud/ros-cdk-core.IResolvable Property localityLoadBalancing: Specifies whether to route traffic to the nearest instance.
name string | @alicloud/ros-cdk-core.IResolvable Property name: The name of the ASM instance.
opa @alicloud/ros-cdk-core.IResolvable | OPAProperty Property opa: OPA settings.
outboundTrafficPolicy string | @alicloud/ros-cdk-core.IResolvable Property outboundTrafficPolicy: The outbound traffic policy of the ASM instance.
pilotPublicEip boolean | @alicloud/ros-cdk-core.IResolvable Property pilotPublicEip: Specifies whether to expose Istio Pilot to the Internet.
proxy @alicloud/ros-cdk-core.IResolvable | ProxyProperty Property proxy: Proxy settings.
telemetry boolean | @alicloud/ros-cdk-core.IResolvable Property telemetry: Specifies whether to enable Prometheus monitoring.
traceSampling number | @alicloud/ros-cdk-core.IResolvable Property traceSampling: The sampling percentage of tracing.
tracing boolean | @alicloud/ros-cdk-core.IResolvable Property tracing: Specifies whether to enable the tracing feature.

vpcIdRequired 

public readonly vpcId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vpcId: The ID of the virtual private cloud (VPC).

vSwitchesRequired 

public readonly vSwitches: any[] | IResolvable;
  • Type: any[] | @alicloud/ros-cdk-core.IResolvable

Property vSwitches: The ID of the vSwitch, eg: ["vsw-xzegf5dndkbf4m6eg****"].

apiServerPublicEipOptional 

public readonly apiServerPublicEip: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property apiServerPublicEip: Specifies whether to expose the API server to the Internet.

Valid values: true and false. Default value: false. If you do not set this parameter, the API server of clusters added to the ASM instance cannot be accessed from the Internet.

auditProjectOptional 

public readonly auditProject: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property auditProject: The name of the Log Service project that is used for mesh audit.

Default value: mesh-log-{meshId}.

customizedZipkinOptional 

public readonly customizedZipkin: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property customizedZipkin: Specifies whether to use a user-created Zipkin system.

enableAuditOptional 

public readonly enableAudit: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableAudit: Specifies whether to enable the mesh audit feature.

To enable this feature, make sure that you have activated Alibaba Cloud Log Service. Valid values: true and false. Default value: false.

includeIpRangesOptional 

public readonly includeIpRanges: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property includeIpRanges: The Classless Inter-Domain Routing (CIDR) block in the ASM instance that are denied to access external services.

istioVersionOptional 

public readonly istioVersion: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property istioVersion: The Istio version of the ASM instance.

localityLoadBalancingOptional 

public readonly localityLoadBalancing: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property localityLoadBalancing: Specifies whether to route traffic to the nearest instance.

Valid values: true and false. Default value: false.

nameOptional 

public readonly name: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property name: The name of the ASM instance.

opaOptional 

public readonly opa: IResolvable | OPAProperty;
  • Type: @alicloud/ros-cdk-core.IResolvable | OPAProperty

Property opa: OPA settings.

outboundTrafficPolicyOptional 

public readonly outboundTrafficPolicy: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property outboundTrafficPolicy: The outbound traffic policy of the ASM instance.

pilotPublicEipOptional 

public readonly pilotPublicEip: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property pilotPublicEip: Specifies whether to expose Istio Pilot to the Internet.

Valid values: true and false. Default value: false. If you do not set this parameter, only clusters in the same VPC as the ASM instance can access Istio Pilot of the instance.

proxyOptional 

public readonly proxy: IResolvable | ProxyProperty;

Property proxy: Proxy settings.

telemetryOptional 

public readonly telemetry: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property telemetry: Specifies whether to enable Prometheus monitoring.

We recommend that you use Application Real-Time Monitoring Service (ARMS).

traceSamplingOptional 

public readonly traceSampling: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property traceSampling: The sampling percentage of tracing.

tracingOptional 

public readonly tracing: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property tracing: Specifies whether to enable the tracing feature.

To enable this feature, make sure that you have activated Alibaba Cloud Tracing Analysis. Valid values: true and false. Default value: false.