​

ves-io-schema-k8s_cluster-API-Create

Published April 5, 2023 | Last modified May 28, 2026

Examples of creating k8s_cluster

Usecase:

Create k8s cluster for a site

Request using vesctl:

vesctl configuration create k8s_cluster -i k8s_cluster.yaml

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

RequestJSON:

{
    "metadata": {
        "name": "k8s-cluster-1",
        "namespace": "system"
    },
    "spec": {
        "local_access_config": {
            "local_domain": "example.com",
            "default_port": {}
        },
        "no_global_access": {},
        "use_default_psp": {},
        "use_default_cluster_roles": {},
        "use_default_cluster_role_bindings": {},
        "no_cluster_wide_apps": {},
        "no_insecure_registries": {},
        "cluster_scoped_access_deny": {},
        "use_default_pod_security_admission": {}
    }
}

vesctl yaml response:

ResponseJSON:

{
    "metadata": {
        "name": "k8s-cluster-1",
        "namespace": "system",
        "labels": {},
        "annotations": {},
        "description": "",
        "disable": false
    },
    "system_metadata": {
        "uid": "6d6ccc41-17f4-4ab5-9ef7-9a9c9fbf34e8",
        "creation_timestamp": "2026-04-13T01:59:41.918520Z",
        "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": {
        "local_access_config": {
            "local_domain": "example.com",
            "default_port": {}
        },
        "no_global_access": {},
        "use_default_psp": {},
        "use_default_cluster_roles": {},
        "use_default_cluster_role_bindings": {},
        "no_cluster_wide_apps": {},
        "no_insecure_registries": {},
        "cluster_scoped_access_deny": {},
        "vk8s_namespace_access_deny": {},
        "use_default_pod_security_admission": {}
    }
}

Request using curl:

curl -X 'POST' -d '{"metadata":{"name":"k8s-cluster-1","namespace":"system"},"spec":{"local_access_config":{"local_domain":"example.com","default_port":{}},"no_global_access":{},"use_default_psp":{},"use_default_cluster_roles":{},"use_default_cluster_role_bindings":{},"no_cluster_wide_apps":{},"no_insecure_registries":{},"cluster_scoped_access_deny":{},"use_default_pod_security_admission":{}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build1414723615_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/k8s_clusters'

curl response:

HTTP/1.1 200 OK
Content-Length: 1094
Content-Type: application/json
Date: Mon, 13 Apr 2026 01:59:41 GMT
Vary: Accept-Encoding


{
  "metadata": {
    "name": "k8s-cluster-1",
    "namespace": "system",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "6d6ccc41-17f4-4ab5-9ef7-9a9c9fbf34e8",
    "creation_timestamp": "2026-04-13T01:59:41.918520Z",
    "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": {
    "local_access_config": {
      "local_domain": "example.com",
      "default_port": {


      }
    },
    "no_global_access": {


    },
    "use_default_psp": {


    },
    "use_default_cluster_roles": {


    },
    "use_default_cluster_role_bindings": {


    },
    "no_cluster_wide_apps": {


    },
    "no_insecure_registries": {


    },
    "cluster_scoped_access_deny": {


    },
    "vk8s_namespace_access_deny": {


    },
    "use_default_pod_security_admission": {


    }
  }
}
On this page: