diff options
Diffstat (limited to 'docs/clamp')
| -rw-r--r-- | docs/clamp/controlloop/design-impl/participants/http-participant.rst | 52 | ||||
| -rw-r--r-- | docs/clamp/controlloop/design-impl/participants/k8s-participant.rst | 132 | ||||
| -rw-r--r-- | docs/clamp/controlloop/design-impl/participants/swagger/k8s-participant-swagger.json | 399 | ||||
| -rw-r--r-- | docs/clamp/controlloop/design-impl/participants/tosca/tosca-http-participant.yml | 439 | ||||
| -rw-r--r-- | docs/clamp/controlloop/design-impl/participants/tosca/tosca-k8s-participant.yml | 304 | ||||
| -rw-r--r-- | docs/clamp/controlloop/images/participants/k8s-participant.png | bin | 0 -> 63460 bytes | |||
| -rw-r--r-- | docs/clamp/controlloop/images/participants/k8s-rest.png | bin | 0 -> 80224 bytes |
7 files changed, 1314 insertions, 12 deletions
diff --git a/docs/clamp/controlloop/design-impl/participants/http-participant.rst b/docs/clamp/controlloop/design-impl/participants/http-participant.rst index 87f0ec6f..b4b9b858 100644 --- a/docs/clamp/controlloop/design-impl/participants/http-participant.rst +++ b/docs/clamp/controlloop/design-impl/participants/http-participant.rst @@ -5,8 +5,6 @@ HTTP Participant ################ -.. warning:: To be completed - The CLAMP HTTP participant receives configuration information from the CLAMP runtime, maps the configuration information to a REST URL, and makes a REST call on the URL. Typically the HTTP Participant is used with another participant such as the @@ -16,8 +14,10 @@ participant can be used to configure the microservice over its REST interface.Of the HTTP participant works towards any REST service, it is not restricted to REST services started by participants. + .. image:: ../../images/participants/http-participant.png + The HTTP participant runs a Control Loop Element to handle the REST dialogues for a particular application domain. The REST dialogues are whatever REST calls that are required to implement the functionality for the application domain. @@ -26,12 +26,6 @@ The HTTP participant allows the REST dialogues for a Control Loop to be managed. particular Control Loop may require many *things* to be configured and managed and this may require many REST dialogues to achieve. -A *Configuration Entity* describes a concept that is managed by the HTTP participant. A -Configuration Entity can be created, Read, Updated, and Deleted (CRUD). The user defines -the Configuration Entities that it wants its HTTP Control Loop Element to manage and -provides a sequence of parameterized REST commands to Create, Read, Update, and Delete -each Configuration Entity. - When a control loop is initialized, the HTTP participant starts a HTTP Control Loop element for the control loop. It reads the configuration information sent from the Control Loop Runtime runs a HTTP client to talk to the REST endpoint that is receiving @@ -42,8 +36,15 @@ Control Loop B. Configuring a Control Loop Element on the HTTP participant for a Control Loop ----------------------------------------------------------------------------- +A *Configuration Entity* describes a concept that is managed by the HTTP participant. A +Configuration Entity can be created, Read, Updated, and Deleted (CRUD). The user defines +the Configuration Entities that it wants its HTTP Control Loop Element to manage and +provides a sequence of parameterized REST commands to Create, Read, Update, and Delete +each Configuration Entity. + +Sample tosca template defining a http participant and a control loop element for a control loop. :download:`click here <tosca/tosca-http-participant.yml>` -The user configures the following properties in the CLAMP GUI for the HTTP participant: +The user configures the following properties in the TOSCA for the HTTP participant: .. list-table:: :widths: 15 10 50 @@ -93,11 +94,40 @@ The *RestRequest* type is described in the following table: - An enum for the HTTP method {GET, PUT, POST, DELETE} * - path - String - - The path of the REST endopint relative to the baseUrl + - The path of the REST endpoint relative to the baseUrl * - body - String - The body of the request for POST and PUT methods * - expectedResponse - HttpStatus - The expected HTTP response code fo the REST request -
\ No newline at end of file + +Http participant Interactions: +------------------------------ +The http participant interacts with Control Loop Runtime on the northbound via DMaap. It interacts with any microservice on the southbound over http for configuration. + +The communication for the Control loop updates and state change requests are sent from the Control Loop Runtime to the participant via DMaap. +The participant invokes the appropriate http endpoint of the microservice based on the received messages from the Control Loop Runtime. + + +startPhase: +----------- +The http participant is often used along with :ref:`Kubernetes Participant <clamp-controlloop-k8s-participant>` to configure the microservice after the deployment. +This requires the Control Loop Element of http participant to be started after the completion of deployment of the microservice. This can be achieved by adding the property `startPhase` +in the Control Loop Element of http participant. Control Loop Runtime starts the elements based on the `startPhase` value defined in the Tosca. The default value of startPhase is taken as '0' +which takes precedence over the Control Loop Elements with the startPhase value '1'. Http Control Loop Elements are defined with value '1' in order to start the Control Loop Element in the second phase. + +Http participant Workflow: +-------------------------- +Once the participant is started, it sends a "REGISTER" event to the DMaap topic which is then consumed by the Control Loop Runtime to register this participant on the runtime database. +The user can commission the tosca definitions from the Policy Gui to the Control Loop Runtime that further updates the participant with these definitions via DMaap. +Once the control loop definitions are available in the runtime database, the Control Loop can be instantiated with the default state "UNINITIALISED" from the Policy Gui. + +When the state of the Control Loop is changed from "UNINITIALISED" to "PASSIVE" from the Policy Gui, the http participant receives the control loop state change event from the runtime and +configures the microservice of the corresponding Control Loop Element over http. +The configuration entity for a microservice is associated with each Control Loop Element for the http participant. +The http participant holds the executed http requests information along with the responses received. + +The participant is used in a generic way to configure any entity over http and it does not hold the information about the microservice to unconfigure/revert the configurations when the +state of Control Loop changes from "PASSIVE" to "UNINITIALISED". + diff --git a/docs/clamp/controlloop/design-impl/participants/k8s-participant.rst b/docs/clamp/controlloop/design-impl/participants/k8s-participant.rst index 1e1a05a3..b30dff39 100644 --- a/docs/clamp/controlloop/design-impl/participants/k8s-participant.rst +++ b/docs/clamp/controlloop/design-impl/participants/k8s-participant.rst @@ -5,4 +5,134 @@ Kubernetes Participant ###################### -.. warning:: To be completed +The kubernetes participant receives a helm chart information from the CLAMP runtime and installs the helm chart in to the +k8s cluster on the specified namespace. It can fetch the helm chart from remote helm repositories as well as from any of the repositories +that are configured on the helm client. The participant acts as a wrapper around the helm client and creates the required +resources in the k8s cluster. + +The kubernetes participant also exposes REST endpoints for onboarding, installing and uninstalling of helm charts from the +local chart database which facilitates the user to also use this component as a standalone application for helm operations. + +In Istanbul version, the kubernetes participant supports the following methods of installation of helm charts. + +- Installation of helm charts from configured helm repositories and remote repositories passed via TOSCA in CLAMP. +- Installation of helm charts from the local chart database via the participant's REST Api. + +Prerequisites for using Kubernetes participant in Istanbul version: +------------------------------------------------------------------- + +- A running Kubernetes cluster. + + Note: + + - If the kubernetes participant is deployed outside the cluster , the config file of the k8s cluster needs to be copied to the `./kube` folder of kubernetes participant's home directory to make the participant work with the external cluster. + + - If the participant needs additional permission to create resources on the cluster, cluster-admin role binding can be created for the service account of the participant with the below command. + + Example: `kubectl create clusterrolebinding k8s-participant-admin-binding --clusterrole=cluster-admin --serviceaccount=<k8s participant service account>` + + +.. image:: ../../images/participants/k8s-participant.png + +Defining a TOSCA CL definition for kubernetes participant: +------------------------------------------------------- +A *chart* parameter map describes the helm chart parameters in tosca template for a microservice that is used by the kubernetes participant for the deployment. +A Control Loop element in TOSCA is mapped to the kubernetes participant and also holds the helm chart parameters for a microservice defined under the properties of the Control Loop Element. + +Sample tosca template defining a participant and a control loop element for a control loop. :download:`click here <tosca/tosca-k8s-participant.yml>` + + +Configuring a Control Loop Element on the kubernetes participant for a Control Loop +----------------------------------------------------------------------------------- + +The user configures the following properties in the TOSCA template for the kubernetes participant: + +.. list-table:: + :widths: 15 10 50 + :header-rows: 1 + + * - Property + - Type + - Description + * - chartId + - ToscaConceptIdentifier + - The name and version of the helm chart that needs to be managed by the kubernetes participant + * - namespace + - String + - The namespace in the k8s cluster where the helm chart needs to be installed + * - releaseName + - String + - The helm deployment name that specifies the installed component in the k8s cluster + * - repository (optional) + - map + - A map of *<String, String>* defining the helm repository parameters for the chart + * - overrideParams (optional) + - map + - A map of *<String, String>* defining the helm chart parameters that needs to be overridden + +Note: The repository property can be skipped if the helm chart is available in the local chart database or +in a repository that is already configured on the helm client. The participant does a chart lookup by default. + +The *repository* type is described in the following table: + +.. list-table:: + :widths: 15 10 50 + :header-rows: 1 + + * - Field + - Type + - Description + * - repoName + - String + - The name of the helm repository that needs to be configured on the helm client + * - protocol + - String + - Specifies http/https protocols to connect with repository url + * - address + - String + - Specifies the ip address or the host name + * - port (optional) + - String + - Specifies the port where the repository service is running + * - userName (optional) + - String + - The username to login the helm repository + * - password (optional) + - String + - The password to login the helm repository + + +Kubernetes participant Interactions: +------------------------------------ +The kubernetes participant interacts with Control Loop Runtime on the northbound via DMaap. It interacts with the helm client on the southbound for performing various helm operations to the k8s cluster. + +The communication for the Control loop updates and state change requests are sent from the Control Loop Runtime to the participant via DMaap. +The participant performs appropriate operations on the k8s cluster via helm client based on the received messages from the Control Loop Runtime. + + +kubernetes participant Workflow: +-------------------------------- +Once the participant is started, it sends a "REGISTER" event to the DMaap topic which is then consumed by the Control Loop Runtime to register this participant on the runtime database. +The user can commission the tosca definitions from the Policy Gui to the Control Loop Runtime that further updates the participant with these definitions via DMaap. +Once the control loop definitions are available in the runtime database, the Control Loop can be instantiated with the default state "UNINITIALISED" from the Policy Gui. + +When the state of the Control Loop is changed from "UNINITIALISED" to "PASSIVE" from the Policy Gui, the kubernetes participant receives the control loop state change event from the runtime and +deploys the helm charts associated with each Control Loop Elements by creating appropriate namespace on the cluster. +If the repository of the helm chart is not passed via TOSCA, the participant looks for the helm chart in the configured helm repositories of helm client. +It also performs a chart look up on the local chart database where the helm charts are onboarded via the participant's REST Api. + +The participant also monitors the deployed pods for the next 3 minutes until the pods comes to RUNNING state. +It holds the deployment information of the pods including the current status of the pods after the deployment. + +When the state of the Control Loop is changed from "PASSIVE" to "UNINITIALISED" back, the participant also undeploys the helm charts from the cluster that are part of the Control Loop Element. + +REST APIs on Kubernetes participant +----------------------------------- + +Kubernetes participant can also be installed as a standalone application which exposes REST endpoints for onboarding, +installing, uninstalling helm charts from local chart database. + + +.. image:: ../../images/participants/k8s-rest.png + +:download:`Download Kubernetes participant API Swagger <swagger/k8s-participant-swagger.json>`
\ No newline at end of file diff --git a/docs/clamp/controlloop/design-impl/participants/swagger/k8s-participant-swagger.json b/docs/clamp/controlloop/design-impl/participants/swagger/k8s-participant-swagger.json new file mode 100644 index 00000000..b2fca37a --- /dev/null +++ b/docs/clamp/controlloop/design-impl/participants/swagger/k8s-participant-swagger.json @@ -0,0 +1,399 @@ +{ + "swagger":"2.0", + "info":{ + "description":"Api Documentation", + "version":"1.0", + "title":"Api Documentation", + "termsOfService":"urn:tos", + "contact":{}, + "license":{ + "name":"Apache 2.0", + "url":"http://www.apache.org/licenses/LICENSE-2.0" + } + }, + "host":"localhost:8083", + "tags":[ + { + "name":"k8s-participant", + "description":"Chart Controller" + } + ], + "paths":{ + "/onap/k8sparticipant/helm/chart/{name}/{version}":{ + "delete":{ + "tags":[ + "k8s-participant" + ], + "summary":"Delete the chart", + "operationId":"deleteChartUsingDELETE", + "produces":[ + "*/*" + ], + "parameters":[ + { + "name":"name", + "in":"path", + "description":"name", + "required":true, + "type":"string" + }, + { + "name":"version", + "in":"path", + "description":"version", + "required":true, + "type":"string" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "type":"object" + } + }, + "204":{ + "description":"Chart Deleted" + }, + "401":{ + "description":"Unauthorized" + }, + "403":{ + "description":"Forbidden" + } + } + } + }, + "/onap/k8sparticipant/helm/charts":{ + "get":{ + "tags":[ + "k8s-participant" + ], + "summary":"Return all Charts", + "operationId":"getAllChartsUsingGET", + "produces":[ + "application/json" + ], + "responses":{ + "200":{ + "description":"chart List", + "schema":{ + "$ref":"#/definitions/ChartList", + "originalRef":"ChartList" + } + }, + "401":{ + "description":"Unauthorized" + }, + "403":{ + "description":"Forbidden" + }, + "404":{ + "description":"Not Found" + } + } + } + }, + "/onap/k8sparticipant/helm/install":{ + "post":{ + "tags":[ + "k8s-participant" + ], + "summary":"Install the chart", + "operationId":"installChartUsingPOST", + "consumes":[ + "application/json" + ], + "produces":[ + "application/json" + ], + "parameters":[ + { + "in":"body", + "name":"info", + "description":"info", + "required":true, + "schema":{ + "$ref":"#/definitions/InstallationInfo", + "originalRef":"InstallationInfo" + } + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "type":"object" + } + }, + "201":{ + "description":"chart Installed", + "schema":{ + "type":"object" + } + }, + "401":{ + "description":"Unauthorized" + }, + "403":{ + "description":"Forbidden" + }, + "404":{ + "description":"Not Found" + } + } + } + }, + "/onap/k8sparticipant/helm/onboard/chart":{ + "post":{ + "tags":[ + "k8s-participant" + ], + "summary":"Onboard the Chart", + "operationId":"onboardChartUsingPOST", + "consumes":[ + "multipart/form-data" + ], + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"chart", + "in":"formData", + "required":false, + "type":"file" + }, + { + "name":"info", + "in":"formData", + "required":false, + "type":"string" + }, + { + "in":"body", + "name":"values", + "description":"values", + "required":false, + "schema":{ + "type":"string", + "format":"binary" + } + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "type":"string" + } + }, + "201":{ + "description":"Chart Onboarded", + "schema":{ + "type":"string" + } + }, + "401":{ + "description":"Unauthorized" + }, + "403":{ + "description":"Forbidden" + }, + "404":{ + "description":"Not Found" + } + } + } + }, + "/onap/k8sparticipant/helm/repo":{ + "post":{ + "tags":[ + "k8s-participant" + ], + "summary":"Configure helm repository", + "operationId":"configureRepoUsingPOST", + "consumes":[ + "application/json" + ], + "produces":[ + "application/json" + ], + "parameters":[ + { + "in":"body", + "name":"repo", + "description":"repo", + "required":true, + "schema":{ + "type":"string" + } + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "type":"object" + } + }, + "201":{ + "description":"Repository added", + "schema":{ + "type":"object" + } + }, + "401":{ + "description":"Unauthorized" + }, + "403":{ + "description":"Forbidden" + }, + "404":{ + "description":"Not Found" + } + } + } + }, + "/onap/k8sparticipant/helm/uninstall/{name}/{version}":{ + "delete":{ + "tags":[ + "k8s-participant" + ], + "summary":"Uninstall the Chart", + "operationId":"uninstallChartUsingDELETE", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"name", + "in":"path", + "description":"name", + "required":true, + "type":"string" + }, + { + "name":"version", + "in":"path", + "description":"version", + "required":true, + "type":"string" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "type":"object" + } + }, + "201":{ + "description":"chart Uninstalled", + "schema":{ + "type":"object" + } + }, + "204":{ + "description":"No Content" + }, + "401":{ + "description":"Unauthorized" + }, + "403":{ + "description":"Forbidden" + } + } + } + } + }, + "definitions":{ + "ChartInfo":{ + "type":"object", + "properties":{ + "chartId":{ + "$ref":"#/definitions/ToscaConceptIdentifier", + "originalRef":"ToscaConceptIdentifier" + }, + "namespace":{ + "type":"string" + }, + "overrideParams":{ + "type":"object", + "additionalProperties":{ + "type":"string" + } + }, + "releaseName":{ + "type":"string" + }, + "repository":{ + "$ref":"#/definitions/HelmRepository", + "originalRef":"HelmRepository" + } + }, + "title":"ChartInfo" + }, + "ChartList":{ + "type":"object", + "properties":{ + "charts":{ + "type":"array", + "items":{ + "$ref":"#/definitions/ChartInfo", + "originalRef":"ChartInfo" + } + } + }, + "title":"ChartList" + }, + "HelmRepository":{ + "type":"object", + "properties":{ + "address":{ + "type":"string" + }, + "password":{ + "type":"string" + }, + "port":{ + "type":"string" + }, + "protocol":{ + "type":"string" + }, + "repoName":{ + "type":"string" + }, + "userName":{ + "type":"string" + } + }, + "title":"HelmRepository" + }, + "InstallationInfo":{ + "type":"object", + "properties":{ + "name":{ + "type":"string" + }, + "version":{ + "type":"string" + } + }, + "title":"InstallationInfo" + }, + "ToscaConceptIdentifier":{ + "type":"object", + "properties":{ + "name":{ + "type":"string" + }, + "version":{ + "type":"string" + } + }, + "title":"ToscaConceptIdentifier" + } + } +} diff --git a/docs/clamp/controlloop/design-impl/participants/tosca/tosca-http-participant.yml b/docs/clamp/controlloop/design-impl/participants/tosca/tosca-http-participant.yml new file mode 100644 index 00000000..dae4c76a --- /dev/null +++ b/docs/clamp/controlloop/design-impl/participants/tosca/tosca-http-participant.yml @@ -0,0 +1,439 @@ +tosca_definitions_version: tosca_simple_yaml_1_3 +data_types: + onap.datatypes.ToscaConceptIdentifier: + derived_from: tosca.datatypes.Root + properties: + name: + type: string + required: true + version: + type: string + required: true + onap.datatype.controlloop.Target: + derived_from: tosca.datatypes.Root + description: Definition for a entity in A&AI to perform a control loop operation on + properties: + targetType: + type: string + description: Category for the target type + required: true + constraints: + - valid_values: + - VNF + - VM + - VFMODULE + - PNF + entityIds: + type: map + description: | + Map of values that identify the resource. If none are provided, it is assumed that the + entity that generated the ONSET event will be the target. + required: false + metadata: + clamp_possible_values: ClampExecution:CSAR_RESOURCES + entry_schema: + type: string + onap.datatype.controlloop.Actor: + derived_from: tosca.datatypes.Root + description: An actor/operation/target definition + properties: + actor: + type: string + description: The actor performing the operation. + required: true + metadata: + clamp_possible_values: Dictionary:DefaultActors,ClampExecution:CDS/actor + operation: + type: string + description: The operation the actor is performing. + metadata: + clamp_possible_values: Dictionary:DefaultOperations,ClampExecution:CDS/operation + required: true + target: + type: onap.datatype.controlloop.Target + description: The resource the operation should be performed on. + required: true + payload: + type: map + description: Name/value pairs of payload information passed by Policy to the actor + required: false + metadata: + clamp_possible_values: ClampExecution:CDS/payload + entry_schema: + type: string + onap.datatype.controlloop.Operation: + derived_from: tosca.datatypes.Root + description: An operation supported by an actor + properties: + id: + type: string + description: Unique identifier for the operation + required: true + description: + type: string + description: A user-friendly description of the intent for the operation + required: false + operation: + type: onap.datatype.controlloop.Actor + description: The definition of the operation to be performed. + required: true + timeout: + type: integer + description: The amount of time for the actor to perform the operation. + required: true + retries: + type: integer + description: The number of retries the actor should attempt to perform the operation. + required: true + default: 0 + success: + type: string + description: Points to the operation to invoke on success. A value of "final_success" indicates and end to the operation. + required: false + default: final_success + failure: + type: string + description: Points to the operation to invoke on Actor operation failure. + required: false + default: final_failure + failure_timeout: + type: string + description: Points to the operation to invoke when the time out for the operation occurs. + required: false + default: final_failure_timeout + failure_retries: + type: string + description: Points to the operation to invoke when the current operation has exceeded its max retries. + required: false + default: final_failure_retries + failure_exception: + type: string + description: Points to the operation to invoke when the current operation causes an exception. + required: false + default: final_failure_exception + failure_guard: + type: string + description: Points to the operation to invoke when the current operation is blocked due to guard policy enforcement. + required: false + default: final_failure_guard + org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.RestRequest: + version: 1.0.0 + derived_from: tosca.datatypes.Root + properties: + restRequestId: + type: onap.datatypes.ToscaConceptIdentifier + typeVersion: 1.0.0 + required: true + description: The name and version of a REST request to be sent to a REST endpoint + httpMethod: + type: string + required: true + constraints: + - valid_values: [POST, PUT, GET, DELETE] + description: The REST method to use + path: + type: string + required: true + description: The path of the REST request relative to the base URL + body: + type: string + required: false + description: The body of the REST request for PUT and POST requests + expectedResponse: + type: integer + required: true + constraints: + - in_range: [100, 599] + description: THe expected HTTP status code for the REST request + org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.ConfigurationEntity: + version: 1.0.0 + derived_from: tosca.datatypes.Root + properties: + configurationEntityId: + type: onap.datatypes.ToscaConceptIdentifier + typeVersion: 1.0.0 + required: true + description: The name and version of a Configuration Entity to be handled by the HTTP Control Loop Element + restSequence: + type: list + entry_schema: + type: org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.RestRequest + typeVersion: 1.0.0 + description: A sequence of REST commands to send to the REST endpoint +node_types: + org.onap.policy.clamp.controlloop.Participant: + version: 1.0.1 + derived_from: tosca.nodetypes.Root + properties: + provider: + type: string + requred: false + org.onap.policy.clamp.controlloop.ControlLoopElement: + version: 1.0.1 + derived_from: tosca.nodetypes.Root + properties: + provider: + type: string + required: false + metadata: + common: true + description: Specifies the organization that provides the control loop element + participant_id: + type: onap.datatypes.ToscaConceptIdentifier + requred: true + metadata: + common: true + participantType: + type: onap.datatypes.ToscaConceptIdentifier + required: true + metadata: + common: true + description: The identity of the participant type that hosts this type of Control Loop Element + startPhase: + type: integer + required: false + constraints: + - greater_or_equal: 0 + metadata: + common: true + description: A value indicating the start phase in which this control loop element will be started, the + first start phase is zero. Control Loop Elements are started in their start_phase order and stopped + in reverse start phase order. Control Loop Elements with the same start phase are started and + stopped simultaneously + uninitializedToPassiveTimeout: + type: integer + required: false + constraints: + - greater_or_equal: 0 + default: 60 + metadata: + common: true + description: The maximum time in seconds to wait for a state chage from uninitialized to passive + passiveToRunningTimeout: + type: integer + required: false + constraints: + - greater_or_equal: 0 + default: 60 + metadata: + common: true + description: The maximum time in seconds to wait for a state chage from passive to running + runningToPassiveTimeout: + type: integer + required: false + constraints: + - greater_or_equal: 0 + default: 60 + metadata: + common: true + description: The maximum time in seconds to wait for a state chage from running to passive + passiveToUninitializedTimeout: + type: integer + required: false + constraints: + - greater_or_equal: 0 + default: 60 + metadata: + common: true + description: The maximum time in seconds to wait for a state chage from passive to uninitialized + org.onap.policy.clamp.controlloop.ControlLoop: + version: 1.0.1 + derived_from: tosca.nodetypes.Root + properties: + provider: + type: string + required: false + metadata: + common: true + description: Specifies the organization that provides the control loop element + elements: + type: list + required: true + metadata: + common: true + entry_schema: + type: onap.datatypes.ToscaConceptIdentifier + description: Specifies a list of control loop element definitions that make up this control loop definition + org.onap.policy.clamp.controlloop.HttpControlLoopElement: + version: 1.0.1 + derived_from: org.onap.policy.clamp.controlloop.ControlLoopElement + properties: + baseUrl: + type: string + required: true + description: The base URL to be prepended to each path, identifies the host for the REST endpoints. + httpHeaders: + type: map + required: false + entry_schema: + type: string + description: HTTP headers to send on REST requests + configurationEntities: + type: map + required: true + entry_schema: + type: org.onap.datatypes.policy.clamp.controlloop.httpControlLoopElement.ConfigurationEntity + typeVersion: 1.0.0 + description: The connfiguration entities the Control Loop Element is managing and their associated REST requests + +topology_template: + node_templates: + org.onap.controlloop.HttpControlLoopParticipant: + version: 2.3.4 + type: org.onap.policy.clamp.controlloop.Participant + type_version: 1.0.1 + description: Participant for Http requests + properties: + provider: ONAP + org.onap.domain.database.Http_PMSHMicroserviceControlLoopElement: + # Consul http config for PMSH. + version: 1.2.3 + type: org.onap.policy.clamp.controlloop.HttpControlLoopElement + type_version: 1.0.1 + description: Control loop element for the http requests of PMSH microservice + properties: + provider: ONAP + participant_id: + name: HttpParticipant0 + version: 1.0.0 + participantType: + name: org.onap.k8s.controlloop.HttpControlLoopParticipant + version: 2.3.4 + uninitializedToPassiveTimeout: 180 + baseUrl: http://consul-server-ui:8500 + httpHeaders: + Content-Type: application/json + configurationEntities: + - configurationEntityId: + name: entity1 + version: 1.0.1 + restSequence: + - restRequestId: + name: request1 + version: 1.0.1 + httpMethod: PUT + path: v1/kv/dcae-pmsh2 + body: '{ + "control_loop_name":"pmsh-control-loop", + "operational_policy_name":"pmsh-operational-policy", + "aaf_password":"demo123456!", + "aaf_identity":"dcae@dcae.onap.org", + "cert_path":"/opt/app/pmsh/etc/certs/cert.pem", + "key_path":"/opt/app/pmsh/etc/certs/key.pem", + "ca_cert_path":"/opt/app/pmsh/etc/certs/cacert.pem", + "enable_tls":"true", + "pmsh_policy":{ + "subscription":{ + "subscriptionName":"ExtraPM-All-gNB-R2B", + "administrativeState":"UNLOCKED", + "fileBasedGP":15, + "fileLocation":"\/pm\/pm.xml", + "nfFilter":{ + "nfNames":[ + "^pnf.*", + "^vnf.*" + ], + "modelInvariantIDs":[ + ], + "modelVersionIDs":[ + ], + "modelNames":[ + ] + }, + "measurementGroups":[ + { + "measurementGroup":{ + "measurementTypes":[ + { + "measurementType":"countera" + }, + { + "measurementType":"counterb" + } + ], + "managedObjectDNsBasic":[ + { + "DN":"dna" + }, + { + "DN":"dnb" + } + ] + } + }, + { + "measurementGroup":{ + "measurementTypes":[ + { + "measurementType":"counterc" + }, + { + "measurementType":"counterd" + } + ], + "managedObjectDNsBasic":[ + { + "DN":"dnc" + }, + { + "DN":"dnd" + } + ] + } + } + ] + } + }, + "streams_subscribes":{ + "aai_subscriber":{ + "type":"message_router", + "dmaap_info":{ + "topic_url":"https://10.152.183.151:3905/events/AAI_EVENT", + "client_role":"org.onap.dcae.aaiSub", + "location":"san-francisco", + "client_id":"1575976809466" + } + }, + "policy_pm_subscriber":{ + "type":"message_router", + "dmaap_info":{ + "topic_url":"https://10.152.183.151:3905/events/org.onap.dmaap.mr.PM_SUBSCRIPTIONS", + "client_role":"org.onap.dcae.pmSubscriber", + "location":"san-francisco", + "client_id":"1575876809456" + } + } + }, + "streams_publishes":{ + "policy_pm_publisher":{ + "type":"message_router", + "dmaap_info":{ + "topic_url":"https://10.152.183.151:3905/events/org.onap.dmaap.mr.PM_SUBSCRIPTIONS", + "client_role":"org.onap.dcae.pmPublisher", + "location":"san-francisco", + "client_id":"1475976809466" + } + }, + "other_publisher":{ + "type":"message_router", + "dmaap_info":{ + "topic_url":"https://10.152.183.151:3905/events/org.onap.dmaap.mr.SOME_OTHER_TOPIC", + "client_role":"org.onap.dcae.pmControlPub", + "location":"san-francisco", + "client_id":"1875976809466" + } + } + } + }' + expectedResponse: 200 + org.onap.domain.sample.GenericK8s_ControlLoopDefinition: + version: 1.2.3 + type: org.onap.policy.clamp.controlloop.ControlLoop + type_version: 1.0.0 + description: Control loop for Hello World + properties: + provider: ONAP + elements: + - name: org.onap.domain.database.Http_PMSHMicroserviceControlLoopElement + version: 1.2.3 + diff --git a/docs/clamp/controlloop/design-impl/participants/tosca/tosca-k8s-participant.yml b/docs/clamp/controlloop/design-impl/participants/tosca/tosca-k8s-participant.yml new file mode 100644 index 00000000..70bbe928 --- /dev/null +++ b/docs/clamp/controlloop/design-impl/participants/tosca/tosca-k8s-participant.yml @@ -0,0 +1,304 @@ +tosca_definitions_version: tosca_simple_yaml_1_3 +data_types: + onap.datatypes.ToscaConceptIdentifier: + derived_from: tosca.datatypes.Root + properties: + name: + type: string + required: true + version: + type: string + required: true + onap.datatype.controlloop.Target: + derived_from: tosca.datatypes.Root + description: Definition for a entity in A&AI to perform a control loop operation on + properties: + targetType: + type: string + description: Category for the target type + required: true + constraints: + - valid_values: + - VNF + - VM + - VFMODULE + - PNF + entityIds: + type: map + description: | + Map of values that identify the resource. If none are provided, it is assumed that the + entity that generated the ONSET event will be the target. + required: false + metadata: + clamp_possible_values: ClampExecution:CSAR_RESOURCES + entry_schema: + type: string + onap.datatype.controlloop.Actor: + derived_from: tosca.datatypes.Root + description: An actor/operation/target definition + properties: + actor: + type: string + description: The actor performing the operation. + required: true + metadata: + clamp_possible_values: Dictionary:DefaultActors,ClampExecution:CDS/actor + operation: + type: string + description: The operation the actor is performing. + metadata: + clamp_possible_values: Dictionary:DefaultOperations,ClampExecution:CDS/operation + required: true + target: + type: onap.datatype.controlloop.Target + description: The resource the operation should be performed on. + required: true + payload: + type: map + description: Name/value pairs of payload information passed by Policy to the actor + required: false + metadata: + clamp_possible_values: ClampExecution:CDS/payload + entry_schema: + type: string + onap.datatype.controlloop.Operation: + derived_from: tosca.datatypes.Root + description: An operation supported by an actor + properties: + id: + type: string + description: Unique identifier for the operation + required: true + description: + type: string + description: A user-friendly description of the intent for the operation + required: false + operation: + type: onap.datatype.controlloop.Actor + description: The definition of the operation to be performed. + required: true + timeout: + type: integer + description: The amount of time for the actor to perform the operation. + required: true + retries: + type: integer + description: The number of retries the actor should attempt to perform the operation. + required: true + default: 0 + success: + type: string + description: Points to the operation to invoke on success. A value of "final_success" indicates and end to the operation. + required: false + default: final_success + failure: + type: string + description: Points to the operation to invoke on Actor operation failure. + required: false + default: final_failure + failure_timeout: + type: string + description: Points to the operation to invoke when the time out for the operation occurs. + required: false + default: final_failure_timeout + failure_retries: + type: string + description: Points to the operation to invoke when the current operation has exceeded its max retries. + required: false + default: final_failure_retries + failure_exception: + type: string + description: Points to the operation to invoke when the current operation causes an exception. + required: false + default: final_failure_exception + failure_guard: + type: string + description: Points to the operation to invoke when the current operation is blocked due to guard policy enforcement. + required: false + default: final_failure_guard +node_types: + org.onap.policy.clamp.controlloop.Participant: + version: 1.0.1 + derived_from: tosca.nodetypes.Root + properties: + provider: + type: string + requred: false + org.onap.policy.clamp.controlloop.ControlLoopElement: + version: 1.0.1 + derived_from: tosca.nodetypes.Root + properties: + provider: + type: string + required: false + metadata: + common: true + description: Specifies the organization that provides the control loop element + participant_id: + type: onap.datatypes.ToscaConceptIdentifier + requred: true + metadata: + common: true + participantType: + type: onap.datatypes.ToscaConceptIdentifier + required: true + metadata: + common: true + description: The identity of the participant type that hosts this type of Control Loop Element + startPhase: + type: integer + required: false + constraints: + - greater_or_equal: 0 + metadata: + common: true + description: A value indicating the start phase in which this control loop element will be started, the + first start phase is zero. Control Loop Elements are started in their start_phase order and stopped + in reverse start phase order. Control Loop Elements with the same start phase are started and + stopped simultaneously + uninitializedToPassiveTimeout: + type: integer + required: false + constraints: + - greater_or_equal: 0 + default: 60 + metadata: + common: true + description: The maximum time in seconds to wait for a state chage from uninitialized to passive + passiveToRunningTimeout: + type: integer + required: false + constraints: + - greater_or_equal: 0 + default: 60 + metadata: + common: true + description: The maximum time in seconds to wait for a state chage from passive to running + runningToPassiveTimeout: + type: integer + required: false + constraints: + - greater_or_equal: 0 + default: 60 + metadata: + common: true + description: The maximum time in seconds to wait for a state chage from running to passive + passiveToUninitializedTimeout: + type: integer + required: false + constraints: + - greater_or_equal: 0 + default: 60 + metadata: + common: true + description: The maximum time in seconds to wait for a state chage from passive to uninitialized + org.onap.policy.clamp.controlloop.ControlLoop: + version: 1.0.1 + derived_from: tosca.nodetypes.Root + properties: + provider: + type: string + required: false + metadata: + common: true + description: Specifies the organization that provides the control loop element + elements: + type: list + required: true + metadata: + common: true + entry_schema: + type: onap.datatypes.ToscaConceptIdentifier + description: Specifies a list of control loop element definitions that make up this control loop definition + org.onap.policy.clamp.controlloop.K8SMicroserviceControlLoopElement: + version: 1.0.1 + derived_from: org.onap.policy.clamp.controlloop.ControlLoopElement + properties: + chart: + type: string + required: true + configs: + type: list + required: false + requirements: + type: string + requred: false + templates: + type: list + required: false + entry_schema: + values: + type: string + required: true + +topology_template: + node_templates: + org.onap.k8s.controlloop.K8SControlLoopParticipant: + version: 2.3.4 + type: org.onap.policy.clamp.controlloop.Participant + type_version: 1.0.1 + description: Participant for K8S + properties: + provider: ONAP + org.onap.domain.database.PMSH_K8SMicroserviceControlLoopElement: + # Chart from new repository + version: 1.2.3 + type: org.onap.policy.clamp.controlloop.K8SMicroserviceControlLoopElement + type_version: 1.0.0 + description: Control loop element for the K8S microservice for PMSH + properties: + provider: ONAP + participant_id: + name: K8sParticipant0 + version: 1.0.0 + participantType: + name: org.onap.k8s.controlloop.K8SControlLoopParticipant + version: 2.3.4 + chart: + chartId: + name: dcae-pmsh + version: 8.0.0 + namespace: onap + releaseName: pmshms + repository: + repoName: chartmuseum + protocol: http + address: chart-museum + port: 80 + userName: onapinitializer + password: demo123456! + overrideParams: + global.masterPassword: test + + org.onap.domain.database.Local_K8SMicroserviceControlLoopElement: + # Chart installation without passing repository info + version: 1.2.3 + type: org.onap.policy.clamp.controlloop.K8SMicroserviceControlLoopElement + type_version: 1.0.0 + description: Control loop element for the K8S microservice for local chart + properties: + provider: ONAP + participant_id: + name: K8sParticipant0 + version: 1.0.0 + participantType: + name: org.onap.k8s.controlloop.K8SControlLoopParticipant + version: 2.3.4 + chart: + chartId: + name: nginx-ingress + version: 0.9.1 + releaseName: nginxms + namespace: test + org.onap.domain.sample.GenericK8s_ControlLoopDefinition: + version: 1.2.3 + type: org.onap.policy.clamp.controlloop.ControlLoop + type_version: 1.0.0 + description: Control loop for Hello World + properties: + provider: ONAP + elements: + - name: org.onap.domain.database.PMSH_K8SMicroserviceControlLoopElement + version: 1.2.3 + - name: org.onap.domain.database.Local_K8SMicroserviceControlLoopElement + version: 1.2.3 diff --git a/docs/clamp/controlloop/images/participants/k8s-participant.png b/docs/clamp/controlloop/images/participants/k8s-participant.png Binary files differnew file mode 100644 index 00000000..55945bc3 --- /dev/null +++ b/docs/clamp/controlloop/images/participants/k8s-participant.png diff --git a/docs/clamp/controlloop/images/participants/k8s-rest.png b/docs/clamp/controlloop/images/participants/k8s-rest.png Binary files differnew file mode 100644 index 00000000..d08982a9 --- /dev/null +++ b/docs/clamp/controlloop/images/participants/k8s-rest.png |
