GPR Template Binding
A GPR template binding is the GPR template that associates with the workspace.
Create GPR Template Binding
Use this API to create a new GPR template binding.
Method and URL
POST /api/v1/gpr-template-binding
Parameters
Parameter | Parameter Type | Description | Required |
---|---|---|---|
workspaceName | String | The name of the workspace. | Mandatory |
clusters | Object | This object is an array of clusters. | Mandatory |
enableAutoGPR | Boolean | This parameter denotes weather Auto GPR is enable or not. | Mandatory |
Clusters Parameters
Parameter | Parameter Type | Description | Required |
---|---|---|---|
clusterName | String | The name of the cluster. | Mandatory |
defaultTemplateName | String | The default GPR template name. | Mandatory |
templates | ListofStrings | The list of the GPR template names. | Mandatory |
Example Request
curl -X POST --location --globoff --request
`{
"workspaceName": "delhi",
"clusters": [
{
"clusterName": "worker-1",
"defaultTemplateName": "api-test1",
"templates": ["api-test1"]
}
],
"enableAutoGPR": true
}'
Example Responses
Response: Success
{
"statusCode": 200,
"status": "OK",
"message": "Success",
"data": '{
"name": "delhi",
"namespace": "kubeslice-avesha",
"clusters": [
{
"clusterName": "worker-1",
"defaultTemplateName": "api-test1",
"templates": [
"api-test1"
]
}
],
"enableAutoGPR": true
}
}
Get GPR Template Binding
Use this API to get the details of GPR template binding.
Method and URL
GET /api/v1/gpr-template-binding
Example Request
curl -X GET --location --globoff --request
{{host}}/api/v1/gpr-template?gprTemplateBindingName=abc
Example Responses
Response: Success
{
"statusCode":200,
"status":"OK",
"message":"Success",
"data":{
"name":"abc",
"clusters":[{
"clusterName":"worker-1",
"defaultTemplateName":"solo-leveling-3-mig-template",
"templates":["dev-team1-2","solo-leveling-5-template","solo-leveling-3-mig-template"],
"defaultTemplateStatus":"Failed",
"templateStatus":{"dev-team1-2":"NotFound","solo-leveling-3-mig-template":"Failed","solo-leveling-5-template":"Ready"}
}],
"enableAutoGPR":false}
}
List GPR Template Bindings
Use this API to list GPR template bindings.
Method and URL
GET /api/v1/gpr-template-binding/list
Example Request
curl -X GET --location --globoff --request
{{host}}/api/v1/gpr-template-binding/list
Example Responses
Response: Success
{
"statusCode": 200,
"status":"OK",
"message":"Success",
"data":{
"templateBindings":[{
"name":"111",
"clusters":[{
"clusterName":
"worker-1",
"defaultTemplateName":"first",
"templates":
["hello-world","first","hello-woorld"],
"defaultTemplateStatus":"Ready",
"templateStatus":{
"first":"Ready",
"hello-world":"Ready"}
}],
"enableAutoGPR":true
},
{
"name":"abc",
"clusters":[{
"clusterName":"worker-1",
"defaultTemplateName":"solo-leveling-3-mig-template",
"templates": ["dev-team1-2","solo-leveling-5-template","solo-leveling-3-mig-template"],
"defaultTemplateStatus":"Failed",
"templateStatus":{
"dev-team1-2":"NotFound",
"solo-leveling-3-mig-template":"Failed",
"solo-leveling-5-template":"Ready"
}
}],
"enableAutoGPR":false},
{
"name":"andromeda",
"clusters":[{
"clusterName":"worker-1",
"defaultTemplateName":"api-test1",
"templates": ["api-test1"],
"defaultTemplateStatus":"Ready",
"templateStatus":{"api-test1":"Ready"}
}],
"enableAutoGPR":false},
{
"name":"api-test",
"clusters":[{
"clusterName":"worker-1",
"defaultTemplateName":
"rest1","templates": ["rest1"],
"defaultTemplateStatus":"Ready",
"templateStatus": {"rest1":"Ready"}
}],
"enableAutoGPR":true},
{
"name":"auto-gpr",
"clusters":null,
"enableAutoGPR":false
},
{
"name":"blue-origin",
"clusters":[{
"clusterName":"worker-1",
"defaultTemplateName":"hello-woorld",
"templates":["hello-woorld"],
"defaultTemplateStatus":"Ready",
"templateStatus":{"hello-woorld":"Ready"}
}],
"enableAutoGPR":false},
}}
Update GPR Template Binding
Use this API to update the GPR template binding.
Method and URL
PUT /api/v1/gpr-template-binding
Parameters
Parameter | Parameter Type | Description | Required |
---|---|---|---|
workspaceName | String | The name of the workspace. | Mandatory |
clusters | Object | This object is an array of clusters. | Mandatory |
enableAutoGPR | Boolean | This is the parameter to enable Auto GPR. | Mandatory |
Clusters Parameters
Parameter | Parameter Type | Description | Required |
---|---|---|---|
clusterName | String | The name of the cluster. | Mandatory |
defaultTemplateName | String | The default template name. | Mandatory |
templates | ListofStrings | The list of the GPR template names. | Mandatory |
Example Request
curl -X PUT --location --globoff --request
'{
"workspaceName": "delhi",
"clusters": [
{
"clusterName": "worker-1",
"defaultTemplateName": "dummy",
"templates": ["dummy", "abc"]
}
],
"enableAutoGPR": true
}.
Example Responses
Response: Success
{
"statusCode": 200,
"status": "OK",
"message": "Success",
"data": {
"name": "delhi",
"namespace": "",
"clusters": [
{
"clusterName": "worker-1",
"defaultTemplateName": "dummy",
"templates": [
"dummy",
"abc"
],
"defaultTemplateStatus": "Ready",
"templateStatus": {
"api-test1": "Ready"
}
}
],
"enableAutoGPR": true
}
}
Delete GPR Template Binding
Use this API to delete the GPR template binding.
Method and URL
DEL /api/v1/gpr-template-binding
Parameters
Parameter | Parameter Type | Description | Required |
---|---|---|---|
gprTemplateBindingName | String | The GPR template name that you want to delete. | Mandatory |
Example Request
curl -X DEL --location --globoff --request
'{
"gprTemplateBindingName": "api-test"
}'
Example Responses
Response: Success
{
"statusCode": 200,
"status": "OK",
"message": "Success",
"data": {}
}