This is an automated email from the ASF dual-hosted git repository.
liuxun 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 a7452aa SUBMARINE-785. Updates the environment docs
a7452aa is described below
commit a7452aab19bb77e30061afa3971b893b5d618d16
Author: KUAN-HSUN-LI <[email protected]>
AuthorDate: Mon Apr 5 16:40:40 2021 +0800
SUBMARINE-785. Updates the environment docs
### What is this PR for?
The environment API changes in #540 .
Updates the API in environment docs.
### What type of PR is it?
[Documentation]
### Todos
### What is the Jira issue?
https://issues.apache.org/jira/browse/SUBMARINE-785
### How should this be tested?
### Screenshots (if appropriate)
### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No
Author: KUAN-HSUN-LI <[email protected]>
Signed-off-by: Liu Xun <[email protected]>
Closes #549 from KUAN-HSUN-LI/SUBMARINE-785 and squashes the following
commits:
dc3af1a [KUAN-HSUN-LI] SUBMARINE-785. Updates the environment docs by
adding pip dependencies
---
website/docs/api/environment.md | 54 ++++++++++++++++++++++++++++-------------
1 file changed, 37 insertions(+), 17 deletions(-)
diff --git a/website/docs/api/environment.md b/website/docs/api/environment.md
index 44b73b3..7a5b00e 100644
--- a/website/docs/api/environment.md
+++ b/website/docs/api/environment.md
@@ -36,12 +36,15 @@ curl -X POST -H "Content-Type: application/json" -d '
"kernelSpec" : {
"name" : "team_default_python_3.7",
"channels" : ["defaults"],
- "dependencies" :
+ "condaDependencies" :
["_ipyw_jlab_nb_ext_conf=0.1.0=py37_0",
"alabaster=0.7.12=py37_0",
"anaconda=2020.02=py37_0",
"anaconda-client=1.7.2=py37_0",
- "anaconda-navigator=1.9.12=py37_0"]
+ "anaconda-navigator=1.9.12=py37_0"],
+ "pipDependencies" :
+ ["apache-submarine==0.5.0",
+ "pyarrow==0.17.0"]
}
}
' http://127.0.0.1:32080/api/v1/environment
@@ -60,12 +63,15 @@ curl -X POST -H "Content-Type: application/json" -d '
"kernelSpec" : {
"name" : "team_default_python_3.7",
"channels" : ["defaults"],
- "dependencies" :
+ "condaDependencies" :
["_ipyw_jlab_nb_ext_conf=0.1.0=py37_0",
"alabaster=0.7.12=py37_0",
"anaconda=2020.02=py37_0",
"anaconda-client=1.7.2=py37_0",
- "anaconda-navigator=1.9.12=py37_0"]
+ "anaconda-navigator=1.9.12=py37_0"],
+ "pipDependencies" :
+ ["apache-submarine==0.5.0",
+ "pyarrow==0.17.0"]
}
}
}
@@ -94,12 +100,15 @@ curl -X GET http://127.0.0.1:32080/api/v1/environment
"kernelSpec" : {
"name" : "team_default_python_3.7",
"channels" : ["defaults"],
- "dependencies" :
+ "condaDependencies" :
["_ipyw_jlab_nb_ext_conf=0.1.0=py37_0",
"alabaster=0.7.12=py37_0",
"anaconda=2020.02=py37_0",
"anaconda-client=1.7.2=py37_0",
- "anaconda-navigator=1.9.12=py37_0"]
+ "anaconda-navigator=1.9.12=py37_0"],
+ "pipDependencies" :
+ ["apache-submarine==0.5.0",
+ "pyarrow==0.17.0"]
}
}
},
@@ -111,8 +120,10 @@ curl -X GET http://127.0.0.1:32080/api/v1/environment
"kernelSpec" : {
"name" : "team_miniconda_python_3.7",
"channels" : ["defaults"],
- "dependencies" :
- ["_ipyw_jlab_nb_ext_conf=0.1.0=py37_0"]
+ "condaDependencies" :
+ ["_ipyw_jlab_nb_ext_conf=0.1.0=py37_0"],
+ "pipDependencies" :
+ [],
}
}
}
@@ -141,12 +152,15 @@ curl -X GET
http://127.0.0.1:32080/api/v1/environment/my-submarine-env
"kernelSpec" : {
"name" : "team_default_python_3.7",
"channels" : ["defaults"],
- "dependencies" :
+ "condaDependencies" :
["_ipyw_jlab_nb_ext_conf=0.1.0=py37_0",
"alabaster=0.7.12=py37_0",
"anaconda=2020.02=py37_0",
"anaconda-client=1.7.2=py37_0",
- "anaconda-navigator=1.9.12=py37_0"]
+ "anaconda-navigator=1.9.12=py37_0"],
+ "pipDependencies" :
+ ["apache-submarine==0.5.0",
+ "pyarrow==0.17.0"]
}
}
}
@@ -165,9 +179,11 @@ curl -X PATCH -H "Content-Type: application/json" -d '
"kernelSpec" : {
"name" : "team_default_python_3.7_updated",
"channels" : ["defaults"],
- "dependencies" :
+ "condaDependencies" :
["_ipyw_jlab_nb_ext_conf=0.1.0=py37_0",
- "alabaster=0.7.12=py37_0"]
+ "alabaster=0.7.12=py37_0"],
+ "pipDependencies" :
+ []
}
}
' http://127.0.0.1:32080/api/v1/environment/my-submarine-env
@@ -187,15 +203,17 @@ curl -X PATCH -H "Content-Type: application/json" -d '
"kernelSpec" : {
"name" : "team_default_python_3.7_updated",
"channels" : ["defaults"],
- "dependencies" :
+ "condaDependencies" :
["_ipyw_jlab_nb_ext_conf=0.1.0=py37_0",
- "alabaster=0.7.12=py37_0"]
+ "alabaster=0.7.12=py37_0"],
+ "pipDependencies" :
+ []
}
}
}
}
```
-> dockerImage, "name" (of kernelSpec), "channels", "dependencies" etc can be
updated using this API.
+> dockerImage, "name" (of kernelSpec), "channels", "condaDependencies",
"pipDependencies" etc can be updated using this API.
"name" of EnvironmentSpec is not supported.
### Delete environment
@@ -219,9 +237,11 @@ curl -X DELETE
http://127.0.0.1:32080/api/v1/environment/my-submarine-env
"kernelSpec" : {
"name" : "team_default_python_3.7_updated",
"channels" : ["defaults"],
- "dependencies" :
+ "condaDependencies" :
["_ipyw_jlab_nb_ext_conf=0.1.0=py37_0",
- "alabaster=0.7.12=py37_0"]
+ "alabaster=0.7.12=py37_0"],
+ "pipDependencies" :
+ []
}
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
