K8S Cluster

K8S Cluster provides tools for creating, listing, retrieving, updating, and deleting resources in F5 Distributed Cloud.

Tools

Tool	Description
`f5xc-api-sites-k8s-cluster-create`	Create Configuration Specification.
`f5xc-api-sites-k8s-cluster-get`	Get Configuration Specification.
`f5xc-api-sites-k8s-cluster-list`	List K8s Cluster.
`f5xc-api-sites-k8s-cluster-update`	Update Configuration Specification.
`f5xc-api-sites-k8s-cluster-delete`	Delete K8s Cluster.

Parameters

Path Parameters

Parameter	Description	Example
`namespace`	Namespace This defines the workspace within which each the configuration object is to be created.	`system`
`name`	Name The name of the configuration object to be fetched.	`example-resource`

Query Parameters

Parameter	Description	Example
`response_format`	The format in which the configuration object is to be fetched. This could be for example - in GetSpec form for the contents of object…	`GET_RSP_FORMAT_DEFAULT`
`label_filter`	A LabelSelectorType expression that every item in list response will satisfy.	`-`
`report_fields`	The report_fields parameter…	`-`
`report_status_fields`	The report_status_fields parameter…	`-`

Configuration Choices

This resource includes mutually exclusive configuration options:

apps_choice

Option	Description	Recommended
`spec.cluster_wide_app_list`	Cluster wide app list
`spec.no_cluster_wide_apps`	No cluster wide apps

cluster_role_bindings_choice

Option	Description	Recommended
`spec.use_custom_cluster_role_bindings`	Use custom cluster role bindings
`spec.use_default_cluster_role_bindings`	Use default cluster role bindings

cluster_role_choice

Option	Description	Recommended
`spec.use_custom_cluster_role_list`	Use custom cluster role list
`spec.use_default_cluster_roles`	Use default cluster roles

cluster_scoped_resource_access_choice

Option	Description	Recommended
`spec.cluster_scoped_access_deny`	Cluster scoped access deny
`spec.cluster_scoped_access_permit`	Cluster scoped access permit

global_access_choice

Option	Description	Recommended
`spec.global_access_enable`	Global access enable
`spec.no_global_access`	No global access

insecure_registries_choice

Option	Description	Recommended
`spec.insecure_registry_list`	Insecure registry list
`spec.no_insecure_registries`	No insecure registries

local_access_choice

Option	Description	Recommended
`spec.local_access_config`	Local access config
`spec.no_local_access`	No local access

pod_security_admission_choice

Option	Description	Recommended
`spec.use_custom_pod_security_admission`	Use custom pod security admission
`spec.use_default_pod_security_admission`	Use default pod security admission

pod_security_policy_choice

Option	Description	Recommended
`spec.use_custom_psp_list`	Use custom psp list
`spec.use_default_psp`	Use default psp

vk8s_namespace_access_choice

Option	Description	Recommended
`spec.vk8s_namespace_access_deny`	Vk8s namespace access deny
`spec.vk8s_namespace_access_permit`	Vk8s namespace access permit

Example Usage

Ask Claude to help you work with K8S Cluster resources:

Create K8S Cluster

“Create a k8s-cluster named ‘example’ in the ‘production’ namespace”

List K8S Clusters

“List all k8s-clusters in the ‘production’ namespace”

Get K8S Cluster Details

“Get details of the k8s-cluster named ‘example’ in namespace ‘production‘“

CURL Examples

# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/k8s_clusters" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"

# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/k8s_clusters/$${PARAM}" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"

# Create resource
curl -X POST "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/k8s_clusters" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d @k8s_cluster.json

# Delete resource
curl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/k8s_clusters/$${PARAM}" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"