summaryrefslogtreecommitdiff
path: root/doc/howto/gdk_commands.md
diff options
context:
space:
mode:
authorToon Claes <toon@gitlab.com>2019-07-18 07:48:08 +0000
committerToon Claes <toon@gitlab.com>2019-07-18 07:48:08 +0000
commitbaa5e571e84ac0a9a5d27a656d3e290aca3afa09 (patch)
tree1d8dddc0bc5fd59cf7d9953be64affebd97f7ea0 /doc/howto/gdk_commands.md
parent9631f7423b3b6595b8f4871348298edb67099463 (diff)
parentb8f13a7336d389fa8f0d4fb712c45272776bc4d8 (diff)
downloadgitlab-ce-docs-gitaly-secrets-mismatch.tar.gz
Merge branch '549-support-multiple-gdk-run-args' into 'master'docs-gitaly-secrets-mismatch
Support `gdk run` with multiple args Closes #549 See merge request gitlab-org/gitlab-development-kit!720
Diffstat (limited to 'doc/howto/gdk_commands.md')
-rw-r--r--doc/howto/gdk_commands.md27
1 files changed, 25 insertions, 2 deletions
diff --git a/doc/howto/gdk_commands.md b/doc/howto/gdk_commands.md
index 943610dde04..e0be0de4c43 100644
--- a/doc/howto/gdk_commands.md
+++ b/doc/howto/gdk_commands.md
@@ -1,5 +1,28 @@
# GDK commands
+## Running
+
+To start up the GDK with all default enabled services, run:
+
+```sh
+gdk run
+```
+
+If you'd like to run a specific group of services, you can do so by providing
+the service group names as arguments. Multiple arguments are supported:
+
+### Run just DB services
+
+```sh
+gdk run db
+```
+
+### Run DB and Geo DB services
+
+```sh
+gdk run db geo_db
+```
+
## Update gitlab and gitlab-shell repositories
When working on a new feature, always check that your `gitlab` repository is up
@@ -8,7 +31,7 @@ to date with the upstream master branch.
In order to fetch the latest code, first make sure that `foreman` for
postgres is runnning (needed for db migration) and then run:
-```
+```sh
gdk update
```
@@ -29,6 +52,6 @@ remove an individual file (e.g. `rm Procfile`) and rebuild it by
running `make`. If you want to rebuild _all_ configuration files
created by the Makefile, run:
-```
+```sh
gdk reconfigure
```