Skip to content

Commit 10a37f8

Browse files
427 docs rfc add docs about forking services (#4490)
forking
1 parent 40347e7 commit 10a37f8

File tree

17 files changed

+294
-27
lines changed

17 files changed

+294
-27
lines changed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
import CLIINSTALL from "versionContent/_partials/_devops-cli-install.mdx";
2+
3+
To manage development forks:
4+
5+
<Procedure>
6+
7+
<CLIINSTALL />
8+
9+
1. **Fork the $SERVICE_SHORT**
10+
11+
```shell
12+
tiger service fork tgrservice --now --no-wait --name bob
13+
```
14+
By default a fork matches the resource of the parent $SERVICE_LONGs. For paid plans specify `--cpu` and/or `--memory` for dedicated resources.
15+
16+
You see something like:
17+
18+
```terminaloutput
19+
🍴 Forking service 'tgrservice' to create 'bob' at current state...
20+
✅ Fork request accepted!
21+
📋 New Service ID: <service_id>
22+
🔐 Password saved to system keyring for automatic authentication
23+
🎯 Set service '<service_id>' as default service.
24+
⏳ Service is being forked. Use 'tiger service list' to check status.
25+
┌───────────────────┬──────────────────────────────────────────────────────────────────────────────────────────────────┐
26+
│ PROPERTY │ VALUE │
27+
├───────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────────┤
28+
│ Service ID │ <service_id> │
29+
│ Name │ bob │
30+
│ Status │ │
31+
│ Type │ TIMESCALEDB │
32+
│ Region │ eu-central-1 │
33+
│ CPU │ 0.5 cores (500m) │
34+
│ Memory │ 2 GB │
35+
│ Direct Endpoint │ <service-id>.<project-id>.tsdb.cloud.timescale.com:<port> │
36+
│ Created │ 2025-10-08 13:58:07 UTC │
37+
│ Connection String │ postgresql://tsdbadmin@<service-id>.<project-id>.tsdb.cloud.timescale.com:<port>/tsdb?sslmode=require │
38+
└───────────────────┴──────────────────────────────────────────────────────────────────────────────────────────────────┘
39+
```
40+
41+
1. **When you are done, delete your forked $SERVICE_SHORT**
42+
43+
1. Use the CLI to request $SERVICE_SHORT delete:
44+
45+
```shell
46+
tiger service delete <service_id>
47+
```
48+
1. Validate the $SERVICE_SHORT delete:
49+
50+
```terminaloutput
51+
Are you sure you want to delete service '<service_id>'? This operation cannot be undone.
52+
Type the service ID '<service_id>' to confirm:
53+
<service_id>
54+
```
55+
You see something like:
56+
```terminaloutput
57+
🗑️ Delete request accepted for service '<service_id>'.
58+
✅ Service '<service_id>' has been successfully deleted.
59+
```
60+
61+
</Procedure>

_partials/_manage-a-data-exporter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,4 +109,4 @@ It must be one of the following:
109109
[console-cloudwatch-configuration]: https://console.aws.amazon.com/cloudwatch/home#logsV2:log-groups
110110
[console-cloudwatch-create-group]: https://console.aws.amazon.com/cloudwatch/home#logsV2:log-groups/create-log-group
111111
[services-portal]: https://console.cloud.timescale.com/dashboard/services
112-
[pricing-plan-features]: /about/:currentVersion:/pricing-and-account-management/#features-included-in-each-plan
112+
[pricing-plan-features]: /about/:currentVersion:/pricing-and-account-management/#features-included-in-each-pricing-plan

_partials/_prometheus-integrate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,4 +209,4 @@ You can further [visualize your data][grafana-prometheus] with Grafana. Use the
209209
[enable-timescaledb]: /self-hosted/:currentVersion:/install/
210210
[prometheus-authentication]: https://prometheus.io/docs/guides/basic-auth/
211211
[scrape-targets]: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config
212-
[pricing-plan-features]: /about/:currentVersion:/pricing-and-account-management/#features-included-in-each-plan
212+
[pricing-plan-features]: /about/:currentVersion:/pricing-and-account-management/#features-included-in-each-pricing-plan

about/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -919,7 +919,7 @@ Highlighted features in TimescaleDB v2.17 are:
919919

920920
### HIPAA compliance
921921

922-
Timescale Cloud's [Enterprise plan](https://docs.timescale.com/about/latest/pricing-and-account-management/#features-included-in-each-plan) is now HIPAA (Health Insurance Portability and Accountability Act) compliant. This allows organizations to securely manage and analyze sensitive healthcare data, ensuring they meet regulatory requirements while building compliant applications.
922+
Timescale Cloud's [Enterprise plan](https://docs.timescale.com/about/latest/pricing-and-account-management/#features-included-in-each-pricing-plan) is now HIPAA (Health Insurance Portability and Accountability Act) compliant. This allows organizations to securely manage and analyze sensitive healthcare data, ensuring they meet regulatory requirements while building compliant applications.
923923

924924
### Expanded logging within Timescale Console
925925

about/pricing-and-account-management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ When you get $CLOUD_LONG at AWS Marketplace, the following pricing options are a
224224
[cloud-billing]: https://console.cloud.timescale.com/dashboard/billing/details
225225
[commercial-sla]: https://www.timescale.com/legal/timescale-cloud-terms-of-service
226226
[pricing-plans]: https://www.timescale.com/pricing
227-
[plan-features]: /about/:currentVersion:/pricing-and-account-management/#features-included-in-each-plan
227+
[plan-features]: /about/:currentVersion:/pricing-and-account-management/#features-included-in-each-pricing-plan
228228
[production-support]: https://www.timescale.com/support
229229
[hipaa-compliance]: https://www.hhs.gov/hipaa/for-professionals/index.html
230230
[aws-pricing]: /about/:currentVersion:/pricing-and-account-management/#aws-marketplace-pricing

ai/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Integrate AI with Tiger Data
3-
excerpt: Build AI assistants with Tiger Data using pgvector, Tiger Eon, Tiger Agents, and MCP server for seamless data integration
3+
excerpt: Build AI Assistants with Tiger Data using pgvector, Tiger Eon, Tiger Agents, and MCP server for seamless data integration
44
products: [cloud, mst, self_hosted]
55
keywords: [ai, vector, pgvector, pgvectorscale, pgai, tiger-eon, tiger-agents, mcp-server]
66
tags: [ai, vector, agents, assistants]
@@ -54,7 +54,7 @@ The [$MCP_LONG](/ai/:currentVersion:/mcp-server/) integrates directly with popul
5454
- Access comprehensive $COMPANY documentation during development
5555
- Use secure authentication and access control
5656

57-
Use the $MCP_SHORT when you want to manage $COMPANY resources from your AI assistant.
57+
Use the $MCP_SHORT when you want to manage $COMPANY resources from your AI Assistant.
5858

5959

6060
<!-- vale Google.Headings = NO -->

getting-started/page-index/page-index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ module.exports = [
2323
excerpt: "Create a Tiger service and connect to it",
2424
},
2525
{
26-
title: "DevOps as code with Tiger",
26+
title: "DevOps as code with Tiger Cloud",
2727
href: "get-started-devops-as-code",
2828
excerpt: "Set up secure authentication for the Tiger REST API and create your first service",
2929
},

integrations/cloudwatch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ tool. You create an exporter on the [project level][projects], in the same AWS r
3434
<ManageDataExporter />
3535

3636
[projects]: /use-timescale/:currentVersion:/security/members/
37-
[pricing-plan-features]: /about/:currentVersion:/pricing-and-account-management/#features-included-in-each-plan
37+
[pricing-plan-features]: /about/:currentVersion:/pricing-and-account-management/#features-included-in-each-pricing-plan
3838
[cloudwatch]: https://aws.amazon.com/cloudwatch/
3939
[cloudwatch-signup]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/GettingSetup.html
4040

integrations/datadog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ comprehensive list of [metrics][datadog-postgres-metrics] collected.
143143
[datadog-agent-restart]: https://docs.datadoghq.com/agent/configuration/agent-commands/#start-stop-and-restart-the-agent
144144
[projects]: /use-timescale/:currentVersion:/security/members/
145145
[datadog-api-key]: https://docs.datadoghq.com/account_management/api-app-keys/#add-an-api-key-or-client-token
146-
[pricing-plan-features]: /about/:currentVersion:/pricing-and-account-management/#features-included-in-each-plan
146+
[pricing-plan-features]: /about/:currentVersion:/pricing-and-account-management/#features-included-in-each-pricing-plan
147147
[run-queries]: /getting-started/:currentVersion:/run-queries-from-console/
148148
[open-console]: https://console.cloud.timescale.com/dashboard/services
149149
[psql]: /integrations/:currentVersion:/psql/

use-timescale/backup-restore.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,31 @@
11
---
2-
title: Back up and recover your Tiger services
3-
excerpt: See how and when Tiger backs up your data, making sure you always have something to fall back on in case of disaster recovery
2+
title: Back up and recover services
3+
excerpt: Tiger Cloud backs up your data, making sure you always have something to fall back on for disaster recovery
44
products: [cloud]
55
keywords: [backups, restore]
66
tags: [recovery, failures]
77
---
88

9-
# Back up and recover your $SERVICE_SHORTs
9+
import CLIFORKS from "versionContent/_partials/_devops-cli-service-forks.mdx";
1010

11-
$CLOUD_LONG automatically handles backup for your $SERVICE_LONGs using the `pgBackRest` tool. You don't need to perform backups manually. What's more, with [cross-region backup][cross-region], you are protected when an entire AWS region goes down.
11+
# Back up and recover $SERVICE_SHORTs
1212

13-
$CLOUD_LONG automatically creates one full backup every week, and
14-
incremental backups every day in the same region as your $SERVICE_SHORT.
13+
$CLOUD_LONG provides comprehensive backup and recovery solutions to protect your data, including automatic daily backups,
14+
cross-region protection, and point-in-time recovery.
1515

16-
On [$SCALE and $PERFORMANCE][pricing-and-account-management] $PRICING_PLANs, you can check the list of backups for the previous 14 days in $CONSOLE_LONG. To do so, select your $SERVICE_SHORT, then click `Operations` > `Backup and restore` > `Backup history`.
16+
## Automatic backups
17+
18+
$CLOUD_LONG automatically handles backup for your $SERVICE_LONGs using the `pgBackRest` tool. You don't need to perform
19+
backups manually. What's more, with [cross-region backup][cross-region], you are protected when an entire AWS region goes down.
1720

18-
Additionally, all [Write-Ahead Log (WAL)][wal] files are retained back to the oldest full backup. This means that you always have a full backup available for the current and previous week:
21+
$CLOUD_LONG automatically creates one full backup every week, and incremental backups every day in the same region as
22+
your $SERVICE_SHORT. Additionally, all [Write-Ahead Log (WAL)][wal] files are retained back to the oldest full backup.
23+
This means that you always have a full backup available for the current and previous week:
1924

2025
![Backup in Tiger](https://assets.timescale.com/docs/images/database-backup-recovery.png)
2126

27+
On [$SCALE and $PERFORMANCE][pricing-and-account-management] $PRICING_PLANs, you can check the list of backups for the previous 14 days in $CONSOLE_LONG. To do so, select your $SERVICE_SHORT, then click `Operations` > `Backup and restore` > `Backup history`.
28+
2229
In the event of a storage failure, a $SERVICE_SHORT automatically recovers from a backup
2330
to the point of failure. If the whole availability zone goes down, your $SERVICE_LONGs are recovered in a different zone. In the event of a user error, you can [create a point-in-time recovery fork][create-fork].
2431

@@ -101,6 +108,7 @@ You initiate a point-in-time recovery from a same-region or cross-region backup
101108
1. Confirm by clicking `Create recovery fork`.
102109

103110
A fork of the $SERVICE_SHORT is created. The recovered $SERVICE_SHORT shows in `Services` with a label specifying which $SERVICE_SHORT it has been forked from.
111+
104112
1. Update the connection strings in your app
105113

106114
Since the point-in-time recovery is done in a fork, to migrate your
@@ -120,6 +128,11 @@ You initiate a point-in-time recovery from a same-region or cross-region backup
120128
</Tabs>
121129

122130

131+
## Create a service fork
132+
133+
<CLIFORKS />
134+
135+
123136
[console]: https://console.cloud.timescale.com/dashboard/services
124137
[ha-replicas]: /about/use-timescale/:currentVersion:/ha-replicas/
125138
[pricing-and-account-management]: /about/:currentVersion:/pricing-and-account-management/

0 commit comments

Comments
 (0)