Alauda Service Mesh
Type
object

Specification

PropertyTypeDescription
specobject

PeerAuthentication defines how traffic will be tunneled (or not) to the sidecar.

statusobject

.spec

Description
PeerAuthentication defines how traffic will be tunneled (or not) to the sidecar.
Type
object
PropertyTypeDescription
mtlsobject

Mutual TLS settings for workload.

portLevelMtlsobject

Port specific mutual TLS settings.

selectorobject

The selector determines the workloads to apply the ChannelAuthentication on.

.spec.mtls

Description
Mutual TLS settings for workload.
Type
object
PropertyTypeDescription
modestring

Defines the mTLS mode used for peer authentication.

.spec.portLevelMtls

Description
Port specific mutual TLS settings.
Type
object

.spec.selector

Description
The selector determines the workloads to apply the ChannelAuthentication on.
Type
object
PropertyTypeDescription
matchLabelsobject

.spec.selector.matchLabels

Type
object

.status

Type
object

API Endpoints

The following API endpoints are available:

  • /apis/security.istio.io/v1beta1/namespaces/{namespace}/peerauthentications
    • DELETE: delete collection of PeerAuthentication
    • GET: list objects of kind PeerAuthentication
    • POST: create a new PeerAuthentication
  • /apis/security.istio.io/v1beta1/namespaces/{namespace}/peerauthentications/{name}
    • DELETE: delete the specified PeerAuthentication
    • GET: read the specified PeerAuthentication
    • PATCH: partially update the specified PeerAuthentication
    • PUT: replace the specified PeerAuthentication
  • /apis/security.istio.io/v1beta1/namespaces/{namespace}/peerauthentications/{name}/status
    • GET: read status of the specified PeerAuthentication
    • PATCH: partially update status of the specified PeerAuthentication
    • PUT: replace status of the specified PeerAuthentication

/apis/security.istio.io/v1beta1/namespaces/{namespace}/peerauthentications

HTTP method
DELETE
Description
delete collection of PeerAuthentication
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind PeerAuthentication
HTTP responses
HTTP codeResponse body
200 - OKPeerAuthenticationList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new PeerAuthentication
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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
ParameterTypeDescription
bodyPeerAuthentication schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKPeerAuthentication schema
201 - CreatedPeerAuthentication schema
202 - AcceptedPeerAuthentication schema
401 - UnauthorizedEmpty

/apis/security.istio.io/v1beta1/namespaces/{namespace}/peerauthentications/{name}

HTTP method
DELETE
Description
delete the specified PeerAuthentication
Query parameters
ParameterTypeDescription
dryRunstringWhen 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 codeResponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
read the specified PeerAuthentication
HTTP responses
HTTP codeResponse body
200 - OKPeerAuthentication schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified PeerAuthentication
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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 codeResponse body
200 - OKPeerAuthentication schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified PeerAuthentication
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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
ParameterTypeDescription
bodyPeerAuthentication schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKPeerAuthentication schema
201 - CreatedPeerAuthentication schema
401 - UnauthorizedEmpty

/apis/security.istio.io/v1beta1/namespaces/{namespace}/peerauthentications/{name}/status

HTTP method
GET
Description
read status of the specified PeerAuthentication
HTTP responses
HTTP codeResponse body
200 - OKPeerAuthentication schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified PeerAuthentication
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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 codeResponse body
200 - OKPeerAuthentication schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified PeerAuthentication
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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
ParameterTypeDescription
bodyPeerAuthentication schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKPeerAuthentication schema
201 - CreatedPeerAuthentication schema
401 - UnauthorizedEmpty