You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-28Lines changed: 28 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
# quickstart(dgrkt)
1
+
# quickstart(quickstart)
2
2
3
-
`dgrkt` is a convenient command-line utility built with Go and Cobra. It's designed to orchestrate and execute a series of commands based on a declarative YAML configuration file, similar to how container orchestrators manage services. This tool simplifies the management of complex multi-command setups, making it ideal for local development environments, testing suites, or task automation.
3
+
`quickstart` is a convenient command-line utility built with Go and Cobra. It's designed to orchestrate and execute a series of commands based on a declarative YAML configuration file, similar to how container orchestrators manage services. This tool simplifies the management of complex multi-command setups, making it ideal for local development environments, testing suites, or task automation.
4
4
5
-
With `dgrkt`, you define your tasks, their execution parameters, and their dependencies, allowing you to bring up and manage an entire set of related processes with a single command. It includes robust health check capabilities, ensuring that each task is healthy before dependent tasks are started.
5
+
With `quickstart`, you define your tasks, their execution parameters, and their dependencies, allowing you to bring up and manage an entire set of related processes with a single command. It includes robust health check capabilities, ensuring that each task is healthy before dependent tasks are started.
6
6
7
7
### Features
8
8
@@ -32,10 +32,10 @@ you'll currently need to manually bypass system security blocks when running the
|`name`| string, required | A unique identifier for the task. |
122
-
|`base_dir`| string | The working directory for the command. cmd.Dir will be set to this path. If not specified, the current working directory of dgrkt will be used. |
122
+
|`base_dir`| string | The working directory for the command. cmd.Dir will be set to this path. If not specified, the current working directory of quickstart will be used. |
123
123
|`executable`| string, required | The path to the executable command |e.g., node, java, ./my-app.|
124
124
|`args`|[]string | A list of arguments to pass to the executable. |
125
125
|`envs`|[]string | A list of environment variables to set for the command |e.g., KEY=VALUE. These are merged with the parent process's environment variables.|
126
126
|`depends_on`|[]string | A list of task names that this task depends on. This task will only start after all its dependencies have successfully passed their health checks. |
127
-
|`healthcheck`| object | Defines how dgrkt determines if a task is healthy. |
127
+
|`healthcheck`| object | Defines how quickstart determines if a task is healthy. |
128
128
|`healthcheck.http`| object | Configures an HTTP GET health check. |
129
129
|`healthcheck.http.url`| string, required | The URL to send the HTTP GET request to. |
130
130
|`healthcheck.http.expect`| object, optional | Defines expected responses.If not set, a 2xx HTTP status code indicates health. |
@@ -149,7 +149,7 @@ Each log file will be named in the format `{task:name}-{date}.log`
149
149
150
150
#### Example 1: Java Application Portable Launch Package
151
151
152
-
Here's an example of how you might configure `dgrkt` to start .jar file using java command
152
+
Here's an example of how you might configure `quickstart` to start .jar file using java command
153
153
154
154
**Prerequisite**
155
155
1. prepare your `myapp.jar` file.
@@ -162,11 +162,11 @@ new-dir/
162
162
├─ bin/
163
163
├─ java(.exe)
164
164
├─ myapp.jar
165
-
├─ dgrkt.yaml
166
-
├─ (Optional) dgrkt-portable(.exe)
165
+
├─ quickstart.yaml
166
+
├─ (Optional) quickstart-portable(.exe)
167
167
```
168
168
169
-
**Example of dgrkt.yaml**
169
+
**Example of quickstart.yaml**
170
170
171
171
- With Portable Jre Java
172
172
```yaml
@@ -190,11 +190,11 @@ new-dir/
190
190
- myapp.jar
191
191
```
192
192
193
-
Double-click the dgrkt portable executable or run `dgrkt up` in your current directory's terminal.
193
+
Double-click the quickstart portable executable or run `quickstart up` in your current directory's terminal.
194
194
195
195
#### Example 2: Portable Elasticsearch and Kibana Set
196
196
197
-
Here's an example of how you might configure `dgrkt` to start Elasticsearch and Kibana,
197
+
Here's an example of how you might configure `quickstart` to start Elasticsearch and Kibana,
198
198
with proper health checks and dependencies:
199
199
200
200
**Prerequisite**
@@ -208,7 +208,7 @@ files structure:
208
208
new-dir/
209
209
├─ elasticsearch/
210
210
├─ kibana/
211
-
├─ dgrkt.yaml
211
+
├─ quickstart.yaml
212
212
├─ kibana.yml
213
213
```
214
214
@@ -224,7 +224,7 @@ xpack:
224
224
encryptionKey: "01234567890123456789012345678901" # only for demo
225
225
```
226
226
227
-
**Example of dgrkt.yaml**
227
+
**Example of quickstart.yaml**
228
228
229
229
```yaml
230
230
tasks:
@@ -284,7 +284,7 @@ tasks:
284
284
- kibana
285
285
```
286
286
287
-
Double-click the dgrkt portable executable or run `dgrkt up` in your current directory's terminal.
287
+
Double-click the quickstart portable executable or run `quickstart up` in your current directory's terminal.
CheckCmd.PersistentFlags().StringVarP(&app.TasksComposeFile, "configfile", "f", "", "Specify the path to the configuration file, default is 'dgrkt.yaml'")
51
+
CheckCmd.PersistentFlags().StringVarP(&app.TasksComposeFile, "configfile", "f", "", "Specify the path to the configuration file, default is 'quickstart.yaml'")
0 commit comments