diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/OOM_and_HEAT_based_deployment.rst | 2 | ||||
| -rw-r--r-- | docs/developer_guide.rst | 53 | ||||
| -rw-r--r-- | docs/images/portal-cli-app.png | bin | 70566 -> 177080 bytes | |||
| -rw-r--r-- | docs/images/portal-cli-arch.png | bin | 135975 -> 253879 bytes | |||
| -rw-r--r-- | docs/images/portal-cli-dowload.png | bin | 70566 -> 178221 bytes | |||
| -rw-r--r-- | docs/images/portal-cli-shell.png | bin | 60357 -> 76348 bytes | |||
| -rw-r--r-- | docs/images/portal-cli-web-con.png | bin | 101711 -> 121037 bytes | |||
| -rw-r--r-- | docs/release-notes.rst | 45 |
8 files changed, 61 insertions, 39 deletions
diff --git a/docs/OOM_and_HEAT_based_deployment.rst b/docs/OOM_and_HEAT_based_deployment.rst index 14197f8a..52e1aad4 100644 --- a/docs/OOM_and_HEAT_based_deployment.rst +++ b/docs/OOM_and_HEAT_based_deployment.rst @@ -13,7 +13,7 @@ HEAT based deployment ---------------------- As part of HEAT based deployment, ONAL CLI docker image is integrated into ONAP Portal and when portal_vm is -successfully installed, it will be available at http://portal_vm-ip:8080 +successfully installed, it will be available at http://portal.api.simpledemo.openecomp.org:8080 To troubleshoot any issues in CLI, please login to portal_vm and CLI docker runs with image onap/cli diff --git a/docs/developer_guide.rst b/docs/developer_guide.rst index e345e624..2e2278e5 100644 --- a/docs/developer_guide.rst +++ b/docs/developer_guide.rst @@ -87,6 +87,57 @@ Follow the steps below to implement new commands in ONAP using YAML: #. Use the command 'onap schema-validate' to validate the YAML before testing its functionality. -#. Run 'onap schema-refresh' command to take the new YAML file. We recommed validating the YAML before running this command. +#. Run 'onap schema-refresh' command to take the new YAML file. We recommended validating the YAML before running this command. #. To test this command, run the command 'onap CMD-NAME --help'. + +Sample YAML +~~~~~~~~~~~~ + +Find more details about YAML specification at :ref:`open_cli_schema_version_1_0`. + +Sample hello-world YAML :: + + open_cli_schema_version: 1.0 + + name: hello-world-http + + description: First cmd hello world using http running under lighttpd in cli at http://<cli-ip>:8080/version.json + + version: sample-1.0 + + service: + name: sample-service + version: 1.0.0 + auth: none + mode: direct + + parameters: + - name: name + description: name of the person + long_option: name + short_option: b + default_value: ${DEMO_NAME} + type: string + is_optional: false + + results: + direction: landscape + attributes: + - name: output + description: hello world output + type: string + scope: short + + http: + request: + uri: /version.json + method: GET + success_codes: + - 200 + - 201 + result_map: + output: Hello ${name}, You are running on $b{$.name} $b{$.version} + + sample_response: + body: {"name": "oclip", "version": "1.0"} diff --git a/docs/images/portal-cli-app.png b/docs/images/portal-cli-app.png Binary files differindex be833ea9..05ac8fbd 100644 --- a/docs/images/portal-cli-app.png +++ b/docs/images/portal-cli-app.png diff --git a/docs/images/portal-cli-arch.png b/docs/images/portal-cli-arch.png Binary files differindex d027e68f..4370183d 100644 --- a/docs/images/portal-cli-arch.png +++ b/docs/images/portal-cli-arch.png diff --git a/docs/images/portal-cli-dowload.png b/docs/images/portal-cli-dowload.png Binary files differindex be833ea9..f57cf204 100644 --- a/docs/images/portal-cli-dowload.png +++ b/docs/images/portal-cli-dowload.png diff --git a/docs/images/portal-cli-shell.png b/docs/images/portal-cli-shell.png Binary files differindex eb49e328..696046e3 100644 --- a/docs/images/portal-cli-shell.png +++ b/docs/images/portal-cli-shell.png diff --git a/docs/images/portal-cli-web-con.png b/docs/images/portal-cli-web-con.png Binary files differindex 97c54aaf..87af9874 100644 --- a/docs/images/portal-cli-web-con.png +++ b/docs/images/portal-cli-web-con.png diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 39389326..da4584b7 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -3,46 +3,17 @@ CLI Release Notes ================= -.. note:: - * This Release Notes must be updated each time the team decides to Release new artifacts. - * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes. - * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes. - * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release. - * This note must be removed after content has been added. - - -Version: x.y.z +Version: 1.1.0 -------------- - -:Release Date: yyyy-mm-dd - +:Release Date: 2017-11-16 (DRAFT) **New Features** -One or two sentences explaining the purpose of this Release. - -**Bug Fixes** - - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing. -**Known Issues** - - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences. - One sentences explaining what is the issue. - - Another sentence explaining the impact of the issue. - - And an optional sentence providing a workaround. - -**Security Issues** - You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_ - - -**Upgrade Notes** - -**Deprecation Notes** - -**Other** - -=========== - -End of Release Notes +* Release first version of Open Command Line Interface Platform (OCLIP), an CLI platform for implementing CLI using YAML file without coding + For more details, :ref:`OCLIP`. +* It provides Open Command Specification (OCS) 1.0 for defining the commands in YAML format, similar to Open API Specification (API). + For more details, :ref:`open_cli_schema_version_1_0`. +* All Onap commands are developed using OCLIP by authoring set of YAML files. + For more details, :ref:`cmd_help`. |
