ves-io-schema-endpoint-API-Create

Examples of creating endpoint

Usecase:

Create productpage endpoint

Request using vesctl:

vesctl configuration create endpoint -i endpoint.yaml

where file endpoint.yaml has following contents (endpoint.CreateRequest):

RequestJSON:

{
    "metadata": {
        "name": "productpage-endpoint",
        "namespace": "documentation"
    },
    "spec": {
        "where": {
            "virtual_site": {
                "ref": [
                    {
                        "kind": "virtual_site",
                        "tenant": "acmecorp",
                        "namespace": "documentation",
                        "name": "acmecorp-vsite"
                    }
                ]
            }
        },
        "protocol": "TCP",
        "port": 9080,
        "service_info": {
            "discovery_type": "K8S",
            "service_name": "productpage"
        }
    }
}

vesctl yaml response:

ResponseJSON:

{
    "metadata": {
        "name": "productpage-endpoint",
        "namespace": "documentation",
        "labels": {},
        "annotations": {},
        "description": "",
        "disable": false
    },
    "system_metadata": {
        "uid": "8fd2f88f-0ec9-49bb-a0ae-35e3340b2d98",
        "creation_timestamp": "2022-09-23T13:12:06.282412246Z",
        "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": {
        "where": {
            "virtual_site": {
                "ref": [
                    {
                        "kind": "virtual_site",
                        "uid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
                        "tenant": "acmecorp",
                        "namespace": "documentation",
                        "name": "acmecorp-vsite"
                    }
                ],
                "network_type": "VIRTUAL_NETWORK_SITE_LOCAL"
            }
        },
        "protocol": "TCP",
        "port": 9080,
        "health_check_port": 0,
        "service_info": {
            "discovery_type": "K8S",
            "service_name": "productpage"
        }
    }
}

Request using curl:

curl -X 'POST' -d '{"metadata":{"name":"productpage-endpoint","namespace":"documentation"},"spec":{"where":{"virtual_site":{"ref":[{"kind":"virtual_site","tenant":"acmecorp","namespace":"documentation","name":"acmecorp-vsite"}]}},"protocol":"TCP","port":9080,"service_info":{"discovery_type":"K8S","service_name":"productpage"}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_tmp_go-build243329498_b001_apidocs.test/host=docker-desktop' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/documentation/endpoints'

curl response:

HTTP/1.1 200 OK
Content-Length: 1158
Content-Type: application/json
Date: Fri, 23 Sep 2022 13:12:06 GMT
Vary: Accept-Encoding

{
  "metadata": {
    "name": "productpage-endpoint",
    "namespace": "documentation",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "8fd2f88f-0ec9-49bb-a0ae-35e3340b2d98",
    "creation_timestamp": "2022-09-23T13:12:06.282412246Z",
    "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": {
    "where": {
      "virtual_site": {
        "ref": [
          {
            "kind": "virtual_site",
            "uid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
            "tenant": "acmecorp",
            "namespace": "documentation",
            "name": "acmecorp-vsite"
          }
        ],
        "network_type": "VIRTUAL_NETWORK_SITE_LOCAL"
      }
    },
    "protocol": "TCP",
    "port": 9080,
    "health_check_port": 0,
    "service_info": {
      "discovery_type": "K8S",
      "service_name": "productpage"
    }
  }
}