summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/pm-subscription-handler/administration.rst
diff options
context:
space:
mode:
authorefiacor <fiachra.corcoran@est.tech>2021-02-09 16:02:02 +0000
committerefiacor <fiachra.corcoran@est.tech>2021-02-09 16:05:03 +0000
commit6132c206cc4a64df2248647326d569393605cf90 (patch)
tree53227fbacf486f1672361f0b761342dd951d5352 /docs/sections/services/pm-subscription-handler/administration.rst
parentfbcf2ebf0d02272c65277e1bd582b5ed132e6f77 (diff)
[PMSH] Add doc updates for update sub use case
Signed-off-by: efiacor <fiachra.corcoran@est.tech> Change-Id: Ibdaf35b844e0dff1fc035173888ab06dcf4e2dd4 Issue-ID: DCAEGEN2-2152
Diffstat (limited to 'docs/sections/services/pm-subscription-handler/administration.rst')
-rw-r--r--docs/sections/services/pm-subscription-handler/administration.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/sections/services/pm-subscription-handler/administration.rst b/docs/sections/services/pm-subscription-handler/administration.rst
new file mode 100644
index 00000000..0cac381e
--- /dev/null
+++ b/docs/sections/services/pm-subscription-handler/administration.rst
@@ -0,0 +1,25 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Administration
+==============
+PMSH has a healthcheck functionality. One can also check the liveliness of the service.
+
+Updating a Subscription
+"""""""""""""""""""""""
+Current functionality does not support updating an active (UNLOCKED) subscription at runtime.
+To update a subscription:
+
+- transition the administrativeState from UNLOCKED to LOCKED
+
+This will attempt to remove any active/running subscriptions from the relevant NFs and set the administrativeState to "LOCKING".
+Monitor the administrativeState via the /subscriptions api endpoint until it has fully LOCKED.
+
+- update the relevant fields of the subscription object
+
+See :ref:`Subscription configuration<Subscription>` for details.
+All subscription fields except the subscriptionName can be updated.
+
+- transition the administrativeState from LOCKED to UNLOCKED
+
+This will attempt to create the updated subscription on the relevant NFs. \ No newline at end of file