From 19d451d0b657d7d33a126434f036d6489e1d3b89 Mon Sep 17 00:00:00 2001 From: rameshiyer27 Date: Wed, 5 Oct 2022 15:56:48 +0100 Subject: Update ACM documentation for Kohn release Removed participant simulator and k8s ppnt standalone endpoints. Updated REST endpoints of ACM Issue-ID: POLICY-4382 Signed-off-by: zrrmmua Change-Id: Ib31253952a32b33b2e193293b0b1775fcb35054b --- .../design-impl/participants/k8s-participant.rst | 25 +++------------------- .../participants/participant-simulator.rst | 21 ------------------ .../acm/design-impl/participants/participants.rst | 1 - 3 files changed, 3 insertions(+), 44 deletions(-) delete mode 100644 docs/clamp/acm/design-impl/participants/participant-simulator.rst (limited to 'docs/clamp/acm/design-impl/participants') diff --git a/docs/clamp/acm/design-impl/participants/k8s-participant.rst b/docs/clamp/acm/design-impl/participants/k8s-participant.rst index 366c8430..ddce0a3c 100644 --- a/docs/clamp/acm/design-impl/participants/k8s-participant.rst +++ b/docs/clamp/acm/design-impl/participants/k8s-participant.rst @@ -13,10 +13,9 @@ 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. +In Kohn 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: ------------------------------------------------------------------- @@ -86,15 +85,9 @@ The *repository* type is described in the following table: * - 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 + - Specifies the url of the hem repository * - userName (optional) - String - The username to login the helm repository @@ -120,20 +113,8 @@ Once the automation composition definitions are available in the runtime databas When the state of the Automation Composition is changed from "UNINITIALISED" to "PASSIVE" from the Policy Gui, the kubernetes participant receives the automation composition state change event from the runtime and deploys the helm charts associated with each Automation Composition 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. +The participant also monitors the deployed pods for the configured time 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 Automation Composition is changed from "PASSIVE" to "UNINITIALISED" back, the participant also undeploys the helm charts from the cluster that are part of the Automation Composition 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 ` \ No newline at end of file diff --git a/docs/clamp/acm/design-impl/participants/participant-simulator.rst b/docs/clamp/acm/design-impl/participants/participant-simulator.rst deleted file mode 100644 index a53e9077..00000000 --- a/docs/clamp/acm/design-impl/participants/participant-simulator.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -.. _clamp-acm-participant-simulator: - -Participant Simulator -##################### - -This can be used for simulation testing purpose when there are no actual frameworks or a full deployment. -Participant simulator can edit the states of AutomationCompositionElements and Participants for verification of other clamp-acm components -for early testing. -All clamp-acm components should be setup, except participant frameworks (for example, no policy framework components -are needed) and participant simulator acts as respective participant framework, and state changes can be done with following REST APIs - -Participant Simulator API -========================= - -This API allows a Participant Simulator to be started and run for test purposes. - -:download:`Download Policy Participant Simulator API Swagger ` - -.. swaggerv2doc:: swagger/participant-sim.json diff --git a/docs/clamp/acm/design-impl/participants/participants.rst b/docs/clamp/acm/design-impl/participants/participants.rst index 9cf38bc7..67c966bd 100644 --- a/docs/clamp/acm/design-impl/participants/participants.rst +++ b/docs/clamp/acm/design-impl/participants/participants.rst @@ -36,4 +36,3 @@ The detailed implementation of the CLAMP Participant ecosystem is described on t http-participant k8s-participant policy-framework-participant - participant-simulator -- cgit 1.2.3-korg