diff options
-rw-r--r-- | deployment/docker/src/main/docker/Dockerfile | 2 | ||||
-rw-r--r-- | deployment/docker/src/main/docker/docker-compose.yaml | 2 | ||||
-rw-r--r-- | deployment/zip/installer/install.sh | 3 | ||||
-rw-r--r-- | deployment/zip/src/main/release/conf/log4j.properties | 2 | ||||
-rw-r--r-- | deployment/zip/src/main/release/conf/open-cli.properties | 2 | ||||
-rw-r--r-- | docs/architecture.rst | 13 | ||||
-rw-r--r-- | docs/cmd_help.rst | 8 | ||||
-rw-r--r-- | docs/images/portal-cli-app-1.png | bin | 177080 -> 0 bytes | |||
-rw-r--r-- | docs/images/portal-cli-dowload-1.png | bin | 178221 -> 0 bytes | |||
-rw-r--r-- | docs/images/portal-cli-shell-1.png | bin | 76348 -> 0 bytes | |||
-rw-r--r-- | docs/images/portal-cli-web-con-1.png | bin | 121037 -> 0 bytes | |||
-rw-r--r-- | framework/src/main/resources/open-cli-schema/schema-refresh.yaml | 2 | ||||
-rw-r--r-- | framework/src/main/resources/open-cli-schema/schema-validate.yaml | 2 |
13 files changed, 22 insertions, 14 deletions
diff --git a/deployment/docker/src/main/docker/Dockerfile b/deployment/docker/src/main/docker/Dockerfile index 074bb164..d6bd9389 100644 --- a/deployment/docker/src/main/docker/Dockerfile +++ b/deployment/docker/src/main/docker/Dockerfile @@ -29,8 +29,6 @@ RUN apt-get update && apt-get install -y lighttpd git curl pandoc vim && \ cp $OPEN_CLI_HOME/http/web/*.* /var/www-data/servers/open-cli/ && \ cp $OPEN_CLI_HOME/http/lighttpd/10-proxy.conf /etc/lighttpd/conf-enabled/ && \ cp $OPEN_CLI_HOME/installer/cli-*.zip /var/www-data/servers/open-cli/oclip.zip - - EXPOSE 80 EXPOSE 8080 diff --git a/deployment/docker/src/main/docker/docker-compose.yaml b/deployment/docker/src/main/docker/docker-compose.yaml index 9ca3cf49..944c2d71 100644 --- a/deployment/docker/src/main/docker/docker-compose.yaml +++ b/deployment/docker/src/main/docker/docker-compose.yaml @@ -30,7 +30,7 @@ services: image: onap/cli environment: OPEN_CLI_MODE: 'daemon' - OPEN_CLI_DEBUG: "true" + OPEN_CLI_DEBUG: "false" ports: - 30260:80 - 30261:8080 diff --git a/deployment/zip/installer/install.sh b/deployment/zip/installer/install.sh index ae702271..4503c371 100644 --- a/deployment/zip/installer/install.sh +++ b/deployment/zip/installer/install.sh @@ -28,8 +28,11 @@ chmod +x ./bin/oclip.sh #Make oclip available in path ln -sf ./bin/oclip.sh /usr/bin/oclip +ln -sf ./bin/oclip.sh /usr/bin/onap #Print the version oclip -v +onap -v + cd -
\ No newline at end of file diff --git a/deployment/zip/src/main/release/conf/log4j.properties b/deployment/zip/src/main/release/conf/log4j.properties index f117ef6e..a0324a9b 100644 --- a/deployment/zip/src/main/release/conf/log4j.properties +++ b/deployment/zip/src/main/release/conf/log4j.properties @@ -1,4 +1,4 @@ -log4j.rootLogger=ERROR, file +log4j.rootLogger=INFO, file # Redirect log messages to a log file, support file rolling. log4j.appender.file=org.apache.log4j.RollingFileAppender diff --git a/deployment/zip/src/main/release/conf/open-cli.properties b/deployment/zip/src/main/release/conf/open-cli.properties index 9b5bceeb..2d68edf8 100644 --- a/deployment/zip/src/main/release/conf/open-cli.properties +++ b/deployment/zip/src/main/release/conf/open-cli.properties @@ -1,5 +1,5 @@ cli.product_name=open-cli -cli.version=1.0 +cli.version=2.0.0 cli.discover_always=false diff --git a/docs/architecture.rst b/docs/architecture.rst index 839fe6bb..771836d2 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -11,15 +11,20 @@ Following diagram shows the high-level architecture of OCLIP. .. image:: images/portal-cli-arch.png -* **Command Registrar** : Registrar keeps track of the commands registered in OCLIP and when user invokes the command, it identify - the corresponding command route the request to that command plug-in. +* **Command Registrar** : Registrar keeps track of the commands registered in OCLIP and when user invokes the command, +it identify the corresponding command and helps to invoke the corresponding command plug-in. -* **Command Discoverer** : Discoverer discovers the commands both in plug-in format and YAML and automatically register them into Registrar. +* **Command Discoverer** : Discoverer discovers the commands both in plug-in format and YAML and automatically register +them into Registrar. -* **Command Plug-ing** : Implement the command as plug-in. More details :ref:`cli_developer_guide` +* **Command Plug-in** : Implement the command as plug-in. More details :ref:`cli_developer_guide` * **HTTP Command** : Plug-in for implementing all Rest based command as YAML without any coding. * **Command Shell** : Provides the interactive command line console from Linux * **Web Command Console** : Provides the interactive command line console from web-browser + +* **Cache** : Provides an persistent storage for discoverer to store the meta-data about the discovered Commands. + +* **open cli schemas** : Set of command YAML provides the CLI definitions. diff --git a/docs/cmd_help.rst b/docs/cmd_help.rst index d5f69024..eee3f4af 100644 --- a/docs/cmd_help.rst +++ b/docs/cmd_help.rst @@ -10,7 +10,9 @@ .. _cli_cmd_help: open-cli -========================== + +Open CLI is the OCLIP platform facilitates creating the commands from YAMLs. Currently it supports commands +for refreshing the existing command YAMLs and validating the YAMLs. [1] schema-refresh ----------------------------------------------- @@ -18,7 +20,7 @@ open-cli usage: oclip schema-refresh -Oclip command to refresh schemas stored in open-cli-schema folders. +OCLIP command to refresh schemas stored in open-cli-schema folders. Product: open-cli Service: schema @@ -66,7 +68,7 @@ Error:: usage: oclip schema-validate -Oclip command to validate schema +OCLIP command to validate schema Product: open-cli Service: schema diff --git a/docs/images/portal-cli-app-1.png b/docs/images/portal-cli-app-1.png Binary files differdeleted file mode 100644 index 05ac8fbd..00000000 --- a/docs/images/portal-cli-app-1.png +++ /dev/null diff --git a/docs/images/portal-cli-dowload-1.png b/docs/images/portal-cli-dowload-1.png Binary files differdeleted file mode 100644 index f57cf204..00000000 --- a/docs/images/portal-cli-dowload-1.png +++ /dev/null diff --git a/docs/images/portal-cli-shell-1.png b/docs/images/portal-cli-shell-1.png Binary files differdeleted file mode 100644 index 696046e3..00000000 --- a/docs/images/portal-cli-shell-1.png +++ /dev/null diff --git a/docs/images/portal-cli-web-con-1.png b/docs/images/portal-cli-web-con-1.png Binary files differdeleted file mode 100644 index 87af9874..00000000 --- a/docs/images/portal-cli-web-con-1.png +++ /dev/null diff --git a/framework/src/main/resources/open-cli-schema/schema-refresh.yaml b/framework/src/main/resources/open-cli-schema/schema-refresh.yaml index 2a80cf7c..2e32b1be 100644 --- a/framework/src/main/resources/open-cli-schema/schema-refresh.yaml +++ b/framework/src/main/resources/open-cli-schema/schema-refresh.yaml @@ -1,6 +1,6 @@ open_cli_schema_version: 1.0 name: schema-refresh -description: Oclip command to refresh schemas stored in open-cli-schema folders. +description: OCLIP command to refresh schemas stored in open-cli-schema folders. info: product: open-cli diff --git a/framework/src/main/resources/open-cli-schema/schema-validate.yaml b/framework/src/main/resources/open-cli-schema/schema-validate.yaml index 98ac8c25..3453d2a9 100644 --- a/framework/src/main/resources/open-cli-schema/schema-validate.yaml +++ b/framework/src/main/resources/open-cli-schema/schema-validate.yaml @@ -1,6 +1,6 @@ open_cli_schema_version: 1.0 name: schema-validate -description: Oclip command to validate schema +description: OCLIP command to validate schema info: product: open-cli |