summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorRuoyu Ying <ruoyu.ying@intel.com>2019-07-30 00:14:08 +0800
committerRuoyu Ying <ruoyu.ying@intel.com>2019-07-30 18:12:53 +0800
commitd53b78f51ed1a37f13163fe0ffd77ebd1c7f6f6f (patch)
treea4d655e8051667c31006dac8eca36ea46c51bd8a /docs
parentca899427a2617dba93da71a00bcacc61b06f4d5a (diff)
Add trouble shooting log
Issue-ID: CLI-165 Signed-off-by: Ruoyu Ying <ruoyu.ying@intel.com> Change-Id: I797f7541e05241469f5e2bf049a0a9ea10cdae7e Signed-off-by: Ruoyu Ying <ruoyu.ying@intel.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst1
-rw-r--r--docs/trouble_shooting_guide.rst33
2 files changed, 34 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
index bb578648..c0385016 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -47,6 +47,7 @@ Following guidelines provides detailed information about CLI.
OOM_and_HEAT_based_deployment.rst
logging.rst
release-notes.rst
+ trouble_shooting_guide.rst
==========================
diff --git a/docs/trouble_shooting_guide.rst b/docs/trouble_shooting_guide.rst
new file mode 100644
index 00000000..c3a0cebc
--- /dev/null
+++ b/docs/trouble_shooting_guide.rst
@@ -0,0 +1,33 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright © Intel Corporation 2019
+
+.. _cli_trouble_shooting_guide:
+
+CLI Trouble Shooting Guide
+==========================
+
+This part provides the trouble shooting guide for ONAP CLI. It aims to provide guidance on the known issues you may encounter.
+
+Details
+--------
+1. IllegalArgumentException
+
+ * Problem: Get an IllegalArgumentException after executing the command.
+ * Cause: The input inside the command contains a special character(e.g. '!', '$','\\') and the console mandates to escape this kind of chars
+ * Sample Exception:
+ ::
+
+ oclip:open-cli>policy-type-list-all -m http://10.12.7.6:30240 -u "healthcheck" -p "zb!XztG34"
+ Exception in thread "main" java.lang.IllegalArgumentException: !XztG34": event not found
+ at jline.console.ConsoleReader.expandEvents(ConsoleReader.java:507)
+ at jline.console.ConsoleReader.finishBuffer(ConsoleReader.java:379)
+ at jline.console.ConsoleReader.readLine(ConsoleReader.java:1327)
+ at jline.console.ConsoleReader.readLine(ConsoleReader.java:1117)
+ at jline.console.ConsoleReader.readLine(ConsoleReader.java:1105)
+ at org.onap.cli.main.OnapCli.handleInteractive(OnapCli.java:369)
+ at org.onap.cli.main.OnapCli.handle(OnapCli.java:645)
+ at org.onap.cli.main.OnapCli.main(OnapCli.java:751)
+
+ * Solution: User need to escape the special character while giving input(e.g. using single/double quote or backslash)
+