EgressQoS [k8s.ovn.org/v1]
Description
EgressQoS is a CRD that allows the user to define a DSCP value for pods egress traffic on its namespace to specified CIDRs. Traffic from these pods will be checked against each EgressQoSRule in the namespace’s EgressQoS, and if there is a match the traffic is marked with the relevant DSCP value.
Type
object
Specification
Property | Type | Description |
---|---|---|
|
| 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 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 |
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| EgressQoSSpec defines the desired state of EgressQoS |
|
| EgressQoSStatus defines the observed state of EgressQoS |
.spec
Description
EgressQoSSpec defines the desired state of EgressQoS
Type
object
Required
egress
Property | Type | Description |
---|---|---|
|
| a collection of Egress QoS rule objects |
|
|
.spec.egress
Description
a collection of Egress QoS rule objects
Type
array
.spec.egress[]
Description
Type
object
Required
dscp
Property | Type | Description |
---|---|---|
|
| DSCP marking value for matching pods’ traffic. |
|
| DstCIDR specifies the destination’s CIDR. Only traffic heading to this CIDR will be marked with the DSCP value. This field is optional, and in case it is not set the rule is applied to all egress traffic regardless of the destination. |
|
| PodSelector applies the QoS rule only to the pods in the namespace whose label matches this definition. This field is optional, and in case it is not set results in the rule being applied to all pods in the namespace. |
.spec.egress[].podSelector
Description
PodSelector applies the QoS rule only to the pods in the namespace whose label matches this definition. This field is optional, and in case it is not set results in the rule being applied to all pods in the namespace.
Type
object
Property | Type | Description |
---|---|---|
|
| matchExpressions is a list of label selector requirements. The requirements are ANDed. |
|
| A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. |
|
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed. |
.spec.egress[].podSelector.matchExpressions
Description
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type
array
.spec.egress[].podSelector.matchExpressions[]
Description
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Type
object
Required
key
operator
Property | Type | Description |
---|---|---|
|
| key is the label key that the selector applies to. |
|
| operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
|
| values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
.status
Description
EgressQoSStatus defines the observed state of EgressQoS
Type
object
API endpoints
The following API endpoints are available:
/apis/k8s.ovn.org/v1/egressqoses
GET
: list objects of kind EgressQoS
/apis/k8s.ovn.org/v1/namespaces/{namespace}/egressqoses
DELETE
: delete collection of EgressQoSGET
: list objects of kind EgressQoSPOST
: create an EgressQoS
/apis/k8s.ovn.org/v1/namespaces/{namespace}/egressqoses/{name}
DELETE
: delete an EgressQoSGET
: read the specified EgressQoSPATCH
: partially update the specified EgressQoSPUT
: replace the specified EgressQoS
/apis/k8s.ovn.org/v1/namespaces/{namespace}/egressqoses/{name}/status
GET
: read status of the specified EgressQoSPATCH
: partially update status of the specified EgressQoSPUT
: replace status of the specified EgressQoS
/apis/k8s.ovn.org/v1/egressqoses
HTTP method
GET
Description
list objects of kind EgressQoS
HTTP code | Reponse body |
---|---|
200 - OK | EgressQoSList schema |
401 - Unauthorized | Empty |
/apis/k8s.ovn.org/v1/namespaces/{namespace}/egressqoses
HTTP method
DELETE
Description
delete collection of EgressQoS
HTTP code | Reponse body |
---|---|
200 - OK | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
list objects of kind EgressQoS
HTTP code | Reponse body |
---|---|
200 - OK | EgressQoSList schema |
401 - Unauthorized | Empty |
HTTP method
POST
Description
create an EgressQoS
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
| EgressQoS schema |
HTTP code | Reponse body |
---|---|
200 - OK | EgressQoS schema |
201 - Created | EgressQoS schema |
202 - Accepted | EgressQoS schema |
401 - Unauthorized | Empty |
/apis/k8s.ovn.org/v1/namespaces/{namespace}/egressqoses/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the EgressQoS |
HTTP method
DELETE
Description
delete an EgressQoS
Parameter | Type | Description |
---|---|---|
|
| 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 code | Reponse body |
---|---|
200 - OK | Status schema |
202 - Accepted | Status schema |
401 - Unauthorized | Empty |
HTTP method
GET
Description
read the specified EgressQoS
HTTP code | Reponse body |
---|---|
200 - OK | EgressQoS schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update the specified EgressQoS
Parameter | Type | Description |
---|---|---|
|
| 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 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 code | Reponse body |
---|---|
200 - OK | EgressQoS schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace the specified EgressQoS
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
| EgressQoS schema |
HTTP code | Reponse body |
---|---|
200 - OK | EgressQoS schema |
201 - Created | EgressQoS schema |
401 - Unauthorized | Empty |
/apis/k8s.ovn.org/v1/namespaces/{namespace}/egressqoses/{name}/status
Parameter | Type | Description |
---|---|---|
|
| name of the EgressQoS |
HTTP method
GET
Description
read status of the specified EgressQoS
HTTP code | Reponse body |
---|---|
200 - OK | EgressQoS schema |
401 - Unauthorized | Empty |
HTTP method
PATCH
Description
partially update status of the specified EgressQoS
Parameter | Type | Description |
---|---|---|
|
| 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 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 code | Reponse body |
---|---|
200 - OK | EgressQoS schema |
401 - Unauthorized | Empty |
HTTP method
PUT
Description
replace status of the specified EgressQoS
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
Parameter | Type | Description |
---|---|---|
| EgressQoS schema |
HTTP code | Reponse body |
---|---|
200 - OK | EgressQoS schema |
201 - Created | EgressQoS schema |
401 - Unauthorized | Empty |