diff options
43 files changed, 1454 insertions, 3 deletions
diff --git a/docs/index.rst b/docs/index.rst index a3ed0e03..548f2e7d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,6 +21,7 @@ Data Collection, Analytics, and Events (DCAE) ./sections/tls_enablement.rst ./sections/sdk/index.rst ./sections/configuration.rst + ./sections/user_guide.rst ./sections/design-components/index-onboarding.rst ./sections/services/serviceindex.rst ./sections/release-notes.rst diff --git a/docs/sections/apis/configbinding.json b/docs/sections/apis/configbinding.json index 0e2931ba..7075b1e9 100644 --- a/docs/sections/apis/configbinding.json +++ b/docs/sections/apis/configbinding.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2.5.2", + "version": "2.5.3", "title": "Config Binding Service" }, "paths": { diff --git a/docs/sections/apis/configbinding.yaml b/docs/sections/apis/configbinding.yaml index 95115c71..f2ce1205 100644 --- a/docs/sections/apis/configbinding.yaml +++ b/docs/sections/apis/configbinding.yaml @@ -1,5 +1,5 @@ # ============LICENSE_START======================================================= -# Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved. +# Copyright (c) 2017-2020 AT&T Intellectual Property. All rights reserved. # ================================================================================ # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -19,7 +19,7 @@ --- swagger: "2.0" info: - version: "2.5.2" + version: "2.5.3" title: "Config Binding Service" paths: /service_component/{service_component_name}: diff --git a/docs/sections/apis/dcaedashboard.json b/docs/sections/apis/dcaedashboard.json new file mode 100644 index 00000000..8d4f463a --- /dev/null +++ b/docs/sections/apis/dcaedashboard.json @@ -0,0 +1,1107 @@ +{ + "swagger": "2.0", + "info": { + "description": "API to manage deployment of microservices using blueprints. HTTP Basic authorization schema is required to authenticate users for all the resource endpoints. The client sends HTTP requests with an Authorization header containing base64-encoded username:password string.", + "version": "1.4.0", + "title": "DCAE Dashboard API", + "contact": { + "email": "rp5662@att.com" + } + }, + "host": "dcae-dashboard:8080", + "basePath": "/ccsdk-app/nb-api/v2", + "tags": [ + { + "name": "Blueprints", + "description": "Query blueprint information" + }, + { + "name": "Deployments", + "description": "Manage deployments" + }, + { + "name": "Tenants", + "description": "Query Cloudify Tenants" + } + ], + "schemes": [ + "https", + "http" + ], + "paths": { + "/tenants": { + "get": { + "tags": [ + "Tenants" + ], + "summary": "Lists all Cloudify Tenants", + "description": "Query all Tenant names from Cloudify", + "operationId": "List Tenants", + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Tenant" + } + } + }, + "400": { + "description": "Invalid status value" + }, + "401": { + "$ref": "#/responses/UnauthorizedError" + } + } + } + }, + "/deployments": { + "get": { + "tags": [ + "Deployments" + ], + "summary": "List all Deployments", + "description": "Query all deployments or Service objects from Inventory", + "operationId": "List Deployments", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "page", + "in": "query", + "description": "pagination control - page number", + "required": true, + "type": "integer" + }, + { + "name": "size", + "in": "query", + "description": "pagination control - page size", + "required": true, + "type": "integer" + }, + { + "name": "filters", + "in": "query", + "description": "search filters, {\"_include\":\"id\", \"tenant\":\"onap-tenant-1\",\"serviceId\":\"dcae\"}", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Deployment" + } + }, + "headers": { + "Link": { + "type": "string", + "description": "pagination header" + } + } + }, + "400": { + "description": "Invalid status value" + }, + "401": { + "$ref": "#/responses/UnauthorizedError" + } + } + }, + "post": { + "tags": [ + "Deployments" + ], + "summary": "Initiate a deployment (install) operation for an application or service", + "description": "Controller sends the blueprint and required inputs to Deployment Handler microservice to initiate the deployment process", + "operationId": "Create Deployment", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Inputs to initiate a deployment: blueprint ID from inventory, Cloudify tenant name, blueprint inputs", + "required": true, + "schema": { + "$ref": "#/definitions/DeploymentInput" + } + } + ], + "responses": { + "201": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DeploymentResource" + } + }, + "401": { + "$ref": "#/responses/UnauthorizedError" + }, + "405": { + "description": "Invalid input" + } + } + } + }, + "/deployments/{deploymentId}": { + "delete": { + "tags": [ + "Deployments" + ], + "summary": "Initiate an uninstall operation for an application or service", + "description": "Controller sends the deployment reference to Deployment Handler microservice to initiate the uninstall process", + "operationId": "Delete Deployment", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "deploymentId", + "in": "path", + "description": "ID of deployment to query", + "required": true, + "type": "string" + }, + { + "name": "tenant", + "in": "query", + "description": "Cloudify Tenant name", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "successful operation", + "schema": { + "type": "string" + } + }, + "400": { + "description": "Invalid status value" + }, + "401": { + "$ref": "#/responses/UnauthorizedError" + } + } + }, + "put": { + "tags": [ + "Deployments" + ], + "summary": "Upgrade or Rollback an existing deployment using Cloudify Helm plugin", + "description": "Upgrade or Rollback an existing deployment using Cloudify Helm plugin", + "operationId": "Upgrade/Rollback Deployment", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "deploymentId", + "in": "path", + "description": "ID of deployment in context", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "body", + "description": "Cloudify Execution Request object that has parameters to start either an upgrade or a rollback execution workflow", + "required": true, + "schema": { + "$ref": "#/definitions/CloudifyDeploymentUpgradeRequest" + } + } + ], + "responses": { + "400": { + "description": "Invalid ID supplied" + }, + "401": { + "$ref": "#/responses/UnauthorizedError" + }, + "404": { + "description": "Deployment not found" + }, + "405": { + "description": "Validation exception" + } + } + }, + "get": { + "tags": [ + "Deployments" + ], + "summary": "Get a Deployment", + "description": "Query a deployment or Service object from Inventory", + "operationId": "Get Deployment", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "deploymentId", + "in": "path", + "description": "ID of deployment to query", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Deployment" + } + } + }, + "400": { + "description": "Invalid status value" + }, + "401": { + "$ref": "#/responses/UnauthorizedError" + } + } + } + }, + "/deployments/{deploymentId}/executions": { + "get": { + "tags": [ + "Deployments" + ], + "summary": "Deployment execution status", + "description": "Query deployment workflow execution status", + "operationId": "Deployment Status", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "deploymentId", + "in": "path", + "description": "ID of deployment to query execution status", + "required": true, + "type": "string" + }, + { + "name": "tenant", + "in": "query", + "description": "tenant name associated with the deployment", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/execution" + } + } + }, + "400": { + "description": "Invalid status value" + }, + "401": { + "$ref": "#/responses/UnauthorizedError" + } + } + } + }, + "/deployments/{deploymentId}/health": { + "get": { + "tags": [ + "Deployments" + ], + "summary": "Deployment health status", + "description": "Query consul for service health using deployment ID filter", + "operationId": "Deployment health", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "deploymentId", + "in": "path", + "description": "ID of deployment to query service health", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/serviceHealth" + } + }, + "401": { + "$ref": "#/responses/UnauthorizedError" + } + } + } + }, + "/deployments/{deploymentId}/inputs": { + "get": { + "tags": [ + "Deployments" + ], + "summary": "Deployment inputs", + "description": "Get blueprint inputs used to create deployment", + "operationId": "Deployment Inputs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "deploymentId", + "in": "path", + "description": "ID of deployment to query execution status", + "required": true, + "type": "string" + }, + { + "name": "tenant", + "in": "query", + "description": "tenant name associated with the deployment", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "object", + "items": { + "$ref": "#/definitions/deploymentInputs" + } + } + }, + "400": { + "description": "Invalid status value" + }, + "401": { + "$ref": "#/responses/UnauthorizedError" + } + } + } + }, + "/blueprints": { + "get": { + "tags": [ + "Blueprints" + ], + "summary": "Find all blueprint templates", + "description": "Fetch the blueprints data from inventory", + "operationId": "List Blueprints", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "page", + "in": "query", + "description": "page number", + "required": false, + "type": "string" + }, + { + "name": "size", + "in": "query", + "description": "page size", + "required": false, + "type": "string" + }, + { + "name": "filters", + "in": "query", + "description": "search filters, {\"owner\":\"user1\", \"name\":\"user1-bp1\",\"id\":\"2334-343\"}", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List of `DCAEServiceType` objects", + "schema": { + "$ref": "#/definitions/InlineResponse200" + }, + "headers": { + "Link": { + "type": "string", + "description": "pagination header" + } + } + }, + "400": { + "description": "Invalid tag value" + }, + "401": { + "$ref": "#/responses/UnauthorizedError" + } + } + }, + "post": { + "tags": [ + "Blueprints" + ], + "summary": "Create/Upload a new blueprint template", + "description": "Upload a new blueprint template into inventory", + "operationId": "Create Blueprint", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "upload blueprint request to inventory", + "required": true, + "schema": { + "$ref": "#/definitions/DCAEServiceTypeRequest" + } + } + ], + "responses": { + "201": { + "description": "A `DCAEServiceType` object", + "schema": { + "$ref": "#/definitions/InlineResponse200" + } + }, + "400": { + "description": "Invalid tag value" + }, + "401": { + "$ref": "#/responses/UnauthorizedError" + } + } + } + }, + "/blueprints/{typeId}": { + "delete": { + "tags": [ + "Blueprints" + ], + "summary": "Delete a blueprint template", + "description": "Delete a blueprint template from inventory", + "operationId": "Delete Blueprint", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "typeId", + "in": "path", + "description": "ID of blueprint to delete", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "successful operation" + }, + "401": { + "$ref": "#/responses/UnauthorizedError" + } + } + } + }, + "/blueprints/{typeId}/services": { + "get": { + "tags": [ + "Blueprints" + ], + "summary": "Get Services mapped to a blueprint template", + "description": "Get Deployment References existing for a blueprint", + "operationId": "Get Deployments for a blueprint", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "typeId", + "in": "path", + "description": "ID of blueprint to query", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "successful operation" + }, + "401": { + "$ref": "#/responses/UnauthorizedError" + } + } + } + } + }, + "securityDefinitions": { + "basicAuth": { + "type": "basic" + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "responses": { + "UnauthorizedError": { + "description": "Authentication information is missing or invalid", + "headers": { + "WWW_Authenticate": { + "type": "string" + } + } + } + }, + "definitions": { + "Tenant": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "cloudify tenant name" + } + } + }, + "InlineResponse200": { + "type": "object", + "properties": { + "totalItems": { + "type": "integer", + "format": "int32" + }, + "totalPages": { + "type": "integer", + "format": "int32" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/DCAEServiceTypeSummary" + } + } + } + }, + "InlineResponse200Links": { + "type": "object", + "properties": { + "previousLink": { + "$ref": "#/definitions/Link" + }, + "nextLink": { + "$ref": "#/definitions/Link" + } + }, + "description": "Pagination links" + }, + "ApiResponseMessage": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "Deployment": { + "type": "object", + "properties": { + "id": { + "description": "cloudify deployment name", + "type": "string" + }, + "blueprint_id": { + "description": "cloudify blueprint name", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "tenant_name": { + "type": "string", + "description": "cloudify tenant name" + } + } + }, + "InlineResponse2001": { + "type": "object", + "properties": { + "links": { + "$ref": "#/definitions/InlineResponse200Links" + }, + "totalCount": { + "type": "integer", + "format": "int32" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/Deployment" + } + } + } + }, + "UriBuilder": { + "type": "object" + }, + "Link": { + "type": "object", + "properties": { + "title": { + "type": "string" + }, + "rel": { + "type": "string" + }, + "uri": { + "type": "string", + "format": "uri" + }, + "uriBuilder": { + "$ref": "#/definitions/UriBuilder" + }, + "rels": { + "type": "array", + "items": { + "type": "string" + } + }, + "params": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "type": { + "type": "string" + } + } + }, + "DCAEServiceComponent": { + "type": "object", + "required": [ + "componentId", + "componentLink", + "componentSource", + "componentType", + "created", + "modified", + "shareable" + ], + "properties": { + "componentId": { + "type": "string", + "description": "The id format is unique to the source" + }, + "componentLink": { + "description": "Link to the underlying resource of this component", + "$ref": "#/definitions/Link" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "modified": { + "type": "string", + "format": "date-time" + }, + "componentType": { + "type": "string" + }, + "componentSource": { + "type": "string", + "description": "Specifies the name of the underying source service that is responsible for this components", + "enum": [ + "DCAEController", + "DMaaPController" + ] + }, + "status": { + "type": "string" + }, + "location": { + "type": "string", + "description": "Location information of the component" + }, + "shareable": { + "type": "integer", + "format": "int32", + "description": "Used to determine if this component can be shared amongst different DCAE services" + } + } + }, + "DCAEServiceTypeRequest": { + "type": "object", + "required": [ + "blueprintTemplate", + "owner", + "typeName", + "typeVersion", + "component" + ], + "properties": { + "owner": { + "type": "string" + }, + "typeName": { + "type": "string", + "description": "Descriptive name for this DCAE service type" + }, + "typeVersion": { + "type": "integer", + "format": "int32", + "description": "Version number for this DCAE service type" + }, + "blueprintTemplate": { + "type": "string", + "description": "String representation of a Cloudify blueprint with unbound variables" + }, + "application": { + "type": "string", + "description": "controller application name" + }, + "component": { + "type": "string", + "description": "onboarding component name e.g. dcae" + } + } + }, + "DCAEServiceType": { + "type": "object", + "required": [ + "blueprintTemplate", + "created", + "owner", + "selfLink", + "typeId", + "typeName", + "typeVersion" + ], + "properties": { + "owner": { + "type": "string" + }, + "typeName": { + "type": "string", + "description": "Descriptive name for this DCAE service type" + }, + "typeVersion": { + "type": "integer", + "format": "int32", + "description": "Version number for this DCAE service type" + }, + "blueprintTemplate": { + "type": "string", + "description": "String representation of a Cloudify blueprint with unbound variables" + }, + "serviceIds": { + "type": "array", + "description": "List of service ids that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service id.", + "items": { + "type": "string" + } + }, + "vnfTypes": { + "type": "array", + "items": { + "type": "string" + } + }, + "serviceLocations": { + "type": "array", + "description": "List of service locations that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service location.", + "items": { + "type": "string" + } + }, + "asdcServiceId": { + "type": "string", + "description": "Id of service this DCAE service type is associated with. Value source is from ASDC's notification event's field `serviceInvariantUUID`." + }, + "asdcResourceId": { + "type": "string", + "description": "Id of vf/vnf instance this DCAE service type is associated with. Value source is from ASDC's notification event's field `resourceInvariantUUID`." + }, + "asdcServiceURL": { + "type": "string", + "description": "URL to the ASDC service model" + }, + "typeId": { + "type": "string", + "description": "Unique identifier for this DCAE service type" + }, + "selfLink": { + "description": "Link to self where the Link.title is typeName", + "$ref": "#/definitions/Link" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "Created timestamp for this DCAE service type in epoch time" + }, + "deactivated": { + "type": "string", + "format": "date-time", + "description": "Deactivated timestamp for this DCAE service type in epoch time" + } + } + }, + "DCAEServiceTypeSummary": { + "type": "object", + "required": [ + "created", + "owner", + "selfLink", + "typeId", + "typeName", + "typeVersion", + "application", + "component" + ], + "properties": { + "owner": { + "type": "string" + }, + "typeName": { + "type": "string", + "description": "Descriptive name for this DCAE service type" + }, + "application": { + "type": "string", + "description": "application name" + }, + "component": { + "type": "string", + "description": "component name" + }, + "typeVersion": { + "type": "integer", + "format": "int32", + "description": "Version number for this DCAE service type" + }, + "typeId": { + "type": "string", + "description": "Unique identifier for this DCAE service type" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "Created timestamp for this DCAE service type in epoch time" + } + } + }, + "CloudifyDeploymentUpgradeRequest": { + "type": "object", + "required": [ + "chartVersion", + "chartRepo", + "config_url", + "config_format", + "tenant", + "workflow" + ], + "properties": { + "chartVersion": { + "type": "string", + "description": "Helm package version used for install" + }, + "chartRepo": { + "type": "string", + "description": "Helm repository URL for the chart" + }, + "config_url": { + "type": "string", + "description": "Helm repository URL for the chart values to update" + }, + "config_format": { + "type": "string", + "description": "yaml format or json format" + }, + "tenant": { + "type": "string", + "description": "cloudify tenant name for the deployment upgrade" + }, + "workflow": { + "type": "string", + "description": "input values are upgrade or rollback - helm upgrade workflow or helm rollback workflow " + } + } + }, + "DeploymentInput": { + "type": "object", + "required": [ + "component", + "tag", + "blueprintId", + "tenant", + "inputs" + ], + "properties": { + "component": { + "type": "string", + "description": "component or namespace for the service" + }, + "tag": { + "type": "string", + "description": "unique tag to identify the deployment. A non-unique value results in name conflict error" + }, + "blueprintId": { + "type": "string", + "description": "typeId from inventory, a unique Id for the blueprint, this can be replaced with blueprintName and blueprintVersion" + }, + "blueprintName": { + "type": "string", + "description": "Descriptive name for this DCAE service type" + }, + "blueprintVersion": { + "type": "integer", + "format": "int32", + "description": "Version number for this DCAE service type, optional. Defaults to 1." + }, + "tenant": { + "type": "string", + "description": "cloudify tenant name" + }, + "inputs": { + "type": "object", + "description": "JSON object containing the input parameter names and values" + } + } + }, + "deploymentInputs": { + "type": "object" + }, + "serviceHealth": { + "type": "object", + "properties": { + "node": { + "type": "string", + "description": "The node where service is deployed" + }, + "checkID": { + "type": "string", + "description": "A unique identifier for the service health check" + }, + "name": { + "type": "string", + "description": "A unique name for this service health check" + }, + "status": { + "type": "string", + "description": "Health check status" + }, + "serviceID": { + "type": "string", + "description": "An identifier containing combination of consul registration ID and consul service name" + }, + "serviceName": { + "type": "string", + "description": "A unique consul service name" + } + } + }, + "execution": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "description": "The time the execution was queued at" + }, + "deployment_id": { + "type": "string", + "description": "The id of the deployment the execution is in the context of" + }, + "id": { + "type": "string", + "description": "A unique identifier for the execution" + }, + "status": { + "type": "string", + "description": "The executions status" + }, + "workflow_id": { + "type": "string", + "description": "The id/name of the workflow the execution is of" + }, + "tenant_name": { + "type": "string", + "description": "Cloudify tenant name where the deployment was done" + } + } + }, + "DeploymentResourceLinks": { + "type": "object", + "properties": { + "self": { + "description": "Link to retrieve information about the service being deployed", + "type": "string" + }, + "outcome": { + "description": "Link to retrieve information about deployment outcome", + "type": "string" + }, + "status": { + "description": "Link to retrieve information about the status of the installation workflow", + "type": "string" + } + } + }, + "DeploymentResource": { + "type": "object", + "properties": { + "deployment_id": { + "type": "string", + "description": "unique ID for the deployment resource" + }, + "links": { + "$ref": "#/definitions/DeploymentResourceLinks", + "description": "Links that the API client can access" + } + } + } + }, + "externalDocs": { + "description": "Find out more about Swagger", + "url": "http://swagger.io" + } +}
\ No newline at end of file diff --git a/docs/sections/apis/dcaedashboard.rst b/docs/sections/apis/dcaedashboard.rst new file mode 100644 index 00000000..c6a2e182 --- /dev/null +++ b/docs/sections/apis/dcaedashboard.rst @@ -0,0 +1,26 @@ +.. This work is licensed under a + Creative Commons Attribution 4.0 International License. + +DCAE Dashboard +============== + +.. toctree:: + :maxdepth: 3 + +Description +~~~~~~~~~~~ + +DCAE Dashboard is a web application that provides a single interface for +DCAE users and Ops users in ONAP to deploy and manage DCAE microservices. + +.. csv-table:: + :header: "API name", "Swagger JSON" + :widths: 10,5 + + "DCAE Dashboard", ":download:`link <dcaedashboard.json>`" + +Contact Information +~~~~~~~~~~~~~~~~~~~ + +onap-discuss@lists.onap.org + diff --git a/docs/sections/offeredapis.rst b/docs/sections/offeredapis.rst index 56fa2da7..139fa46d 100644 --- a/docs/sections/offeredapis.rst +++ b/docs/sections/offeredapis.rst @@ -7,6 +7,7 @@ Offered APIs :maxdepth: 1 :titlesonly: + apis/dcaedashboard.rst apis/configbinding.rst apis/deployment-handler.rst apis/inventory.rst diff --git a/docs/sections/platform-doc/attachments/dashboard_1.png b/docs/sections/platform-doc/attachments/dashboard_1.png Binary files differnew file mode 100644 index 00000000..511e9d58 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_1.png diff --git a/docs/sections/platform-doc/attachments/dashboard_10.png b/docs/sections/platform-doc/attachments/dashboard_10.png Binary files differnew file mode 100644 index 00000000..d3855fc9 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_10.png diff --git a/docs/sections/platform-doc/attachments/dashboard_11.png b/docs/sections/platform-doc/attachments/dashboard_11.png Binary files differnew file mode 100644 index 00000000..e28d8598 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_11.png diff --git a/docs/sections/platform-doc/attachments/dashboard_12.png b/docs/sections/platform-doc/attachments/dashboard_12.png Binary files differnew file mode 100644 index 00000000..e4e1fa87 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_12.png diff --git a/docs/sections/platform-doc/attachments/dashboard_13.png b/docs/sections/platform-doc/attachments/dashboard_13.png Binary files differnew file mode 100644 index 00000000..0752abdc --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_13.png diff --git a/docs/sections/platform-doc/attachments/dashboard_14.png b/docs/sections/platform-doc/attachments/dashboard_14.png Binary files differnew file mode 100644 index 00000000..482a6857 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_14.png diff --git a/docs/sections/platform-doc/attachments/dashboard_15.png b/docs/sections/platform-doc/attachments/dashboard_15.png Binary files differnew file mode 100644 index 00000000..3888ce8d --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_15.png diff --git a/docs/sections/platform-doc/attachments/dashboard_16.png b/docs/sections/platform-doc/attachments/dashboard_16.png Binary files differnew file mode 100644 index 00000000..e6c3a16e --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_16.png diff --git a/docs/sections/platform-doc/attachments/dashboard_17.png b/docs/sections/platform-doc/attachments/dashboard_17.png Binary files differnew file mode 100644 index 00000000..779c7d6e --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_17.png diff --git a/docs/sections/platform-doc/attachments/dashboard_18.png b/docs/sections/platform-doc/attachments/dashboard_18.png Binary files differnew file mode 100644 index 00000000..31eba797 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_18.png diff --git a/docs/sections/platform-doc/attachments/dashboard_19.png b/docs/sections/platform-doc/attachments/dashboard_19.png Binary files differnew file mode 100644 index 00000000..f3e27507 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_19.png diff --git a/docs/sections/platform-doc/attachments/dashboard_2.png b/docs/sections/platform-doc/attachments/dashboard_2.png Binary files differnew file mode 100644 index 00000000..dc0365ed --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_2.png diff --git a/docs/sections/platform-doc/attachments/dashboard_20.png b/docs/sections/platform-doc/attachments/dashboard_20.png Binary files differnew file mode 100644 index 00000000..95238bb6 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_20.png diff --git a/docs/sections/platform-doc/attachments/dashboard_21.png b/docs/sections/platform-doc/attachments/dashboard_21.png Binary files differnew file mode 100644 index 00000000..75461c32 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_21.png diff --git a/docs/sections/platform-doc/attachments/dashboard_22.png b/docs/sections/platform-doc/attachments/dashboard_22.png Binary files differnew file mode 100644 index 00000000..91993670 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_22.png diff --git a/docs/sections/platform-doc/attachments/dashboard_23.png b/docs/sections/platform-doc/attachments/dashboard_23.png Binary files differnew file mode 100644 index 00000000..2e9ac4e0 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_23.png diff --git a/docs/sections/platform-doc/attachments/dashboard_24.png b/docs/sections/platform-doc/attachments/dashboard_24.png Binary files differnew file mode 100644 index 00000000..5ed7e626 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_24.png diff --git a/docs/sections/platform-doc/attachments/dashboard_25.png b/docs/sections/platform-doc/attachments/dashboard_25.png Binary files differnew file mode 100644 index 00000000..cbf6daf5 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_25.png diff --git a/docs/sections/platform-doc/attachments/dashboard_26.png b/docs/sections/platform-doc/attachments/dashboard_26.png Binary files differnew file mode 100644 index 00000000..7c6c5060 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_26.png diff --git a/docs/sections/platform-doc/attachments/dashboard_27.png b/docs/sections/platform-doc/attachments/dashboard_27.png Binary files differnew file mode 100644 index 00000000..30632e98 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_27.png diff --git a/docs/sections/platform-doc/attachments/dashboard_28.png b/docs/sections/platform-doc/attachments/dashboard_28.png Binary files differnew file mode 100644 index 00000000..b722d4ba --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_28.png diff --git a/docs/sections/platform-doc/attachments/dashboard_29.png b/docs/sections/platform-doc/attachments/dashboard_29.png Binary files differnew file mode 100644 index 00000000..a1200557 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_29.png diff --git a/docs/sections/platform-doc/attachments/dashboard_3.png b/docs/sections/platform-doc/attachments/dashboard_3.png Binary files differnew file mode 100644 index 00000000..53b31fc1 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_3.png diff --git a/docs/sections/platform-doc/attachments/dashboard_30.png b/docs/sections/platform-doc/attachments/dashboard_30.png Binary files differnew file mode 100644 index 00000000..525eaf35 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_30.png diff --git a/docs/sections/platform-doc/attachments/dashboard_31.png b/docs/sections/platform-doc/attachments/dashboard_31.png Binary files differnew file mode 100644 index 00000000..bf72028d --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_31.png diff --git a/docs/sections/platform-doc/attachments/dashboard_32.png b/docs/sections/platform-doc/attachments/dashboard_32.png Binary files differnew file mode 100644 index 00000000..b6e52bbb --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_32.png diff --git a/docs/sections/platform-doc/attachments/dashboard_33.png b/docs/sections/platform-doc/attachments/dashboard_33.png Binary files differnew file mode 100644 index 00000000..387d50c0 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_33.png diff --git a/docs/sections/platform-doc/attachments/dashboard_34.png b/docs/sections/platform-doc/attachments/dashboard_34.png Binary files differnew file mode 100644 index 00000000..acb53299 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_34.png diff --git a/docs/sections/platform-doc/attachments/dashboard_35.png b/docs/sections/platform-doc/attachments/dashboard_35.png Binary files differnew file mode 100644 index 00000000..588090e2 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_35.png diff --git a/docs/sections/platform-doc/attachments/dashboard_4.png b/docs/sections/platform-doc/attachments/dashboard_4.png Binary files differnew file mode 100644 index 00000000..ef0247d9 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_4.png diff --git a/docs/sections/platform-doc/attachments/dashboard_5.png b/docs/sections/platform-doc/attachments/dashboard_5.png Binary files differnew file mode 100644 index 00000000..b11e563f --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_5.png diff --git a/docs/sections/platform-doc/attachments/dashboard_6.png b/docs/sections/platform-doc/attachments/dashboard_6.png Binary files differnew file mode 100644 index 00000000..aea65b43 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_6.png diff --git a/docs/sections/platform-doc/attachments/dashboard_7.png b/docs/sections/platform-doc/attachments/dashboard_7.png Binary files differnew file mode 100644 index 00000000..c75cea42 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_7.png diff --git a/docs/sections/platform-doc/attachments/dashboard_8.png b/docs/sections/platform-doc/attachments/dashboard_8.png Binary files differnew file mode 100644 index 00000000..8ce2ba28 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_8.png diff --git a/docs/sections/platform-doc/attachments/dashboard_9.png b/docs/sections/platform-doc/attachments/dashboard_9.png Binary files differnew file mode 100644 index 00000000..3e7e6a88 --- /dev/null +++ b/docs/sections/platform-doc/attachments/dashboard_9.png diff --git a/docs/sections/platform-doc/dcaedashboard_userguide.rst b/docs/sections/platform-doc/dcaedashboard_userguide.rst new file mode 100644 index 00000000..0d7611d9 --- /dev/null +++ b/docs/sections/platform-doc/dcaedashboard_userguide.rst @@ -0,0 +1,303 @@ +DCAE Dashboard User Guide +========================= + + +Overview +-------- + +DCAE Dashboard is a web application that provides a unified interface for DCAE +users and Ops users in ONAP to manage DCAE microservices. + + +Starting with the Dashboard +--------------------------- + +Type in the application login URL in a web browser. The Login page +should appear. + +|dashboard_1.png| + +If you are a first time user, then click on the **Sign up** button. Fill in +the Sign up FORM and submit it to register for an account. Upon a +successful login by providing valid login credentials, the user's +dashboard (Home) screen is displayed. The header navigation bar contains +menu links and a user profile section in the top right corner. The +collapsible left sidebar contains all the application menus; each item +(except "Home") can be expanded into sub-items by clicking on the item. + +User Dashboard contents appear in the panel to the right of the left +navigation menu. By default(initial view), the screen displays tiles +contains the count of blueprints and count of deployments owned by the +signed-in user. The count of plugins uploaded to the Cloudify Orchestrator +is also shown in the Plugins tile. Each tile is clickable and will +navigate control to the individual screens that display detailed +information about the items. There is a switch at the top to toggle +between user level or user role group access for the dashboard +contents. By switching access type to **Group**, the aggregate count of +inventory items at the user group (role) level are shown on the dashboard. + +|dashboard_2.png| + +|dashboard_3.png| + +Auto Refresh switch lets user automatically reload the dashboard at +regular intervals. + +An autocomplete list of blueprints lets a user find a specific blueprint +and trigger a deployments list query. Upon selecting a blueprint item, a +query is triggered to find associated deployments for the selected +blueprint. Similarly upon selecting a specific deployment entity, any +matching execution workflows are queried and displayed in the executions +data grid. By default the user dashboard shows currently active +executions that are happening in Cloudify. + +|dashboard_4.png| + +|dashboard_5.png| + +|dashboard_6.png| + +Working with blueprints and deployments +--------------------------------------- + +Searching/Filtering Blueprints +------------------------------ + + +1. Click on the "Inventory" menu item, which will expand to show + sub-items. Select the "Blueprints" sub-item. + +A "Blueprints" screen appears, which displays the blueprints retrieved from +Inventory. By default, a blueprint owner filter is applied to display +items where the owner is the signed in user. By deselecting the "My +Blueprints" checkbox, all blueprints belonging to the role group will be +displayed. + +|dashboard_7.png| + +|dashboard_8.png| + +2. You can search for blueprints based on their name. Type the name of +the blueprint you wish to work with in the search box at the top right +hand of the screen and press 'enter' or click the magnifying glass icon +to look for it. + +|dashboard_9.png| + +3. You can use search filters by clicking on the down arrow at the right +end of the search box. Filter by blueprint name and/or owner is available. Once +finished, click the magnifying glass at the bottom of the advanced +filters box or press "enter". + +|dashboard_10.png| + +|dashboard_11.png| + +|dashboard_12.png| + +4. Lookup deployments mapped to a blueprint + +|dashboard_13.png| + +Creating Blueprints +------------------- + +1. A user can create a new blueprint either from scratch or by uploading + an existing file. To do this, select the "Blueprints" sub-menu + +Once the existing set of blueprints appear on the screen, click on the +"Upload" Button + +|dashboard_14.png| + +2. In the "Upload Blueprint" pop-up, fill out all the fields. Provide + the name and version number for the blueprint -- hints on nomenclature are + available by clicking on the input field help icon (question mark + symbol). A blueprint file can be either "dragged and dropped" from + the user's own directory or it can be created from scratch. When + finished, press "Save". *Note:*\ **Import Data**\ *function is not + supported and will be removed later.* + +|dashboard_15.png| + +3. Allow the Blueprints screen to reload and then check that the + blueprint you created is in the table. + + +Viewing/Exporting Blueprints +---------------------------- + +1. Navigate to the Blueprints screen via the sidebar menu On the + Blueprints screen, click on the Actions button icon (More actions) + for the blueprint you wish to work with. A number of choices are + indicated in a pop-up: View, Export, Update, Deploy and Delete. + +|dashboard_16.png| + +2. Choose "View" to display the contents of the blueprint + +|dashboard_17.png| + +Deploying Blueprints +-------------------- + +3. Navigate to the Blueprints screen via the sidebar menu. On the + Blueprints screen, click on the Actions button icon (More actions) + for the blueprint you wish to work with and select "Deploy" + +|dashboard_18.png| + +4. On the "Deploy Blueprint" pop-up, fill in all the fields. There are + two ways to supply the input parameters for the blueprint: one is to + drag and drop a parameters file; the other is to manually fill in the + name-value pairs. When finished, press the "Deploy" button at the + bottom. + +|dashboard_19.png| + +5. Navigate to the Deployments screen via the sidebar menu and check + that the blueprint deployed is listed on the screen + +|dashboard_20.png| + +Searching/Filtering Deployments +------------------------------- + +1. Navigate to the Deployments screen via the sidebar menu. + +2. By default, the deployment owner filter and application cache filters are + applied to display items where the owner is the signed in user. Data is + fetched from the application cache store. By deselecting the "My + Deployments" checkbox, all deployments belonging to the role group + will be displayed. By deselecting "Cache" checkbox, cache is bypassed + and data is fetched from Cloudify Maanger. "Tenant" filter can be + applied to restrict the query per tenant partition. Upon selecting the + "Tenant" checkbox, the tenants list dropdown appears. + +3. You can search for Deployments by an ID. Enter the ID and press + 'Enter' or click the magnifying glass icon. + +|dashboard_21.png| + +4. If you wish to make an advanced search, select the "Tenant" checkbox, + select a tenant from the tenants list, click the down arrow at the + right end of the input field to expand the advanced search filters. + Here you can filter by deployment IDs, owners, (installation) + Status and Helm chart deployment. Once finished, click the magnifying + glass at the bottom of the advanced filters box. + +|dashboard_22.png| + +Viewing Blueprint, Inputs, Executions +------------------------------------- + +1. Navigate to the Deployments screen on the left hand menu + +On the deployments table screen, click on the "Actions" button icon for +the deployment you wish to manage. + +|dashboard_23.png| + +|dashboard_24.png| + +|dashboard_25.png| + +|dashboard_26.png| + +|dashboard_27.png| + +Undeploying Deployments +----------------------- + +1. Navigate to the Deployments screen on the left hand menu + +2. On the deployments table screen, click on the "Actions" button icon + for the deployment you wish to uninstall. Click on Undeploy. + +|dashboard_28.png| + +3. On the confirmation popup, confirm the tenant is correct and select + "Undeploy" when ready to undeploy + +|dashboard_29.png| + +Helm Status, Upgrade, Rollback +------------------------------ + +1. Navigate to the Deployments screen on the left hand menu + +2. Ensure that the deployment is a helm deployment + +On the deployments table screen, click on the "Actions" button icon for +the deployment you wish to perform helm operations on. + +|dashboard_30.png| + +*Helm Status* + +|dashboard_31.png| + +*Helm Upgrade* + +|dashboard_32.png| + +*Helm Rollback* + +|dashboard_33.png| + +Checking system health +---------------------- + + +Viewing Service Health +---------------------- + +Navigate to the Service Health screen on the sidebar menu + +|dashboard_34.png| + +Node Health +----------- + +Viewing Node Health +------------------- + +Navigate to the Node Health screen on the sidebar menu + +|dashboard_35.png| + +.. |dashboard_1.png| image:: attachments/dashboard_1.png +.. |dashboard_2.png| image:: attachments/dashboard_2.png +.. |dashboard_3.png| image:: attachments/dashboard_3.png +.. |dashboard_4.png| image:: attachments/dashboard_4.png +.. |dashboard_5.png| image:: attachments/dashboard_5.png +.. |dashboard_6.png| image:: attachments/dashboard_6.png +.. |dashboard_7.png| image:: attachments/dashboard_7.png +.. |dashboard_8.png| image:: attachments/dashboard_8.png +.. |dashboard_9.png| image:: attachments/dashboard_9.png +.. |dashboard_10.png| image:: attachments/dashboard_10.png +.. |dashboard_11.png| image:: attachments/dashboard_11.png +.. |dashboard_12.png| image:: attachments/dashboard_12.png +.. |dashboard_13.png| image:: attachments/dashboard_13.png +.. |dashboard_14.png| image:: attachments/dashboard_14.png +.. |dashboard_15.png| image:: attachments/dashboard_15.png +.. |dashboard_16.png| image:: attachments/dashboard_16.png +.. |dashboard_17.png| image:: attachments/dashboard_17.png +.. |dashboard_18.png| image:: attachments/dashboard_18.png +.. |dashboard_19.png| image:: attachments/dashboard_19.png +.. |dashboard_20.png| image:: attachments/dashboard_20.png +.. |dashboard_21.png| image:: attachments/dashboard_21.png +.. |dashboard_22.png| image:: attachments/dashboard_22.png +.. |dashboard_23.png| image:: attachments/dashboard_23.png +.. |dashboard_24.png| image:: attachments/dashboard_24.png +.. |dashboard_25.png| image:: attachments/dashboard_25.png +.. |dashboard_26.png| image:: attachments/dashboard_26.png +.. |dashboard_27.png| image:: attachments/dashboard_27.png +.. |dashboard_28.png| image:: attachments/dashboard_28.png +.. |dashboard_29.png| image:: attachments/dashboard_29.png +.. |dashboard_30.png| image:: attachments/dashboard_30.png +.. |dashboard_31.png| image:: attachments/dashboard_31.png +.. |dashboard_32.png| image:: attachments/dashboard_32.png +.. |dashboard_33.png| image:: attachments/dashboard_33.png +.. |dashboard_34.png| image:: attachments/dashboard_34.png +.. |dashboard_35.png| image:: attachments/dashboard_35.png diff --git a/docs/sections/user_guide.rst b/docs/sections/user_guide.rst new file mode 100644 index 00000000..c62c5200 --- /dev/null +++ b/docs/sections/user_guide.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +User Guide +========== + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + ./platform-doc/dcaedashboard_userguide.rst + ./design-components/DCAE-MOD/DCAE-MOD-User-Guide.rst +
\ No newline at end of file |
