Skip to content
This repository was archived by the owner on May 14, 2025. It is now read-only.

Commit 06b6195

Browse files
markpollackericbottard
authored andcommitted
Add docs for shell
1 parent 0317748 commit 06b6195

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

spring-cloud-dataflow-docs/src/main/asciidoc/configuration.adoc

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,38 @@
33
[partintro]
44
--
55
In this section you will learn how to configure Spring Cloud Data Flow server's features such as the relational database to use and security.
6+
You will also learn how to configure Spring Cloud Data Flow shell's features.
67
--
8+
9+
[[shell-options]]
10+
== Shell Options
11+
The shell takes the following command line options
12+
[source,bash]
13+
----
14+
unix:>java -jar spring-cloud-dataflow-shell-1.2.1.RELEASE.jar --help
15+
Data Flow Options:
16+
--dataflow.uri=<uri> Address of the Data Flow Server [default: http://localhost:9393].
17+
--dataflow.username=<USER> Username of the Data Flow Server [no default].
18+
--dataflow.password=<PASSWORD> Password of the Data Flow Server [no default].
19+
--dataflow.credentials-provider-command=<COMMAND> Executes an external command which must return an OAuth Access Token [no default].
20+
--dataflow.skip-ssl-validation=<true|false> Accept any SSL certificate (even self-signed) [default: no].
21+
--spring.shell.historySize=<SIZE> Default size of the shell log file [default: 3000].
22+
--spring.shell.commandFile=<FILE> Data Flow Shell executes commands read from the file(s) and then exits.
23+
--help This message.
24+
----
25+
26+
The `spring.shell.commandFile` option is of note, as it can be used to point to an existing file which contains
27+
all the shell commands to deploy one or many related streams and tasks. This is useful when creating some scripts to
28+
help automate the deployment.
29+
30+
There is also a shell command
31+
[source,bash]
32+
----
33+
dataflow:>script --file <YOUR_AWESOME_SCRIPT>
34+
----
35+
This is useful to help modularize a complex script into multiple indepenent files.
36+
37+
738
[[enable-disable-specific-features]]
839
== Feature Toggles
940

0 commit comments

Comments
 (0)