Skip to content

Commit b2b07f2

Browse files
RonShvarzRonShvarz
committed
Better user expecience with process ending,
Better outputs, Added documentation for the new features in README.MD
1 parent d683806 commit b2b07f2

File tree

3 files changed

+315
-5
lines changed

3 files changed

+315
-5
lines changed

‎README.md

+310-2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Options:
2222
|--rejectUnauthorized|set to false to ignore certificate signing errors. Useful for self signed TLS certificate|boolean|||
2323
|--endpoint|url of hkube api endpoint|string|||
2424
|--pathPrefix|path prefix url of hkube api endpoint |string||/hkube/api-server/|
25+
|--dataSourcePathPrefix|path prefix url of hkube api endpoint |string||/hkube/datasources-service/|
2526
|--verbose|verbose logging|boolean|||
2627
|-j, --json|output json to stdout|boolean|||
2728
|--help|Show help|boolean|||
@@ -124,6 +125,282 @@ Options:
124125
|-f, --file|file path/name for extra data|string|||
125126
|--noWait|if true, does not wait for the execution to finish |boolean||false|
126127
|--noResult|if true, does not show the result of the execution |boolean||false|
128+
### export
129+
---
130+
```shell
131+
$ hkubectl export
132+
```
133+
Export all pipelines to source environment
134+
#### all
135+
136+
```shell
137+
$ hkubectl export all < outputDirectory >
138+
```
139+
Get and save all algorithms/pipelines as JSON/YAML files in a chosen directory
140+
Options:
141+
142+
143+
|option|description|type|required|default|
144+
|---|---|---|---|---|
145+
|outputDirectory|Path of your directory|string|true||
146+
|-f, --format|Output format (e.g. json, yaml) |string||json|
147+
#### algorithms
148+
149+
```shell
150+
$ hkubectl export algorithms < outputDirectory >
151+
```
152+
get and save all algorithms as JSON/YAML files in a chosen directory
153+
Options:
154+
155+
156+
|option|description|type|required|default|
157+
|---|---|---|---|---|
158+
|outputDirectory|path/of/your/directory|string|true||
159+
|-f, --format|Output format (e.g., json, yaml) |string||json|
160+
#### pipelines
161+
162+
```shell
163+
$ hkubectl export pipelines < outputDirectory >
164+
```
165+
get and save all pipelines as JSON/YAML files in a chosen directory
166+
Options:
167+
168+
169+
|option|description|type|required|default|
170+
|---|---|---|---|---|
171+
|outputDirectory|path/of/your/directory|string|true||
172+
|-f, --format|Output format (e.g. json, yaml) |string||json|
173+
### export
174+
---
175+
```shell
176+
$ hkubectl export
177+
```
178+
Export all pipelines to source environment
179+
#### all
180+
181+
```shell
182+
$ hkubectl export all < outputDirectory >
183+
```
184+
Get and save all algorithms/pipelines as JSON/YAML files in a chosen directory
185+
Options:
186+
187+
188+
|option|description|type|required|default|
189+
|---|---|---|---|---|
190+
|outputDirectory|Path of your directory|string|true||
191+
|-f, --format|Output format (e.g. json, yaml) |string||json|
192+
#### algorithms
193+
194+
```shell
195+
$ hkubectl export algorithms < outputDirectory >
196+
```
197+
get and save all algorithms as JSON/YAML files in a chosen directory
198+
Options:
199+
200+
201+
|option|description|type|required|default|
202+
|---|---|---|---|---|
203+
|outputDirectory|path/of/your/directory|string|true||
204+
|-f, --format|Output format (e.g., json, yaml) |string||json|
205+
#### pipelines
206+
207+
```shell
208+
$ hkubectl export pipelines < outputDirectory >
209+
```
210+
get and save all pipelines as JSON/YAML files in a chosen directory
211+
Options:
212+
213+
214+
|option|description|type|required|default|
215+
|---|---|---|---|---|
216+
|outputDirectory|path/of/your/directory|string|true||
217+
|-f, --format|Output format (e.g. json, yaml) |string||json|
218+
### export
219+
---
220+
```shell
221+
$ hkubectl export
222+
```
223+
Export all pipelines to source environment
224+
#### all
225+
226+
```shell
227+
$ hkubectl export all < outputDirectory >
228+
```
229+
Get and save all algorithms/pipelines as JSON/YAML files in a chosen directory
230+
Options:
231+
232+
233+
|option|description|type|required|default|
234+
|---|---|---|---|---|
235+
|outputDirectory|Path of your directory|string|true||
236+
|-f, --format|Output format (e.g. json, yaml) |string||json|
237+
#### algorithms
238+
239+
```shell
240+
$ hkubectl export algorithms < outputDirectory >
241+
```
242+
get and save all algorithms as JSON/YAML files in a chosen directory
243+
Options:
244+
245+
246+
|option|description|type|required|default|
247+
|---|---|---|---|---|
248+
|outputDirectory|path/of/your/directory|string|true||
249+
|-f, --format|Output format (e.g., json, yaml) |string||json|
250+
#### pipelines
251+
252+
```shell
253+
$ hkubectl export pipelines < outputDirectory >
254+
```
255+
get and save all pipelines as JSON/YAML files in a chosen directory
256+
Options:
257+
258+
259+
|option|description|type|required|default|
260+
|---|---|---|---|---|
261+
|outputDirectory|path/of/your/directory|string|true||
262+
|-f, --format|Output format (e.g. json, yaml) |string||json|
263+
### import
264+
---
265+
```shell
266+
$ hkubectl import
267+
```
268+
Import all pipelines to source environment
269+
#### all
270+
271+
```shell
272+
$ hkubectl import all < inputDirectory >
273+
```
274+
Import your algorithms/pipelines files from a chosen directory to your Hkube
275+
environment
276+
Options:
277+
278+
279+
|option|description|type|required|default|
280+
|---|---|---|---|---|
281+
|inputDirectory|path/of/your/directory|string|true||
282+
|-r, --registry|docker registry for importing algorithms (e.g docker.io, myInternalRegistry)|string|||
283+
|--overwrite, --or|Should overwrite exsiting algorithms|boolean|||
284+
#### algorithms
285+
286+
```shell
287+
$ hkubectl import algorithms < inputDirectory >
288+
```
289+
Import your algorithms from a chosen directory to your Hkube environment
290+
Options:
291+
292+
293+
|option|description|type|required|default|
294+
|---|---|---|---|---|
295+
|inputDirectory|path/of/your/directory|string|true||
296+
|-r, --replace|Replace a value like docker registry|(e.g docker.io, myInternalRegistry)|||
297+
|--overwrite, --or|Should overwrite exsiting algorithms|boolean|||
298+
#### pipelines
299+
300+
```shell
301+
$ hkubectl import pipelines < inputDirectory >
302+
```
303+
Import your pipelines from a chosen directory to your Hkube environment
304+
Options:
305+
306+
307+
|option|description|type|required|default|
308+
|---|---|---|---|---|
309+
|inputDirectory|path/of/your/directory|string|true||
310+
### import
311+
---
312+
```shell
313+
$ hkubectl import
314+
```
315+
Import all pipelines to source environment
316+
#### all
317+
318+
```shell
319+
$ hkubectl import all < inputDirectory >
320+
```
321+
Import your algorithms/pipelines files from a chosen directory to your Hkube
322+
environment
323+
Options:
324+
325+
326+
|option|description|type|required|default|
327+
|---|---|---|---|---|
328+
|inputDirectory|path/of/your/directory|string|true||
329+
|-r, --registry|docker registry for importing algorithms (e.g docker.io, myInternalRegistry)|string|||
330+
|--overwrite, --or|Should overwrite exsiting algorithms|boolean|||
331+
#### algorithms
332+
333+
```shell
334+
$ hkubectl import algorithms < inputDirectory >
335+
```
336+
Import your algorithms from a chosen directory to your Hkube environment
337+
Options:
338+
339+
340+
|option|description|type|required|default|
341+
|---|---|---|---|---|
342+
|inputDirectory|path/of/your/directory|string|true||
343+
|-r, --replace|Replace a value like docker registry|(e.g docker.io, myInternalRegistry)|||
344+
|--overwrite, --or|Should overwrite exsiting algorithms|boolean|||
345+
#### pipelines
346+
347+
```shell
348+
$ hkubectl import pipelines < inputDirectory >
349+
```
350+
Import your pipelines from a chosen directory to your Hkube environment
351+
Options:
352+
353+
354+
|option|description|type|required|default|
355+
|---|---|---|---|---|
356+
|inputDirectory|path/of/your/directory|string|true||
357+
### import
358+
---
359+
```shell
360+
$ hkubectl import
361+
```
362+
Import all pipelines to source environment
363+
#### all
364+
365+
```shell
366+
$ hkubectl import all < inputDirectory >
367+
```
368+
Import your algorithms/pipelines files from a chosen directory to your Hkube
369+
environment
370+
Options:
371+
372+
373+
|option|description|type|required|default|
374+
|---|---|---|---|---|
375+
|inputDirectory|path/of/your/directory|string|true||
376+
|-r, --registry|docker registry for importing algorithms (e.g docker.io, myInternalRegistry)|string|||
377+
|--overwrite, --or|Should overwrite exsiting algorithms|boolean|||
378+
#### algorithms
379+
380+
```shell
381+
$ hkubectl import algorithms < inputDirectory >
382+
```
383+
Import your algorithms from a chosen directory to your Hkube environment
384+
Options:
385+
386+
387+
|option|description|type|required|default|
388+
|---|---|---|---|---|
389+
|inputDirectory|path/of/your/directory|string|true||
390+
|-r, --replace|Replace a value like docker registry|(e.g docker.io, myInternalRegistry)|||
391+
|--overwrite, --or|Should overwrite exsiting algorithms|boolean|||
392+
#### pipelines
393+
394+
```shell
395+
$ hkubectl import pipelines < inputDirectory >
396+
```
397+
Import your pipelines from a chosen directory to your Hkube environment
398+
Options:
399+
400+
401+
|option|description|type|required|default|
402+
|---|---|---|---|---|
403+
|inputDirectory|path/of/your/directory|string|true||
127404
### algorithm
128405
---
129406
```shell
@@ -257,7 +534,7 @@ sync local source folder into algorithm container in the cluster
257534
```shell
258535
$ hkubectl sync watch
259536
```
260-
watch a local folder
537+
watch a local folder, navigate menu to apply sync changes at will
261538
Options:
262539

263540

@@ -282,6 +559,31 @@ Options:
282559
|--env|algorithm runtime environment [choices: "python", "nodejs"]|string|||
283560
|-e, --entryPoint|the main file of the algorithm|string|||
284561
|--baseImage|base image for the algorithm|string|||
562+
#### start
563+
564+
```shell
565+
$ hkubectl sync start
566+
```
567+
Engage development mode for an algorithm
568+
Options:
569+
570+
571+
|option|description|type|required|default|
572+
|---|---|---|---|---|
573+
|-a, --algorithmName|The name of the algorithm to sync files into [required]|string|true||
574+
|-f, --devFolder|folder in pod to sync to|string|true||
575+
#### stop
576+
577+
```shell
578+
$ hkubectl sync stop
579+
```
580+
Disengage development mode for an algorithm
581+
Options:
582+
583+
584+
|option|description|type|required|default|
585+
|---|---|---|---|---|
586+
|-a, --algorithmName|The name of the algorithm to stop syncing files into|string|true||
285587
### config
286588
---
287589
```shell
@@ -325,4 +627,10 @@ the.dvc files
325627
```shell
326628
$ hkubectl datasource push
327629
```
328-
calls dvc, git push and hkube datasource hkube datasource prepare and sync
630+
calls dvc, git push and hkube datasource hkube datasource prepare and sync
631+
#### commit
632+
633+
```shell
634+
$ hkubectl datasource commit
635+
```
636+
prepares dvc files, commit changes to git and pushes

‎commands/sync/start.js

+4-3
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,10 @@ const startHandler = async ({ endpoint, rejectUnauthorized, algorithmName, devFo
1717
console.log(`code: ${res.result.error.code}, message: ${msg}`);
1818
return;
1919
}
20-
console.log(`algorithm ${algorithmName} modified to be in development mode.`);
21-
console.log('to sync the folder to the algorithm run');
22-
console.log(`${appName} sync watch -a ${algorithmName} -f localAlgoFolder`);
20+
console.log(`algorithm ${algorithmName} modified to be in development mode with the synced path being ${devFolder}.`);
21+
console.log('to sync the folder to the algorithm run:');
22+
console.log(`${appName} sync watch -a ${algorithmName} -f <localAlgoFolder>`);
23+
process.exit(0); // release terminal
2324
};
2425
module.exports = {
2526
command: 'start',

‎commands/sync/stop.js

+1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ const stopHandler = async ({ endpoint, rejectUnauthorized, algorithmName }) => {
1818
return;
1919
}
2020
console.log(`algorithm ${algorithmName} removed from development mode.`);
21+
process.exit(0); // release terminal
2122
};
2223
module.exports = {
2324
command: 'stop',

0 commit comments

Comments
 (0)