diff --git a/cloudtower-api-doc/static/sks-specs/1.4.0-swagger.json b/cloudtower-api-doc/static/sks-specs/1.4.0-swagger.json index e56caa2..f70f25a 100644 --- a/cloudtower-api-doc/static/sks-specs/1.4.0-swagger.json +++ b/cloudtower-api-doc/static/sks-specs/1.4.0-swagger.json @@ -19,7 +19,7 @@ "/api/v1/servers/connectivity-probes/:namespace/:name": { "post": { "tags": [ - "Instances" + "Instance" ], "summary": "Network connectivity probe on serverInstance.", "operationId": "instances/connectivity-probes", @@ -103,9 +103,9 @@ "/api/v1/servers/labels": { "get": { "tags": [ - "Instances" + "Instance" ], - "summary": "Get all Ready ServiceInstance label sets.", + "summary": "Get ready ServiceInstance label sets.", "operationId": "instances/jobs", "responses": { "200": { @@ -134,7 +134,7 @@ "/api/v1/servers/prepare-environment": { "get": { "tags": [ - "Instances" + "Instance" ], "summary": "Download prepare environment command.", "operationId": "instances/commands", @@ -165,9 +165,9 @@ "/clusters": { "get": { "tags": [ - "Clusters" + "Cluster" ], - "summary": "Get all workload clusters.", + "summary": "Get workload clusters.", "operationId": "ListClusters", "parameters": [ { @@ -204,7 +204,7 @@ }, "post": { "tags": [ - "Clusters" + "Cluster" ], "summary": "Create a workload cluster", "operationId": "CreateCluster", @@ -257,7 +257,7 @@ "/clusters/:cluster": { "get": { "tags": [ - "Clusters" + "Cluster" ], "summary": "Get a workload cluster.", "operationId": "GetCluster", @@ -296,7 +296,7 @@ }, "put": { "tags": [ - "Clusters" + "Cluster" ], "summary": "Update a workload cluster.", "operationId": "UpdateCluster", @@ -347,7 +347,7 @@ }, "delete": { "tags": [ - "Clusters" + "Cluster" ], "summary": "Delete a workload cluster.", "operationId": "DeleteCluster", @@ -390,7 +390,7 @@ "/clusters/:cluster/addons": { "get": { "tags": [ - "Clusters" + "Cluster" ], "summary": "Get addons of a workload cluster.", "operationId": "listClusterAddons", @@ -431,7 +431,7 @@ "/clusters/:cluster/kubeconfig": { "get": { "tags": [ - "Clusters" + "Cluster" ], "summary": "Get the kubeconfig of a workload cluster.", "operationId": "GetClusterKubeconfig", @@ -472,7 +472,7 @@ "/clusters/{cluster}/proxy/{k8s_url}": { "get": { "tags": [ - "Workload Clusters" + "Workload Cluster" ], "summary": "Proxy all requests to the workload kubernetes cluster.", "description": "The request uri format is like /api/v1/clusters/{cluster}/proxy/{k8s_url}. Support any HTTP method of the proxied API (GET, POST, DELETE, PUT, PATCH, etc.)", @@ -875,7 +875,22 @@ "type": "object", "properties": { "Format": { - "type": "string" + "type": "string", + "enum": [ + "DecimalExponent", + "BinarySI", + "DecimalSI" + ], + "x-enum-varnames": [ + "DecimalExponent", + "BinarySI", + "DecimalSI" + ], + "x-enum-comments": { + "BinarySI": "e.g., 12Mi (12 * 2^20)", + "DecimalExponent": "e.g., 12e6", + "DecimalSI": "e.g., 12M (12 * 10^6)" + } } } }, @@ -2533,6 +2548,33 @@ } } }, + "v1alpha1.KubeSmartClusterPhase": { + "type": "string", + "enum": [ + "Creating", + "Failed", + "Running", + "Ready", + "Paused", + "Updating", + "Upgrading", + "Rollbacking", + "Deleting", + "Deleted" + ], + "x-enum-varnames": [ + "KubeSmartClusterPhaseCreating", + "KubeSmartClusterPhaseFailed", + "KubeSmartClusterPhaseRunning", + "KubeSmartClusterPhaseReady", + "KubeSmartClusterPhasePaused", + "KubeSmartClusterPhaseUpdating", + "KubeSmartClusterPhaseUpgrading", + "KubeSmartClusterPhaseRollbacking", + "KubeSmartClusterPhaseDeleting", + "KubeSmartClusterPhaseDeleted" + ] + }, "v1alpha1.KubeSmartClusterSpec": { "type": "object", "properties": { @@ -3298,8 +3340,13 @@ "type": "object", "properties": { "phase": { - "type": "string", - "description": "Phase represents the current operation phase of the cluster." + "type": "object", + "description": "Phase represents the current operation phase of the cluster.", + "allOf": [ + { + "$ref": "#/components/schemas/v1alpha1.KubeSmartClusterPhase" + } + ] }, "startTime": { "type": "string", @@ -4841,4 +4888,4 @@ } }, "x-original-swagger-version": "2.0" -} +} \ No newline at end of file diff --git a/cloudtower-api-doc/swagger/locales/en/sks-1.4.0.json b/cloudtower-api-doc/swagger/locales/en/sks-1.4.0.json index bbabdec..4dcf84f 100644 --- a/cloudtower-api-doc/swagger/locales/en/sks-1.4.0.json +++ b/cloudtower-api-doc/swagger/locales/en/sks-1.4.0.json @@ -6,14 +6,11 @@ "errors.ErrorResponse": { "apiVersion": "", "code": "", - "continue": "", "details": "", "kind": "", "message": "", + "metadata": "", "reason": "", - "remainingItemCount": "", - "resourceVersion": "", - "selfLink": "", "status": "" }, "instance.connectivityResponse": { @@ -24,14 +21,18 @@ "protocol": "", "success": "" }, + "instance.labelSets": {}, "intstr.IntOrString": { "intVal": "", "strVal": "", "type": "" }, - "intstr.Type": {}, - "k8s_io_api_core_v1.ConditionStatus": {}, - "instance.labelSets": {}, + "intstr.Type": { + "enum": "" + }, + "k8s_io_api_core_v1.ConditionStatus": { + "enum": "" + }, "license.License": { "license_type": "", "max_socket_num": "", @@ -42,37 +43,58 @@ "sign_date": "", "software_edition": "" }, + "license.LicenseType": { + "enum": "" + }, + "license.SoftwareEdition": { + "enum": "" + }, "license.licenseCode": { "code": "" }, "resource.Quantity": { - "Format": "" + "enum": "" }, "restful.Info": { "message": "" }, "runtime.RawExtension": {}, - "sigs.k8s.io_cluster-api_api_v1beta1.APIEndpoint": { + "sigs_k8s_io_cluster-api_api_v1beta1.APIEndpoint": { "host": "", "port": "" }, - "sigs.k8s.io_cluster-api_bootstrap_kubeadm_api_v1beta1.APIEndpoint": { + "sigs_k8s_io_cluster-api_bootstrap_kubeadm_api_v1beta1.APIEndpoint": { "advertiseAddress": "", "bindPort": "" }, + "v1.CauseType": { + "enum": "" + }, "v1.Duration": { "time.Duration": "" }, "v1.FieldsV1": {}, + "v1.HostPathType": { + "enum": "" + }, "v1.LabelSelector": { "matchExpressions": "", "matchLabels": "" }, + "v1.LabelSelectorOperator": { + "enum": "" + }, "v1.LabelSelectorRequirement": { "key": "", "operator": "", "values": "" }, + "v1.ListMeta": { + "continue": "", + "remainingItemCount": "", + "resourceVersion": "", + "selfLink": "" + }, "v1.ManagedFieldsEntry": { "apiVersion": "", "fieldsType": "", @@ -82,6 +104,29 @@ "subresource": "", "time": "" }, + "v1.ManagedFieldsOperationType": { + "enum": "" + }, + "v1.NodeConditionType": { + "enum": "" + }, + "v1.ObjectMeta": { + "annotations": "", + "creationTimestamp": "", + "deletionGracePeriodSeconds": "", + "deletionTimestamp": "", + "finalizers": "", + "generateName": "", + "generation": "", + "labels": "", + "managedFields": "", + "name": "", + "namespace": "", + "ownerReferences": "", + "resourceVersion": "", + "selfLink": "", + "uid": "" + }, "v1.ObjectReference": { "apiVersion": "", "fieldPath": "", @@ -116,12 +161,18 @@ "retryAfterSeconds": "", "uid": "" }, + "v1.StatusReason": { + "enum": "" + }, "v1.Taint": { "effect": "", "key": "", "timeAdded": "", "value": "" }, + "v1.TaintEffect": { + "enum": "" + }, "v1.TypedObjectReference": { "apiGroup": "", "kind": "", @@ -129,25 +180,11 @@ "namespace": "" }, "v1alpha1.Addon": { - "annotations": "", "apiVersion": "", - "creationTimestamp": "", - "deletionGracePeriodSeconds": "", - "deletionTimestamp": "", - "finalizers": "", - "generateName": "", - "generation": "", "kind": "", - "labels": "", - "managedFields": "", - "name": "", - "namespace": "", - "ownerReferences": "", - "resourceVersion": "", - "selfLink": "", + "metadata": "", "spec": "", - "status": "", - "uid": "" + "status": "" }, "v1alpha1.AddonDataValues": { "secretRef": "", @@ -155,11 +192,8 @@ }, "v1alpha1.AddonList": { "apiVersion": "", - "continue": "", "kind": "", - "remainingItemCount": "", - "resourceVersion": "", - "selfLink": "" + "metadata": "" }, "v1alpha1.AddonPackage": { "name": "", @@ -176,6 +210,9 @@ "ready": "", "version": "" }, + "v1alpha1.AddonType": { + "enum": "" + }, "v1alpha1.AddonsStatus": { "details": "", "progress": "", @@ -186,6 +223,9 @@ "enabled": "", "hostConfigAgent": "" }, + "v1alpha1.Architecture": { + "enum": "" + }, "v1alpha1.CNIConfig": { "config": "", "ecpConfig": "", @@ -211,11 +251,17 @@ "disabled": "", "version": "" }, + "v1alpha1.CloneMode": { + "enum": "" + }, "v1alpha1.CloudProviderSpec": { "cloudtower": "", "ksph": "", "name": "" }, + "v1alpha1.CloudTowerAuthMode": { + "enum": "" + }, "v1alpha1.CloudTowerConnect": { "authMode": "", "password": "", @@ -258,6 +304,12 @@ "skipTLSVerify": "", "timezone": "" }, + "v1alpha1.ClusterInfraType": { + "enum": "" + }, + "v1alpha1.ClusterOperation": { + "enum": "" + }, "v1alpha1.ClusterResources": { "controlPlane": "", "total": "", @@ -381,33 +433,19 @@ "version": "" }, "v1alpha1.KubeSmartCluster": { - "annotations": "", "apiVersion": "", - "creationTimestamp": "", - "deletionGracePeriodSeconds": "", - "deletionTimestamp": "", - "finalizers": "", - "generateName": "", - "generation": "", "kind": "", - "labels": "", - "managedFields": "", - "name": "", - "namespace": "", - "ownerReferences": "", - "resourceVersion": "", - "selfLink": "", + "metadata": "", "spec": "", - "status": "", - "uid": "" + "status": "" }, "v1alpha1.KubeSmartClusterList": { "apiVersion": "", - "continue": "", "kind": "", - "remainingItemCount": "", - "resourceVersion": "", - "selfLink": "" + "metadata": "" + }, + "v1alpha1.KubeSmartClusterPhase": { + "enum": "" }, "v1alpha1.KubeSmartClusterSpec": { "cloudProvider": "", @@ -531,6 +569,12 @@ "netmask": "", "network": "" }, + "v1alpha1.NetworkTag": { + "enum": "" + }, + "v1alpha1.NetworkType": { + "enum": "" + }, "v1alpha1.NodeAutoscaler": { "maxSize": "", "minSize": "" @@ -578,6 +622,9 @@ "port": "", "protocol": "" }, + "v1alpha1.ProtocolType": { + "enum": "" + }, "v1alpha1.ProxyConfiguration": { "http": "", "https": "", @@ -679,6 +726,12 @@ "status": "", "type": "" }, + "v1beta1.ConditionSeverity": { + "enum": "" + }, + "v1beta1.ConditionType": { + "enum": "" + }, "v1beta1.ContainerLinuxConfig": { "additionalConfig": "", "strict": "" @@ -701,6 +754,9 @@ "filesystems": "", "partitions": "" }, + "v1beta1.Encoding": { + "enum": "" + }, "v1beta1.Etcd": { "external": "", "local": "" @@ -735,6 +791,9 @@ "partition": "", "replaceFS": "" }, + "v1beta1.Format": { + "enum": "" + }, "v1beta1.HostPathMount": { "hostPath": "", "mountPath": "", @@ -795,6 +854,9 @@ "rollingUpdate": "", "type": "" }, + "v1beta1.MachineDeploymentStrategyType": { + "enum": "" + }, "v1beta1.MachineRollingUpdateDeployment": { "deletePolicy": "", "maxSurge": "", @@ -865,32 +927,32 @@ }, "tags": [ { - "name": "instances", + "name": "Instance", "x-displayName": "", "description": "" }, { - "name": "clusters", + "name": "Cluster", "x-displayName": "", "description": "" }, { - "name": "workload clusters", + "name": "Workload Cluster", "x-displayName": "", "description": "" }, { - "name": "upgrade", + "name": "SKS Version", "x-displayName": "", "description": "" }, { - "name": "healthz", + "name": "Healthz", "x-displayName": "", "description": "" }, { - "name": "license", + "name": "License", "x-displayName": "", "description": "" } diff --git a/cloudtower-api-doc/swagger/locales/zh/sks-1.4.0.json b/cloudtower-api-doc/swagger/locales/zh/sks-1.4.0.json index bbabdec..c9ca174 100644 --- a/cloudtower-api-doc/swagger/locales/zh/sks-1.4.0.json +++ b/cloudtower-api-doc/swagger/locales/zh/sks-1.4.0.json @@ -6,14 +6,11 @@ "errors.ErrorResponse": { "apiVersion": "", "code": "", - "continue": "", "details": "", "kind": "", "message": "", + "metadata": "", "reason": "", - "remainingItemCount": "", - "resourceVersion": "", - "selfLink": "", "status": "" }, "instance.connectivityResponse": { @@ -24,14 +21,18 @@ "protocol": "", "success": "" }, + "instance.labelSets": {}, "intstr.IntOrString": { "intVal": "", "strVal": "", "type": "" }, - "intstr.Type": {}, - "k8s_io_api_core_v1.ConditionStatus": {}, - "instance.labelSets": {}, + "intstr.Type": { + "enum": "" + }, + "k8s_io_api_core_v1.ConditionStatus": { + "enum": "" + }, "license.License": { "license_type": "", "max_socket_num": "", @@ -42,37 +43,58 @@ "sign_date": "", "software_edition": "" }, + "license.LicenseType": { + "enum": "" + }, + "license.SoftwareEdition": { + "enum": "" + }, "license.licenseCode": { "code": "" }, "resource.Quantity": { - "Format": "" + "enum": "" }, "restful.Info": { "message": "" }, "runtime.RawExtension": {}, - "sigs.k8s.io_cluster-api_api_v1beta1.APIEndpoint": { + "sigs_k8s_io_cluster-api_api_v1beta1.APIEndpoint": { "host": "", "port": "" }, - "sigs.k8s.io_cluster-api_bootstrap_kubeadm_api_v1beta1.APIEndpoint": { + "sigs_k8s_io_cluster-api_bootstrap_kubeadm_api_v1beta1.APIEndpoint": { "advertiseAddress": "", "bindPort": "" }, + "v1.CauseType": { + "enum": "" + }, "v1.Duration": { "time.Duration": "" }, "v1.FieldsV1": {}, + "v1.HostPathType": { + "enum": "" + }, "v1.LabelSelector": { "matchExpressions": "", "matchLabels": "" }, + "v1.LabelSelectorOperator": { + "enum": "" + }, "v1.LabelSelectorRequirement": { "key": "", "operator": "", "values": "" }, + "v1.ListMeta": { + "continue": "", + "remainingItemCount": "", + "resourceVersion": "", + "selfLink": "" + }, "v1.ManagedFieldsEntry": { "apiVersion": "", "fieldsType": "", @@ -82,6 +104,29 @@ "subresource": "", "time": "" }, + "v1.ManagedFieldsOperationType": { + "enum": "" + }, + "v1.NodeConditionType": { + "enum": "" + }, + "v1.ObjectMeta": { + "annotations": "", + "creationTimestamp": "", + "deletionGracePeriodSeconds": "", + "deletionTimestamp": "", + "finalizers": "", + "generateName": "", + "generation": "", + "labels": "", + "managedFields": "", + "name": "", + "namespace": "", + "ownerReferences": "", + "resourceVersion": "", + "selfLink": "", + "uid": "" + }, "v1.ObjectReference": { "apiVersion": "", "fieldPath": "", @@ -116,12 +161,18 @@ "retryAfterSeconds": "", "uid": "" }, + "v1.StatusReason": { + "enum": "" + }, "v1.Taint": { "effect": "", "key": "", "timeAdded": "", "value": "" }, + "v1.TaintEffect": { + "enum": "" + }, "v1.TypedObjectReference": { "apiGroup": "", "kind": "", @@ -129,25 +180,11 @@ "namespace": "" }, "v1alpha1.Addon": { - "annotations": "", "apiVersion": "", - "creationTimestamp": "", - "deletionGracePeriodSeconds": "", - "deletionTimestamp": "", - "finalizers": "", - "generateName": "", - "generation": "", "kind": "", - "labels": "", - "managedFields": "", - "name": "", - "namespace": "", - "ownerReferences": "", - "resourceVersion": "", - "selfLink": "", + "metadata": "", "spec": "", - "status": "", - "uid": "" + "status": "" }, "v1alpha1.AddonDataValues": { "secretRef": "", @@ -155,11 +192,8 @@ }, "v1alpha1.AddonList": { "apiVersion": "", - "continue": "", "kind": "", - "remainingItemCount": "", - "resourceVersion": "", - "selfLink": "" + "metadata": "" }, "v1alpha1.AddonPackage": { "name": "", @@ -176,6 +210,9 @@ "ready": "", "version": "" }, + "v1alpha1.AddonType": { + "enum": "" + }, "v1alpha1.AddonsStatus": { "details": "", "progress": "", @@ -186,6 +223,9 @@ "enabled": "", "hostConfigAgent": "" }, + "v1alpha1.Architecture": { + "enum": "" + }, "v1alpha1.CNIConfig": { "config": "", "ecpConfig": "", @@ -211,11 +251,17 @@ "disabled": "", "version": "" }, + "v1alpha1.CloneMode": { + "enum": "" + }, "v1alpha1.CloudProviderSpec": { "cloudtower": "", "ksph": "", "name": "" }, + "v1alpha1.CloudTowerAuthMode": { + "enum": "" + }, "v1alpha1.CloudTowerConnect": { "authMode": "", "password": "", @@ -258,6 +304,12 @@ "skipTLSVerify": "", "timezone": "" }, + "v1alpha1.ClusterInfraType": { + "enum": "" + }, + "v1alpha1.ClusterOperation": { + "enum": "" + }, "v1alpha1.ClusterResources": { "controlPlane": "", "total": "", @@ -381,33 +433,19 @@ "version": "" }, "v1alpha1.KubeSmartCluster": { - "annotations": "", "apiVersion": "", - "creationTimestamp": "", - "deletionGracePeriodSeconds": "", - "deletionTimestamp": "", - "finalizers": "", - "generateName": "", - "generation": "", "kind": "", - "labels": "", - "managedFields": "", - "name": "", - "namespace": "", - "ownerReferences": "", - "resourceVersion": "", - "selfLink": "", + "metadata": "", "spec": "", - "status": "", - "uid": "" + "status": "" }, "v1alpha1.KubeSmartClusterList": { "apiVersion": "", - "continue": "", "kind": "", - "remainingItemCount": "", - "resourceVersion": "", - "selfLink": "" + "metadata": "" + }, + "v1alpha1.KubeSmartClusterPhase": { + "enum": "" }, "v1alpha1.KubeSmartClusterSpec": { "cloudProvider": "", @@ -531,6 +569,12 @@ "netmask": "", "network": "" }, + "v1alpha1.NetworkTag": { + "enum": "" + }, + "v1alpha1.NetworkType": { + "enum": "" + }, "v1alpha1.NodeAutoscaler": { "maxSize": "", "minSize": "" @@ -578,6 +622,9 @@ "port": "", "protocol": "" }, + "v1alpha1.ProtocolType": { + "enum": "" + }, "v1alpha1.ProxyConfiguration": { "http": "", "https": "", @@ -679,6 +726,12 @@ "status": "", "type": "" }, + "v1beta1.ConditionSeverity": { + "enum": "" + }, + "v1beta1.ConditionType": { + "enum": "" + }, "v1beta1.ContainerLinuxConfig": { "additionalConfig": "", "strict": "" @@ -701,6 +754,9 @@ "filesystems": "", "partitions": "" }, + "v1beta1.Encoding": { + "enum": "" + }, "v1beta1.Etcd": { "external": "", "local": "" @@ -735,6 +791,9 @@ "partition": "", "replaceFS": "" }, + "v1beta1.Format": { + "enum": "" + }, "v1beta1.HostPathMount": { "hostPath": "", "mountPath": "", @@ -795,6 +854,9 @@ "rollingUpdate": "", "type": "" }, + "v1beta1.MachineDeploymentStrategyType": { + "enum": "" + }, "v1beta1.MachineRollingUpdateDeployment": { "deletePolicy": "", "maxSurge": "", @@ -865,34 +927,34 @@ }, "tags": [ { - "name": "instances", - "x-displayName": "", - "description": "" + "name": "Instance", + "x-displayName": "裸金属机器实例", + "description": "裸金属机器实例" }, { - "name": "clusters", - "x-displayName": "", - "description": "" + "name": "Cluster", + "x-displayName": "集群", + "description": "集群" }, { - "name": "workload clusters", - "x-displayName": "", - "description": "" + "name": "Workload Cluster", + "x-displayName": "工作负载集群", + "description": "工作负载集群" }, { - "name": "upgrade", - "x-displayName": "", - "description": "" + "name": "SKS Version", + "x-displayName": "SKS 版本", + "description": "SKS 版本" }, { - "name": "healthz", - "x-displayName": "", - "description": "" + "name": "Healthz", + "x-displayName": "服务可用", + "description": "服务可用" }, { - "name": "license", - "x-displayName": "", - "description": "" + "name": "License", + "x-displayName": "软件许可", + "description": "软件许可" } ], "paths": {