Describe pod API (#1861)

This commit is contained in:
adfost
2022-05-02 18:35:36 -07:00
committed by GitHub
parent fef7863810
commit 00bcb54b67
23 changed files with 3811 additions and 2 deletions

View File

@@ -1200,6 +1200,49 @@ func init() {
}
}
},
"/namespaces/{namespace}/tenants/{tenant}/pods/{podName}/describe": {
"get": {
"tags": [
"OperatorAPI"
],
"summary": "Describe Pod",
"operationId": "DescribePod",
"parameters": [
{
"type": "string",
"name": "namespace",
"in": "path",
"required": true
},
{
"type": "string",
"name": "tenant",
"in": "path",
"required": true
},
{
"type": "string",
"name": "podName",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/describePodWrapper"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/error"
}
}
}
}
},
"/namespaces/{namespace}/tenants/{tenant}/pods/{podName}/events": {
"get": {
"tags": [
@@ -2017,6 +2060,28 @@ func init() {
}
}
},
"condition": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"configMap": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
}
},
"configureTenantRequest": {
"type": "object",
"properties": {
@@ -2025,6 +2090,65 @@ func init() {
}
}
},
"container": {
"type": "object",
"properties": {
"args": {
"type": "array",
"items": {
"type": "string"
}
},
"containerID": {
"type": "string"
},
"environmentVariables": {
"type": "array",
"items": {
"$ref": "#/definitions/environmentVariable"
}
},
"hostPorts": {
"type": "array",
"items": {
"type": "string"
}
},
"image": {
"type": "string"
},
"imageID": {
"type": "string"
},
"lastState": {
"$ref": "#/definitions/state"
},
"mounts": {
"type": "array",
"items": {
"$ref": "#/definitions/mount"
}
},
"name": {
"type": "string"
},
"ports": {
"type": "array",
"items": {
"type": "string"
}
},
"ready": {
"type": "boolean"
},
"restartCount": {
"type": "integer"
},
"state": {
"$ref": "#/definitions/state"
}
}
},
"createTenantRequest": {
"type": "object",
"required": [
@@ -2157,6 +2281,95 @@ func init() {
}
}
},
"describePodWrapper": {
"type": "object",
"properties": {
"annotations": {
"type": "array",
"items": {
"$ref": "#/definitions/annotation"
}
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/definitions/condition"
}
},
"containers": {
"type": "array",
"items": {
"$ref": "#/definitions/container"
}
},
"controllerRef": {
"type": "string"
},
"deletionGracePeriodSeconds": {
"type": "integer"
},
"deletionTimestamp": {
"type": "string"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/label"
}
},
"message": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"nodeName": {
"type": "string"
},
"nodeSelector": {
"type": "array",
"items": {
"$ref": "#/definitions/nodeSelector"
}
},
"phase": {
"type": "string"
},
"podIP": {
"type": "string"
},
"priority": {
"type": "integer"
},
"priorityClassName": {
"type": "string"
},
"qosClass": {
"type": "string"
},
"reason": {
"type": "string"
},
"startTime": {
"type": "string"
},
"tolerations": {
"type": "array",
"items": {
"$ref": "#/definitions/toleration"
}
},
"volumes": {
"type": "array",
"items": {
"$ref": "#/definitions/volume"
}
}
}
},
"directCSIDriveInfo": {
"type": "object",
"properties": {
@@ -2324,6 +2537,17 @@ func init() {
}
]
},
"environmentVariable": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"error": {
"type": "object",
"required": [
@@ -2886,6 +3110,23 @@ func init() {
}
}
},
"mount": {
"type": "object",
"properties": {
"mountPath": {
"type": "string"
},
"name": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"subPath": {
"type": "string"
}
}
},
"namespace": {
"type": "object",
"required": [
@@ -3357,6 +3598,34 @@ func init() {
}
}
},
"projectedVolume": {
"type": "object",
"properties": {
"sources": {
"type": "array",
"items": {
"$ref": "#/definitions/projectedVolumeSource"
}
}
}
},
"projectedVolumeSource": {
"type": "object",
"properties": {
"configMap": {
"$ref": "#/definitions/configMap"
},
"downwardApi": {
"type": "boolean"
},
"secret": {
"$ref": "#/definitions/secret"
},
"serviceAccountToken": {
"$ref": "#/definitions/serviceAccountToken"
}
}
},
"prometheusConfiguration": {
"type": "object",
"properties": {
@@ -3383,6 +3652,17 @@ func init() {
}
}
},
"pvc": {
"type": "object",
"properties": {
"claimName": {
"type": "string"
},
"readOnly": {
"type": "boolean"
}
}
},
"pvcsListResponse": {
"type": "object",
"properties": {
@@ -3442,6 +3722,17 @@ func init() {
}
}
},
"secret": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
}
},
"securityContext": {
"type": "object",
"required": [
@@ -3465,6 +3756,40 @@ func init() {
}
}
},
"serviceAccountToken": {
"type": "object",
"properties": {
"expirationSeconds": {
"type": "integer"
}
}
},
"state": {
"type": "object",
"properties": {
"exitCode": {
"type": "integer"
},
"finished": {
"type": "string"
},
"message": {
"type": "string"
},
"reason": {
"type": "string"
},
"signal": {
"type": "integer"
},
"started": {
"type": "string"
},
"state": {
"type": "string"
}
}
},
"subscriptionValidateRequest": {
"type": "object",
"properties": {
@@ -3901,6 +4226,26 @@ func init() {
}
}
},
"toleration": {
"type": "object",
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"tolerationSeconds": {
"type": "integer"
},
"value": {
"type": "string"
}
}
},
"updateDomainsRequest": {
"type": "object",
"properties": {
@@ -4088,6 +4433,20 @@ func init() {
}
}
}
},
"volume": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"projected": {
"$ref": "#/definitions/projectedVolume"
},
"pvc": {
"$ref": "#/definitions/pvc"
}
}
}
},
"securityDefinitions": {
@@ -5270,6 +5629,49 @@ func init() {
}
}
},
"/namespaces/{namespace}/tenants/{tenant}/pods/{podName}/describe": {
"get": {
"tags": [
"OperatorAPI"
],
"summary": "Describe Pod",
"operationId": "DescribePod",
"parameters": [
{
"type": "string",
"name": "namespace",
"in": "path",
"required": true
},
{
"type": "string",
"name": "tenant",
"in": "path",
"required": true
},
{
"type": "string",
"name": "podName",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/describePodWrapper"
}
},
"default": {
"description": "Generic error response.",
"schema": {
"$ref": "#/definitions/error"
}
}
}
}
},
"/namespaces/{namespace}/tenants/{tenant}/pods/{podName}/events": {
"get": {
"tags": [
@@ -6930,6 +7332,28 @@ func init() {
}
}
},
"condition": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"configMap": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
}
},
"configureTenantRequest": {
"type": "object",
"properties": {
@@ -6938,6 +7362,65 @@ func init() {
}
}
},
"container": {
"type": "object",
"properties": {
"args": {
"type": "array",
"items": {
"type": "string"
}
},
"containerID": {
"type": "string"
},
"environmentVariables": {
"type": "array",
"items": {
"$ref": "#/definitions/environmentVariable"
}
},
"hostPorts": {
"type": "array",
"items": {
"type": "string"
}
},
"image": {
"type": "string"
},
"imageID": {
"type": "string"
},
"lastState": {
"$ref": "#/definitions/state"
},
"mounts": {
"type": "array",
"items": {
"$ref": "#/definitions/mount"
}
},
"name": {
"type": "string"
},
"ports": {
"type": "array",
"items": {
"type": "string"
}
},
"ready": {
"type": "boolean"
},
"restartCount": {
"type": "integer"
},
"state": {
"$ref": "#/definitions/state"
}
}
},
"createTenantRequest": {
"type": "object",
"required": [
@@ -7070,6 +7553,95 @@ func init() {
}
}
},
"describePodWrapper": {
"type": "object",
"properties": {
"annotations": {
"type": "array",
"items": {
"$ref": "#/definitions/annotation"
}
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/definitions/condition"
}
},
"containers": {
"type": "array",
"items": {
"$ref": "#/definitions/container"
}
},
"controllerRef": {
"type": "string"
},
"deletionGracePeriodSeconds": {
"type": "integer"
},
"deletionTimestamp": {
"type": "string"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/label"
}
},
"message": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"nodeName": {
"type": "string"
},
"nodeSelector": {
"type": "array",
"items": {
"$ref": "#/definitions/nodeSelector"
}
},
"phase": {
"type": "string"
},
"podIP": {
"type": "string"
},
"priority": {
"type": "integer"
},
"priorityClassName": {
"type": "string"
},
"qosClass": {
"type": "string"
},
"reason": {
"type": "string"
},
"startTime": {
"type": "string"
},
"tolerations": {
"type": "array",
"items": {
"$ref": "#/definitions/toleration"
}
},
"volumes": {
"type": "array",
"items": {
"$ref": "#/definitions/volume"
}
}
}
},
"directCSIDriveInfo": {
"type": "object",
"properties": {
@@ -7237,6 +7809,17 @@ func init() {
}
]
},
"environmentVariable": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"error": {
"type": "object",
"required": [
@@ -7787,6 +8370,23 @@ func init() {
}
}
},
"mount": {
"type": "object",
"properties": {
"mountPath": {
"type": "string"
},
"name": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"subPath": {
"type": "string"
}
}
},
"namespace": {
"type": "object",
"required": [
@@ -8123,6 +8723,34 @@ func init() {
}
}
},
"projectedVolume": {
"type": "object",
"properties": {
"sources": {
"type": "array",
"items": {
"$ref": "#/definitions/projectedVolumeSource"
}
}
}
},
"projectedVolumeSource": {
"type": "object",
"properties": {
"configMap": {
"$ref": "#/definitions/configMap"
},
"downwardApi": {
"type": "boolean"
},
"secret": {
"$ref": "#/definitions/secret"
},
"serviceAccountToken": {
"$ref": "#/definitions/serviceAccountToken"
}
}
},
"prometheusConfiguration": {
"type": "object",
"properties": {
@@ -8149,6 +8777,17 @@ func init() {
}
}
},
"pvc": {
"type": "object",
"properties": {
"claimName": {
"type": "string"
},
"readOnly": {
"type": "boolean"
}
}
},
"pvcsListResponse": {
"type": "object",
"properties": {
@@ -8208,6 +8847,17 @@ func init() {
}
}
},
"secret": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
}
},
"securityContext": {
"type": "object",
"required": [
@@ -8231,6 +8881,40 @@ func init() {
}
}
},
"serviceAccountToken": {
"type": "object",
"properties": {
"expirationSeconds": {
"type": "integer"
}
}
},
"state": {
"type": "object",
"properties": {
"exitCode": {
"type": "integer"
},
"finished": {
"type": "string"
},
"message": {
"type": "string"
},
"reason": {
"type": "string"
},
"signal": {
"type": "integer"
},
"started": {
"type": "string"
},
"state": {
"type": "string"
}
}
},
"subscriptionValidateRequest": {
"type": "object",
"properties": {
@@ -8667,6 +9351,26 @@ func init() {
}
}
},
"toleration": {
"type": "object",
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"tolerationSeconds": {
"type": "integer"
},
"value": {
"type": "string"
}
}
},
"updateDomainsRequest": {
"type": "object",
"properties": {
@@ -8854,6 +9558,20 @@ func init() {
}
}
}
},
"volume": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"projected": {
"$ref": "#/definitions/projectedVolume"
},
"pvc": {
"$ref": "#/definitions/pvc"
}
}
}
},
"securityDefinitions": {