Skip to content

Cluster

High Risk Operation

This resource includes operations that may cause significant changes. Review carefully before executing.

Confirmation Required

Some operations on this resource require explicit confirmation before execution.

Replacing an cluster object will update the object by replacing the existing spec with the provided one. For read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.

Tools

Tool Description
f5xc-api-virtual-cluster-create Create Cluster.
f5xc-api-virtual-cluster-get GET Cluster.
f5xc-api-virtual-cluster-list List Cluster.
f5xc-api-virtual-cluster-update Replace Cluster.
f5xc-api-virtual-cluster-delete DELETE Cluster.

Parameters

Path Parameters

Parameter Description Example
metadata.namespace Namespace -
name Name -
namespace Namespace -
metadata.name Name -

Query Parameters

Parameter Description Example
response_format The format in which the configuration object is to be fetched. This could be for example -
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 -

Side Effects

Operations on this resource may have the following effects:

Creates:

  • cluster

Modifies:

  • cluster

Deletes:

  • cluster
  • contained_resources

Example Usage

Ask Claude to help you work with Cluster resources:

Create Cluster

"Create a cluster named 'example' in the 'production' namespace"

List Clusters

"List all clusters in the 'production' namespace"

Get Cluster Details

"Get details of the cluster named 'example' in namespace 'production'"

CURL Examples

# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/clusters" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json"

# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/clusters/<name>" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json"

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

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