Self-Service Manage Nodepools
note
This documentation is currently a work in progress and this feature will be available soon
Overview
The Self-Service Manage Nodepools feature allows users to interact with their cluster nodepools directly through the REST API. API definition can be found on trustnest APIM
Access Requirements
To manage nodepools, you must request K8SAAS APIM Access
Who can interact with nodepool?
Only members of the group <CLUSTER_NAME>-k8saas-devops-cluster-role have the necessary permissions to execute operations related to managing cluster nodepools.
The self-service Provide access allow to add members to <CLUSTER_NAME>-k8saas-devops-cluster-role's group.
How to interact with operations
There are two types of operations you can perform:
- Instantaneous Operations: These operations (GET) are synchronous and return results immediately within their payload.
- Long-Term Operations: These operations (PUT, POST and DELETE) are asynchronous. Once initiated, users must poll the Task Status API to check the current status of the operation.
Operation Workflow
Task Status Flow
Operations available
| Request Type | Description | API Details(require APIM access) |
|---|---|---|
| DELETE | Delete k8saas nodepool | details |
| GET | Retrieve the details of a specific nodepool in a k8saas cluster | details |
| GET | Retrieve the list of nodepools in a specific k8saas cluster | details |
| GET | Retrieve the status of a specific task in a k8saas cluster | details |
| POST | Start k8saas nodepool | details |
| POST | Stop k8saas nodepool | details |
| PUT | Update the details of a specific nodepool in a k8saas cluster | details |