ServiceMeshProps

Properties for defining a ServiceMesh.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkasm"
&alicloudroscdkasm.ServiceMeshProps {
    VpcId: interface{},
    VSwitches: interface{},
    AccessLogEnabled: interface{},
    AccessLogFile: interface{},
    AccessLogFormat: interface{},
    AccessLogProject: interface{},
    AccessLogServiceEnabled: interface{},
    AccessLogServiceHost: interface{},
    AccessLogServicePort: interface{},
    ApiServerLoadBalancerSpec: interface{},
    ApiServerPublicEip: interface{},
    AuditProject: interface{},
    AutoRenew: interface{},
    AutoRenewPeriod: interface{},
    CertChain: interface{},
    ChargeType: interface{},
    ClusterSpec: interface{},
    ConfigSourceEnabled: interface{},
    ConfigSourceNacosId: interface{},
    ControlPlaneLogEnabled: interface{},
    ControlPlaneLogProject: interface{},
    CrAggregationEnabled: interface{},
    CustomizedPrometheus: interface{},
    CustomizedZipkin: interface{},
    DnsProxyingEnabled: interface{},
    DubboFilterEnabled: interface{},
    Edition: interface{},
    EnableAcmg: interface{},
    EnableAmbient: interface{},
    EnableAudit: interface{},
    EnableCrHistory: interface{},
    EnableSdsServer: interface{},
    ExcludeInboundPorts: interface{},
    ExcludeIpRanges: interface{},
    ExcludeOutboundPorts: interface{},
    ExistingCaCert: interface{},
    ExistingCaKey: interface{},
    ExistingCaType: interface{},
    ExistingRootCaCert: interface{},
    ExistingRootCaKey: interface{},
    FilterGatewayClusterConfig: interface{},
    GatewayApiEnabled: interface{},
    GuestCluster: interface{},
    IncludeIpRanges: interface{},
    IstioVersion: interface{},
    KialiEnabled: interface{},
    LocalityLbConf: interface{},
    LocalityLoadBalancing: interface{},
    MseEnabled: interface{},
    MultiBufferEnabled: interface{},
    MultiBufferPollDelay: interface{},
    MysqlFilterEnabled: interface{},
    Name: interface{},
    Opa: interface{},
    OpaEnabled: interface{},
    OutboundTrafficPolicy: interface{},
    Period: interface{},
    PilotLoadBalancerSpec: interface{},
    PilotPublicEip: interface{},
    PlaygroundScene: interface{},
    PrometheusUrl: interface{},
    Proxy: interface{},
    Telemetry: interface{},
    TraceSampling: interface{},
    Tracing: interface{},
    UseExistingCa: interface{},
    WebAssemblyFilterEnabled: interface{},
}

Properties

VpcId^Required

VpcId interface{}

• Type: interface{}

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

VSwitches^Required

VSwitches interface{}

• Type: interface{}

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

AccessLogEnabled^Optional

AccessLogEnabled interface{}

• Type: interface{}

Property accessLogEnabled: Specifies whether to enable access log.

Valid values:

• true: Enables access log.
• false: Disables access log. Default value: false.

AccessLogFile^Optional

AccessLogFile interface{}

• Type: interface{}

Property accessLogFile: Enable and disable access logs.

Value:

• "" : Turn off access logs.
• /dev/stdout: Enables access logging

AccessLogFormat^Optional

AccessLogFormat interface{}

• Type: interface{}

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

AccessLogProject interface{}

• Type: interface{}

Property accessLogProject: The Log Service project for access logs.

AccessLogServiceEnabled^Optional

AccessLogServiceEnabled interface{}

• Type: interface{}

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

AccessLogServiceHost interface{}

• Type: interface{}

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

AccessLogServicePort^Optional

AccessLogServicePort interface{}

• Type: interface{}

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

ApiServerLoadBalancerSpec^Optional

ApiServerLoadBalancerSpec interface{}

• Type: interface{}

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

ApiServerPublicEip interface{}

• Type: interface{}

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

AuditProject interface{}

• Type: interface{}

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

Default value: mesh-log-{meshId}.

AutoRenew^Optional

AutoRenew interface{}

• Type: interface{}

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

Value:

• true: Automatic renewal.
• false: No automatic renewal.

AutoRenewPeriod^Optional

AutoRenewPeriod interface{}

• Type: interface{}

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

CertChain interface{}

• Type: interface{}

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

ChargeType^Optional

ChargeType interface{}

• Type: interface{}

Property chargeType: CLB payment type.

Value:

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

ClusterSpec^Optional

ClusterSpec interface{}

• Type: interface{}

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

• enterprise: Enterprise Edition
• ultimate: ultimate.

ConfigSourceEnabled^Optional

ConfigSourceEnabled interface{}

• Type: interface{}

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

ConfigSourceNacosId interface{}

• Type: interface{}

Property configSourceNacosId: The Nacos ID for config source.

ControlPlaneLogEnabled^Optional

ControlPlaneLogEnabled interface{}

