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

vpcId^Required

public readonly vpcId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

vSwitches^Required

public readonly vSwitches: any[] | IResolvable;

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

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

accessLogEnabled^Optional

public readonly accessLogEnabled: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property accessLogEnabled: Specifies whether to enable access log.

Valid values: - true: Enables access log. - false: Disables access log. Default value: false.

accessLogFile^Optional

public readonly accessLogFile: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property accessLogFile: Enable and disable access logs.

Value: - "" : Turn off access logs. - \/dev\/stdout: Enables access logging

accessLogFormat^Optional

public readonly accessLogFormat: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property accessLogFormat: The custom format of access logs.

This parameter is available only if you enable access log. The value must be a JSON string that contains the following keys: authority_for, bytes_received, bytes_sent, downstream_local_address, downstream_remote_address, duration, istio_policy_status, method, path, protocol, requested_server_name, response_code, response_flags, route_name, start_time, trace_id, upstream_cluster, upstream_host, upstream_local_address, upstream_service_time, upstream_transport_failure_reason, user_agent, and x_forwarded_for.

accessLogProject^Optional

public readonly accessLogProject: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property accessLogProject: The Log Service project for access logs.

accessLogServiceEnabled^Optional

public readonly accessLogServiceEnabled: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property accessLogServiceEnabled: Whether Envoy's gRPC logging service (ALS) is enabled.

Value: - true: Enables Envoy's gRPC logging service. - false: Envoy's gRPC logging service is not enabled. Default value: false

accessLogServiceHost^Optional

public readonly accessLogServiceHost: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property accessLogServiceHost: Address where Envoy's gRPC logging service (ALS) is enabled.

accessLogServicePort^Optional

public readonly accessLogServicePort: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property accessLogServicePort: Port on which Envoy's gRPC logging service (ALS) is enabled.

apiServerLoadBalancerSpec^Optional

public readonly apiServerLoadBalancerSpec: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property apiServerLoadBalancerSpec: CLB specification for the APIServer binding.

Value: Compact type I (slb.s1.small), Standard type I (slb.s2.small), Standard Type II (slb.s2.medium), high-order type I (slb.s3.small), high-order type II (slb.s3.medium), Super type I (slb.s3.large).

apiServerPublicEip^Optional

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.

auditProject^Optional

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}.

autoRenew^Optional

public readonly autoRenew: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property autoRenew: If CLB is annual and monthly, whether it will be automatically renewed.

Value: - true: Automatic renewal. - false: No automatic renewal.

autoRenewPeriod^Optional

public readonly autoRenewPeriod: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property autoRenewPeriod: This parameter is valid only if you set ChargeType to PrePay.

The auto-renewal period. If the subscription duration is less than one year, the value of this parameter indicates the number of months for which you want to renew the instance. If the subscription duration is more than one year, the value of this parameter indicates the number of years for which you want to renew the instance.

certChain^Optional

public readonly certChain: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property certChain: The certificate chain from CaCert to RootCert contains at least two certificates.

chargeType^Optional

public readonly chargeType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property chargeType: CLB payment type.

Value: - PayOnDemand: pay-as-you-go type - PrePay: Annual and monthly.

clusterSpec^Optional

public readonly clusterSpec: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property clusterSpec: Service grid instance specification, value: - standard: The standard version.

enterprise: Enterprise Edition - ultimate: ultimate.

configSourceEnabled^Optional

public readonly configSourceEnabled: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property configSourceEnabled: Whether to enable an external service registry.

Value: - true: Enables the external service registry. - false: The external service registry is not enabled. Default value: false

configSourceNacosId^Optional

public readonly configSourceNacosId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property configSourceNacosId: The Nacos ID for config source.

controlPlaneLogEnabled^Optional

public readonly controlPlaneLogEnabled: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property controlPlaneLogEnabled: Specifies whether to enable control plane log collection.

Valid values: - true: Enables control plane log collection. - false: Disables control plane log collection. Default value: false.

controlPlaneLogProject^Optional

public readonly controlPlaneLogProject: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property controlPlaneLogProject: The Log Service project for control plane logs.

crAggregationEnabled^Optional

