Alauda Service Mesh

描述: MicroService is the Schema for the microservices API
类型: object

规格

属性	类型	描述
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
`spec`	`object`	MicroServiceSpec defines the desired state of MicroService
`status`	`object`	MicroServiceStatus defines the observed state of MicroService

.spec

描述: MicroServiceSpec defines the desired state of MicroService
类型: object

属性	类型	描述
`accessLogging`	`object`	Access-log configuration.
`auth`	`object`	Authentication information.
`clusters`	`array`	Cluster information.
`configMaps`	`array`	Configuration.
`daemonsets`	`array`	Daemonset.
`deployments`	`array`	Deployment.
`otelJavaAgent`	`object`	OpenTelemetry Java agent configuration.
`secrets`	`array`	Secret.
`services`	`array`	Kubernetes Service information.
`sidecar`	`object`
`statefulsets`	`array`	Statefulset.
`swagger`	`object`	Swagger information.

.spec.accessLogging

描述: Access-log configuration.
类型: object
必填: enabled

属性	类型	描述
`enabled`	`boolean`

.spec.auth

描述: Authentication information.
类型: object

属性	类型	描述
`enabled`	`boolean`

.spec.clusters

描述: Cluster information.
类型: array

.spec.clusters[]

类型: object
必填: namesidecarInject

属性	类型	描述
`name`	`string`
`sidecarInject`	`string`

.spec.configMaps

描述: Configuration.
类型: array

.spec.configMaps[]

类型: object
必填: name

属性	类型	描述
`name`	`string`

.spec.daemonsets

描述: Daemonset.
类型: array

.spec.daemonsets[]

类型: object
必填: name

属性	类型	描述
`containerImage`	`array`	Container image.
`name`	`string`	Deployment name.
`otelJavaAgentImage`	`string`	OpenTelemetry java agent image. Deprecated: OtelJavaAgentImage
`sidecarEnabled`	`boolean`	Whether to add sidecar.
`version`	`string`	Deployment version。

.spec.daemonsets[].containerImage

描述: Container image.
类型: array

.spec.daemonsets[].containerImage[]

类型: string

.spec.deployments

描述: Deployment.
类型: array

.spec.deployments[]

类型: object
必填: name

属性	类型	描述
`containerImage`	`array`	Container image.
`name`	`string`	Deployment name.
`otelJavaAgentImage`	`string`	OpenTelemetry java agent image. Deprecated: OtelJavaAgentImage
`sidecarEnabled`	`boolean`	Whether to add sidecar.
`version`	`string`	Deployment version。

.spec.deployments[].containerImage

描述: Container image.
类型: array

.spec.deployments[].containerImage[]

类型: string

.spec.otelJavaAgent

描述: OpenTelemetry Java agent configuration.
类型: object

属性	类型	描述
`agentFileName`	`string`	The file name of agent.
`enabled`	`boolean`	Whether to add Otel Java Agent.
`mountPath`	`string`	The mount path of the agent.
`repository`	`string`	Image repository address of agent.
`version`	`string`	Agent version.

.spec.secrets

描述: Secret.
类型: array

.spec.secrets[]

类型: object
必填: name

属性	类型	描述
`name`	`string`

.spec.services

描述: Kubernetes Service information.
类型: array

.spec.services[]

类型: object
必填: iscreatebysystemname

属性	类型	描述
`iscreatebysystem`	`boolean`	Whether created by the system.
`name`	`string`	Kubernetes Service name.

.spec.sidecar

类型: object

属性	类型	描述
`excludeInboundPorts`	`string`
`excludeOutboundIPRanges`	`string`
`excludeOutboundPorts`	`string`

.spec.statefulsets

描述: Statefulset.
类型: array

.spec.statefulsets[]

类型: object
必填: name

属性	类型	描述
`containerImage`	`array`	Container image.
`name`	`string`	Deployment name.
`otelJavaAgentImage`	`string`	OpenTelemetry java agent image. Deprecated: OtelJavaAgentImage
`sidecarEnabled`	`boolean`	Whether to add sidecar.
`version`	`string`	Deployment version。

.spec.statefulsets[].containerImage

描述: Container image.
类型: array

.spec.statefulsets[].containerImage[]

类型: string

.spec.swagger

描述: Swagger information.
类型: object

属性	类型	描述
`opId`	`string`
`port`	`integer`
`url`	`string`

.status

描述: MicroServiceStatus defines the observed state of MicroService
类型: object

