aboutsummaryrefslogtreecommitdiffstats
path: root/docs/clamp/acm/design-impl/participants
diff options
context:
space:
mode:
Diffstat (limited to 'docs/clamp/acm/design-impl/participants')
-rw-r--r--docs/clamp/acm/design-impl/participants/swagger/participant-sim.json36
-rw-r--r--docs/clamp/acm/design-impl/participants/tosca/tosca-k8s-participant.yml66
2 files changed, 51 insertions, 51 deletions
diff --git a/docs/clamp/acm/design-impl/participants/swagger/participant-sim.json b/docs/clamp/acm/design-impl/participants/swagger/participant-sim.json
index 79fc3011..b258f85a 100644
--- a/docs/clamp/acm/design-impl/participants/swagger/participant-sim.json
+++ b/docs/clamp/acm/design-impl/participants/swagger/participant-sim.json
@@ -15,10 +15,10 @@
"/onap/participantsim/v2/elements": {
"put": {
"tags": [
- "Clamp Control Loop Participant Simulator API"
+ "Clamp Automation Composition Participant Simulator API"
],
- "summary": "Updates simulated control loop elements",
- "description": "Updates simulated control loop elements, returning the updated control loop definition IDs",
+ "summary": "Updates simulated automation composition elements",
+ "description": "Updates simulated automation composition elements, returning the updated automation composition definition IDs",
"operationId": "updateUsingPUT",
"consumes": [
"application/json"
@@ -31,11 +31,11 @@
{
"in": "body",
"name": "body",
- "description": "Body of a control loop element",
+ "description": "Body of a automation composition element",
"required": true,
"schema": {
- "$ref": "#/definitions/ControlLoopElementReq",
- "originalRef": "ControlLoopElementReq"
+ "$ref": "#/definitions/AutomationCompositionElementReq",
+ "originalRef": "AutomationCompositionElementReq"
}
},
{
@@ -51,8 +51,8 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/TypedSimpleResponse«ControlLoopElement»",
- "originalRef": "TypedSimpleResponse«ControlLoopElement»"
+ "$ref": "#/definitions/TypedSimpleResponse«AutomationCompositionElement»",
+ "originalRef": "TypedSimpleResponse«AutomationCompositionElement»"
}
},
"201": {
@@ -130,10 +130,10 @@
"/onap/participantsim/v2/elements/{name}/{version}": {
"get": {
"tags": [
- "Clamp Control Loop Participant Simulator API"
+ "Clamp Automation Composition Participant Simulator API"
],
- "summary": "Query details of the requested simulated control loop elements",
- "description": "Queries details of the requested simulated control loop elements, returning all control loop element details",
+ "summary": "Query details of the requested simulated automation composition elements",
+ "description": "Queries details of the requested simulated automation composition elements, returning all automation composition element details",
"operationId": "elementsUsingGET",
"produces": [
"application/json",
@@ -143,14 +143,14 @@
{
"name": "name",
"in": "path",
- "description": "Control loop element name",
+ "description": "Automation Composition element name",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
- "description": "Control loop element version",
+ "description": "Automation Composition element version",
"required": true,
"type": "string"
},
@@ -169,8 +169,8 @@
"schema": {
"type": "object",
"additionalProperties": {
- "$ref": "#/definitions/ControlLoopElementRes",
- "originalRef": "ControlLoopElementRes"
+ "$ref": "#/definitions/AutomationCompositionElementRes",
+ "originalRef": "AutomationCompositionElementRes"
}
}
},
@@ -246,10 +246,10 @@
"/onap/participantsim/v2/participants": {
"put": {
"tags": [
- "Clamp Control Loop Participant Simulator API"
+ "Clamp Automation Composition Participant Simulator API"
],
"summary": "Updates simulated participants",
- "description": "Updates simulated participants, returning the updated control loop definition IDs",
+ "description": "Updates simulated participants, returning the updated automation composition definition IDs",
"operationId": "updateUsingPUT_1",
"consumes": [
"application/json"
@@ -361,7 +361,7 @@
"/onap/participantsim/v2/participants/{name}/{version}": {
"get": {
"tags": [
- "Clamp Control Loop Participant Simulator API"
+ "Clamp Automation Composition Participant Simulator API"
],
"summary": "Query details of the requested simulated participants",
"description": "Queries details of the requested simulated participants, returning all participant details",
diff --git a/docs/clamp/acm/design-impl/participants/tosca/tosca-k8s-participant.yml b/docs/clamp/acm/design-impl/participants/tosca/tosca-k8s-participant.yml
index 70bbe928..f411eb55 100644
--- a/docs/clamp/acm/design-impl/participants/tosca/tosca-k8s-participant.yml
+++ b/docs/clamp/acm/design-impl/participants/tosca/tosca-k8s-participant.yml
@@ -9,9 +9,9 @@ data_types:
version:
type: string
required: true
- onap.datatype.controlloop.Target:
+ onap.datatype.acm.Target:
derived_from: tosca.datatypes.Root
- description: Definition for a entity in A&AI to perform a control loop operation on
+ description: Definition for a entity in A&AI to perform a automation composition operation on
properties:
targetType:
type: string
@@ -33,7 +33,7 @@ data_types:
clamp_possible_values: ClampExecution:CSAR_RESOURCES
entry_schema:
type: string
- onap.datatype.controlloop.Actor:
+ onap.datatype.acm.Actor:
derived_from: tosca.datatypes.Root
description: An actor/operation/target definition
properties:
@@ -50,7 +50,7 @@ data_types:
clamp_possible_values: Dictionary:DefaultOperations,ClampExecution:CDS/operation
required: true
target:
- type: onap.datatype.controlloop.Target
+ type: onap.datatype.acm.Target
description: The resource the operation should be performed on.
required: true
payload:
@@ -61,7 +61,7 @@ data_types:
clamp_possible_values: ClampExecution:CDS/payload
entry_schema:
type: string
- onap.datatype.controlloop.Operation:
+ onap.datatype.acm.Operation:
derived_from: tosca.datatypes.Root
description: An operation supported by an actor
properties:
@@ -74,7 +74,7 @@ data_types:
description: A user-friendly description of the intent for the operation
required: false
operation:
- type: onap.datatype.controlloop.Actor
+ type: onap.datatype.acm.Actor
description: The definition of the operation to be performed.
required: true
timeout:
@@ -117,14 +117,14 @@ data_types:
required: false
default: final_failure_guard
node_types:
- org.onap.policy.clamp.controlloop.Participant:
+ org.onap.policy.clamp.acm.Participant:
version: 1.0.1
derived_from: tosca.nodetypes.Root
properties:
provider:
type: string
requred: false
- org.onap.policy.clamp.controlloop.ControlLoopElement:
+ org.onap.policy.clamp.acm.AutomationCompositionElement:
version: 1.0.1
derived_from: tosca.nodetypes.Root
properties:
@@ -133,7 +133,7 @@ node_types:
required: false
metadata:
common: true
- description: Specifies the organization that provides the control loop element
+ description: Specifies the organization that provides the automation composition element
participant_id:
type: onap.datatypes.ToscaConceptIdentifier
requred: true
@@ -144,7 +144,7 @@ node_types:
required: true
metadata:
common: true
- description: The identity of the participant type that hosts this type of Control Loop Element
+ description: The identity of the participant type that hosts this type of automation composition Element
startPhase:
type: integer
required: false
@@ -152,9 +152,9 @@ node_types:
- 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
+ description: A value indicating the start phase in which this automation composition element will be started, the
+ first start phase is zero. Automation Composition Elements are started in their start_phase order and stopped
+ in reverse start phase order. Automation Composition Elements with the same start phase are started and
stopped simultaneously
uninitializedToPassiveTimeout:
type: integer
@@ -192,7 +192,7 @@ node_types:
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:
+ org.onap.policy.clamp.acm.AutomationComposition:
version: 1.0.1
derived_from: tosca.nodetypes.Root
properties:
@@ -201,7 +201,7 @@ node_types:
required: false
metadata:
common: true
- description: Specifies the organization that provides the control loop element
+ description: Specifies the organization that provides the automation composition element
elements:
type: list
required: true
@@ -209,10 +209,10 @@ node_types:
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:
+ description: Specifies a list of automation composition element definitions that make up this automation composition definition
+ org.onap.policy.clamp.acm.K8SMicroserviceAutomationCompositionElement:
version: 1.0.1
- derived_from: org.onap.policy.clamp.controlloop.ControlLoopElement
+ derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
properties:
chart:
type: string
@@ -233,26 +233,26 @@ node_types:
topology_template:
node_templates:
- org.onap.k8s.controlloop.K8SControlLoopParticipant:
+ org.onap.k8s.acm.K8SAutomationCompositionParticipant:
version: 2.3.4
- type: org.onap.policy.clamp.controlloop.Participant
+ type: org.onap.policy.clamp.acm.Participant
type_version: 1.0.1
description: Participant for K8S
properties:
provider: ONAP
- org.onap.domain.database.PMSH_K8SMicroserviceControlLoopElement:
+ org.onap.domain.database.PMSH_K8SMicroserviceAutomationCompositionElement:
# Chart from new repository
version: 1.2.3
- type: org.onap.policy.clamp.controlloop.K8SMicroserviceControlLoopElement
+ type: org.onap.policy.clamp.acm.K8SMicroserviceAutomationCompositionElement
type_version: 1.0.0
- description: Control loop element for the K8S microservice for PMSH
+ description: Automation composition 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
+ name: org.onap.k8s.acm.K8SAutomationCompositionParticipant
version: 2.3.4
chart:
chartId:
@@ -270,19 +270,19 @@ topology_template:
overrideParams:
global.masterPassword: test
- org.onap.domain.database.Local_K8SMicroserviceControlLoopElement:
+ org.onap.domain.database.Local_K8SMicroserviceAutomationCompositionElement:
# Chart installation without passing repository info
version: 1.2.3
- type: org.onap.policy.clamp.controlloop.K8SMicroserviceControlLoopElement
+ type: org.onap.policy.clamp.acm.K8SMicroserviceAutomationCompositionElement
type_version: 1.0.0
- description: Control loop element for the K8S microservice for local chart
+ description: Automation composition 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
+ name: org.onap.k8s.acm.K8SAutomationCompositionParticipant
version: 2.3.4
chart:
chartId:
@@ -290,15 +290,15 @@ topology_template:
version: 0.9.1
releaseName: nginxms
namespace: test
- org.onap.domain.sample.GenericK8s_ControlLoopDefinition:
+ org.onap.domain.sample.GenericK8s_AutomationCompositionDefinition:
version: 1.2.3
- type: org.onap.policy.clamp.controlloop.ControlLoop
+ type: org.onap.policy.clamp.acm.AutomationComposition
type_version: 1.0.0
- description: Control loop for Hello World
+ description: Automation composition for Hello World
properties:
provider: ONAP
elements:
- - name: org.onap.domain.database.PMSH_K8SMicroserviceControlLoopElement
+ - name: org.onap.domain.database.PMSH_K8SMicroserviceAutomationCompositionElement
version: 1.2.3
- - name: org.onap.domain.database.Local_K8SMicroserviceControlLoopElement
+ - name: org.onap.domain.database.Local_K8SMicroserviceAutomationCompositionElement
version: 1.2.3