From 8823b04bb54266a0a1bb1d693d7d5f729339d6ce Mon Sep 17 00:00:00 2001
From: ToineSiebelink <toine.siebelink@est.tech>
Date: Thu, 23 Jan 2025 11:30:14 +0000
Subject: RTD Updates for Policy Executor Integration
- Updated page describing Policy Executor feature
- Updated deployment page, added config parameters for Policy Executor
- Corrected release note: Jira for Policy Executor should not have been included before
- Clean up release note: removed redundant version mentioning
- Clean up tables on deployment page: removed redundant empty lines
Issue-ID: CPS-2443
Change-Id: I5750868b6c29e9de29cd08521b8efffff4f37eaf
Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
---
docs/policy-executor.rst | 16 ++++++++++++----
1 file changed, 12 insertions(+), 4 deletions(-)
(limited to 'docs/policy-executor.rst')
diff --git a/docs/policy-executor.rst b/docs/policy-executor.rst
index b934a579b1..712b4fcf38 100644
--- a/docs/policy-executor.rst
+++ b/docs/policy-executor.rst
@@ -1,11 +1,10 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. Copyright (C) 2024 Nordix Foundation
+.. Copyright (C) 2024-2025 Nordix Foundation
-.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
+.. DO NOT CHANGE THIS LABEL - EVEN THOUGH IT GIVES A WARNING
.. _policy_executor:
-
Policy Executor
###############
@@ -15,7 +14,16 @@ Policy Executor
Introduction
============
-Work In Progress: This feature is not yet completed and does not affect current NCMP functionality.
+The Policy Executor feature can be used to connect an external system to make decisions on CM write operation.
+When the feature is enabled, NCMP will first call the configured external system and depending on the response, return an error or continue.
+The details of the interface can be found in the ':ref:`policy_executor_consumed_apis`' section.
+
+This feature is available on 'legacy data interface' for operation on a single cm handle: "/v1/ch/{cm-handle}/data/ds/{datastore-name}" and only applies to "ncmp-datastore:passthrough-running".
+
+By default, the feature is not enabled. This is controlled by 'config.additional.ncmp.policy-executor.enabled' and other deployment parameters in the same group to enable it. See :ref:`additional-cps-ncmp-customizations`
+
+.. DO NOT CHANGE THIS LABEL - EVEN THOUGH IT GIVES A WARNING
+.. _policy_executor_consumed_apis:
Consumed APIs
-------------
--
cgit