-
Notifications
You must be signed in to change notification settings - Fork 126
427 docs rfc add docs about forking services #4490
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
billy-the-fish
merged 23 commits into
503-cli-mcp-agent-milestone-branch
from
427-docs-rfc-add-docs-about-forking-databases
Oct 21, 2025
Merged
Changes from all commits
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
193cc1a
chore: first draft of dev fork.
692ae14
chore: remove best practice sentence from dimension partitioning sect…
cb0b46b
chore: add dev forks in service management and backups.
9fa181a
chore: updates on review.
ce66d6e
Merge branch 'latest' of https://github.com/timescale/docs into 427-d…
3cb023c
chore: Update for Jasja's fork stuff.
billy-the-fish 3d2bdc4
chore: updates to integrate Jascha's stuff.
e77e591
chore: updates to integrate Jascha's stuff.
fd2b08b
Merge branch '503-cli-mcp-agent-milestone-branch' into 427-docs-rfc-a…
billy-the-fish c521663
Apply suggestions from code review
billy-the-fish af4ac8a
chore: Updates on review.
3238b68
Apply suggestions from code review
billy-the-fish 387565f
Apply suggestions from code review
billy-the-fish c53a646
Apply suggestions from code review
billy-the-fish 93800d3
Update _partials/_devops-cli-service-forks.md
billy-the-fish 9f711a7
Update use-timescale/fork-services.md
billy-the-fish 1217c24
Update use-timescale/fork-services.md
billy-the-fish 36de26c
Update use-timescale/fork-services.md
billy-the-fish 63b7a79
Update use-timescale/fork-services.md
billy-the-fish 9aed1c0
chore: Update on review.
billy-the-fish 11847ef
chore: Updates on review.
6199c6e
Merge branch '503-cli-mcp-agent-milestone-branch' into 427-docs-rfc-a…
billy-the-fish bb35150
chore: Updates on review.
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
import CLIINSTALL from "versionContent/_partials/_devops-cli-install.mdx"; | ||
|
||
To manage development forks: | ||
|
||
<Procedure> | ||
|
||
<CLIINSTALL /> | ||
|
||
1. **Fork the $SERVICE_SHORT** | ||
|
||
```shell | ||
tiger service fork tgrservice --now --no-wait --name bob | ||
``` | ||
By default a fork matches the resource of the parent $SERVICE_LONGs. For paid plans specify `--cpu` and/or `--memory` for dedicated resources. | ||
|
||
You see something like: | ||
|
||
```terminaloutput | ||
🍴 Forking service 'tgrservice' to create 'bob' at current state... | ||
✅ Fork request accepted! | ||
📋 New Service ID: <service_id> | ||
🔐 Password saved to system keyring for automatic authentication | ||
🎯 Set service '<service_id>' as default service. | ||
⏳ Service is being forked. Use 'tiger service list' to check status. | ||
┌───────────────────┬──────────────────────────────────────────────────────────────────────────────────────────────────┐ | ||
│ PROPERTY │ VALUE │ | ||
├───────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────────┤ | ||
│ Service ID │ <service_id> │ | ||
│ Name │ bob │ | ||
│ Status │ │ | ||
│ Type │ TIMESCALEDB │ | ||
│ Region │ eu-central-1 │ | ||
│ CPU │ 0.5 cores (500m) │ | ||
│ Memory │ 2 GB │ | ||
│ Direct Endpoint │ <service-id>.<project-id>.tsdb.cloud.timescale.com:<port> │ | ||
│ Created │ 2025-10-08 13:58:07 UTC │ | ||
│ Connection String │ postgresql://tsdbadmin@<service-id>.<project-id>.tsdb.cloud.timescale.com:<port>/tsdb?sslmode=require │ | ||
└───────────────────┴──────────────────────────────────────────────────────────────────────────────────────────────────┘ | ||
``` | ||
|
||
1. **When you are done, delete your forked $SERVICE_SHORT** | ||
|
||
1. Use the CLI to request $SERVICE_SHORT delete: | ||
|
||
```shell | ||
tiger service delete <service_id> | ||
``` | ||
1. Validate the $SERVICE_SHORT delete: | ||
|
||
```terminaloutput | ||
Are you sure you want to delete service '<service_id>'? This operation cannot be undone. | ||
Type the service ID '<service_id>' to confirm: | ||
<service_id> | ||
``` | ||
You see something like: | ||
```terminaloutput | ||
🗑️ Delete request accepted for service '<service_id>'. | ||
✅ Service '<service_id>' has been successfully deleted. | ||
``` | ||
|
||
</Procedure> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.