diff options
| author |   Eric Multanen <eric.w.multanen@intel.com> | 2020-08-12 15:33:12 -0700 |
|---|---|---|
| committer | Eric Multanen <eric.w.multanen@intel.com> | 2020-08-31 15:50:06 -0700 |
| commit | 645c6a331cd00043fcf9f567f5f261a9db070918 (patch) | |
| tree | 3298b48aca4d93d22680960bd2a27290799b5732 /docs/emco_apis.yaml | |
| parent | ce99856834a225f6f68b6eda725ae7122a2f8185 (diff) | |
Enhance the status query API
This patch enhances the status query API.
- The ResourceBundleState CRD is modified to just use the
k8s Pod structure instead of a customized struct.
- Status queries can either present results showing
the rsync status of the composite app and resources
or from information received from the cluster via
the ResourceBundleState CR
- Query parameters are provided to the API call to
customize the query and response
- Support for querying status of cluster network
intents is added
Issue-ID: MULTICLOUD-1042
Signed-off-by: Eric Multanen <eric.w.multanen@intel.com>
Change-Id: Icca4cdd901e2f2b446414fade256fc24d87594cd
Diffstat (limited to 'docs/emco_apis.yaml')
| -rw-r--r-- | docs/emco_apis.yaml | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/docs/emco_apis.yaml b/docs/emco_apis.yaml index 419c1316..163e3d69 100644 --- a/docs/emco_apis.yaml +++ b/docs/emco_apis.yaml @@ -1312,6 +1312,44 @@ paths: - $ref: '#/components/parameters/compositeAppName' - $ref: '#/components/parameters/compositeAppVersion' - $ref: '#/components/parameters/deploymentIntentGroupName' + - in: query + name: type + description: source of status information + schema: + type: string + enum: [rsync, cluster] + default: rsync + - in: query + name: output + description: output format + schema: + type: string + enum: [summary, all, detail] + default: all + - in: query + name: instance + description: instance identifier + schema: + type: string + maxLength: 32 + - in: query + name: app + description: app name + schema: + type: string + maxLength: 64 + - in: query + name: cluster + description: cluster-provider+cluster + schema: + type: string + maxLength: 128 + - in: query + name: resource + description: resource name + schema: + type: string + maxLength: 64 get: tags: - Deployment Lifecycle @@ -2210,6 +2248,65 @@ paths: requestBody: content: {} + + /cluster-providers/{cluster-providers-name}/clusters/{cluster-name}/status: + # parameters list that are used with each operation for this path + parameters: + - $ref: '#/components/parameters/clusterProviderName' + - $ref: '#/components/parameters/clusterName' + - in: query + name: type + description: source of status information + schema: + type: string + enum: [rsync, cluster] + default: rsync + - in: query + name: output + description: output format + schema: + type: string + enum: [summary, all, detail] + default: all + - in: query + name: instance + description: instance identifier + schema: + type: string + maxLength: 32 + - in: query + name: app + description: app name + schema: + type: string + maxLength: 64 + - in: query + name: cluster + description: cluster-provider+cluster + schema: + type: string + maxLength: 128 + - in: query + name: resource + description: resource name + schema: + type: string + maxLength: 64 + get: + tags: + - Networks + summary: Query status of cluster network intents + description: Query status of cluster network intents + operationId: statusNetworksForCluster + responses: + '200': + description: Success + content: {} + '404': + description: No Status found + content: {} + + ######################## Network Controller Intent API's########################################## /projects/{project-name}/composite-apps/{composite-app-name}/{composite-app-version}/network-controller-intent: parameters: |