From 441e10c814648c1ccda73d2075c28eca9e3c36a1 Mon Sep 17 00:00:00 2001 From: Ian Woodard <17186604+IanWoodard@users.noreply.github.com> Date: Wed, 23 Apr 2025 11:24:10 -0700 Subject: [PATCH 1/2] feat(toggle): Adding docs for the toggle command --- .../devservices.mdx | 25 +++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/develop-docs/development-infrastructure/devservices.mdx b/develop-docs/development-infrastructure/devservices.mdx index 040af283c82e3..b8c3ea3f9f7fe 100644 --- a/develop-docs/development-infrastructure/devservices.mdx +++ b/develop-docs/development-infrastructure/devservices.mdx @@ -11,8 +11,8 @@ usage: devservices [-h] [--version] COMMAND ... CLI tool for managing service dependencies. options: - -h, --help show this help message and exit - --version show program's version number and exit + -h, --help show this help message and exit + --version show program's version number and exit commands: up Bring up a service and its dependencies @@ -23,6 +23,7 @@ commands: logs View logs for a service update Update devservices to the latest version purge Purge the local devservices cache + toggle Toggle how a service is run ``` ## Installation @@ -81,6 +82,26 @@ Common modes: devservices up --mode symbolicator ``` +## Running a dependency locally rather than as a container + +If you want to run a dependency locally rather than as a container, you can do so by toggling the runtime to LOCAL. + +For example, if you are running Sentry and want to use your local Snuba, you can do the following: + +```shell +devservices toggle snuba LOCAL +``` + +This will tell devservices to not bring up snuba and its dependencies, allowing you to run snuba locally instead. + +To toggle the runtime back to using the container, you can do the following: + +```shell +devservices toggle snuba CONTAINERIZED +``` + +If you don't provide a runtime when toggling, it will toggle to the opposite of the current runtime. + ## Migrating data from the deprecated `sentry devservices` From bf434032522bf634dd81d8a58895acd7f17fdc75 Mon Sep 17 00:00:00 2001 From: Ian Woodard <17186604+IanWoodard@users.noreply.github.com> Date: Fri, 25 Apr 2025 10:11:50 -0700 Subject: [PATCH 2/2] Update develop-docs/development-infrastructure/devservices.mdx Co-authored-by: Hubert Deng --- develop-docs/development-infrastructure/devservices.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/develop-docs/development-infrastructure/devservices.mdx b/develop-docs/development-infrastructure/devservices.mdx index b8c3ea3f9f7fe..fa318c5786915 100644 --- a/develop-docs/development-infrastructure/devservices.mdx +++ b/develop-docs/development-infrastructure/devservices.mdx @@ -82,7 +82,7 @@ Common modes: devservices up --mode symbolicator ``` -## Running a dependency locally rather than as a container +## Running a dependency locally If you want to run a dependency locally rather than as a container, you can do so by toggling the runtime to LOCAL.