From 40dddac068135f4f57d8ced23a3f7440ccde99b7 Mon Sep 17 00:00:00 2001
From: Mike Ball <mikedball@gmail.com>
Date: Thu, 17 Feb 2022 16:52:05 -0500
Subject: [PATCH] add 'read only' mode README documentation

Signed-off-by: Mike Ball <mikedball@gmail.com>
---
 plugins/splunk-on-call/README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/plugins/splunk-on-call/README.md b/plugins/splunk-on-call/README.md
index 0200cacc50..967e1e0940 100644
--- a/plugins/splunk-on-call/README.md
+++ b/plugins/splunk-on-call/README.md
@@ -74,6 +74,28 @@ proxy:
 
 In addition, to make certain API calls (trigger-resolve-acknowledge an incident) you need to add the `PATCH` method to the backend `cors` methods list: `[GET, POST, PUT, DELETE, PATCH]`.
 
+**WARNING**: In current implementation, the Splunk OnCall plugin requires the `/splunk-on-call` proxy endpoint be exposed by the Backstage backend as an unprotected endpoint, in effect enabling Splunk OnCall API access using the configured `SPLUNK_ON_CALL_API_KEY` for any user or process with access to the `/splunk-on-call` Backstage backend endpoint. See below for further configuration options enabling protection of this endpoint.
+
+### Read Only mode
+
+The Splunk OnCall plugin also supports a "read only" mode if you wish to suppress the rendering of UI controls to trigger-resolve-acknowledge incidents.
+
+```yaml
+# enable readOnly mode
+splunkOnCall:
+  readOnly: true
+
+proxy:
+  # ...
+  '/splunk-on-call':
+    target: https://api.victorops.com/api-public
+    headers:
+      X-VO-Api-Id: ${SPLUNK_ON_CALL_API_ID}
+      X-VO-Api-Key: ${SPLUNK_ON_CALL_API_KEY}
+    # prohibit non-GET requests from the /splunk-on-call proxy
+    allowedMethods: ['GET']
+```
+
 ### Adding your team name to the entity annotation
 
 The information displayed for each entity is based on either an associated team name or an associated routing key.