ves-io-schema-protocol_policer-API-Create
Examples of creating protocol_policer
Usecase:
Create protocol-policer-1 to rate limit all TCP SYN packets
Request using vesctl:
vesctl configuration create protocol_policer -i protocol_policer.yaml
where file protocol_policer.yaml has following contents (protocol_policer.CreateRequest):
RequestJSON:
{
"metadata": {
"name": "protocol-policer-1",
"namespace": "system"
},
"spec": {
"protocol_policer": [
{
"protocol": {
"tcp": {
"flags": [
"SYN"
]
}
},
"policer": [
{
"kind": "policer",
"name": "tcp-syn-limiter"
}
]
}
]
}
}
vesctl yaml response:
ResponseJSON:
{
"metadata": {
"name": "protocol-policer-1",
"namespace": "system",
"labels": {},
"annotations": {},
"description": "",
"disable": false
},
"system_metadata": {
"uid": "db58212a-0ac5-4fde-a13e-64922cf9a1f4",
"creation_timestamp": "2024-03-21T14:06:41.254405Z",
"deletion_timestamp": null,
"modification_timestamp": null,
"initializers": null,
"finalizers": [],
"tenant": "acmecorp",
"creator_class": "examplesvc",
"creator_id": "examplesvc",
"object_index": 0,
"owner_view": null,
"labels": {}
},
"spec": {
"protocol_policer": [
{
"protocol": {
"tcp": {
"flags": [
"SYN"
]
}
},
"policer": [
{
"kind": "policer",
"uid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"tenant": "acmecorp",
"namespace": "system",
"name": "tcp-syn-limiter"
}
]
}
]
}
}
Request using curl:
curl -X 'POST' -d '{"metadata":{"name":"protocol-policer-1","namespace":"system"},"spec":{"protocol_policer":[{"protocol":{"tcp":{"flags":["SYN"]}},"policer":[{"kind":"policer","name":"tcp-syn-limiter"}]}]}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_2__8qnt6fwd5dvglr1xqq6l8b7w0000gp_T_go-build3109416560_b001_apidocs.test/host=C02FN35BMD6R/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/protocol_policers'
curl response:
HTTP/1.1 200 OK
Content-Length: 1036
Content-Type: application/json
Date: Thu, 21 Mar 2024 14:06:41 GMT
Vary: Accept-Encoding
{
"metadata": {
"name": "protocol-policer-1",
"namespace": "system",
"labels": {
},
"annotations": {
},
"description": "",
"disable": false
},
"system_metadata": {
"uid": "db58212a-0ac5-4fde-a13e-64922cf9a1f4",
"creation_timestamp": "2024-03-21T14:06:41.254405Z",
"deletion_timestamp": null,
"modification_timestamp": null,
"initializers": null,
"finalizers": [
],
"tenant": "acmecorp",
"creator_class": "examplesvc",
"creator_id": "examplesvc",
"object_index": 0,
"owner_view": null,
"labels": {
}
},
"spec": {
"protocol_policer": [
{
"protocol": {
"tcp": {
"flags": [
"SYN"
]
}
},
"policer": [
{
"kind": "policer",
"uid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"tenant": "acmecorp",
"namespace": "system",
"name": "tcp-syn-limiter"
}
]
}
]
}
}
Usecase:
Create protocol-policer-2 to rate limit all ICMP packets
Request using vesctl:
vesctl configuration create protocol_policer -i protocol_policer.yaml
where file protocol_policer.yaml has following contents (protocol_policer.CreateRequest):
RequestJSON:
{
"metadata": {
"name": "protocol-policer-2",
"namespace": "system"
},
"spec": {
"protocol_policer": [
{
"protocol": {
"icmp": {
"type": [
"ALL_ICMP_MSG"
]
}
},
"policer": [
{
"kind": "policer",
"name": "icmp-limiter"
}
]
}
]
}
}
vesctl yaml response:
ResponseJSON:
{
"metadata": {
"name": "protocol-policer-2",
"namespace": "system",
"labels": {},
"annotations": {},
"description": "",
"disable": false
},
"system_metadata": {
"uid": "4e5a2648-72e9-4372-9728-ac065fab43bc",
"creation_timestamp": "2024-03-21T14:06:41.278524Z",
"deletion_timestamp": null,
"modification_timestamp": null,
"initializers": null,
"finalizers": [],
"tenant": "acmecorp",
"creator_class": "examplesvc",
"creator_id": "examplesvc",
"object_index": 0,
"owner_view": null,
"labels": {}
},
"spec": {
"protocol_policer": [
{
"protocol": {
"icmp": {
"type": [
"ALL_ICMP_MSG"
]
}
},
"policer": [
{
"kind": "policer",
"uid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"tenant": "acmecorp",
"namespace": "system",
"name": "icmp-limiter"
}
]
}
]
}
}
Request using curl:
curl -X 'POST' -d '{"metadata":{"name":"protocol-policer-2","namespace":"system"},"spec":{"protocol_policer":[{"protocol":{"icmp":{"type":["ALL_ICMP_MSG"]}},"policer":[{"kind":"policer","name":"icmp-limiter"}]}]}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_2__8qnt6fwd5dvglr1xqq6l8b7w0000gp_T_go-build3109416560_b001_apidocs.test/host=C02FN35BMD6R/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/protocol_policers'
curl response:
HTTP/1.1 200 OK
Content-Length: 1042
Content-Type: application/json
Date: Thu, 21 Mar 2024 14:06:41 GMT
Vary: Accept-Encoding
{
"metadata": {
"name": "protocol-policer-2",
"namespace": "system",
"labels": {
},
"annotations": {
},
"description": "",
"disable": false
},
"system_metadata": {
"uid": "4e5a2648-72e9-4372-9728-ac065fab43bc",
"creation_timestamp": "2024-03-21T14:06:41.278524Z",
"deletion_timestamp": null,
"modification_timestamp": null,
"initializers": null,
"finalizers": [
],
"tenant": "acmecorp",
"creator_class": "examplesvc",
"creator_id": "examplesvc",
"object_index": 0,
"owner_view": null,
"labels": {
}
},
"spec": {
"protocol_policer": [
{
"protocol": {
"icmp": {
"type": [
"ALL_ICMP_MSG"
]
}
},
"policer": [
{
"kind": "policer",
"uid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"tenant": "acmecorp",
"namespace": "system",
"name": "icmp-limiter"
}
]
}
]
}
}