public readonly crAggregationEnabled: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property crAggregationEnabled: Whether to enable Kubernetes API for data plane cluster to access Istio resources (ASM instance v1.9.7.93 or later). Value: - true: Enable data plane cluster Kubernetes API to access Istio resources. - false: Data plane cluster Kubernetes API is not enabled to access Istio resources. Default value: false.

customizedPrometheus^Optional

public readonly customizedPrometheus: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property customizedPrometheus: Specifies whether to use a self-managed Prometheus system.

Valid values: - true: Uses a self-managed Prometheus system. - false: Does not use a self-managed Prometheus system. Default value: false.

customizedZipkin^Optional

public readonly customizedZipkin: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property customizedZipkin: Specifies whether to use a self-managed Zipkin system.

Valid values: - true: Uses a self-managed Zipkin system. - false: Uses Tracing Analysis. Default value: false.

dnsProxyingEnabled^Optional

public readonly dnsProxyingEnabled: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property dnsProxyingEnabled: Specifies whether to enable DNS proxy.

Valid values: - true: Enables DNS proxy. - false: Disables DNS proxy. Default value: false.

dubboFilterEnabled^Optional

public readonly dubboFilterEnabled: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property dubboFilterEnabled: Specifies whether to enable the Dubbo filter.

Valid values: - true: Enables the Dubbo filter. - false: Disables the Dubbo filter. Default value: false.

edition^Optional

public readonly edition: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property edition: The edition of the ASM instance.

enableAcmg^Optional

public readonly enableAcmg: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableAcmg: Specifies whether to enable ACMG.

enableAmbient^Optional

public readonly enableAmbient: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableAmbient: Specifies whether to enable ambient mode.

enableAudit^Optional

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.

enableCrHistory^Optional

public readonly enableCrHistory: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableCrHistory: Specifies whether to enable the history version management feature for Istio resources in ASM.

Valid values: - true: Enables the history version management feature. - false: Disables the history version management feature. Default value: false.

enableSdsServer^Optional

public readonly enableSdsServer: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableSdsServer: Specifies whether to enable the Secret Discovery Service (SDS).

Valid values: - true: Enables SDS. - false: Disables SDS. Default value: false.

excludeInboundPorts^Optional

public readonly excludeInboundPorts: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property excludeInboundPorts: The inbound ports to exclude from traffic management.

excludeIpRanges^Optional

public readonly excludeIpRanges: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property excludeIpRanges: The IP ranges to exclude from traffic management.

excludeOutboundPorts^Optional

public readonly excludeOutboundPorts: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property excludeOutboundPorts: The outbound ports to exclude from traffic management.

existingCaCert^Optional

public readonly existingCaCert: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property existingCaCert: The existing CA certificate.

existingCaKey^Optional

public readonly existingCaKey: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property existingCaKey: The existing CA key.

existingCaType^Optional

public readonly existingCaType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property existingCaType: The type of the existing certificate: - 1: A self-signed certificate of Istiod.

This corresponds to the istio-ca-secret secret in the istio-system namespace. If you use this type, you must also provide the ExistingCaCert and ExsitingCaKey parameters. - 2: An external certificate of Istiod. For more information, see plugin ca cert. This generally corresponds to the cacerts secret in the istio-system namespace. If you use this type, you must also provide the ExisingRootCaCert and ExisingRootCaKey parameters.

existingRootCaCert^Optional

public readonly existingRootCaCert: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property existingRootCaCert: The existing root CA certificate.

existingRootCaKey^Optional

public readonly existingRootCaKey: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property existingRootCaKey: The existing root CA key.

filterGatewayClusterConfig^Optional

public readonly filterGatewayClusterConfig: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property filterGatewayClusterConfig: Specifies whether to enable gateway configuration filtering.

Valid values: - true: Enables gateway configuration filtering. - false: Disables gateway configuration filtering. Default value: false.

gatewayApiEnabled^Optional

public readonly gatewayApiEnabled: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property gatewayApiEnabled: Specifies whether to enable the Gateway API.

Valid values: - true: Enables the Gateway API. - false: Disables the Gateway API. Default value: false.

guestCluster^Optional

public readonly guestCluster: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property guestCluster: When you create a Service Mesh instance, you can add a cluster to the instance.

