ves-io-schema-endpoint-API-Create
On This Page:
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": "bb248c40-3c78-4878-bfe3-408b93290a71",
"creation_timestamp": "2024-03-21T14:05:16.801092Z",
"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",
"disable_internet_vip": {},
"refs": []
}
},
"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=_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/documentation/endpoints'
curl response:
HTTP/1.1 200 OK
Content-Length: 1230
Content-Type: application/json
Date: Thu, 21 Mar 2024 14:05:16 GMT
Vary: Accept-Encoding
{
"metadata": {
"name": "productpage-endpoint",
"namespace": "documentation",
"labels": {
},
"annotations": {
},
"description": "",
"disable": false
},
"system_metadata": {
"uid": "bb248c40-3c78-4878-bfe3-408b93290a71",
"creation_timestamp": "2024-03-21T14:05:16.801092Z",
"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",
"disable_internet_vip": {
},
"refs": [
]
}
},
"protocol": "TCP",
"port": 9080,
"health_check_port": 0,
"service_info": {
"discovery_type": "K8S",
"service_name": "productpage"
}
}
}