Cluster Nodes (Scaling)
A set of operations for managing the scaling of Kubernetes clusters.
Hyperstack Kubernetes is currently in Beta, and you may experience bugs or performance issues as we refine it.
| Endpoint Name | URL | Description |
|---|---|---|
| Create Nodes | POST /core/clusters/nodes | Adds node(s) to an existing cluster. |
| Retrieve Nodes | GET /core/clusters/{id}/nodes | Retrieves the details of a clusters nodes. |
| Delete Node | DELETE /core/clusters/{id}/nodes | Removes a node from a specified cluster. |
The node object
Node endpoints return the nodes object(s), offering comprehensive details about your cluster nodes.
Attributes of the node object
id integer
The unique identifier assigned to the node.
instance_id integer
The ID of the VM instance for the node.
instance_name string
The name of the VM instance associated with the node.
role string
Defines the function of the node within the cluster. Each cluster consists of at least one node of each type, with the possibility of multiple worker nodes to handle workload distribution. To learn more about Kubernetes architecture and node roles, click here.
Possible values:
worker– Executes workloads and processes applications.master– Oversees cluster state, orchestrates scheduling, and manages workloads.bastion– Serves as a secure SSH gateway for administrative access to the cluster.load-balancer– Routes and distributes traffic across worker nodes to ensure high availability and reliability.
status string
The current status of the node (e.g., CREATING, ACTIVE).
status_reason string
A brief explanation of the node’s current status.
is_bastion boolean
Indicates whether the node functions as a bastion host (true or false).
requires_public_ip boolean
Indicates whether the node requires a public IP address (true or false).
created_at date-time
The timestamp when the node was created.
updated_at date-time
The timestamp when the node was last updated.
{
"id": 1383,
"instance_id": 7444,
"instance_name": "kube-example-cluster-worker-0",
"role": "worker",
"status": "CREATING",
"status_reason": "VM is creating",
"is_bastion": false,
"requires_public_ip": false,
"created_at": "2025-02-27T13:10:35",
"updated_at": "2025-02-27T13:10:35"
}