diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst index 5eaed7d..fa04d72 100644 --- a/doc/source/cli/index.rst +++ b/doc/source/cli/index.rst @@ -24,3 +24,7 @@ variables:: Once you've configured your authentication parameters, you can run ``solum help`` to see a complete listing of available commands. + +.. toctree:: + + solum diff --git a/doc/source/cli/solum.rst b/doc/source/cli/solum.rst new file mode 100644 index 0000000..ee8f159 --- /dev/null +++ b/doc/source/cli/solum.rst @@ -0,0 +1,108 @@ +============================================================================= +Software Development Lifecycle Automation service (solum) command-line client +============================================================================= + +The solum client is the command-line interface (CLI) for +the Software Development Lifecycle Automation service (solum) API and its +extensions. + +This chapter documents :command:`solum` version ``2.4.0``. + +.. _solum_command_usage: + +solum usage +~~~~~~~~~~~ + +``solum help`` + Show this help message. + +``solum info`` + Show Solum endpoint and API release version. + +``solum --version`` + Show current Solum client version and exit. + +``solum lp help`` + Show a help message specific to languagepack commands. + +``solum lp create `` + Create a new language pack from a git repo. + +``solum lp list`` + Print and index of all available language packs. + +``solum lp show `` + Print the details of a language pack. + +``solum lp delete `` + Destroy a language pack. + +``solum lp logs `` + Show logs for a language pack. + +``solum app help`` + Show a help message specific to app commands. + +``solum app list`` + Print an index of all deployed applications. + +``solum app show `` + Print detailed information about one application. + +``solum app create`` + Register a new application with Solum. + + .. code-block:: console + + solum app create [--app-file ] [--git-url ] + [--lp ] + [--param-file ] + [--setup-trigger] + [--trigger-workflow ] + =(unittest | build | unittest+build) + + Without the ``--trigger-workflow`` flag, the workflow ``unittest+build+deploy`` + is triggered (this is the default workflow). + +``solum app deploy `` + Deploy an application, building any applicable artifacts first. + du-id is optional flag. It can be used to pass in ID of a previously + created deployment unit. If passed, this command will deploy the du + referenced by the provided ``du-id`` instead of building one first. + +``solum app delete `` + Delete an application and all related artifacts. + +``solum app logs [--wf-id ]`` + Show the logs of an application for all the workflows. + ``wf-id`` is optional flag which can be used to pass in ID of one of + the existing workflows. If provided, the logs only for that workflow + are displayed. + +``solum app scale `` + +``solum workflow list `` + List all application workflows. + +``solum workflow show `` + Print the details of a workflow. + +``solum workflow logs `` + List all the logs of a given workflow. + +**SOON TO BE DEPRECATED:** + +``solum oldapp create`` + Register a new application with Solum. + + .. code-block:: console + + solum oldapp create [--plan-file ] [--git-url ] + [--lp ] [--run-cmd ] + [--unittest-cmd ] + [--name ] [--port ] + [--param-file ] + [--desc ] + [--setup-trigger] + [--private-repo] + [--trigger-workflow ] diff --git a/doc/source/index.rst b/doc/source/index.rst index 4df2551..68364b6 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,8 +3,8 @@ python-solumclient documentation ================================ This is a client for the OpenStack Application Lifecycle Management API. -There's a Python API (the :mod:`solumclient` module) and a command-line -script (installed as :program:`solum`). +There's a Python API (the :mod:`solumclient` module) and a +:doc:`command-line script ` (installed as :program:`solum`). .. toctree:: :maxdepth: 2