Alauda Service Mesh

Alauda Service Mesh

Description: CanaryEvent is the Schema for the CanaryEvent API
Type: object

Specification

Property	Type	Description
`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`	CanaryDeliverySpec defines the desired state of CanaryDelivery

.spec

Description: CanaryDeliverySpec defines the desired state of CanaryDelivery
Type: object

Property	Type	Description
`currentRecordId`	`integer`	current max record id
`records`	`object`	CanaryRecord list for canary

.spec.records

Description: CanaryRecord list for canary
Type: object
Required: namespacestartTime

Property	Type	Description
`currentWeight`	`integer`
`endTime`	`string`
`canarydeploy`	`string`
`configtracks`	`array`
`primarydeploy`	`string`
`events`	`array`
`id`	`integer`	Id for this record
`name`	`string`
`namespace`	`string`
`startTime`	`string`
`status`	`string`

.spec.records.configtracks

Type: array

.spec.records.configtracks[]

Type: object
Required: configtypename

Property	Type	Description
`canaryyaml`	`string`
`configtype`	`string`	config type configmap or secret
`name`	`string`	ConfigTracks
`primaryyaml`	`string`

.spec.records.events

Type: array

.spec.records.events[]

Description: CanaryEvent is used for events of canary
Type: object

Property	Type	Description
`eventName`	`string`	name for the event
`eventType`	`string`	event type like canary ab bluegreen
`message`	`string`	the message flagger report
`phase`	`string`	Phase
`timestamp`	`string`	the event generate time
`weight`	`integer`	current weight

API Endpoints

The following API endpoints are available:

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

/apis/asm.alauda.io/v1alpha1/namespaces/{namespace}/canaryevents

HTTP method: DELETE
Description: delete collection of CanaryEvent
HTTP responses

HTTP code	Response body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list objects of kind CanaryEvent
HTTP responses

HTTP code	Response body
200 - OK	`CanaryEventList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create a new CanaryEvent

Query parameters

Parameter	Type	Description
`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 parameters

Parameter	Type	Description
`body`	`CanaryEvent` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`CanaryEvent` schema
201 - Created	`CanaryEvent` schema
202 - Accepted	`CanaryEvent` schema
401 - Unauthorized	Empty

/apis/asm.alauda.io/v1alpha1/namespaces/{namespace}/canaryevents/{name}

HTTP method: DELETE
Description: delete the specified CanaryEvent

Query parameters

Parameter	Type	Description
`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 responses

HTTP code	Response body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified CanaryEvent
HTTP responses

HTTP code	Response body
200 - OK	`CanaryEvent` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified CanaryEvent

Query parameters

Parameter	Type	Description
`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 responses

HTTP code	Response body
200 - OK	`CanaryEvent` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified CanaryEvent

Query parameters

Parameter	Type	Description
`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 parameters

Parameter	Type	Description
`body`	`CanaryEvent` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`CanaryEvent` schema
201 - Created	`CanaryEvent` schema
401 - Unauthorized	Empty