> For the complete documentation index, see [llms.txt](https://docs.cloud.olakrutrim.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cloud.olakrutrim.com/sdk-guide/krutrim-kubernetes-system-sdk.md). # Krutrim Kubernetes System SDK ## POST /v1/kks/clusters > Create Cluster ```json {"openapi":"3.0.0","info":{"title":"KKS - Cloud - public Prod","version":"1.0.0"},"servers":[{"url":"http://10.230.150.171","description":"Production Server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Cluster":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"},"resourcesVpcConfig":{"type":"object","properties":{"vpcKrn":{"type":"string"},"subnetKrns":{"type":"string"}}},"kubernetesNetworkConfig":{"type":"object","properties":{"podIpv4Cidr":{"type":"string"},"serviceIpv4Cidr":{"type":"string"}}}}}}},"paths":{"/v1/kks/clusters":{"post":{"summary":"Create Cluster","tags":["Clusters"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cluster"}}}},"responses":{"201":{"description":"Created"}}}}}} ``` ## POST /v1/kks/clusters/{clusterKrn}/node-groups > Create Nodegroup ```json {"openapi":"3.0.0","info":{"title":"KKS - Cloud - public Prod","version":"1.0.0"},"servers":[{"url":"http://10.230.150.171","description":"Production Server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Nodegroup":{"type":"object","properties":{"name":{"type":"string"},"instanceTypes":{"type":"string"},"diskSize":{"type":"integer"},"scalingConfig":{"type":"object","properties":{"minSize":{"type":"integer"},"maxSize":{"type":"integer"},"desiredSize":{"type":"integer"}}},"subnetsKrn":{"type":"string"},"remoteAccess":{"type":"object","properties":{"sshKeyKrn":{"type":"string"},"sourceSecurityGroupsKrns":{"type":"array","items":{"type":"string"}}}},"nodeRepairConfig":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}}}},"paths":{"/v1/kks/clusters/{clusterKrn}/node-groups":{"post":{"summary":"Create Nodegroup","tags":["Node Groups"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Nodegroup"}}}},"responses":{"201":{"description":"Created"}}}}}} ``` ## GET /v1/kks/flavors > List flavors ```json {"openapi":"3.0.0","info":{"title":"KKS - Cloud - public Prod","version":"1.0.0"},"servers":[{"url":"http://10.230.150.171","description":"Production Server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v1/kks/flavors":{"get":{"summary":"List flavors","tags":["Metadata"],"responses":{"200":{"description":"Success"}}}}}} ``` ## POST /v1/kks/clusters/{clusterKrn}/addons > Install Addon ```json {"openapi":"3.0.0","info":{"title":"KKS - Cloud - public Prod","version":"1.0.0"},"servers":[{"url":"http://10.230.150.171","description":"Production Server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v1/kks/clusters/{clusterKrn}/addons":{"post":{"summary":"Install Addon","tags":["Addons"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"addonName":{"type":"string"}}}}}},"responses":{"201":{"description":"Installed"}}}}}} ``` ## GET /v1/kks/addons > List All addons ```json {"openapi":"3.0.0","info":{"title":"KKS - Cloud - public Prod","version":"1.0.0"},"servers":[{"url":"http://10.230.150.171","description":"Production Server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v1/kks/addons":{"get":{"summary":"List All addons","tags":["Metadata"],"responses":{"200":{"description":"Success"}}}}}} ``` ## GET /v1/kks/clusters/{clusterKrn}/kubeconfig > Retrieve kubeconfig ```json {"openapi":"3.0.0","info":{"title":"KKS - Cloud - public Prod","version":"1.0.0"},"servers":[{"url":"http://10.230.150.171","description":"Production Server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v1/kks/clusters/{clusterKrn}/kubeconfig":{"get":{"summary":"Retrieve kubeconfig","tags":["Clusters"],"responses":{"200":{"description":"kubeconfig file content"}}}}}} ``` ## GET /v1/kks/clusters > Get ALL clusters ```json {"openapi":"3.0.0","info":{"title":"KKS - Cloud - public Prod","version":"1.0.0"},"servers":[{"url":"http://10.230.150.171","description":"Production Server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v1/kks/clusters":{"get":{"summary":"Get ALL clusters","tags":["Clusters"],"responses":{"200":{"description":"Success"}}}}}} ``` ## GET /v1/kks/clusters/{clusterKrn} > Cluster by Cluster KRN ```json {"openapi":"3.0.0","info":{"title":"KKS - Cloud - public Prod","version":"1.0.0"},"servers":[{"url":"http://10.230.150.171","description":"Production Server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v1/kks/clusters/{clusterKrn}":{"get":{"summary":"Cluster by Cluster KRN","tags":["Clusters"],"responses":{"200":{"description":"Success"}}}}}} ``` ## GET /v1/kks/clusters/{clusterKrn}/node-groups > List All NodeGroups ```json {"openapi":"3.0.0","info":{"title":"KKS - Cloud - public Prod","version":"1.0.0"},"servers":[{"url":"http://10.230.150.171","description":"Production Server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v1/kks/clusters/{clusterKrn}/node-groups":{"get":{"summary":"List All NodeGroups","tags":["Node Groups"],"responses":{"200":{"description":"Success"}}}}}} ``` ## GET /v1/kks/clusters/{clusterKrn}/node-groups/{nodegroupKrn} > GET Nodegroup Details ```json {"openapi":"3.0.0","info":{"title":"KKS - Cloud - public Prod","version":"1.0.0"},"servers":[{"url":"http://10.230.150.171","description":"Production Server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v1/kks/clusters/{clusterKrn}/node-groups/{nodegroupKrn}":{"get":{"summary":"GET Nodegroup Details","tags":["Node Groups"],"responses":{"200":{"description":"Success"}}}}}} ``` ## GET /v1/kks/clusters/{clusterKrn}/addons > List Cluster Addons ```json {"openapi":"3.0.0","info":{"title":"KKS - Cloud - public Prod","version":"1.0.0"},"servers":[{"url":"http://10.230.150.171","description":"Production Server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v1/kks/clusters/{clusterKrn}/addons":{"get":{"summary":"List Cluster Addons","tags":["Addons"],"responses":{"200":{"description":"Success"}}}}}} ``` ## DELETE /v1/kks/clusters/{clusterKrn} > Delete cluster ```json {"openapi":"3.0.0","info":{"title":"KKS - Cloud - public Prod","version":"1.0.0"},"servers":[{"url":"http://10.230.150.171","description":"Production Server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v1/kks/clusters/{clusterKrn}":{"delete":{"summary":"Delete cluster","tags":["Clusters"],"responses":{"204":{"description":"Deleted"}}}}}} ``` ## DELETE /v1/kks/clusters/{clusterKrn}/node-groups/{nodegroupKrn} > Delete Nodegroup ```json {"openapi":"3.0.0","info":{"title":"KKS - Cloud - public Prod","version":"1.0.0"},"servers":[{"url":"http://10.230.150.171","description":"Production Server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v1/kks/clusters/{clusterKrn}/node-groups/{nodegroupKrn}":{"delete":{"summary":"Delete Nodegroup","tags":["Node Groups"],"responses":{"204":{"description":"Deleted"}}}}}} ``` ## DELETE /v1/kks/clusters/{clusterKrn}/addons/{addonKrn} > Delete Addon ```json {"openapi":"3.0.0","info":{"title":"KKS - Cloud - public Prod","version":"1.0.0"},"servers":[{"url":"http://10.230.150.171","description":"Production Server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v1/kks/clusters/{clusterKrn}/addons/{addonKrn}":{"delete":{"summary":"Delete Addon","tags":["Addons"],"responses":{"204":{"description":"Deleted"}}}}}} ``` ## POST /v1/kks/clusters/{clusterKrn}/updates > Upgrade cluster ```json {"openapi":"3.0.0","info":{"title":"KKS - Cloud - public Prod","version":"1.0.0"},"servers":[{"url":"http://10.230.150.171","description":"Production Server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v1/kks/clusters/{clusterKrn}/updates":{"post":{"summary":"Upgrade cluster","tags":["Clusters"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string"}}}}}},"responses":{"200":{"description":"Upgrade initiated"}}}}}} ``` ## PUT /v1/kks/clusters/{clusterKrn}/node-groups/{nodegroupKrn} > Upgrade nodegroup ```json {"openapi":"3.0.0","info":{"title":"KKS - Cloud - public Prod","version":"1.0.0"},"servers":[{"url":"http://10.230.150.171","description":"Production Server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v1/kks/clusters/{clusterKrn}/node-groups/{nodegroupKrn}":{"put":{"summary":"Upgrade nodegroup","tags":["Node Groups"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"scalingConfig":{"type":"object","properties":{"minSize":{"type":"integer"},"maxSize":{"type":"integer"},"desiredSize":{"type":"integer"}}}}}}}},"responses":{"200":{"description":"Updated"}}}}}} ``` ## The Cluster object ```json {"openapi":"3.0.0","info":{"title":"KKS - Cloud - public Prod","version":"1.0.0"},"components":{"schemas":{"Cluster":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"},"resourcesVpcConfig":{"type":"object","properties":{"vpcKrn":{"type":"string"},"subnetKrns":{"type":"string"}}},"kubernetesNetworkConfig":{"type":"object","properties":{"podIpv4Cidr":{"type":"string"},"serviceIpv4Cidr":{"type":"string"}}}}}}}} ``` ## The Nodegroup object ```json {"openapi":"3.0.0","info":{"title":"KKS - Cloud - public Prod","version":"1.0.0"},"components":{"schemas":{"Nodegroup":{"type":"object","properties":{"name":{"type":"string"},"instanceTypes":{"type":"string"},"diskSize":{"type":"integer"},"scalingConfig":{"type":"object","properties":{"minSize":{"type":"integer"},"maxSize":{"type":"integer"},"desiredSize":{"type":"integer"}}},"subnetsKrn":{"type":"string"},"remoteAccess":{"type":"object","properties":{"sshKeyKrn":{"type":"string"},"sourceSecurityGroupsKrns":{"type":"array","items":{"type":"string"}}}},"nodeRepairConfig":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.cloud.olakrutrim.com/sdk-guide/krutrim-kubernetes-system-sdk.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.