This is an automated email from the ASF dual-hosted git repository.
pingsutw pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/submarine.git
The following commit(s) were added to refs/heads/master by this push:
new b8af344 SUBMARINE-1116. Write SDK CLI Docs
b8af344 is described below
commit b8af34429d807552b7930fbb028288a358e2b7a6
Author: atosystem <[email protected]>
AuthorDate: Tue Jan 25 13:51:35 2022 +0800
SUBMARINE-1116. Write SDK CLI Docs
### What is this PR for?
CLI Docs for using submarine CLI
The docs is put under userDocs
### What type of PR is it?
[Documentation]
### Todos
None
### What is the Jira issue?
https://issues.apache.org/jira/browse/SUBMARINE-1116
### How should this be tested?
### Screenshots (if appropriate)
### Questions:
* Do the license files need updating? No
* Are there breaking changes for older versions? No
* Does this need new documentation? No
Author: atosystem <[email protected]>
Signed-off-by: Kevin <[email protected]>
Closes #872 from atosystem/SUBMARINE-1116 and squashes the following
commits:
a303cc81 [atosystem] SUBMARINE-1116. fix conflicts
fe8b660e [atosystem] SUBMARINE-1116. add userDocs for CLI
8b36faad [atosystem] SUBMARINE-1133. implement notebook CLI
cc73adf4 [atosystem] SUBMARINE-1133. Add notebook client
---
.../docs/userDocs/submarine-sdk/submarine-cli.md | 149 +++++++++++++++++++++
website/sidebars.js | 1 +
2 files changed, 150 insertions(+)
diff --git a/website/docs/userDocs/submarine-sdk/submarine-cli.md
b/website/docs/userDocs/submarine-sdk/submarine-cli.md
new file mode 100644
index 0000000..ca17a67
--- /dev/null
+++ b/website/docs/userDocs/submarine-sdk/submarine-cli.md
@@ -0,0 +1,149 @@
+---
+title: Submarine CLI
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+Submarine CLI comes with pysubmarine python package. You can get CLI tools by
pip installing apache-submarine.
+
+## Config
+
+You can set your CLI settings by this command
+
+## Init
+
+```bash
+submarine config init
+```
+Return
+```bash
+Submarine CLI Config initialized
+```
+
+Restore CLI config to default (hostname=`localhost`,port=`32080`)
+
+## Show current config
+
+```bash
+submarine config list
+```
+For example : return
+```bash
+╭──────────────────── SubmarineCliConfig ─────────────────────╮
+│ { │
+│ "connection": { │
+│ "hostname": "localhost", │
+│ "port": 32080 │
+│ } │
+│ } │
+╰─────────────────────────────────────────────────────────────╯
+```
+
+## Set config
+
+```bash
+submarine config set <parameter_path> <value>
+```
+
+For example,
+Set connection port to 8080:
+```bash
+submarine config set connection.port 8080
+```
+
+## Get config
+
+```bash
+submarine config get <parameter_path>
+```
+
+For example,
+```bash
+submarine config get connection.port
+```
+Return
+```bash
+connection.port=8080
+```
+
+## Notebooks
+
+### List Notebooks
+
+```bash
+submarine list notebook
+```
+
+### Get Notebooks
+
+```bash
+submarine get notebook <notebook id>
+```
+
+> you can get notebook id by using `list command`
+
+### Delete Notebooks
+
+```bash
+submarine delete notebook <notebook id>
+```
+
+## Experiments
+
+### List Experiments
+
+```bash
+submarine list experiment
+```
+
+### Get Experiment
+
+```bash
+submarine get experiment <experiment id>
+```
+
+> you can get experiment id by using `list command`
+
+### Delete Experiment
+
+```bash
+submarine delete experiment <experiment id> [--wait/--no-wait]
+```
+* --wait/--no-wait: blocking or non blocking (default no wait)
+
+## Environments
+
+### List Environments
+
+```bash
+submarine list environment
+```
+
+### Get Environments
+
+```bash
+submarine get environment <environment name>
+```
+
+### Delete Environments
+
+```bash
+submarine delete experiment <environment name>
+```
diff --git a/website/sidebars.js b/website/sidebars.js
index 5855017..74cca2d 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -39,6 +39,7 @@ module.exports = {
{
"Submarine SDK": [
"userDocs/submarine-sdk/experiment-client",
+ "userDocs/submarine-sdk/submarine-cli",
"userDocs/submarine-sdk/tracking",
],
},
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