属性	类型	描述
`availableReplicas`	`integer`
`canHotUpgrade`	`boolean`	Indicates whether the hot upgrade is enabled.
`containsTcp`	`boolean`	Is there any TCP service within?
`deployStatus`	`string`
`phase`	`string`
`replicas`	`integer`
`sidecar`	`object`	SidecarStatus
`sidecarHotUpgrade`	`object`
`validatingStatus`	`object`	otel status

.status.sidecar

描述: SidecarStatus
类型: object

属性	类型	描述
`conditions`	`array`
`reason`	`string`
`revision`	`object`
`state`	`string`

.status.sidecar.conditions

类型: array

.status.sidecar.conditions[]

描述: Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` // other fields }
类型: object
必填: lastTransitionTimemessagereasonstatustype

属性	类型	描述
`lastTransitionTime`	`string`	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
`message`	`string`	message is a human readable message indicating details about the transition. This may be an empty string.
`observedGeneration`	`integer`	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
`reason`	`string`	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
`status`	`string`	status of the condition, one of True, False, Unknown.
`type`	`string`	type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)

.status.sidecar.revision

类型: object
必填: currenttarget

属性	类型	描述
`current`	`string`
`target`	`string`

.status.sidecarHotUpgrade

类型: object

属性	类型	描述
`status`	`object`	Mirror of actual sidecar hot upgrade status.
`version`	`object`
`versions`	`array`

.status.sidecarHotUpgrade.status

描述: Mirror of actual sidecar hot upgrade status.
类型: object

属性	类型	描述
`observedRef`	`object`
`progress`	`object`	HotUpgradeProgress
`reason`	`string`
`state`	`string`

.status.sidecarHotUpgrade.status.observedRef

类型: object

属性	类型	描述
`generation`	`integer`
`uid`	`string`	UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.

.status.sidecarHotUpgrade.status.progress

描述: HotUpgradeProgress
类型: object

属性	类型	描述
`failed`	`integer`
`pods`	`array`
`success`	`integer`
`total`	`integer`

.status.sidecarHotUpgrade.status.progress.pods

类型: array

.status.sidecarHotUpgrade.status.progress.pods[]

类型: object
必填: nametarget

属性	类型	描述
`message`	`string`
`name`	`string`
`planUID`	`string`	UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.
`state`	`string`
`target`	`string`

.status.sidecarHotUpgrade.version

类型: object
必填: currenttarget

属性	类型	描述
`current`	`string`
`target`	`string`

.status.sidecarHotUpgrade.versions

类型: array

.status.sidecarHotUpgrade.versions[]

类型: object
必填: currentnametarget

属性	类型	描述
`current`	`string`
`name`	`string`
`target`	`string`

.status.validatingStatus

描述: otel status
类型: object

属性	类型	描述
`invalid`	`boolean`
`message`	`array`

.status.validatingStatus.message

类型: array

.status.validatingStatus.message[]

类型: string

API 端点

可用的 API 端点如下：

/apis/asm.alauda.io/v1beta3/namespaces/{namespace}/microservices
- DELETE: delete collection of MicroService
- GET: list objects of kind MicroService
- POST: create a new MicroService
/apis/asm.alauda.io/v1beta3/namespaces/{namespace}/microservices/{name}
- DELETE: delete the specified MicroService
- GET: read the specified MicroService
- PATCH: partially update the specified MicroService
- PUT: replace the specified MicroService
/apis/asm.alauda.io/v1beta3/namespaces/{namespace}/microservices/{name}/status
- GET: read status of the specified MicroService
- PATCH: partially update status of the specified MicroService
- PUT: replace status of the specified MicroService

/apis/asm.alauda.io/v1beta3/namespaces/{namespace}/microservices

HTTP 方法: DELETE
描述: delete collection of MicroService
HTTP 响应

HTTP 状态码	响应体
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: list objects of kind MicroService
HTTP 响应

HTTP 状态码	响应体
200 - OK	`MicroServiceList` schema
401 - Unauthorized	Empty

HTTP 方法: POST
描述: create a new MicroService

查询参数

参数	类型	描述
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

请求体参数

参数	类型	描述
`body`	`MicroService` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`MicroService` schema
201 - Created	`MicroService` schema
202 - Accepted	`MicroService` schema
401 - Unauthorized	Empty

/apis/asm.alauda.io/v1beta3/namespaces/{namespace}/microservices/{name}

HTTP 方法: DELETE
描述: delete the specified MicroService

查询参数

参数	类型	描述
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

HTTP 响应

HTTP 状态码	响应体
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: read the specified MicroService
HTTP 响应

HTTP 状态码	响应体
200 - OK	`MicroService` schema
401 - Unauthorized	Empty

HTTP 方法: PATCH
描述: partially update the specified MicroService

查询参数

参数	类型	描述
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP 响应

HTTP 状态码	响应体
200 - OK	`MicroService` schema
401 - Unauthorized	Empty

HTTP 方法: PUT
描述: replace the specified MicroService

查询参数

参数	类型	描述
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

请求体参数

参数	类型	描述
`body`	`MicroService` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`MicroService` schema
201 - Created	`MicroService` schema
401 - Unauthorized	Empty

/apis/asm.alauda.io/v1beta3/namespaces/{namespace}/microservices/{name}/status

HTTP 方法: GET
描述: read status of the specified MicroService
HTTP 响应

HTTP 状态码	响应体
200 - OK	`MicroService` schema
401 - Unauthorized	Empty

HTTP 方法: PATCH
描述: partially update status of the specified MicroService

查询参数

参数	类型	描述
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP 响应

HTTP 状态码	响应体
200 - OK	`MicroService` schema
401 - Unauthorized	Empty

HTTP 方法: PUT
描述: replace status of the specified MicroService

查询参数

参数	类型	描述
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

请求体参数

参数	类型	描述
`body`	`MicroService` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`MicroService` schema
201 - Created	`MicroService` schema
401 - Unauthorized	Empty

#规格

#.spec

#.spec.accessLogging

#.spec.auth

#.spec.clusters

#.spec.clusters[]

#.spec.configMaps

#.spec.configMaps[]

#.spec.daemonsets

#.spec.daemonsets[]

#.spec.daemonsets[].containerImage

#.spec.daemonsets[].containerImage[]

#.spec.deployments

#.spec.deployments[]

#.spec.deployments[].containerImage

#.spec.deployments[].containerImage[]

#.spec.otelJavaAgent

#.spec.secrets

#.spec.secrets[]

#.spec.services

#.spec.services[]

#.spec.sidecar

#.spec.statefulsets

#.spec.statefulsets[]

#.spec.statefulsets[].containerImage

#.spec.statefulsets[].containerImage[]

#.spec.swagger

#.status

#.status.sidecar

#.status.sidecar.conditions

#.status.sidecar.conditions[]

#.status.sidecar.revision

#.status.sidecarHotUpgrade

#.status.sidecarHotUpgrade.status

#.status.sidecarHotUpgrade.status.observedRef

#.status.sidecarHotUpgrade.status.progress

#.status.sidecarHotUpgrade.status.progress.pods

#.status.sidecarHotUpgrade.status.progress.pods[]

#.status.sidecarHotUpgrade.version

#.status.sidecarHotUpgrade.versions

#.status.sidecarHotUpgrade.versions[]

#.status.validatingStatus

#.status.validatingStatus.message

#.status.validatingStatus.message[]

API 端点#

/apis/asm.alauda.io/v1beta3/namespaces/{namespace}/microservices#

/apis/asm.alauda.io/v1beta3/namespaces/{namespace}/microservices/{name}#

/apis/asm.alauda.io/v1beta3/namespaces/{namespace}/microservices/{name}/status#

规格

.spec

.spec.accessLogging

.spec.auth

.spec.clusters

.spec.clusters[]

.spec.configMaps

.spec.configMaps[]

.spec.daemonsets

.spec.daemonsets[]

.spec.daemonsets[].containerImage

.spec.daemonsets[].containerImage[]

.spec.deployments

.spec.deployments[]

.spec.deployments[].containerImage

.spec.deployments[].containerImage[]

.spec.otelJavaAgent

.spec.secrets

.spec.secrets[]

.spec.services

.spec.services[]

.spec.sidecar

.spec.statefulsets

.spec.statefulsets[]

.spec.statefulsets[].containerImage

.spec.statefulsets[].containerImage[]

.spec.swagger

.status

.status.sidecar

.status.sidecar.conditions

.status.sidecar.conditions[]

.status.sidecar.revision

.status.sidecarHotUpgrade

.status.sidecarHotUpgrade.status

.status.sidecarHotUpgrade.status.observedRef

.status.sidecarHotUpgrade.status.progress

.status.sidecarHotUpgrade.status.progress.pods

.status.sidecarHotUpgrade.status.progress.pods[]

.status.sidecarHotUpgrade.version

.status.sidecarHotUpgrade.versions

.status.sidecarHotUpgrade.versions[]

.status.validatingStatus

.status.validatingStatus.message

.status.validatingStatus.message[]

API 端点

/apis/asm.alauda.io/v1beta3/namespaces/{namespace}/microservices

/apis/asm.alauda.io/v1beta3/namespaces/{namespace}/microservices/{name}

/apis/asm.alauda.io/v1beta3/namespaces/{namespace}/microservices/{name}/status