• Type: interface{}

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

ControlPlaneLogProject interface{}

• Type: interface{}

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

CrAggregationEnabled^Optional

CrAggregationEnabled interface{}

• Type: interface{}

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

CustomizedPrometheus interface{}

• Type: interface{}

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

CustomizedZipkin interface{}

• Type: interface{}

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

DnsProxyingEnabled interface{}

• Type: interface{}

Property dnsProxyingEnabled: Specifies whether to enable DNS proxy.

Valid values:

• true: Enables DNS proxy.
• false: Disables DNS proxy. Default value: false.

DubboFilterEnabled^Optional

DubboFilterEnabled interface{}

• Type: interface{}

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

Edition interface{}

• Type: interface{}

Property edition: The edition of the ASM instance.

EnableAcmg^Optional

EnableAcmg interface{}

• Type: interface{}

Property enableAcmg: Specifies whether to enable ACMG.

EnableAmbient^Optional

EnableAmbient interface{}

• Type: interface{}

Property enableAmbient: Specifies whether to enable ambient mode.

EnableAudit^Optional

EnableAudit interface{}

• Type: interface{}

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

EnableCrHistory interface{}

• Type: interface{}

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

EnableSdsServer interface{}

• Type: interface{}

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

Valid values:

• true: Enables SDS.
• false: Disables SDS. Default value: false.

ExcludeInboundPorts^Optional

ExcludeInboundPorts interface{}

• Type: interface{}

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

ExcludeIpRanges^Optional

ExcludeIpRanges interface{}

• Type: interface{}

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

ExcludeOutboundPorts^Optional

ExcludeOutboundPorts interface{}

• Type: interface{}

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

ExistingCaCert^Optional

ExistingCaCert interface{}

• Type: interface{}

Property existingCaCert: The existing CA certificate.

ExistingCaKey^Optional

ExistingCaKey interface{}

• Type: interface{}

Property existingCaKey: The existing CA key.

ExistingCaType^Optional

ExistingCaType interface{}

• Type: interface{}

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

ExistingRootCaCert interface{}

• Type: interface{}

Property existingRootCaCert: The existing root CA certificate.

ExistingRootCaKey^Optional

ExistingRootCaKey interface{}

• Type: interface{}

Property existingRootCaKey: The existing root CA key.

FilterGatewayClusterConfig^Optional

FilterGatewayClusterConfig interface{}

• Type: interface{}

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

GatewayApiEnabled interface{}

• Type: interface{}

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

GuestCluster interface{}

• Type: interface{}

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

IncludeIpRanges interface{}

• Type: interface{}

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

IstioVersion^Optional

IstioVersion interface{}

• Type: interface{}

Property istioVersion: The Istio version of the ASM instance.

KialiEnabled^Optional

KialiEnabled interface{}

• Type: interface{}

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

LocalityLbConf interface{}

• Type: interface{}

Property localityLbConf: The locality load balancing configuration.

LocalityLoadBalancing^Optional

LocalityLoadBalancing interface{}

• Type: interface{}

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

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

MseEnabled^Optional

MseEnabled interface{}

• Type: interface{}

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

Valid values:

• true: Enables MSE.
• false: Disables MSE. Default value: false.

MultiBufferEnabled^Optional

MultiBufferEnabled interface{}

• Type: interface{}

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

MultiBufferPollDelay interface{}

• Type: interface{}

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

Default value: 30s.

MysqlFilterEnabled^Optional

MysqlFilterEnabled interface{}

• Type: interface{}

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

Name interface{}

• Type: interface{}

Property name: The name of the ASM instance.

Opa^Optional

Opa interface{}

• Type: interface{}

Property opa: OPA settings.

OpaEnabled^Optional

OpaEnabled interface{}

• Type: interface{}

Property opaEnabled: Specifies whether to enable OPA.

Valid values:

• true: Enables OPA.
• false: Disables OPA. Default value: false.

OutboundTrafficPolicy^Optional

OutboundTrafficPolicy interface{}

• Type: interface{}

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

Period^Optional

Period interface{}

• Type: interface{}

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

PilotLoadBalancerSpec interface{}

• Type: interface{}

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

PilotPublicEip interface{}

• Type: interface{}

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

PlaygroundScene interface{}

• Type: interface{}

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

PrometheusUrl interface{}

• Type: interface{}

Property prometheusUrl: The URL for Prometheus.

Proxy^Optional

Proxy interface{}

• Type: interface{}

Property proxy: Proxy settings.

Telemetry^Optional

Telemetry interface{}

• Type: interface{}

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

TraceSampling interface{}

• Type: interface{}

Property traceSampling: The sampling percentage of tracing.

Tracing^Optional

Tracing interface{}

• Type: interface{}

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

UseExistingCa interface{}

• Type: interface{}

Property useExistingCa: Specifies whether to use an existing CA.

WebAssemblyFilterEnabled^Optional

WebAssemblyFilterEnabled interface{}

• Type: interface{}

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