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 protocolpolicer.yaml has following contents (protocolpolicer.CreateRequest):

metadata:
  name: protocol-policer-1
  namespace: documentation
spec:
  protocolPolicer:
  - policer:
    - kind: policer
      name: tcp-syn-limiter
    protocol:
      tcp:
        flags:
        - SYN

vesctl yaml response:

metadata:
  annotations: {}
  labels: {}
  name: protocol-policer-1
  namespace: documentation
spec:
  protocolPolicer:
  - policer:
    - kind: policer
      name: tcp-syn-limiter
      namespace: documentation
      tenant: acmecorp
      uid: ffffffff-ffff-ffff-ffff-ffffffffffff
    protocol:
      tcp:
        flags:
        - SYN
systemMetadata:
  creationTimestamp: "2020-07-02T15:53:21.845528200Z"
  creatorClass: examplesvc.ves.io
  finalizers: []
  tenant: acmecorp
  uid: 3730805c-0af0-4be9-81c8-bdaeb722ba62

Request using curl:

curl -X 'POST' -d '{"metadata":{"name":"protocol-policer-1","namespace":"documentation"},"spec":{"protocolPolicer":[{"protocol":{"tcp":{"flags":["SYN"]}},"policer":[{"kind":"policer","name":"tcp-syn-limiter"}]}]}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_tmp_go-build743694289_b001_apidocs.test/host=docker-desktop' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/documentation/protocol_policers'

curl response:

HTTP/1.1 200 OK
Content-Length: 1027
Content-Type: application/json
Date: Thu, 02 Jul 2020 15:53:21 GMT
Vary: Accept-Encoding

{
  "metadata": {
    "name": "protocol-policer-1",
    "namespace": "documentation",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "3730805c-0af0-4be9-81c8-bdaeb722ba62",
    "creation_timestamp": "2020-07-02T15:53:21.845528200Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc.ves.io",
    "creator_id": "",
    "object_index": 0,
    "owner_view": null
  },
  "spec": {
    "protocol_policer": [
      {
        "protocol": {
          "tcp": {
            "flags": [
              "SYN"
            ]
          }
        },
        "policer": [
          {
            "kind": "policer",
            "uid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
            "tenant": "acmecorp",
            "namespace": "documentation",
            "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 protocolpolicer.yaml has following contents (protocolpolicer.CreateRequest):

metadata:
  name: protocol-policer-2
  namespace: documentation
spec:
  protocolPolicer:
  - policer:
    - kind: policer
      name: icmp-limiter
    protocol:
      icmp:
        type:
        - ALL_ICMP_MSG

vesctl yaml response:

metadata:
  annotations: {}
  labels: {}
  name: protocol-policer-2
  namespace: documentation
spec:
  protocolPolicer:
  - policer:
    - kind: policer
      name: icmp-limiter
      namespace: documentation
      tenant: acmecorp
      uid: ffffffff-ffff-ffff-ffff-ffffffffffff
    protocol:
      icmp:
        type:
        - ALL_ICMP_MSG
systemMetadata:
  creationTimestamp: "2020-07-02T15:53:21.850740900Z"
  creatorClass: examplesvc.ves.io
  finalizers: []
  tenant: acmecorp
  uid: 83b5964c-270b-4995-9147-7953798a8273

Request using curl:

curl -X 'POST' -d '{"metadata":{"name":"protocol-policer-2","namespace":"documentation"},"spec":{"protocolPolicer":[{"protocol":{"icmp":{"type":["ALL_ICMP_MSG"]}},"policer":[{"kind":"policer","name":"icmp-limiter"}]}]}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_tmp_go-build743694289_b001_apidocs.test/host=docker-desktop' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/documentation/protocol_policers'

curl response:

HTTP/1.1 200 OK
Content-Length: 1033
Content-Type: application/json
Date: Thu, 02 Jul 2020 15:53:21 GMT
Vary: Accept-Encoding

{
  "metadata": {
    "name": "protocol-policer-2",
    "namespace": "documentation",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "83b5964c-270b-4995-9147-7953798a8273",
    "creation_timestamp": "2020-07-02T15:53:21.850740900Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc.ves.io",
    "creator_id": "",
    "object_index": 0,
    "owner_view": null
  },
  "spec": {
    "protocol_policer": [
      {
        "protocol": {
          "icmp": {
            "type": [
              "ALL_ICMP_MSG"
            ]
          }
        },
        "policer": [
          {
            "kind": "policer",
            "uid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
            "tenant": "acmecorp",
            "namespace": "documentation",
            "name": "icmp-limiter"
          }
        ]
      }
    ]
  }
}