| (window.webpackJsonp=window.webpackJsonp||[]).push([[38],{105:function(e,n,t){"use strict";t.r(n),t.d(n,"frontMatter",(function(){return o})),t.d(n,"metadata",(function(){return c})),t.d(n,"toc",(function(){return b})),t.d(n,"default",(function(){return s}));var r=t(3),a=t(7),i=(t(0),t(193)),o={title:"Submarine CLI"},c={unversionedId:"userDocs/submarine-sdk/submarine-cli",id:"userDocs/submarine-sdk/submarine-cli",isDocsHomePage:!1,title:"Submarine CLI",description:"\x3c!--",source:"@site/docs/userDocs/submarine-sdk/submarine-cli.md",slug:"/userDocs/submarine-sdk/submarine-cli",permalink:"/docs/next/userDocs/submarine-sdk/submarine-cli",editUrl:"https://github.com/apache/submarine/edit/master/website/docs/userDocs/submarine-sdk/submarine-cli.md",version:"current",sidebar:"docs",previous:{title:"Experiment Client",permalink:"/docs/next/userDocs/submarine-sdk/experiment-client"},next:{title:"Tracking",permalink:"/docs/next/userDocs/submarine-sdk/tracking"}},b=[{value:"Config",id:"config",children:[]},{value:"Init",id:"init",children:[]},{value:"Show current config",id:"show-current-config",children:[]},{value:"Set config",id:"set-config",children:[]},{value:"Get config",id:"get-config",children:[]},{value:"Notebooks",id:"notebooks",children:[{value:"List Notebooks",id:"list-notebooks",children:[]},{value:"Get Notebooks",id:"get-notebooks",children:[]},{value:"Delete Notebooks",id:"delete-notebooks",children:[]}]},{value:"Experiments",id:"experiments",children:[{value:"List Experiments",id:"list-experiments",children:[]},{value:"Get Experiment",id:"get-experiment",children:[]},{value:"Delete Experiment",id:"delete-experiment",children:[]}]},{value:"Environments",id:"environments",children:[{value:"List Environments",id:"list-environments",children:[]},{value:"Get Environments",id:"get-environments",children:[]},{value:"Delete Environments",id:"delete-environments",children:[]}]}],l={toc:b};function s(e){var n=e.components,t=Object(a.a)(e,["components"]);return Object(i.b)("wrapper",Object(r.a)({},l,t,{components:n,mdxType:"MDXLayout"}),Object(i.b)("p",null,"Submarine CLI comes with pysubmarine python package. You can get CLI tools by pip installing apache-submarine."),Object(i.b)("h2",{id:"config"},"Config"),Object(i.b)("p",null,"You can set your CLI settings by this command"),Object(i.b)("h2",{id:"init"},"Init"),Object(i.b)("pre",null,Object(i.b)("code",{parentName:"pre",className:"language-bash"},"submarine config init \n")),Object(i.b)("p",null,"Return"),Object(i.b)("pre",null,Object(i.b)("code",{parentName:"pre",className:"language-bash"},"Submarine CLI Config initialized\n")),Object(i.b)("p",null,"Restore CLI config to default (hostname=",Object(i.b)("inlineCode",{parentName:"p"},"localhost"),",port=",Object(i.b)("inlineCode",{parentName:"p"},"32080"),")"),Object(i.b)("h2",{id:"show-current-config"},"Show current config"),Object(i.b)("pre",null,Object(i.b)("code",{parentName:"pre",className:"language-bash"},"submarine config list \n")),Object(i.b)("p",null,"For example : return"),Object(i.b)("pre",null,Object(i.b)("code",{parentName:"pre",className:"language-bash"},'\u256d\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500 SubmarineCliConfig \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 { \u2502\n\u2502 "connection": { \u2502\n\u2502 "hostname": "localhost", \u2502\n\u2502 "port": 32080 \u2502\n\u2502 } \u2502\n\u2502 } \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n')),Object(i.b)("h2",{id:"set-config"},"Set config"),Object(i.b)("pre",null,Object(i.b)("code",{parentName:"pre",className:"language-bash"},"submarine config set <parameter_path> <value> \n")),Object(i.b)("p",null,"For example,\nSet connection port to 8080:"),Object(i.b)("pre",null,Object(i.b)("code",{parentName:"pre",className:"language-bash"},"submarine config set connection.port 8080\n")),Object(i.b)("h2",{id:"get-config"},"Get config"),Object(i.b)("pre",null,Object(i.b)("code",{parentName:"pre",className:"language-bash"},"submarine config get <parameter_path>\n")),Object(i.b)("p",null,"For example,"),Object(i.b)("pre",null,Object(i.b)("code",{parentName:"pre",className:"language-bash"},"submarine config get connection.port\n")),Object(i.b)("p",null,"Return"),Object(i.b)("pre",null,Object(i.b)("code",{parentName:"pre",className:"language-bash"},"connection.port=8080\n")),Object(i.b)("h2",{id:"notebooks"},"Notebooks"),Object(i.b)("h3",{id:"list-notebooks"},"List Notebooks"),Object(i.b)("pre",null,Object(i.b)("code",{parentName:"pre",className:"language-bash"},"submarine list notebook \n")),Object(i.b)("h3",{id:"get-notebooks"},"Get Notebooks"),Object(i.b)("pre",null,Object(i.b)("code",{parentName:"pre",className:"language-bash"},"submarine get notebook <notebook id>\n")),Object(i.b)("blockquote",null,Object(i.b)("p",{parentName:"blockquote"},"you can get notebook id by using ",Object(i.b)("inlineCode",{parentName:"p"},"list command"))),Object(i.b)("h3",{id:"delete-notebooks"},"Delete Notebooks"),Object(i.b)("pre",null,Object(i.b)("code",{parentName:"pre",className:"language-bash"},"submarine delete notebook <notebook id>\n")),Object(i.b)("h2",{id:"experiments"},"Experiments"),Object(i.b)("h3",{id:"list-experiments"},"List Experiments"),Object(i.b)("pre",null,Object(i.b)("code",{parentName:"pre",className:"language-bash"},"submarine list experiment \n")),Object(i.b)("h3",{id:"get-experiment"},"Get Experiment"),Object(i.b)("pre",null,Object(i.b)("code",{parentName:"pre",className:"language-bash"},"submarine get experiment <experiment id>\n")),Object(i.b)("blockquote",null,Object(i.b)("p",{parentName:"blockquote"},"you can get experiment id by using ",Object(i.b)("inlineCode",{parentName:"p"},"list command"))),Object(i.b)("h3",{id:"delete-experiment"},"Delete Experiment"),Object(i.b)("pre",null,Object(i.b)("code",{parentName:"pre",className:"language-bash"},"submarine delete experiment <experiment id> [--wait/--no-wait]\n")),Object(i.b)("ul",null,Object(i.b)("li",{parentName:"ul"},"--wait/--no-wait: blocking or non blocking (default no wait)")),Object(i.b)("h2",{id:"environments"},"Environments"),Object(i.b)("h3",{id:"list-environments"},"List Environments"),Object(i.b)("pre",null,Object(i.b)("code",{parentName:"pre",className:"language-bash"},"submarine list environment \n")),Object(i.b)("h3",{id:"get-environments"},"Get Environments"),Object(i.b)("pre",null,Object(i.b)("code",{parentName:"pre",className:"language-bash"},"submarine get environment <environment name>\n")),Object(i.b)("h3",{id:"delete-environments"},"Delete Environments"),Object(i.b)("pre",null,Object(i.b)("code",{parentName:"pre",className:"language-bash"},"submarine delete experiment <environment name>\n")))}s.isMDXComponent=!0},193:function(e,n,t){"use strict";t.d(n,"a",(function(){return u})),t.d(n,"b",(function(){return d}));var r=t(0),a=t.n(r);function i(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function o(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function c(e){for(var n=1;n<arguments.length;n++){var t=null!=arguments[n]?arguments[n]:{};n%2?o(Object(t),!0).forEach((function(n){i(e,n,t[n])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):o(Object(t)).forEach((function(n){Object.defineProperty(e,n,Object.getOwnPropertyDescriptor(t,n))}))}return e}function b(e,n){if(null==e)return{};var t,r,a=function(e,n){if(null==e)return{};var t,r,a={},i=Object.keys(e);for(r=0;r<i.length;r++)t=i[r],n.indexOf(t)>=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)t=i[r],n.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=a.a.createContext({}),s=function(e){var n=a.a.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):c(c({},n),e)),t},u=function(e){var n=s(e.components);return a.a.createElement(l.Provider,{value:n},e.children)},p={inlineCode:"code",wrapper:function(e){var n=e.children;return a.a.createElement(a.a.Fragment,{},n)}},m=a.a.forwardRef((function(e,n){var t=e.components,r=e.mdxType,i=e.originalType,o=e.parentName,l=b(e,["components","mdxType","originalType","parentName"]),u=s(t),m=r,d=u["".concat(o,".").concat(m)]||u[m]||p[m]||i;return t?a.a.createElement(d,c(c({ref:n},l),{},{components:t})):a.a.createElement(d,c({ref:n},l))}));function d(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var i=t.length,o=new Array(i);o[0]=m;var c={};for(var b in n)hasOwnProperty.call(n,b)&&(c[b]=n[b]);c.originalType=e,c.mdxType="string"==typeof e?e:r,o[1]=c;for(var l=2;l<i;l++)o[l]=t[l];return a.a.createElement.apply(null,o)}return a.a.createElement.apply(null,t)}m.displayName="MDXCreateElement"}}]); |