Alauda Service Mesh
简体中文

微服务资源描述

本文档主要提供 ServiceMesh 类型微服务的资源描述。

MicroService 资源参考

YAML 示例

apiVersion: asm.alauda.io/v1beta3
kind: MicroService
metadata:
  labels:
    app.cpaas.io/microservice-type: service-mesh
  name: xqren-s1
  namespace: xqren-ovn
spec:
  accessLogging:
    enabled: true
  auth:
    enabled: true
  deployments:
    - name: asm-test-image
  otelJavaAgent:
    enabled: false
  services:
    - name: xqren-s1
  sidecar:
    enabled: true
    cpuLimit: '0.1'
    memoryLimit: 256Mi
    envoyLogLevel: warning

顶层参数

参数名称必填类型描述
apiVersion是stringAPI 版本，必须为 asm.alauda.io/v1beta3。
kind是string资源对象类型，必须为 MicroService。
metadata是object服务的元数据，包括服务名称（name）、命名空间（namespace）、标签（labels）和注解（annotations）。
spec是object服务的详细信息，包括服务配置选项，如访问日志、Sidecar、OpenTelemetry Java Agent、Deployment 等。

spec 参数

  • deployments

    deployments 用于指定运行该服务的 Deployment。Deployment 必须与服务处于同一命名空间。

    参数名称必填描述
    name是与服务关联的 Deployment 的名称。

  • services

    services 用于描述与 deployments 一一对应 的服务。

    Service 必须满足以下条件：

    • 仅有一个服务与该服务的 Deployment 关联，且该服务仅关联所选的 Deployment。

    • 服务类型为 NodePort 或 ClusterIP。

    • 服务支持 HTTP、HTTP2、gRPC 和 TCP 协议。

    参数名称必填描述
    name是服务的名称。

  • accessLogging

    accessLogging 用于控制是否收集并输出访问当前服务的 Web 服务的访问日志（access log）。

    | 参数名称 | 必填 | 描述 | |------------|------|--------------------------------------------| | enabled | 否 | 是否收集并输出访问当前服务的访问日志。 |

  • auth

    auth 用于控制服务配置的黑白名单规则是否生效。

    | 参数名称 | 必填 | 描述 | |------------|------|----------------------------------------| | enabled | 否 | 黑白名单规则是否生效，默认禁用。 |