If you do not specify this parameter, no cluster is added. The cluster must be in the same VPC and vSwitch as the Service Mesh instance, and must have the same domain name.

includeIpRanges^Optional

public readonly includeIpRanges: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property includeIpRanges: The IP address ranges that are allowed to access the proxy.

istioVersion^Optional

public readonly istioVersion: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property istioVersion: The Istio version of the ASM instance.

kialiEnabled^Optional

public readonly kialiEnabled: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property kialiEnabled: Specifies whether to enable the mesh topology feature.

To enable this feature, you must first enable Prometheus monitoring. If Prometheus monitoring is disabled, this feature is forcibly disabled. Valid values: - true: Enables the mesh topology feature. - false: Disables the mesh topology feature. Default value: false.

localityLbConf^Optional

public readonly localityLbConf: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property localityLbConf: The locality load balancing configuration.

localityLoadBalancing^Optional

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.

mseEnabled^Optional

public readonly mseEnabled: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property mseEnabled: Specifies whether to enable Microservices Engine (MSE).

Valid values: - true: Enables MSE. - false: Disables MSE. Default value: false.

multiBufferEnabled^Optional

public readonly multiBufferEnabled: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property multiBufferEnabled: Specifies whether to enable TLS performance optimization that is based on MultiBuffer.

Valid values: - true: Enables the feature. - false: Disables the feature. Default value: true.

multiBufferPollDelay^Optional

public readonly multiBufferPollDelay: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property multiBufferPollDelay: The synchronization period of the MultiBuffer enabling status.

Default value: 30s.

mysqlFilterEnabled^Optional

public readonly mysqlFilterEnabled: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property mysqlFilterEnabled: Specifies whether to enable the MySQL filter.

Valid values: - true: Enables the MySQL filter. - false: Disables the MySQL filter. Default value: false.

name^Optional

public readonly name: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property name: The name of the ASM instance.

opa^Optional

public readonly opa: IResolvable | OPAProperty;

• Type: @alicloud/ros-cdk-core.IResolvable | OPAProperty

Property opa: OPA settings.

opaEnabled^Optional

public readonly opaEnabled: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property opaEnabled: Specifies whether to enable OPA.

Valid values: - true: Enables OPA. - false: Disables OPA. Default value: false.

outboundTrafficPolicy^Optional

public readonly outboundTrafficPolicy: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

period^Optional

public readonly period: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property period: This parameter is valid only if you set ChargeType to PrePay.

The subscription duration of the SLB instance. Unit: months. If you want to purchase the instance for one year, enter 12.

pilotLoadBalancerSpec^Optional

public readonly pilotLoadBalancerSpec: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property pilotLoadBalancerSpec: The specification of the SLB instance that is bound to Istio Pilot of the control plane.

Valid values: slb.s1.small, slb.s2.small, slb.s2.medium, slb.s3.small, slb.s3.medium, and slb.s3.large.

pilotPublicEip^Optional

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.

playgroundScene^Optional

public readonly playgroundScene: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property playgroundScene: The playground scenario.

If you specify this parameter, an ASM playground instance is created. Valid value: - ewmaLb: the exponentially weighted moving average (EWMA) load balancing scenario

prometheusUrl^Optional

public readonly prometheusUrl: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property prometheusUrl: The URL for Prometheus.

proxy^Optional

public readonly proxy: IResolvable | ProxyProperty;

• Type: @alicloud/ros-cdk-core.IResolvable | ProxyProperty

Property proxy: Proxy settings.

telemetry^Optional

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 Managed Service for Prometheus. Valid values: - true: Enables Prometheus monitoring. - false: Disables Prometheus monitoring. Default value: false.

traceSampling^Optional

public readonly traceSampling: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property traceSampling: The sampling percentage of tracing.

tracing^Optional

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.

useExistingCa^Optional

public readonly useExistingCa: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property useExistingCa: Specifies whether to use an existing CA.

webAssemblyFilterEnabled^Optional

public readonly webAssemblyFilterEnabled: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property webAssemblyFilterEnabled: Specifies whether to enable the WebAssembly filter.

Valid values: - true: Enables the WebAssembly filter. - false: Disables the WebAssembly filter. Default value: false.

Protocols