Skip to content

Commit e93d744

Browse files
feat(toggle): Adding docs for the toggle command (#13487)
## DESCRIBE YOUR PR This change adds documentation for the new toggle command in devservices and outlines how/when it is used. ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [ ] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) --------- Co-authored-by: Hubert Deng <[email protected]>
1 parent 6222d5a commit e93d744

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

develop-docs/development-infrastructure/devservices.mdx

+23-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ usage: devservices [-h] [--version] COMMAND ...
1111
CLI tool for managing service dependencies.
1212

1313
options:
14-
-h, --help show this help message and exit
15-
--version show program's version number and exit
14+
-h, --help show this help message and exit
15+
--version show program's version number and exit
1616
1717
commands:
1818
up Bring up a service and its dependencies
@@ -23,6 +23,7 @@ commands:
2323
logs View logs for a service
2424
update Update devservices to the latest version
2525
purge Purge the local devservices cache
26+
toggle Toggle how a service is run
2627
```
2728
2829
## Installation
@@ -81,6 +82,26 @@ Common modes:
8182
devservices up --mode symbolicator
8283
```
8384
85+
## Running a dependency locally
86+
87+
If you want to run a dependency locally rather than as a container, you can do so by toggling the runtime to LOCAL.
88+
89+
For example, if you are running Sentry and want to use your local Snuba, you can do the following:
90+
91+
```shell
92+
devservices toggle snuba LOCAL
93+
```
94+
95+
This will tell devservices to not bring up snuba and its dependencies, allowing you to run snuba locally instead.
96+
97+
To toggle the runtime back to using the container, you can do the following:
98+
99+
```shell
100+
devservices toggle snuba CONTAINERIZED
101+
```
102+
103+
If you don't provide a runtime when toggling, it will toggle to the opposite of the current runtime.
104+
84105
## Migrating data from the deprecated `sentry devservices`
85106

86107
<Alert level="warning" title="Important">

0 commit comments

Comments
 (0)