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):

metadata:
  name: productpage-endpoint
  namespace: documentation
spec:
  port: 9080
  protocol: TCP
  serviceInfo:
    discoveryType: K8S
    serviceName: productpage
  where:
    virtualSite:
      ref:
      - kind: virtual_site
        name: acmecorp-vsite
        namespace: documentation
        tenant: acmecorp

vesctl yaml response:

metadata:
  annotations: {}
  labels: {}
  name: productpage-endpoint
  namespace: documentation
spec:
  port: 9080
  protocol: TCP
  serviceInfo:
    discoveryType: K8S
    serviceName: productpage
  where:
    virtualSite:
      ref:
      - kind: virtual_site
        name: acmecorp-vsite
        namespace: documentation
        tenant: acmecorp
        uid: ffffffff-ffff-ffff-ffff-ffffffffffff
systemMetadata:
  creationTimestamp: "2021-08-25T09:02:58.630693501Z"
  creatorClass: examplesvc
  creatorId: examplesvc
  finalizers: []
  tenant: acmecorp
  uid: fc18733a-de65-4562-81c9-21827f711c0c

Request using curl:

curl -X 'POST' -d '{"metadata":{"name":"productpage-endpoint","namespace":"documentation"},"spec":{"where":{"virtualSite":{"ref":[{"kind":"virtual_site","tenant":"acmecorp","namespace":"documentation","name":"acmecorp-vsite"}]}},"protocol":"TCP","port":9080,"serviceInfo":{"discoveryType":"K8S","serviceName":"productpage"}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_tmp_go-build970361017_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: 1135
Content-Type: application/json
Date: Wed, 25 Aug 2021 09:02:58 GMT
Vary: Accept-Encoding

{
  "metadata": {
    "name": "productpage-endpoint",
    "namespace": "documentation",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "fc18733a-de65-4562-81c9-21827f711c0c",
    "creation_timestamp": "2021-08-25T09:02:58.630693501Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc",
    "creator_id": "examplesvc",
    "object_index": 0,
    "owner_view": null
  },
  "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"
    }
  }
}