aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>2017-10-25 09:41:34 +0530
committerKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>2017-11-21 18:07:48 +0530
commita4f668a3cc9f1b8e9ba39c523b9e7d174dd81237 (patch)
tree379f11baa8905e2ffbcf7ba7483b76a726100d03
parent25dcd38d5a35a82cd4c607082273675e12ad9481 (diff)
Update README.md and index.html
Issue-Id: CLI-66 Change-Id: I5f1b466563261ec54c2e86b18c12b611453a3794 Signed-off-by: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
-rw-r--r--README.md2
-rw-r--r--deployment/http/web/index.html27
2 files changed, 18 insertions, 11 deletions
diff --git a/README.md b/README.md
index 18ed70fd..cffd134e 100644
--- a/README.md
+++ b/README.md
@@ -28,6 +28,8 @@ And use the directive set to set the values for following parameters:
2. **host-username** - Service user name
3. **host-password** - Service password
+NOTE: This mode is available as Web command console when OCLIP is running from docker.
+
Select the product version
--------------------------
CLI framework is enhanced to handle multiple product versions at same
diff --git a/deployment/http/web/index.html b/deployment/http/web/index.html
index bf588334..ecf1d27b 100644
--- a/deployment/http/web/index.html
+++ b/deployment/http/web/index.html
@@ -1,32 +1,35 @@
<!DOCTYPE html><html><head><link rel="icon" href="./open-cli.png">
-<meta charset="utf-8"><title>Open CLI Platform (OCLIP)</title><style></style></head><body id="preview">
+<meta charset="utf-8"><title>Open CLI Platform (OCLIP)</title><style></style></head><body id="preview" style="background-color: black; color: #c3c3c3">
<script>
function redirectToConsole(){
window.location.href="http://"+ window.location.hostname + ":9090";
}
</script>
-
-<h1 id="open-command-line-interface-cli">Open Command-line interface Platform (OCLIP)</h1>
-<p>Provides unified commands to operate any cloud enabled software products from Linux/Web console. Configure the following environment variables, before using it:</p>
+<h1 id="open-command-line-interface-platform-oclip">Open Command-line interface Platform (OCLIP)</h1>
+<p>Provides unified commands to operate any cloud enabled software products from Linux/Web console.</p>
+<p>Set the following environment variable, before using OCLIP:</p>
+<p><strong>OPEN_CLI_HOME</strong> - Complete path of directory, where OCLIP is installed.</p>
+<h2 id="to-run-a-command">To Run a command</h2>
+<p>Configure the following environment variables:</p>
<ol style="list-style-type: decimal">
<li><strong>OPEN_CLI_HOST_URL</strong> - Catalog service URL or a service URL</li>
<li><strong>OPEN_CLI_HOST_USERNAME</strong> - Service user name</li>
<li><strong>OPEN_CLI_HOST_PASSWORD</strong> - Service password</li>
</ol>
-<h2 id="to-run-a-command">To Run a command</h2>
-<p>Type <strong>oclip <command></strong> from linux console.</p>
+<p>Run <strong>oclip <command></strong> from Linux console.</p>
<h2 id="to-run-in-interactive-mode">To Run in Interactive mode</h2>
-<p>Type <strong>oclip</strong> from linux console.</p>
+<p>Run <strong>oclip</strong> from Linux console.</p>
<p>And use the directive set to set the values for following parameters:</p>
<ol style="list-style-type: decimal">
<li><strong>host-url</strong> - Catalog service URL or a service URL</li>
<li><strong>host-username</strong> - Service user name</li>
<li><strong>host-password</strong> - Service password</li>
</ol>
-<h2 id="set-the-product-version">Set the product version</h2>
+<p>NOTE: This mode is available as Web command console when OCLIP is running from docker.</p>
+<h2 id="select-the-product-version">Select the product version</h2>
<p>CLI framework is enhanced to handle multiple product versions at same time. so to choose the product version, set evironment variable <strong>OPEN_CLI_PROUDCT_IN_USE</strong>.</p>
<p>NOTE: In interactive mode, product version can be selected using typing <strong>use <product-version></strong></p>
-<p>Run <em>oclip [-v|--version]</em> to see the CLI and available product version details</p>
+<p>Run <em>oclip [-v|--version]</em> to see the available product version details.</p>
<h2 id="set-the-parameter-values">Set the parameter values</h2>
<p>Use the directive 'set' for setting the values for parameters and 'unset' for un-seting the values.</p>
<h2 id="help">Help</h2>
@@ -37,6 +40,7 @@ function redirectToConsole(){
<li>OPEN_CLI_DEBUG - By default its false, otherwise Set to true</li>
<li>OPEN_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number</li>
</ol>
+
<h2>
<a id="More_details_42"></a>More details
</h2>
@@ -46,11 +50,12 @@ function redirectToConsole(){
<h2>
<a id="Download_42"></a>To download
</h2>
-<p style="color:red">Please download Open CLI Platform <a href="./open-cli.zip">here</a></p>
+<p>Please download Open CLI Platform <a href="./open-cli.zip">here</a></p>
+<h2>
<a id="Console_42"></a>Web Command console
</h2>
-<p style="color:blue">Click me <a onclick="redirectToConsole();">here</a></p>
+<p style="color:blue">Click <a onclick="redirectToConsole();">here</a></p>
<<<<<<< 476f5637ae4e816f7abf3536c5eeb156e0af6bed
<h2><a id="Download_42"></a>To download</h2>