diff --git a/api/page-index/page-index.js b/api/page-index/page-index.js index 036be7507b8c..84caba4258b5 100644 --- a/api/page-index/page-index.js +++ b/api/page-index/page-index.js @@ -407,9 +407,9 @@ module.exports = [ href: 'jobs', }, { - title: "timescaledb_information.job_stats", - href: "job_stats" - } + title: 'timescaledb_information.job_stats', + href: 'job_stats', + }, ], }, { diff --git a/api/time_bucket_ng.md b/api/time_bucket_ng.md index 8656e2439413..8737c3e5c361 100644 --- a/api/time_bucket_ng.md +++ b/api/time_bucket_ng.md @@ -54,6 +54,7 @@ timezone and so the function can't be used with continuous aggregates. The function returns the bucket's start time. The return value type is the same as `ts`. + ### Sample Usage In this example, `time_bucket_ng()` is used to create bucket data in three month diff --git a/timescale-forge/backup-restore-cloud.md b/cloud/backup-restore-cloud.md similarity index 100% rename from timescale-forge/backup-restore-cloud.md rename to cloud/backup-restore-cloud.md diff --git a/timescale-forge/forge-multi-node.md b/cloud/cloud-multi-node.md similarity index 91% rename from timescale-forge/forge-multi-node.md rename to cloud/cloud-multi-node.md index 4f38736650f8..d65a92f57bf0 100644 --- a/timescale-forge/forge-multi-node.md +++ b/cloud/cloud-multi-node.md @@ -1,25 +1,25 @@ -# Setting up TimescaleDB 2.0 multi-node on Timescale Forge +# Setting up TimescaleDB 2.0 multi-node on Timescale Cloud TimescaleDB 2.0 [introduces a number of new features][changes-in-tsdb2] to supercharge time-series data even further. One of the most anticipated new features is what we call **multi-node** - the ability to create a cluster of TimescaleDB instances to scale both reads and writes. -In this How To, we’ll show you how to create a multi-node cluster in your -Timescale Forge account using TimescaleDB 2.0. +In this How To, we'll show you how to create a multi-node cluster in your +Timescale Cloud account using TimescaleDB 2.0. -This document details a "do-it-yourself" (DIY) multi-node experience on Forge. +This document details a "do-it-yourself" (DIY) multi-node experience on Cloud. In the future, we will offer a seamless point-and-click multi-node -experience within the Timescale Forge console UI, but we wanted to provide a way +experience within the Timescale Cloud console UI, but we wanted to provide a way for users to setup and test this feature before that interface is available. If you’re ready to set up a TimescaleDB multi-node cluster as part of your -Timescale Forge account, continue on! If you want to follow along but don't -yet have a Timescale Forge account, [sign-up today for a 100% free, 30-day +Timescale Cloud account, continue on! If you want to follow along but don't +yet have a Timescale Cloud account, [sign-up today for a 100% free, 30-day trial][sign-up]! ## Overview of multi-node setup Multi-node clusters consist of at least two or more TimescaleDB instances -(called **Services** in Timescale Forge). Each cluster has one access node +(called **Services** in Timescale Cloud). Each cluster has one access node (AN) and one or more data nodes (DN). As outlined in our [architecture blog posts][distributed-architechture], the access node is intended to be the only TimescaleDB instance that you or your applications @@ -35,12 +35,12 @@ single-node TimescaleDB instance and is not recommended. ### Create services for access and data nodes -First, you need to create new Services within your Forge account. As mentioned +First, you need to create new Services within your Cloud account. As mentioned earlier, you should create _at least_ three Services to set up a multi-node cluster: one access node and two data nodes. There is currently no way to distinguish between the access node and data nodes -within the Timescale Forge console, so we strongly recommend that you include +within the Timescale Cloud console, so we strongly recommend that you include "an" and "dn" in the names of each service, respectively. For example, use "an-mycluster", "dn1-mycluster", and "dn2-mycluster". To prevent problems later on, always use all lowercase names for your new nodes. Services can only assume @@ -48,7 +48,7 @@ one role in a cluster (access or data node), and only one Service can act as the access node. For simplicity you can start with the same hardware configuration for all -Services. On Timescale Forge, Service configuration can be modified later to +Services. On Timescale Cloud, Service configuration can be modified later to better tune access and data node requirements. @@ -72,7 +72,7 @@ distributed planning process. To that end, we highly recommend these settings be modified for the **Access Node** only under the **Settings** tab, shown in the -[Customize database configuration][forge-configuration] documentation. +[Customize database configuration][cloud-configuration] documentation. * `jit` = off * `max_prepared_transactions` > 0 (150 is a recommended starting value) @@ -84,13 +84,13 @@ access node and all data nodes. The currently supported method for securing communication between nodes is through **user mapping authentication**. This is also a manual process for now. As we continue to develop Timescale -Forge and multi-node functionality, this process will be a much smoother user -experience, completed directly from the Timescale Forge Console. +Cloud and multi-node functionality, this process will be a much smoother user +experience, completed directly from the Timescale Cloud Console. #### About user mapping authentication User mapping authentication allows users to continue connecting with the `tsdbadmin` PostgreSQL user for all data access and cluster management. It also -allows you to continue making secure (SSL) connections to your Timescale Forge +allows you to continue making secure (SSL) connections to your Timescale Cloud Access node. With user mapping authentication, you don’t need to manage any new users, @@ -242,7 +242,7 @@ data. And as always, consider joining our vibrant community [Slack channel][slack] to ask questions and learn from Timescale staff and other community members. -[sign-up]: https://forge.timescale.com/signup +[sign-up]: https://console.cloud.timescale.com/signup [maintenance-tasks]: timescaledb/:currentVersion:/how-to-guides/multi-node-setup/maintenance-tasks/ [slack]: https://slack.timescale.com/ [changes-in-tsdb2]: /timescaledb/:currentVersion:/overview/release-notes/changes-in-timescaledb-2 @@ -250,4 +250,4 @@ ask questions and learn from Timescale staff and other community members. [postgres-user-mapping]: https://www.postgresql.org/docs/current/view-pg-user-mappings.html [sample-data]: /timescaledb/:currentVersion:/tutorials/sample-datasets [promscale]: https://github.com/timescale/promscale -[forge-configuration]: /customize-configuration +[cloud-configuration]: /customize-configuration diff --git a/timescale-forge/create-a-service.md b/cloud/create-a-service.md similarity index 86% rename from timescale-forge/create-a-service.md rename to cloud/create-a-service.md index a4bc025e65de..9a9fd1e36ba7 100644 --- a/timescale-forge/create-a-service.md +++ b/cloud/create-a-service.md @@ -1,11 +1,11 @@ -# Exploring Timescale Forge -Welcome to Timescale Forge! Timescale Forge is a cloud-native TimescaleDB as a +# Exploring Timescale Cloud +Welcome to Timescale Cloud! Timescale Cloud is a cloud-native TimescaleDB as a service that is easy to get started and powerful enough for the most demanding -scenarios. This tutorial walks you through setting up your Timescale Forge +scenarios. This tutorial walks you through setting up your Timescale Cloud account and completing your first tutorial project. -### Create a Timescale Forge account -Sign up for Timescale Forge by visiting [forge.timescale.com][forge-signup]. +### Create a Timescale Cloud account +Sign up for Timescale Cloud by visiting [console.cloud.timescale.com][cloud-signup]. Provide your full name, email address, and a strong password to start: Sign up for Timescale Forge @@ -16,7 +16,7 @@ If you do not receive this link, check your spam folder first, then ### Create your first service When you have completed account verification, visit the -[Timescale Forge console][forge-console] and login with your credentials. +[Timescale Cloud console][cloud-console] and login with your credentials. To begin, click `Create service`. @@ -34,11 +34,11 @@ To begin, click `Create service`. 1. Click `Create service` when your configuration is complete. -Don't worry if too much about the size settings that you choose initially. -With Timescale Forge, it's easy to modify both the compute (CPU/Memory) and +Don't worry too much about the size settings that you choose initially. +With Timescale Cloud, it's easy to modify both the compute (CPU/Memory) and storage associated with the service that you just created. As you get to know TimescaleDB and how your data processing needs vary, it's easy to [right-size -your service with a few clicks](/timescale-forge/latest/scaling-a-service/)! +your service with a few clicks](/cloud/latest/scaling-a-service/)! After you select `Create service`, you will see confirmation of your service @@ -66,7 +66,7 @@ a service altogether. View Timescale Forge service information ### Complete your first tutorial -Congratulations! You are now up and running with Timescale Forge. To +Congratulations! You are now up and running with Timescale Cloud. To familiarize yourself with the features and capabilities of the product, we recommend that you complete the [Getting Started][getting-started] tutorial. @@ -81,7 +81,7 @@ Read about TimescaleDB features in our documentation: ### Keep testing during your free trial You’re now on your way to a great start with Timescale! -You will have an unthrottled, 30-day free trial with Timescale Forge to +You will have an unthrottled, 30-day free trial with Timescale Cloud to continue to test your use case. Before the end of your trial, we encourage you to add your credit card information. This will ensure a smooth transition after your trial period concludes. @@ -93,18 +93,18 @@ feel free to [join our community Slack group][slack-info] or [contact us][contact-timescale] directly. ## Advanced configuration and multi-node setup -Timescale Forge is a versatile hosting service that provides a growing list of +Timescale Cloud is a versatile hosting service that provides a growing list of advanced features for your PostgreSQL and time-series data workloads. For additional documentation on how to: * [Resize compute and storage][resize] at any time * [Customize your database configuration][configuration] easily -* [Create a TimescaleDB multi-node cluster][multi-node] in Timescale Forge +* [Create a TimescaleDB multi-node cluster][multi-node] in Timescale Cloud -[forge-signup]: https://forge.timescale.com +[cloud-signup]: https://console.cloud.timescale.com [slack-info]: https://slack-login.timescale.com [getting-started]: /timescaledb/latest/getting-started/ -[forge-console]: https://console.forge.timescale.com/login +[cloud-console]: https://console.cloud.timescale.com/login [contact-timescale]: https://www.timescale.com/contact [hypertable-info]: /timescaledb/latest/how-to-guides/hypertables [time-bucket-info]: /timescaledb/latest/how-to-guides/query-data/advanced-analytic-queries#time-bucket @@ -112,4 +112,4 @@ For additional documentation on how to: [aggregates-info]: /timescaledb/latest/getting-started/create-cagg [resize]: /scaling-a-service/ [configuration]: /customize-configuration/ -[multi-node]: /forge-multi-node/ +[multi-node]: /cloud-multi-node/ diff --git a/timescale-forge/customize-configuration.md b/cloud/customize-configuration.md similarity index 95% rename from timescale-forge/customize-configuration.md rename to cloud/customize-configuration.md index c4a487b5360b..d07c3411edfc 100644 --- a/timescale-forge/customize-configuration.md +++ b/cloud/customize-configuration.md @@ -1,5 +1,5 @@ -# Customize database configuration in Timescale Forge -Timescale Forge allows you to customize many TimescaleDB and PostgreSQL +# Customize database configuration in Timescale Cloud +Timescale Cloud allows you to customize many TimescaleDB and PostgreSQL configuration options for each Service individually. Most configuration values for a Service are initially set in accordance with best practices given the compute and storage settings of the Service. Any time you increase or decrease @@ -8,12 +8,12 @@ of the new Service. There are times, however, when your specific workload may require tuning some of the many available TimescaleDB and PostgreSQL parameters. By providing the -ability to tune various runtime settings, Timescale Forge provides the balance +ability to tune various runtime settings, Timescale Cloud provides the balance and flexibility you need when running your workloads in our hosted environment. Modifications of most parameters can be applied without restarting -the Timescale Forge Service. However, as when modifying the compute resources +the Timescale Cloud Service. However, as when modifying the compute resources of a running Service, some settings will require that a restart be performed, resulting in some brief downtime (usually about 30 seconds). @@ -65,7 +65,7 @@ and the `Apply changes` (or `Restart and apply changes`) button is available to click, prompting you to confirm any changes before the Service is modified. ## PostgreSQL extensions -You can use PostgreSQL extensions with Timescale Forge. If you run +You can use PostgreSQL extensions with Timescale Cloud. If you run `pg_available_extensions` at the command prompt, the returned list of extensions is inaccurate. To see the allowed extensions, use this command instead: ```sql diff --git a/timescale-forge/disk-management.md b/cloud/disk-management.md similarity index 92% rename from timescale-forge/disk-management.md rename to cloud/disk-management.md index a7b1163c0f56..12a9edcf8e96 100644 --- a/timescale-forge/disk-management.md +++ b/cloud/disk-management.md @@ -1,7 +1,7 @@ # Disk management -Timescale Forge contains several mechanisms for managing disk space on your -services. There are four key tasks that Forge performs to handle disk space: +Timescale Cloud contains several mechanisms for managing disk space on your +services. There are four key tasks that Cloud performs to handle disk space: 1. Detect if storage capacity begins to fill up 1. Notify you about the growth of storage consumption @@ -13,7 +13,7 @@ of them. ## Continuous storage monitoring -Timescale Forge continuously monitors the health and resource consumption of all +Timescale Cloud continuously monitors the health and resource consumption of all database services. You can check your health data by navigating to the `metrics` tab in your service dashboard. These metrics are also monitored by the Timescale operations team. @@ -42,7 +42,7 @@ about a particular service. If your database continues to increase in size past these thresholds, automated overload protection is activated when your disk becomes 99% full. When this happens, your database is put into read-only mode, and you receive a -notification on email and the Timescale Forge console shows the changed status. +notification on email and the Timescale Cloud console shows the changed status. When this happens, you can still query your database, but you cannot add any new data to it. This is to ensure that your disk does not fill up to 100%, which @@ -55,7 +55,7 @@ avoid the problem occurring again in the future. ## Online storage resizing -You can increase your storage size in the Timescale Forge console. +You can increase your storage size in the Timescale Cloud console. You can only increase your service's storage once every six hours, and you cannot @@ -63,7 +63,7 @@ currently decrease your storage size once set. ### Procedure: Increasing service resources -1. In the Timescale Forge console, navigate to `Services` and click the service +1. In the Timescale Cloud console, navigate to `Services` and click the service you want to adjust. Navigate to the `Operations` tab, and go to the `Resources` section. 1. Adjust the sliders for CPU and disk size as required. If you increase the diff --git a/timescale-forge/index.md b/cloud/index.md similarity index 78% rename from timescale-forge/index.md rename to cloud/index.md index 1c61446d6a05..a8ebb23bdbe5 100644 --- a/timescale-forge/index.md +++ b/cloud/index.md @@ -1,11 +1,11 @@ -# Timescale Forge +# Timescale Cloud -Timescale Forge is a cloud-native TimescaleDB as a service that is easy to get +Timescale Cloud is a cloud-native TimescaleDB as a service that is easy to get started and powerful enough for the most demanding scenarios. You can -[try Timescale Forge for free][sign-up], no credit card required. +[try Timescale Cloud for free][sign-up], no credit card required. ### Cloud-native, easy start, low cost -Built and operated by the team behind TimescaleDB, Timescale Forge is the +Built and operated by the team behind TimescaleDB, Timescale Cloud is the innovative and cost-effective way to store and analyze your time-series data. * Spin up your first instance in 30 seconds * Decoupled storage and compute options for extreme flexibility @@ -35,4 +35,8 @@ and extensions. * More than 75 popular PostgreSQL extensions including PostGIS, pre-installed * Integrated support for Prometheus long-term storage - [sign-up]: https://console.forge.timescale.com/signup \ No newline at end of file +For more information on Timescale Cloud's terms of service, visit the [Timescale website][tos]. + + + [sign-up]: https://console.cloud.timescale.com/signup + [tos]: https://www.timescale.com/legal/timescale-cloud-terms-of-service \ No newline at end of file diff --git a/timescale-forge/maintenance.md b/cloud/maintenance.md similarity index 90% rename from timescale-forge/maintenance.md rename to cloud/maintenance.md index c775daebdb61..7e72f954de5b 100644 --- a/timescale-forge/maintenance.md +++ b/cloud/maintenance.md @@ -1,5 +1,5 @@ # Maintenance -On Timescale Forge, minor software updates are handled automatically by us, and you do +On Timescale Cloud, minor software updates are handled automatically by us, and you do not need to perform any actions. Non-critical software updates are applied during a maintenance window that you @@ -35,7 +35,7 @@ your maintenance window occur during office hours, so that you can monitor your system during the upgrade. ### Procedure: Adjusting your maintenance window -1. [Log in to your Timescale Forge account][cloud-login]. Click the name of the +1. [Log in to your Timescale Cloud account][cloud-login]. Click the name of the service that you want to manage the maintenance window for. 1. In the `Operations` tab, navigate to the `Maintenance` section, and click `Change maintenance window`. @@ -43,11 +43,11 @@ system during the upgrade. timezone that you want the maintenance window to start. Maintenance windows can run for up to four hours. 1. Check `Apply new maintenance window to all services` if you want to use the - same maintenance window settings for all of your Timescale Forge services. + same maintenance window settings for all of your Timescale Cloud services. 1. Click `Apply Changes`. ## Critical updates Critical upgrades and security fixes are installed outside normal maintenance windows when necessary, and sometimes require a short outage. -[cloud-login]: https://console.forge.timescale.com/login +[cloud-login]: https://cloud.timescale.com diff --git a/timescale-forge/page-index/page-index.js b/cloud/page-index/page-index.js similarity index 85% rename from timescale-forge/page-index/page-index.js rename to cloud/page-index/page-index.js index 62eb5687048f..e92c20e25c83 100644 --- a/timescale-forge/page-index/page-index.js +++ b/cloud/page-index/page-index.js @@ -1,10 +1,10 @@ module.exports = [ { - title: "Timescale Forge", + title: "Timescale Cloud", filePath: 'index.md', - href: "timescale-forge", - name: 'Timescale Forge', - excerpt: 'Timescale Forge is a fully managed TimescaleDB service that allows you to start querying data in less than a minute!', + href: "cloud", + name: 'Timescale Cloud', + excerpt: 'Timescale Cloud is a fully managed TimescaleDB service that allows you to start querying data in less than a minute!', children: [ { title: "Create a service", @@ -20,7 +20,7 @@ module.exports = [ }, { title: "Create a multi-node cluster", - href: "forge-multi-node" + href: "cloud-multi-node" }, { title: "VPC peering with AWS", diff --git a/cloud/scaling-a-service.md b/cloud/scaling-a-service.md new file mode 100644 index 000000000000..bb6ebf3f4a77 --- /dev/null +++ b/cloud/scaling-a-service.md @@ -0,0 +1,113 @@ +# Resizing compute and storage in Timescale Cloud +Timescale Cloud allows you to resize compute (CPU/RAM) and storage independently +at any time. This is extremely useful when users have a need to increase storage +(for instance) but not compute. The Timescale Cloud console makes this very easy +to do for any service. + +Before you modify the compute or storage settings for a Cloud Service, please +note the following limitations and when a change to these settings will result +in momentary downtime. + +**Storage**: Storage changes are applied with no downtime, typically available +within a few seconds. Other things to note about storage changes: +* At the current time, storage can only be _increased_ in size. +* Storage size changes can only be made once every six (6) hours. +* Storage can be modified in various increments between 10GB and 10TB. + +**Compute**: Modifications to the compute size of your service (increases or +decreases) can be applied at any time, however, please note the following: +* **_There is momentary downtime_** while the compute settings are applied. + In most cases, this downtime is less than 30 seconds. +* Because there will be an interruption to your service, you should plan + accordingly to have the settings applied at an appropriate service window. + +## View service operation details +To modify the compute or storage of your Service, first select the Service that +you want to modify. This displays the `service details`, which list four tabs +across the top: Overview, Operations, Metrics, and Logs. Select `Operations`. + +View Timescale Forge service operational information + +## Display the current service resources +Under the Operations tab, you can perform the same basic operations as before +(Reset password, Pause service, Delete service). There is now a second, advanced +section on the left labeled `Resources`. Selecting this option displays the +current resource settings for the Service. + +View Timescale Forge service resource information + +## Modify service resources +Once you have navigated to the current Service resources, it's easy to modify +either the compute (CPU/Memory) or disk size. As you modify either setting, +notice that the current and new hourly charges are displayed in real-time +so that it's easy to verify how these changes will impact your costs. + +As noted above, changes to disk size will not cause any downtime. However, +the platform currently only supports _increasing_ disk size (not decreasing it), +and you can increase disk size once every six (6) hours. + +When you're satisfied with the changes, click `Apply` (storage resizes only) or +`Apply and Restart` (when modifying compute resources). + +View Timescale Forge service apply resize +# Compute resources and disk size +You can use the Timescale Cloud console to change how much CPU and memory +resources your service has available, as well as change the disk size for your +service. You can adjust this manually as required, or for disk size you can use autoscaling. + +## Change resource allocations manually +When you change the disk size, the changes are applied with no downtime, and the +new size generally becomes available within a few seconds. You can change the +disk size once every six hours, and you can only increase the size, not decrease +it. You can have a disk up to 10 TB in size. + +You can change the CPU and memory allocation for your service at any time, with +minimal downtime, usually less than thirty seconds. The new resources become +available as soon as the service restarts. You can change the CPU and memory +allocation up or down, as frequently as required. + + +Changing your compute settings usually requires a short downtime. Make sure you +plan for this before you begin! + + +### Procedure: Changing resource allocations manually +1. In the Timescale Cloud console, from the `Services` list, click the name of + the service you want to modify. +1. In the `Service details` page, navigate to the `Operations` tab, and click + `Resources`. +1. In the `Resize CPU / memory` field, select the new CPU and memory + allocation. +1. In the `Increase disk size` field, adjust the slider to the new disk size. +1. Review the new allocations and costs in the comparison chart. +1. Click `Apply` to save your changes. If you have changed the CPU and memory + allocation, your service will go down briefly while the changes are applied. + Configure resource allocations + +## Configure autoscaling for disk size +Disk size autoscaling is enabled by default on most services. When you consume +95% or more of your existing disk space, disk size is automatically increased to +the next size available, up to a configurable limit. + +Autoscaling can change the disk size once every six hours. When the increase is +requested, the used space is optimized before the new limit is applied. As your +disk size increases, this optimization process can take longer, and the six +hours does not start running until the new size is applied, after the +optimization is complete. + +Autoscaling can only increase disk size, not decrease it. You can have a disk up +to 10 TB in size. + +### Procedure: Configuring autoscaling for disk size +1. In the Timescale Cloud console, from the `Services` list, click the name of + the service you want to modify. +1. In the `Service overview` page, navigate to the `Operations` tab, and click + `Autoscaling`. +1. Toggle `Enable storage autoscaling` to turn autoscaling on or off. +1. In the `Storage autoscaling limit` field, adjust the slider to set the + maximum disk size. Autoscaling can not increase the disk size higher than + this limit. +1. Review the new allocations and costs in the comparison chart. +1. Click `Apply` to save your changes. The new disk size generally becomes + available within a few seconds. + Configure autoscaling disk size diff --git a/timescale-forge/vpc-peering-aws/create.md b/cloud/vpc-peering-aws/create.md similarity index 82% rename from timescale-forge/vpc-peering-aws/create.md rename to cloud/vpc-peering-aws/create.md index ef610c4eabe4..d44bb27a2ef4 100644 --- a/timescale-forge/vpc-peering-aws/create.md +++ b/cloud/vpc-peering-aws/create.md @@ -1,33 +1,33 @@ -# Create and connect a Timescale Forge VPC with AWS +# Create and connect a Timescale Cloud VPC with AWS ## Setup -Before you begin, log in to the [Timescale Forge console](https://console.forge.timescale.com/). +Before you begin, log in to the [Timescale Cloud console](https://console.cloud.timescale.com/). ## Create a new VPC -In the Timescale Forge console, click `VPC` in the left navigation bar to go to the VPC -dashboard. You can add new VPCs here for your Timescale Forge services to attach to. +In the Timescale Cloud console, click `VPC` in the left navigation bar to go to the VPC +dashboard. You can add new VPCs here for your Timescale Cloud services to attach to. The VPCs created here are peered with your own VPC as part of the setup process. Navigate to the VPC dashboard in the console Click `Create VPC`, type a name for your new VPC, and provide an IPv4 CIDR block (E.G., `10.0.0.0/16` or `192.168.0.0/24`). Make sure that the CIDR block you -choose for your Timescale Forge VPC does not overlap with the AWS VPC you are using to create +choose for your Timescale Cloud VPC does not overlap with the AWS VPC you are using to create a peering connection. If the CIDR blocks overlap, the peering process will fail. You can always find the CIDR block of your AWS VPC from the AWS console. Create a new Forge VPC -VPC peering can be enabled for free during your Timescale Forge trial, but you will be +VPC peering can be enabled for free during your Timescale Cloud trial, but you will be required to enter a valid payment method in order to create a VPC (even though you will not yet be charged for it). ## Create a peering connection -When you have created a Timescale Forge VPC, you are ready to create a peering connection -between your Forge VPC and your cloud VPC. To do this, click the `Add` text in -the `VPC Peering` column for the Forge VPC that you would like to connect. +When you have created a Timescale Cloud VPC, you are ready to create a peering connection +between your Cloud VPC and your cloud VPC. To do this, click the `Add` text in +the `VPC Peering` column for the Cloud VPC that you would like to connect. Expand the VPC Peering dropdown menu and enter info @@ -41,7 +41,7 @@ accept a peering connection from an unknown account. Navigate to the AWS console's [Peering Connections](https://console.aws.amazon.com/vpc/home#PeeringConnections:) -dashboard. Find the new peering connection request sent from Timescale Forge, and +dashboard. Find the new peering connection request sent from Timescale Cloud, and accept the request. @@ -53,7 +53,7 @@ Make note of the peering connection ID (starting with `pcx-`) as it is used in t ## Network routing and security in AWS Once you have accepted the peering connection, the two VPCs will now be peered; however, in order to use this peering connection, you need to update your -VPC's route table to include the CIDR block of your peered Timescale Forge VPC, +VPC's route table to include the CIDR block of your peered Timescale Cloud VPC, and you also need to update your VPC's security groups. ### Route table @@ -65,7 +65,7 @@ the `Routes` tab and click the `Edit routes` button. The AWS Route Tables dashboard with Routes tab expanded From this view, click `Add route`. In the `Destination` column of the new row, -enter the CIDR block of the Timescale Forge VPC for which the peering connection +enter the CIDR block of the Timescale Cloud VPC for which the peering connection was configured in the previous few steps. In the `Target` column, enter the peering connection ID (starting with `pcx-`) @@ -73,7 +73,7 @@ noted in the previous step where you created the peering connection. No other configuration is needed here, so click `Save routes`. This configuration allows network traffic to flow from your VPC, across the peering -connection, and over to the Timescale Forge VPC where your TimescaleDB services reside. +connection, and over to the Timescale Cloud VPC where your TimescaleDB services reside. Adding a new route table entry for our peering connection @@ -91,14 +91,14 @@ however, for simplicity we will assume the creation of a new security group. From the `Create security group` view, enter a name for your security group. Add whatever content you would like to the description field. For the `VPC` field, select the VPC -which has been peered with your Forge VPC. +which has been peered with your Cloud VPC. No inbound rules are required, so leave the inbound rules section empty. In the outbound rules section, select `Custom TCP` for the rule type. The protocol should remain as TCP. The port range should be `5432`, which is the port which will -be used to connect to your Timescale Forge services. The Destination should be set -to `Custom` and the value should be the CIDR block of your Forge VPC. +be used to connect to your Timescale Cloud services. The Destination should be set +to `Custom` and the value should be the CIDR block of your Cloud VPC. AWS may pre-populate the `Destination` column with the value `0.0.0.0/0`. Though this @@ -106,19 +106,19 @@ value will certainly work, it is more "open" than needed, and should be deleted. Finally, click `Create security group`. With this step, you will now be able to -connect to any of your Timescale Forge services attached to your peered VPC. In the next -section, you will learn how to create a Timescale Forge service with a VPC attachment. +connect to any of your Timescale Cloud services attached to your peered VPC. In the next +section, you will learn how to create a Timescale Cloud service with a VPC attachment. ## Create a service with VPC attachment -In the Timescale Forge console, navigate to the -[Services Dashboard](https://console.forge.timescale.com/dashboard/services). Click +In the Timescale Cloud console, navigate to the +[Services Dashboard](https://console.cloud.timescale.com/dashboard/services). Click `Create service` and select the compute and disk size which fits your needs. Expand the dropdown menu under the `Select a VPC` step and select the VPC you created previously. If you have multiple VPCs, select the VPC which you want your new service to be attached to. -Click `Create Service`, and Timescale Forge will create your new service. Due to +Click `Create Service`, and Timescale Cloud will create your new service. Due to selecting a VPC during setup, your new service will be created with an attachment to your selected VPC. diff --git a/timescale-forge/vpc-peering-aws/index.md b/cloud/vpc-peering-aws/index.md similarity index 65% rename from timescale-forge/vpc-peering-aws/index.md rename to cloud/vpc-peering-aws/index.md index 91a9c7458cb8..cc19bc24a515 100644 --- a/timescale-forge/vpc-peering-aws/index.md +++ b/cloud/vpc-peering-aws/index.md @@ -1,19 +1,19 @@ -# VPC peering with AWS in Timescale Forge +# VPC peering with AWS in Timescale Cloud -Timescale Forge allows you to create a private network peering connection between -your cloud VPC and the Timescale Forge cloud infrastructure where your Timescale +Timescale Cloud allows you to create a private network peering connection between +your cloud VPC and the Timescale Cloud cloud infrastructure where your Timescale services are hosted. -VPC peering isolates your Timescale Forge services ensuring that they are only +VPC peering isolates your Timescale Cloud services ensuring that they are only accessible via your peered VPC, offering greater security due to a reduced attack vector surface. -The Timescale Forge console makes creating and configuring your VPC peering connections +The Timescale Cloud console makes creating and configuring your VPC peering connections simple. It provides controls for adding and removing VPC peering connections, migrating services to and from VPCs, and creating new services with VPC peering attachments. ## Requirements and limitations -To use Timescale Forge VPC peering, you need your own cloud VPC, where your +To use Timescale Cloud VPC peering, you need your own cloud VPC, where your applications and infrastructure are already running. If you do not have administrative access to your cloud provider account, you will need @@ -24,12 +24,12 @@ to work with someone from your team with sufficient permissions to: - configure security group and firewall rules. -Timescale Forge defaults to a limit of 3 VPCs per project. If you need more VPCs, +Timescale Cloud defaults to a limit of 3 VPCs per project. If you need more VPCs, you may contact support to request a quota increase. -Once you have attached your Timescale Forge service to a VPC, it will no longer be accessible +Once you have attached your Timescale Cloud service to a VPC, it will no longer be accessible via the public internet. It will only be accessible via your AWS VPC which has been peered -with your Timescale Forge VPC. +with your Timescale Cloud VPC. \ No newline at end of file diff --git a/timescale-forge/vpc-peering-aws/migrate.md b/cloud/vpc-peering-aws/migrate.md similarity index 89% rename from timescale-forge/vpc-peering-aws/migrate.md rename to cloud/vpc-peering-aws/migrate.md index a1b792a5ae6e..1baa91b10740 100644 --- a/timescale-forge/vpc-peering-aws/migrate.md +++ b/cloud/vpc-peering-aws/migrate.md @@ -1,24 +1,24 @@ # Migrating a service between networks -Timescale Forge services may be migrated between VPCs within a Forge project, and may also +Timescale Forge services may be migrated between VPCs within a Cloud project, and may also be migrated to and from the public network. Typically, once you have attached your service to a VPC, it should remain attached to ensure that your applications running in your AWS VPC will have continued connectivity to your service. -Timescale Forge uses a different DNS name for a Timescale service once it has been attached +Timescale Cloud uses a different DNS name for a Timescale service once it has been attached to a VPC. This means that you will need to update your connection string if migrating a service from the public internet into a VPC, or vice-versa. -To migrate a Timescale Forge service between VPCs, or to migrate to/from the public network, -navigate to the [Services Dashboard](https://console.forge.timescale.com/dashboard/services), +To migrate a Timescale Cloud service between VPCs, or to migrate to/from the public network, +navigate to the [Services Dashboard](https://console.cloud.timescale.com/dashboard/services), select the service you wish to migrate, click the `Operations` tab in the service details view, and click the `VPC` tab within the `Operations` view. From this view, you have a few options depending on the state of your service. -After migrating your Timescale Forge service, please allow a few minutes for DNS +After migrating your Timescale Cloud service, please allow a few minutes for DNS propagation. If you receive DNS errors indicating that the DNS name could not be resolved, this indicates that more time is needed for DNS propagation. @@ -45,10 +45,10 @@ for connecting to your service. When migrating your service into a VPC, ensure that your AWS VPC's security groups -allow network access from your AWS VPC to the Forge VPC which your service has +allow network access from your AWS VPC to the Cloud VPC which your service has migrated into. Security group configuration was previously covered as part of peering connection setup. Double-check to be sure, otherwise you will not be able -to connect to your Timescale Forge service. +to connect to your Timescale Cloud service. ## Migrate between VPCs @@ -72,10 +72,10 @@ be updated, only the IP address which the DNS name is associated with will be up When migrating your service between VPCs, ensure that your AWS VPC's security groups -allow network access from your AWS VPC to the Forge VPC which your service has +allow network access from your AWS VPC to the Cloud VPC which your service has migrated into. Security group configuration was previously covered as part of peering connection setup. Double-check to be sure, otherwise you will not be able -to connect to your Timescale Forge service. +to connect to your Timescale Cloud service. ### Migrate back to public network diff --git a/timescale-cloud/connection-pools.md b/mst/connection-pools.md similarity index 97% rename from timescale-cloud/connection-pools.md rename to mst/connection-pools.md index f47d1c2881ab..7782a10c5567 100644 --- a/timescale-cloud/connection-pools.md +++ b/mst/connection-pools.md @@ -61,12 +61,12 @@ this mode. This mode is best suited to specialized workloads that use sharding front-end proxies. ## Set up a connection pool -You can set up a connection pool from the Timescale Cloud +You can set up a connection pool from the Managed Service for TimescaleDB portal. Make sure you have already created a service that you want to add connection pooling to. ### Procedure: Setting up a connection pool -1. In the Timescale Cloud portal, navigate to the +1. In the MST portal, navigate to the `Services` list, and click the name of the service you want to add connection pooling to. 1. In the `Service overview` page, navigate to the `Pools` tab. When you have created some pools, they are shown here. diff --git a/timescale-cloud/create-a-service.md b/mst/create-a-service.md similarity index 74% rename from timescale-cloud/create-a-service.md rename to mst/create-a-service.md index 1292bafa1bc4..d5d36fe311ea 100644 --- a/timescale-cloud/create-a-service.md +++ b/mst/create-a-service.md @@ -1,13 +1,15 @@ # About services -A Timescale Cloud service is an instance that corresponds to a cloud service provider tier. -You can access all your services from the `Services` tab within your projects. -Before you begin, make sure you have [signed up to Timescale Cloud][sign-up] and created your account. +A managed TimescaleDB service is an instance that corresponds to a cloud service +provider tier. You can access all your services from the `Services` tab within +your projects. Before you begin, make sure you have +[signed up to Managed Service for TimescaleDB][sign-up] and created your account. ## Create a service -When you have your account set up, you can log in to the [Timescale Cloud portal][timescale-cloud-portal] and create your first service. +When you have your account set up, you can log in to the Managed Service for +TimescaleDB [portal][timescale-mst-portal] and create your first service. ### Procedure: Creating a service -1. [Log in to your Timescale Cloud account][mst-login]. By default, you start in the +1. [Log in to your account][mst-login]. By default, you start in the `Services` view, showing any services you currently have in your project. 1. Click `Create a new service`. 1. In the `Select your service` section, click `TimescaleDB`: @@ -28,12 +30,13 @@ When you have your account set up, you can log in to the [Timescale Cloud portal Building the service -During your Timescale Cloud trial, you have up to US$300 in credits to use. This -is enough credit to complete all our tutorials and run a few test projects. +During your Managed Service for TimescaleDB trial, you have up to US$300 in +credits to use. This is enough credit to complete all our tutorials and run a +few test projects. If you're interested in learning more about pricing, visit the -[Timescale Cloud pricing calculator][timescale-pricing]. Or, +[Managed Service for TimescaleDB pricing calculator][timescale-pricing]. Or, [contact us][contact] and we can walk you through the best configuration for your use case. @@ -43,8 +46,8 @@ utility. If you haven't already installed `psql`, you can follow [these instructions][install-psql]. ### Procedure: Accessing your database -1. In the [Timescale Cloud account][mst-login] `Services` view, click the name of your new - Grafana service. +1. In the [Managed Service for TimescaleDB account][mst-login] `Services` view, + click the name of your new Grafana service. 1. On the service details page, take a note of the service URI for your service. 1. Open a terminal, and use `psql` to connect to your service using the URI: ```bash @@ -66,8 +69,8 @@ Now you have your service up and running, you can try your [sign-up]: https://www.timescale.com/cloud-signup [mst-login]: https://portal.timescale.cloud/login -[timescale-cloud-portal]: http://portal.timescale.cloud -[timescale-pricing]: https://www.timescale.com/products#cloud-pricing +[timescale-mst-portal]: https://portal.managed.timescale.com +[timescale-pricing]: https://www.timescale.com/products [contact]: https://www.timescale.com/contact [getting-started]: /timescaledb/:currentVersion:/getting-started/ [install-psql]: /timescaledb/:currentVersion:/how-to-guides/connecting/psql diff --git a/timescale-cloud/index.md b/mst/index.md similarity index 75% rename from timescale-cloud/index.md rename to mst/index.md index 52b73f4a2af9..1c9ff84d3b01 100644 --- a/timescale-cloud/index.md +++ b/mst/index.md @@ -1,19 +1,21 @@ -# Timescale Cloud -Timescale Cloud provides managed TimescaleDB services -hosted in more than 75 regions using AWS, Azure, or GCP. You can use Timescale Cloud to -create database instances, or services, in the cloud and automate most of your -most common operational tasks. This allows you to spend more time focusing on -your time-series workloads and less time worrying about database management. +# Managed Service for TimescaleDB +Managed Service for TimescaleDB provides a fully-managed TimescaleDB service +hosted in more than 75 regions using AWS, Azure, or GCP. You can use this +service to create database instances, or services, in the cloud and automate +most of your most common operational tasks. This allows you to spend more time +focusing on your time-series workloads and less time worrying about database +management. * Find out [about services][create-a-service] -* Create a [multi-node cluster][cloud-multi-node] +* Create a [multi-node cluster][mst-multi-node] * View [service logs][viewing-service-logs] * Use [VPC peering][vpc-peering] * Understand [security for Timescale Cloud][security] -Some important Timescale Cloud terms: -* **Account:** Your Timescale Cloud account. You can register for an account on the - [Timescale Cloud signup][sign-up] page. +Some important terms: +* **Account:** Your Managed Service for TimescaleDB account. You can register + for an account on the + [Managed Service for TimescaleDB signup][sign-up] page. * **Project:** An empty project is created for you automatically when you sign up. Projects help you organize your services and billing settings. You can also use projects to manage user access to your services. @@ -27,8 +29,8 @@ Some important Timescale Cloud terms: database management that is performed for a given TimescaleDB deployment. ## Hosted TimescaleDB -Built and operated by the team behind TimescaleDB, Timescale Cloud provides a -flexible relational time-series database. +Built and operated by the TimescaleDB team, Managed Service for TimescaleDB +provides a flexible relational time-series database: * Select between more than 75 regions across AWS, GCP, or Azure * Choose from more than 2000 possible configurations, from 1 CPUs and 20 GB disk to 72 CPUs and 10 TB disk. @@ -62,9 +64,12 @@ integrations and extensions. * Connect applications securely with VPC Peering and IP whitelisting. * SOC2, HIPAA, ISO27001, CCPA, and GDPR compliance. +For more information on Managed Service for TimescaleDB's terms of service, visit the [Timescale website][tos]. + [create-a-service]: /create-a-service -[cloud-multi-node]: /cloud-multi-node +[mst-multi-node]: /mst-multi-node [viewing-service-logs]: /viewing-service-logs [vpc-peering]: /vpc-peering [security]: /security [sign-up]: https://www.timescale.com/cloud-signup +[tos]: https://www.timescale.com/legal/mst-terms-of-service diff --git a/timescale-cloud/ingest-data.md b/mst/ingest-data.md similarity index 96% rename from timescale-cloud/ingest-data.md rename to mst/ingest-data.md index e2549618d2a2..9382283cafb7 100644 --- a/timescale-cloud/ingest-data.md +++ b/mst/ingest-data.md @@ -1,5 +1,6 @@ # Ingest data -There are several different ways of ingesting your data into Timescale Cloud. This section contains instructions to: +There are several different ways of ingesting your data into Managed Service for +TimescaleDB. This section contains instructions to: * Bulk upload [from a `.csv` file](#bulk-upload-from-csv-files) * Migrate data [from an existing database][migrate-data] * Migrate data [from InfluxDB][migrate-influxdb] @@ -12,7 +13,8 @@ There are several different ways of ingesting your data into Timescale Cloud. Th Before you begin, make sure you have -[created your Timescale Cloud service](/create-a-service/), and can connect to it using `psql`. +[created your Managed Service for TimescaleDB service](/create-a-service/), and +can connect to it using `psql`. ## Procedure: Preparing your new database diff --git a/timescale-cloud/maintenance.md b/mst/maintenance.md similarity index 86% rename from timescale-cloud/maintenance.md rename to mst/maintenance.md index 861e276c02af..1cfef0c931f4 100644 --- a/timescale-cloud/maintenance.md +++ b/mst/maintenance.md @@ -1,8 +1,9 @@ # Maintenance -On Timescale Cloud, software updates are handled automatically by us, and you do not need to perform any actions. +On Managed Service for TimescaleDB, software updates are handled automatically +by us, and you do not need to perform any actions to keep up to date. -Non-critical software updates are applied during a maintenance window that you can define to suit your workload. -If we detect a security vulnerability that affects you, we might need to perform maintenance outside of +Non-critical software updates are applied during a maintenance window that you can define to suit your workload. +If we detect a security vulnerability that affects you, we might need to perform maintenance outside of the scheduled maintenance window. @@ -28,7 +29,7 @@ your maintenance window occur during office hours, so that you can monitor your system during the upgrade. ### Procedure: Adjusting your maintenance window -1. [Log in to your Timescale Cloud account][mst-login]. Click the name of the service that +1. [Log in to your account][mst-login]. Click the name of the service that you want to manage the maintenance window for. 1. In the `Maintenance window` section, click `Change`. 1. In the `Service Maintenance Window` dialog, select the day of the week and @@ -38,7 +39,7 @@ system during the upgrade. 1. Click `Save Changes`. ## Critical updates -Critical upgrades and security fixes are installed outside normal maintenance windows when +Critical upgrades and security fixes are installed outside normal maintenance windows when necessary, and sometimes require a short outage. Upgrades are performed as rolling upgrades where completely new server instances @@ -51,4 +52,4 @@ get clients connected again. In most cases, there is five to ten second outage during this process. -[mst-login]: https://portal.timescale.cloud/login +[mst-login]: https://portal.managed.timescale.com diff --git a/timescale-cloud/metrics-datadog.md b/mst/metrics-datadog.md similarity index 81% rename from timescale-cloud/metrics-datadog.md rename to mst/metrics-datadog.md index 06f134a77748..bf1602faf13c 100644 --- a/timescale-cloud/metrics-datadog.md +++ b/mst/metrics-datadog.md @@ -1,25 +1,26 @@ # Metrics and Datadog Datadog is a popular cloud-based monitoring service. You can send metrics to Datadog using a metrics collection agent for graphing, service dashboards, -alerting, and logging. Timescale Cloud can send data +alerting, and logging. Managed Service for TimescaleDB can send data directly to Datadog for monitoring. Datadog integrations are provided free of -charge on Timescale Cloud. +charge on Managed Service for TimescaleDB. You need to create a Datadog API key, and use the key to enable metrics for your -Timescale Cloud service. +Managed Service for TimescaleDB service. -We do not currently support Datadog logging on Timescale Cloud. +We do not currently support Datadog logging on Managed Service for TimescaleDB. ## Create and upload a Datadog API key -You can create an API key in your Datadog account, and upload it to your Timescale Cloud -account. +You can create an API key in your Datadog account, and upload it to your Managed +Service for TimescaleDB account. -Before you begin, you need to have signed up for both Datadog and Timescale Cloud, and be able -to log in to your Datadog and Timescale Cloud dashboards. You also need a running Timescale Cloud -service. +Before you begin, you need to have signed up for both Datadog and Managed +Service for TimescaleDB, and be able to log in to your Datadog and Managed +Service for TimescaleDB dashboards. You also need a running Managed Service for +TimescaleDB service. ### Procedure: Creating a Datadog API key @@ -31,8 +32,8 @@ service. 1. Hover your mouse over the purple bar in the `Key` field to see the key, and copy it to use later. -### Procedure: Uploading a Datadog API key to Timescale Cloud -1. [Log in to your Timescale Cloud][mst-login]. By default, you start in the +### Procedure: Uploading a Datadog API key to MST +1. [Log in to your Managed Service for TimescaleDB][mst-login]. By default, you start in the `Services` view, showing any services you currently have in your project. 1. Check that you are in the project that you want to connect to Datadog, and click `Service Integrations`. @@ -49,7 +50,7 @@ service. When you have successfully added the endpoint, you can set up one of your services to send data to Datadog. ### Procedure: Activating Datadog integration for a service -1. In the Timescale Cloud `Services` view, click the name of the service that you want to +1. In the Managed Service for TimescaleDB `Services` view, click the name of the service that you want to connect to Datadog. 1. In the `Service integrations` section, click `Manage integrations`. Locate the Datadog integration, and click `Use integration`. diff --git a/timescale-cloud/cloud-multi-node.md b/mst/mst-multi-node.md similarity index 83% rename from timescale-cloud/cloud-multi-node.md rename to mst/mst-multi-node.md index 2c6d7f5334d5..a7b334e8bd51 100644 --- a/timescale-cloud/cloud-multi-node.md +++ b/mst/mst-multi-node.md @@ -1,28 +1,28 @@ - -Timescale currently offers two hosting options. If you are a -Timescale Forge user, please use the documentation for -[setting up multi-node on Forge](timescale-forge/latest/forge-multi-node) instead. + +Timescale currently offers two hosting options. If you are a Timescale Cloud +(previously called Timescale Forge) user, please use the documentation for +[setting up multi-node on Cloud](cloud/cloud-multi-node) instead. -# Setting up TimescaleDB 2.0 multi-node on Timescale Cloud +# Setting up TimescaleDB 2.0 multi-node on Managed Service for TimescaleDB TimescaleDB 2.0 [introduces a number of new features][changes-in-tsdb2] to supercharge time-series data even further. One of the most anticipated new features is what we call **multi-node** - the ability to create a cluster of TimescaleDB instances to scale both reads and writes. In this How To, we’ll show you how to create a multi-node cluster in your -Timescale Cloud account with TimescaleDB 2.0 as a "do-it-yourself" (DIY) -multi-node experience. +Managed Service for TimescaleDB account with TimescaleDB 2.0 as a +"do-it-yourself" (DIY) multi-node experience. ## Overview of multi-node setup Multi-node clusters consist of at least two or more TimescaleDB instances -(called **Services** in Timescale Cloud). Each cluster has one access node -(AN) and one or more data nodes (DN). As outlined in our -[architecture blog posts][distributed-architecture], the access node is -intended to be the only TimescaleDB instance that you or your applications -connect to once the cluster is set up. It becomes the "brains" and traffic -controller of all distributed hypertable activity. In contrast, data nodes are -not intended to be accessed directly once joined to a multi-node cluster. +(called **Services** in Managed Service for TimescaleDB). Each cluster has one +access node (AN) and one or more data nodes (DN). As outlined in our +[architecture blog posts][distributed-architecture], the access node is intended +to be the only TimescaleDB instance that you or your applications connect to +once the cluster is set up. It becomes the "brains" and traffic controller of +all distributed hypertable activity. In contrast, data nodes are not intended to +be accessed directly once joined to a multi-node cluster. A proper TimescaleDB cluster should have at least two data nodes to begin @@ -36,16 +36,16 @@ First, you need to create new Services within your Cloud account. As mentioned earlier, you should create _at least_ three Services to set up a multi-node cluster: one access node and two data nodes. -There is currently no way to visually distinguish between the access node -and data nodes within the Timescale Cloud console, **so we strongly recommend -that you include "AN" and "DN" in the names of each service, respectively (eg. -"an-mycluster", "dn1-mycluster", "dn2-mycluster", etc.)**. Services can only -assume one role in a cluster (access or data node), and only one Service can act -as the access node. +There is currently no way to visually distinguish between the access node and +data nodes within the Managed Service for TimescaleDB console, **so we strongly +recommend that you include "AN" and "DN" in the names of each service, +respectively (eg. "an-mycluster", "dn1-mycluster", "dn2-mycluster", etc.)**. +Services can only assume one role in a cluster (access or data node), and only +one Service can act as the access node. For simplicity you can start with the same hardware configuration for all -Services. On Timescale Cloud, Service plans can be upgraded later to better tune -access and data node requirements. +Services. On Managed Service for TimescaleDB, Service plans can be upgraded +later to better tune access and data node requirements. More advanced users might consider using larger disks on data nodes (this is @@ -54,8 +54,8 @@ access node. -To setup your first multi-node instance in Timescale Cloud, you will -need to create new Services for the Access Node and Data Nodes. +To setup your first multi-node instance in Managed Service for TimescaleDB, you +will need to create new Services for the Access Node and Data Nodes. ### Modify access node settings @@ -66,12 +66,12 @@ down some types of queries to the data nodes. To that end, we highly recommend the following settings be modified for the **Access Node** only using the **Advanced Configuration** section in the -Timescale Cloud console. +Managed Service for TimescaleDB console. * `pg.jit` = off * `pg.max_prepared_transactions` > 0 (150 is a recommended starting value) -Timescale Cloud advanced configuration +Managed TimescaleDB advanced configuration ### Add data nodes to the cluster Once you've created your new Services, you'll enable communication between the @@ -83,8 +83,8 @@ This is a one-time, manual process that must be completed for each data node. #### About user mapping authentication User mapping authentication allows users to continue connecting with the `tsdbadmin` PostgreSQL user for all data access and cluster management. It also -allows you to continue making secure (SSL) connections to your Timescale Cloud -Access node. +allows you to continue making secure (SSL) connections to your Managed Service +for TimescaleDB Access node. With user mapping authentication, you don’t need to manage any new users, however, **you need to have the passwords for the `tsdbadmin` user from each @@ -102,11 +102,11 @@ For this step, you'll need to copy the `Host`, `Password`, and `Port` details listed under the `Connection Information` section of the Service details to use with the `add_data_node` command in the next section. -Timescale Cloud multi-node connection information +Managed Service for TimescaleDB multi-node connection information -When you have the `password` and `host` for each data node Service, connect -to the access node using the `tsdbadmin` user. On Timescale Cloud this -is easily accomplished by copying the `Service URI` (after clicking +When you have the `password` and `host` for each data node Service, connect to +the access node using the `tsdbadmin` user. On Managed Service for TimescaleDB, +you can do this by copying the `Service URI` (after clicking `CLICK_TO:REVEAL_PASSWORD`). It should look something like the following, but with different ports, password and Service URI. diff --git a/timescale-cloud/page-index/page-index.js b/mst/page-index/page-index.js similarity index 76% rename from timescale-cloud/page-index/page-index.js rename to mst/page-index/page-index.js index 3366fc8819b1..426acd0dd946 100644 --- a/timescale-cloud/page-index/page-index.js +++ b/mst/page-index/page-index.js @@ -1,10 +1,10 @@ module.exports = [ { - title: "Timescale Cloud", + title: "Managed Service for TimescaleDB", filePath: 'index.md', - href: "timescale-cloud", - name: 'Timescale Cloud', - excerpt: 'Timescale Cloud is a fully managed TimescaleDB service that allows you to quickly deploy across 75+ regions in AWS, Azure or GCP', + href: "mst", + name: 'Managed Service for TimescaleDB', + excerpt: 'Managed Service for TimescaleDB is a fully managed TimescaleDB service that allows you to quickly deploy across 75+ regions in AWS, Azure or GCP', children: [ { title: "Create services", @@ -20,7 +20,7 @@ module.exports = [ }, { title: "Create a multi-node cluster", - href: "cloud-multi-node" + href: "mst-multi-node" }, { title: "Connection pools", diff --git a/timescale-cloud/security.md b/mst/security.md similarity index 68% rename from timescale-cloud/security.md rename to mst/security.md index f9c8b2b3c07f..b79d802d19a7 100644 --- a/timescale-cloud/security.md +++ b/mst/security.md @@ -1,18 +1,18 @@ # Security overview ## Cloud provider accounts -The regular Timescale Cloud services are hosted under cloud provider accounts -controlled by Timescale Cloud. These accounts are managed only by Timescale -Cloud (eg Timescale and Aiven) operations personnel and customers cannot directly -access the cloud provider account resources. +The regular managed TimescaleDB services are hosted under cloud provider +accounts controlled by Managed Service for TimescaleDB. These accounts are +managed only by Timescale and Aiven operations personnel. Customers cannot +directly access the cloud provider account resources. ## Virtual machines -Each Timescale Cloud service consists of one or more virtual machines, which are -automatically launched to the target cloud region chosen by the customer. In -cloud regions that have multiple Availability Zones (or a similar mechanism), -the virtual machines are distributed evenly across the zones in order to provide -best possible service in cases when an entire Availability Zone (may include one -or more data centers) goes unavailable. +Each Managed Service for TimescaleDB service consists of one or more virtual +machines, which are automatically launched to the target cloud region chosen by +the customer. In cloud regions that have multiple Availability Zones (or a +similar mechanism), the virtual machines are distributed evenly across the zones +in order to provide best possible service in cases when an entire Availability +Zone (may include one or more data centers) goes unavailable. Service-providing virtual machines are dedicated for a single customer, i.e. there is no multi-tenancy on a VM basis, and the customer data never leaves the @@ -22,8 +22,8 @@ Virtual machines are not reused and will be terminated and wiped upon service upgrade or termination. ## Data encryption -Timescale Cloud at-rest data encryption covers both active service instances as -well as service backups in cloud object storage. +Managed Service for TimescaleDB at-rest data encryption covers both active +service instances as well as service backups in cloud object storage. Service instances and the underlying VMs use full volume encryption using LUKS with a randomly generated ephemeral key per each instance and each volume. The @@ -45,8 +45,9 @@ same region where the service virtual machines are located. Customer access to provided services is only provided over TLS encrypted connections. There is no option for using unencrypted plaintext connections. -Communication between virtual machines within Timescale Cloud is secured with -either TLS or IPsec. There are no unencrypted plaintext connections. +Communication between virtual machines within Managed Service for TimescaleDB is +secured with either TLS or IPsec. There are no unencrypted plaintext +connections. Virtual machines network interfaces are protected by a dynamically configured iptables-based firewall that only allows connections from specific addresses both @@ -63,41 +64,40 @@ The service providing virtual machines are still contained under Timescale Cloud provider accounts. ## Operator access -Normally all the resources required for providing an Timescale Cloud service are -automatically created, maintained and terminated by the Timescale Cloud -infrastructure and there is no manual Timescale Cloud operator intervention required. +Normally all the resources required for providing an Managed Service for +TimescaleDB service are automatically created, maintained and terminated by the +Timescale Cloud infrastructure and there is no manual operator intervention +required. -However, the Timescale Cloud Operations Team has the capability to securely login -to the service Virtual Machines for troubleshooting purposes. These accesses are -audit logged. +However, the Managed Service for TimescaleDB Operations Team has the capability +to securely login to the service Virtual Machines for troubleshooting purposes. +These accesses are audit logged. No customer access to the virtual machine level is provided. ## Customer data privacy -Customer data privacy is of utmost importance at Timescale Cloud and is covered +Customer data privacy is of utmost importance at Timescale and is covered by internal Security and Customer Privacy policies as well as the strict EU regulations. - -Timescale Cloud operators will never access the customer data, unless explicitly +Timescale operators will never access the customer data, unless explicitly requested by the customer in order to troubleshoot a technical issue. -Timescale Cloud operations team has mandatory recurring training regarding the +The Timescale operations team has mandatory recurring training regarding the applicable policies. -Periodic Security Evaluation -Timescale Cloud services are periodically assessed and penetration tested for any +TimescaleDB services are periodically assessed and penetration tested for any security issues by an independent professional cyber security vendor. The latest evaluation report can be found [here][cloud-security-eval]. -## Advanced Timescale Cloud configuration +## Advanced Managed Service for TimescaleDB configuration ### Securing network access to Timescale Cloud -One very critical piece of securing your database within Timescale Cloud is network protection. +One very critical piece of securing your database within Managed Service for TimescaleDB is network protection. TimescaleDB provides the ability to configure, in a fine-grained manner, the set of source IP addresses and ranges, as well as connection ports, that can -access your Timescale Cloud services. +access your Managed Service for TimescaleDB services. This tutorial will walk you through how to configure this capability. @@ -108,10 +108,11 @@ get signed up and create your first database instance. #### Step 1 - Navigate to your TimescaleDB instance -Once you have a database instance setup in the [Timescale Cloud portal][timescale-cloud-portal], -browse to this service and click on the 'Overview' tab. In the 'Connection Information' -section, you will see the port number that is used for database connections. This is -the port we will protect by managing inbound access. +Once you have a database instance setup in the +[Managed Service for TimescaleDB portal][timescale-mst-portal], browse to this +service and click on the 'Overview' tab. In the 'Connection Information' +section, you will see the port number that is used for database connections. +This is the port we will protect by managing inbound access. Timescale Cloud Overview tab @@ -142,6 +143,6 @@ Click 'Save Changes' and see this take effect immediately. Limiting IP address inbound access is just one option to improve the security of your Timescale Cloud database instance. There are many other types of security measures you should take into account when securing your data. To learn more about security options within Timescale Cloud, -visit the [Timescale Cloud Knowledge Base][timescale-cloud-kb]. +visit the [Managed TimescaleDB Knowledge Base][timescale-mst-kb]. [cloud-security-eval]: https://www.google.com/url?sa=t&rct=j&q=&esrc=s&source=web&cd=1&cad=rja&uact=8&ved=0ahUKEwjtm4bbn4rbAhUBDZoKHdBRDgkQFggpMAA&url=https%3A%2F%2Fwww.elfgroup.fi%2Fecc%2F1708-S6-71acd0046.pdf&usg=AOvVaw2wcBEPGeys6PL21W3G6wGW diff --git a/timescale-cloud/troubleshooting.md b/mst/troubleshooting.md similarity index 68% rename from timescale-cloud/troubleshooting.md rename to mst/troubleshooting.md index fd7d32f42a08..821a734a51f8 100644 --- a/timescale-cloud/troubleshooting.md +++ b/mst/troubleshooting.md @@ -1,6 +1,6 @@ # Troubleshooting This section covers some common errors or problems you might run into while -using your Timescale Cloud account. +using your Managed Service for TimescaleDB account. ## Database is low on disk, memory, or CPU When your database reaches 90% of your allocated disk, memory, or CPU resources, @@ -8,17 +8,18 @@ an automated message is sent to the email address listed on your account. The email looks like this: ```txt -Your Timescale Cloud service, in project "ExampleAccount", is running low on +Your Managed Service for TimescaleDB service, in project "ExampleAccount", is running low on CPU. Running low on CPU affects performance and could affect service availability. Please either optimize your usage pattern or reduce the workload, and consider upgrading to a larger plan to avoid service outage. ``` -You can resolve this by logging in to your Timescale Cloud account and increasing your -available resources. From the Timescale Cloud Dashboard, select the service that you want to -increase resources for. In the `Overview` tab, locate the `Service Plan` -section, and click `Upgrade Plan`. Select the plan that suits your requirements, -and click `Upgrade` to enable the additional resources. +You can resolve this by logging in to your Managed Service for TimescaleDB +account and increasing your available resources. From the Managed Service for +TimescaleDB Dashboard, select the service that you want to increase resources +for. In the `Overview` tab, locate the `Service Plan` section, and click +`Upgrade Plan`. Select the plan that suits your requirements, and click +`Upgrade` to enable the additional resources. If you run out of resources regularly, you might need to consider using your resources more efficiently. Consider enabling [compression][howto-compression], diff --git a/timescale-cloud/user-management.md b/mst/user-management.md similarity index 87% rename from timescale-cloud/user-management.md rename to mst/user-management.md index 6bfa9c0e41b7..ad7d513127bc 100644 --- a/timescale-cloud/user-management.md +++ b/mst/user-management.md @@ -1,6 +1,7 @@ # User Management -You can add new users, and manage existing users, in the Timescale Cloud console. New users can be added to an entire project, or a -single service. +You can add new users, and manage existing users, in the Managed Service for +TimescaleDB console. New users can be added to an entire project, or a single +service. ## Project members You can invite new users to join your project as project members. There are @@ -14,7 +15,7 @@ several roles available for project members: |Read-only|❌|❌|❌|❌|✅| ### Procedure: Adding project members -1. [Log in to your Timescale Cloud account][mst-login]. By default, you start in the +1. [Log in to your account][mst-login]. By default, you start in the `Services` view, showing any services you currently have in your project. 1. Check that you are in the project that you want to change the members for, and click `Members`. @@ -36,7 +37,7 @@ Your service must be running before you can manage users. ### Procedure: Adding service users -1. [Log in to your Timescale Cloud account][mst-login]. By default, you start in the +1. [Log in to your account][mst-login]. By default, you start in the `Services` view, showing any services you currently have in your project. 1. Click the name of the service that you want to add users to, and navigate to the `Users` tab. diff --git a/timescale-cloud/viewing-service-logs.md b/mst/viewing-service-logs.md similarity index 65% rename from timescale-cloud/viewing-service-logs.md rename to mst/viewing-service-logs.md index 18e7370a0e5b..bd018d8807f7 100644 --- a/timescale-cloud/viewing-service-logs.md +++ b/mst/viewing-service-logs.md @@ -1,11 +1,13 @@ # Viewing service logs -Occasionally there is a need to inspect logs from Timescale Cloud. For example, -to debug query performance or inspecting errors caused by a specific workload. +Occasionally there is a need to inspect logs from Managed Service for +TimescaleDB. For example, to debug query performance or inspecting errors caused +by a specific workload. -There are different built-in ways to inspect service logs at Timescale Cloud: +There are different built-in ways to inspect service logs at Managed Service for +TimescaleDB: - * In [Timescale Cloud portal][], when selecting a specific service, under "Logs" tab + * In the [portal][mst-portal], when selecting a specific service, under "Logs" tab recent events are available. Logs can be browsed back in time, but scrolling up several thousand lines is not very convenient. * [Command-line client][] supports programmatically downloading logs. avn service l @@ -15,6 +17,6 @@ output, in case programmatic access is needed. Service logs included on the normal service price are stored only for a few days. Unless you are using logs integration to another service, older logs are not accessible. -[Timescale Cloud portal]: https://portal.timescale.cloud/ +[mst-portal]: https://portal.timescale.cloud/ [Command-line client]: https://github.com/aiven/aiven-client [REST API]: https://kb.timescale.cloud/en/articles/2949775-rest-api diff --git a/timescale-cloud/vpc-peering.md b/mst/vpc-peering.md similarity index 86% rename from timescale-cloud/vpc-peering.md rename to mst/vpc-peering.md index 60b1c117998e..97a5ec593682 100644 --- a/timescale-cloud/vpc-peering.md +++ b/mst/vpc-peering.md @@ -18,8 +18,8 @@ VPC peered network or on public internet. ## Setting it up -In order to set up a VPC peering for your Timescale Cloud project please submit -a request in the Timescale Cloud VPC section. +In order to set up a VPC peering for your Managed Service for TimescaleDB +project please submit a request in the VPC section of the dashboard. When creating a new service, you can choose whether the service will be placed in a VPC or not: The list of cloud providers and regions contains options like @@ -37,10 +37,10 @@ Peering connections can be requested with the VPC request, or added later. Note however that the VPC is not accessible until at least one connection has been created. After the request has been submitted VPC peering will be automatically set up by -Timescale Cloud, and the status is updated in the web console's VPC view together +Manage Service for TimescaleDB, and the status is updated in the web console's VPC view together with instructions for starting peering with our network. Note that you'll need to accept a VPC peering connection request (AWS) or create a corresponding -peering from your project to Timescale Cloud's (Google) before Timescale Cloud's +peering from your project to Manage Service for TimescaleDB's (Google) before Manage Service for TimescaleDB's backend can notice the peering is ready and traffic can be routed through it. After setting up your side, the VPC peering will activate shortly on the Timescale Cloud console. diff --git a/page-index/page-index.js b/page-index/page-index.js index 1d675f4d11f1..5c8e24f3764c 100644 --- a/page-index/page-index.js +++ b/page-index/page-index.js @@ -1,14 +1,14 @@ const apiReferencePageIndex = require('../api/page-index/page-index') const timescaleDbPageIndex = require('../timescaledb/page-index/page-index') -const timescaleForgePageIndex = require('../timescale-forge/page-index/page-index') -const timescaleCloudPageIndex = require('../timescale-cloud/page-index/page-index') +const timescaleCloudPageIndex = require('../cloud/page-index/page-index') +const timescaleMSTPageIndex = require('../mst/page-index/page-index') const promscalePageIndex = require('../promscale/page-index/page-index') module.exports = [ ...timescaleDbPageIndex, ...apiReferencePageIndex, - ...timescaleForgePageIndex, ...timescaleCloudPageIndex, + ...timescaleMSTPageIndex, ...promscalePageIndex, { Title: "GitHub", diff --git a/timescale-forge/scaling-a-service.md b/timescale-forge/scaling-a-service.md deleted file mode 100644 index 9cc10842b6e3..000000000000 --- a/timescale-forge/scaling-a-service.md +++ /dev/null @@ -1,61 +0,0 @@ -# Compute resources and disk size -You can use the Timescale Forge console to change how much CPU and memory -resources your service has available, as well as change the disk size for your -service. You can adjust this manually as required, or for disk size you can use autoscaling. - -## Change resource allocations manually -When you change the disk size, the changes are applied with no downtime, and the -new size generally becomes available within a few seconds. You can change the -disk size once every six hours, and you can only increase the size, not decrease -it. You can have a disk up to 10 TB in size. - -You can change the CPU and memory allocation for your service at any time, with -minimal downtime, usually less than thirty seconds. The new resources become -available as soon as the service restarts. You can change the CPU and memory -allocation up or down, as frequently as required. - - -Changing your compute settings usually requires a short downtime. Make sure you -plan for this before you begin! - - -### Procedure: Changing resource allocations manually -1. In the Timescale Forge console, from the `Services` list, click the name of - the service you want to modify. -1. In the `Service details` page, navigate to the `Operations` tab, and click - `Resources`. -1. In the `Resize CPU / memory` field, select the new CPU and memory - allocation. -1. In the `Increase disk size` field, adjust the slider to the new disk size. -1. Review the new allocations and costs in the comparison chart. -1. Click `Apply` to save your changes. If you have changed the CPU and memory - allocation, your service will go down briefly while the changes are applied. - Configure resource allocations - -## Configure autoscaling for disk size -Disk size autoscaling is enabled by default on most services. When you consume -95% or more of your existing disk space, disk size is automatically increased to -the next size available, up to a configurable limit. - -Autoscaling can change the disk size once every six hours. When the increase is -requested, the used space is optimized before the new limit is applied. As your -disk size increases, this optimization process can take longer, and the six -hours does not start running until the new size is applied, after the -optimization is complete. - -Autoscaling can only increase disk size, not decrease it. You can have a disk up -to 10 TB in size. - -### Procedure: Configuring autoscaling for disk size -1. In the Timescale Forge console, from the `Services` list, click the name of - the service you want to modify. -1. In the `Service overview` page, navigate to the `Operations` tab, and click - `Autoscaling`. -1. Toggle `Enable storage autoscaling` to turn autoscaling on or off. -1. In the `Storage autoscaling limit` field, adjust the slider to set the - maximum disk size. Autoscaling can not increase the disk size higher than - this limit. -1. Review the new allocations and costs in the comparison chart. -1. Click `Apply` to save your changes. The new disk size generally becomes - available within a few seconds. - Configure autoscaling disk size diff --git a/timescaledb/getting-started/access-timescaledb.md b/timescaledb/getting-started/access-timescaledb.md index 97d85ad3c1f8..0680f0615ece 100644 --- a/timescaledb/getting-started/access-timescaledb.md +++ b/timescaledb/getting-started/access-timescaledb.md @@ -1,6 +1,6 @@ # Access your database -Now that you have TimescaleDB setup and running in Timescale Forge, it's time +Now that you have TimescaleDB setup and running in Timescale Cloud, it's time to connect to your database. While this can be accomplished with many tools, `psql` is the standard command line interface for interacting with a PostgreSQL or TimescaleDB instance. @@ -28,9 +28,9 @@ in our How-to guides for [Installing `psql`](/timescaledb/latest/how-to-guides/c ## Connect to your TimescaleDB server Now that we've confirmed that `psql` is installed, it's time to connect to your -Timescale Forge instance. +Timescale Cloud instance. -In Timescale Forge, open the **Service Details** by clicking on the service +In Timescale Cloud, open the **Service Details** by clicking on the service that you created in [Step 1][launch-timescaledb]. Copy the **Service URL** from the information displayed. This service URL contains @@ -44,7 +44,7 @@ psql postgres://[USERNAME]:[PASSWORD]@[HOSTNAME]:[PORT]/[DATABASENAME]?sslmode=r ``` -Because the URL provided in the Timescale Forge interface does not supply the +Because the URL provided in the Timescale Cloud interface does not supply the password, you will be prompted for the password in order to finish authenticating. If you want to save yourself time, you can add the password to the URL by adding @@ -52,7 +52,7 @@ a colon and the password between the username and the hostname as shown in the placeholder above -Now that you've connected to your Timescale Forge service, let's look at how to +Now that you've connected to your Timescale Cloud service, let's look at how to quickly add data so that you can quickly start to explore the power of TimescaleDB. [install-psql]: /how-to-guides/connecting/psql/ diff --git a/timescaledb/getting-started/launch-timescaledb.md b/timescaledb/getting-started/launch-timescaledb.md index 994e4a02297a..265622869d53 100644 --- a/timescaledb/getting-started/launch-timescaledb.md +++ b/timescaledb/getting-started/launch-timescaledb.md @@ -1,11 +1,11 @@ # Launch your first instance -For this Getting Started tutorial we'll use Timescale Forge to get you up -and running quickly. Timescale Forge combines the power and reliability +For this Getting Started tutorial we'll use Timescale Cloud to get you up +and running quickly. Timescale Cloud combines the power and reliability of TimescaleDB with a fully-managed, cloud-native experience that is easy to start and less expensive to operate. -Creating a Timescale Forge account is fast and simple, allowing you to explore +Creating a Timescale Cloud account is fast and simple, allowing you to explore TimescaleDB free for 30 days, no credit card required. We're just excited that you are ready to dive into the world of time-series data with TimescaleDB! @@ -15,9 +15,9 @@ along with the rest of the _Getting Started_ tutorial, please see our documentat for [installing self-hosted TimescaleDB](/timescaledb/latest/how-to-guides/install-timescaledb/) -### Step 1: Create a Timescale Forge account +### Step 1: Create a Timescale Cloud account -Sign up for Timescale Forge by visiting [forge.timescale.com][forge-signup]. +Sign up for Timescale Cloud by visiting [console.cloud.timescale.com][cloud-signup]. Provide your full name, email address, and a strong password to start: @@ -30,14 +30,14 @@ and, failing that, please [contact us][contact-timescale]. ### Step 2: Create your first service After you complete account verification, you can visit the -[Timescale Forge console][forge-console] and login with your credentials. +[Timescale Cloud console][cloud-console] and login with your credentials. To begin, click 'Create service'. Set up a Timescale Forge service For the purposes of this tutorial, **you can simply select the default name, compute -and storage options**. But don't worry, if you want to do more with Timescale Forge +and storage options**. But don't worry, if you want to do more with Timescale Cloud after you've completed everything, you can always resize your service or create a new one in a few clicks! @@ -69,6 +69,6 @@ Now let's make sure you can connect to the database before we start adding data and learning about everything that TimescaleDB offers! [install-timescaledb]: /how-to-guides/install-timescaledb/ -[forge-signup]: https://forge.timescale.com -[forge-console]: https://console.forge.timescale.com/login +[cloud-signup]: https://cloud.timescale.com +[cloud-console]: https://console.cloud.timescale.com/login [contact-timescale]: https://www.timescale.com/contact diff --git a/timescaledb/getting-started/page-index/page-index.js b/timescaledb/getting-started/page-index/page-index.js index fcd6a5eecae1..c1394dd9da90 100644 --- a/timescaledb/getting-started/page-index/page-index.js +++ b/timescaledb/getting-started/page-index/page-index.js @@ -8,8 +8,8 @@ module.exports = [ title: "1. Launch your first instance", href: "launch-timescaledb", tags: ['learn', 'create', 'tsc'], - keywords: ['tutorial', 'Timescale Forge'], - excerpt: "Use Timescale Forge to launch your first TimescaleDB instance" + keywords: ['tutorial', 'Timescale Cloud'], + excerpt: "Use Timescale Cloud to launch your first TimescaleDB instance" }, { title: "2. Access your database", diff --git a/timescaledb/how-to-guides/install-timescaledb-toolkit.md b/timescaledb/how-to-guides/install-timescaledb-toolkit.md index 5450d78d291e..65e9a7b6f9dd 100644 --- a/timescaledb/how-to-guides/install-timescaledb-toolkit.md +++ b/timescaledb/how-to-guides/install-timescaledb-toolkit.md @@ -1,10 +1,10 @@ # Installing TimescaleDB Toolkit In order to use functions from the TimescaleDB Toolkit, you'll need to install -it. If you are using [Timescale Forge][] to host your database, the Toolkit is already +it. If you are using [Timescale Cloud][] to host your database, the Toolkit is already installed. -On [Timescale Cloud][] you may need to run `CREATE EXTENSION timescaledb_toolkit;` +On [Managed TimescaleDB][] you may need to run `CREATE EXTENSION timescaledb_toolkit;` in each database that you need to use the functions with. If you already have it installed and are updating to the latest version, run @@ -15,6 +15,6 @@ If you are hosting your own TimescaleDB database and need to install the Timesca Toolkit first, follow the instructions provided at the GitHub repo to [install it from source][install-source]. -[Timescale Forge]: /timescale-forge/:currentVersion:/ -[Timescale Cloud]: /timescale-cloud/:currentVersion:/ +[Timescale Cloud]: /cloud/:currentVersion:/ +[MST]: /mst/:currentVersion:/ [install-source]: https://github.com/timescale/timescaledb-toolkit#-installing-from-source \ No newline at end of file diff --git a/timescaledb/how-to-guides/install-timescaledb/installation-cloud.md b/timescaledb/how-to-guides/install-timescaledb/installation-cloud.md index bfebe342f3dd..2f7f492695ec 100644 --- a/timescaledb/how-to-guides/install-timescaledb/installation-cloud.md +++ b/timescaledb/how-to-guides/install-timescaledb/installation-cloud.md @@ -1,32 +1,25 @@ # Timescale Cloud -Timescale Cloud is a Database as a Service (DBaaS) offering that provides -an easy way for you to store and analyze time-series. +Timescale Cloud is a time-series platform that provides +a cloud-native experience for storing and analyzing time-series. Powered by TimescaleDB, you can create database instances in the cloud and automate many of your most common operational tasks. You can register for a Timescale Cloud account on the -[sign up][sign-up] page. Once you have a login, you can access -the Timescale Cloud [portal][portal]. - -After you create an account and login for the first time, -a default project is created for you. In this project is where -you create your first TimescaleDB service. +[sign up][sign-up] page. Timescale Cloud automatically gives you access to all the features and capabilities in [TimescaleDB](https://www.timescale.com/products). -Now that your database account is setup, it's time to -[setup Timescale Cloud][timescale-cloud-setup]. +Now that your database account is set up, it's time to +[set up Timescale Cloud][timescale-cloud-setup]. --- -[sign-up]: https://www.timescale.com/cloud-signup -[portal]: http://portal.timescale.cloud +[sign-up]: https://console.cloud.timescale.com/signup [timescale-features]: https://www.timescale.com/products -[timescale-cloud-setup]: /timescale-cloud/:currentVersion:/create-a-service -[intercom]: https://kb.timescale.cloud/ +[timescale-cloud-setup]: /cloud/:currentVersion:/create-a-service/ [contact]: https://www.timescale.com/contact [slack]: https://slack.timescale.com/ diff --git a/timescaledb/how-to-guides/install-timescaledb/installation-forge.md b/timescaledb/how-to-guides/install-timescaledb/installation-forge.md deleted file mode 100644 index 1e7a53615509..000000000000 --- a/timescaledb/how-to-guides/install-timescaledb/installation-forge.md +++ /dev/null @@ -1,25 +0,0 @@ -# Timescale Forge - -Timescale Forge is a time-series platform that provides -a cloud-native experience for storing and analyzing time-series. -Powered by TimescaleDB, you can create database instances in the cloud -and automate many of your most common operational tasks. - -You can register for a Timescale Forge account on the -[sign up][sign-up] page. - - -Timescale Forge automatically gives you access to all the features -and capabilities in [TimescaleDB](https://www.timescale.com/products). - - -Now that your database account is set up, it's time to -[set up Timescale Forge][timescale-forge-setup]. - ---- - -[sign-up]: https://forge.timescale.com/signup -[timescale-features]: https://www.timescale.com/products -[timescale-forge-setup]: /timescale-forge/:currentVersion:/create-a-service/ -[contact]: https://www.timescale.com/contact -[slack]: https://slack.timescale.com/ diff --git a/timescaledb/how-to-guides/install-timescaledb/installation-mst.md b/timescaledb/how-to-guides/install-timescaledb/installation-mst.md new file mode 100644 index 000000000000..75ec515b0c97 --- /dev/null +++ b/timescaledb/how-to-guides/install-timescaledb/installation-mst.md @@ -0,0 +1,32 @@ +# Managed Service for TimescaleDB + +Managed Service for TimescaleDB is a Database as a Service (DBaaS) offering that provides +an easy way for you to store and analyze time-series. +Powered by TimescaleDB, you can create database instances in the cloud +and automate many of your most common operational tasks. + +You can register for a Managed Service for TimescaleDB account on the +[sign up][sign-up] page. Once you have a login, you can access +the Managed Service for TimescaleDB [portal][portal]. + +After you create an account and login for the first time, +a default project is created for you. In this project is where +you create your first TimescaleDB service. + + +Managed Service for TimescaleDB automatically gives you access to all the features +and capabilities in [TimescaleDB](https://www.timescale.com/products). + + +Now that your database account is setup, it's time to +[setup Managed Service for TimescaleDB][mst-setup]. + +--- + +[sign-up]: https://www.timescale.com/cloud-signup +[portal]: http://portal.timescale.cloud +[timescale-features]: https://www.timescale.com/products +[mst-setup]: /mst/:currentVersion:/create-a-service +[intercom]: https://kb.timescale.cloud/ +[contact]: https://www.timescale.com/contact +[slack]: https://slack.timescale.com/ diff --git a/timescaledb/how-to-guides/install-timescaledb/managed-service-for-timescaledb.md b/timescaledb/how-to-guides/install-timescaledb/managed-service-for-timescaledb.md new file mode 100644 index 000000000000..34feca2098e3 --- /dev/null +++ b/timescaledb/how-to-guides/install-timescaledb/managed-service-for-timescaledb.md @@ -0,0 +1,183 @@ +# Exploring Managed Service for TimescaleDB + +Welcome to managed service for TimescaleDB. Managed service for TimescaleDB is a managed TimescaleDB service hosted +in 75+ regions in AWS, Azure, or GCP. You can [try managed service for TimescaleDB for free][sign-up], +no credit card required. + +Powered by [TimescaleDB][timescale-features], you can create database instances in the +cloud and automate many of your most common operational tasks. This allows you +to spend more time focusing on your time-series workloads and less time worrying +about database management. + +Before we start, let's review a few core concepts and phrases: + +- **Account**: Your managed service for TimescaleDB account. You can register for a managed service for TimescaleDB account on the [managed service for TimescaleDB signup][sign-up] page. +- **Project**: An empty Project is created for you automatically when you sign-up. Projects organize groups of Services, and have different billing settings. You can use Projects as a way to organize Services in your account and provide access to those Services with other users. +- **Service**: A Service is an instance that corresponds to a cloud service provider tier (e.g., AWS Timescale-Pro-512-IO-Optimized). You can access all your Services from the 'Services' tab for a given Project. +- **Database**: Databases are created within a Service. You can view and create a Database within a Service by selecting one of your Services, and then selecting the 'Databases' tab. +- **Service Plans**: A Service Plan defines the configuration and level of database management that will be performed for a given TimescaleDB deployment. + +### Step 1: Sign up for managed service for TimescaleDB + +Visit the [managed service for TimescaleDB signup page][sign-up] and supply your name, email address, and password. + +Once you've submitted the information, verify your account by clicking on the link in the +email you receive. If you don't receive this email shortly after submitting the form, +check your spam folder. + +### Step 2: Create your first service + +After you complete account verification, you can visit the [managed service for TimescaleDB portal][mst-portal] +and login with your credentials. + +You can create a new service by clicking on the `Create a new service` button. + +In the resulting screen, you'll see several options that enable you to choose: + +- **Service type**. Today, we support TimescaleDB and Grafana services. +- **Cloud provider**. We support Amazon Web Services, Google Cloud, or Microsoft Azure. +- **Cloud region**. We support most cloud regions offered by each cloud provider. +- **Service plan**. We support many common configurations of CPU, memory, storage, backup, and nodes. *If you're still a managed service for TimescaleDB trial user*, we recommend using the `Dev` plan as it will be most cost effective during your evaluation period. + + +During your managed service for TimescaleDB trial, you have up to $300 USD in credits to use. +This will be sufficient to complete all our tutorials and run a few test projects. + + +If you're interested in learning more about pricing of managed service for TimescaleDB, visit the +[managed service for TimescaleDB pricing calculator][timescale-pricing]. Or, [contact us][contact] +and we will be happy to walk you through the best managed service for TimescaleDB configuration +for your use cases. + +Once you've selected your service options, click `Create Service`. + +It will take a few minutes for your service to provision in your cloud. Now is +a good time to familiarize yourself with some of the [features of TimescaleDB][using-timescale] +and our [getting started tutorial][getting-started]. + +### Step 3: Install psql + +Nearly all of our tutorials require some working knowledge of `psql`, the command-line +utility for configuring and maintaining PostgreSQL. We recommend +[installing psql][install-psql]. + +### Step 4: Connect to your database using psql + +You will see a green `Running` label and a green dot under the "Nodes" column when +your instance is ready for use. + +Once your instance is ready, navigate to the ‘Overview Tab’ of your Timescale +Cloud dashboard and locate your `host`, `port`, and `password`, as highlighted below. + +NYC Taxis + +Afterward, connect to your managed service for TimescaleDB database from `psql` +by typing the command below into your terminal, +ensuring that you replace the {curly brackets} with your real +password, hostname, and port number found in the overview tab. + +```bash +psql -x "postgres://tsdbadmin:{YOUR_PASSWORD_HERE}@{YOUR_HOSTNAME_HERE}:{YOUR_PORT_HERE}/defaultdb?sslmode=require" +``` + +You should see the following connection message: + +```bash +psql (12.2, server 11.6) +SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, bits: 256, compression: off) +Type "help" for help. +tsdbadmin@defaultdb=> +``` + +### Step 5: Verify that TimescaleDB is installed + +To verify that TimescaleDB is installed, run the `\dx` command +to list all installed extensions to your PostgreSQL database. +You should see something similar to the following output: + +```sql + List of installed extensions +| Name | Version | Schema | Description | +|-------------|---------|------------|----------------------------------------------| +| plpgsql | 1.0 | pg_catalog | PL/pgSQL procedural language | +| timescaledb | 1.6.0 | public | Enables scalable inserts and complex queries | +``` + +### Step 6: Hello, Timescale! + +Congratulations! You are now up and running with managed service for TimescaleDB. In order to +familiarize yourself with the features and capabilities of the product, we +recommend that you complete the [Getting Started][getting-started] tutorial. + +--- + +## Advanced managed service for TimescaleDB Configuration + +### Securing network access to managed service for TimescaleDB + +One very critical piece of securing your database within managed service for TimescaleDB is network protection. + +TimescaleDB provides the ability to configure, in a fine-grained manner, the +set of source IP addresses and ranges, as well as connection ports, that can +access your managed service for TimescaleDB services. + +This tutorial will walk you through how to configure this capability. + +#### Before you start + +Be sure to follow the instructions to [setup managed service for TimescaleDB][mst-install] in order to +get signed up and create your first database instance. + +#### Step 1 - Navigate to your TimescaleDB instance + +Once you have a database instance setup in the [managed service for TimescaleDB portal][mst-portal], +browse to this service and click on the 'Overview' tab. In the 'Connection Information' +section, you will see the port number that is used for database connections. This is +the port we will protect by managing inbound access. + +Timescale Cloud Overview tab + +#### Step 2 - Find the allowed IP addresses section + +Scroll down to find the 'Allowed IP Addresses' section. By default, this value is set to +`0.0.0.0/0` which is actually wide-open. + + + This wide-open setting simplifies getting started since it will accept incoming + traffic from all sources, but you will absolutely want to narrow this range. + + +If you are curious about how to interpret this [Classless Inter-Domain Routing][cidr-wiki] (CIDR) syntax, +check out [this great online tool][cidr-tool] to help decipher CIDR. + +Allowed IP addresses + +#### Step 3 - Change the allowed IP addresses section + +Click 'Change' and adjust the CIDR value based on where your source traffic will come from. +For example, entering a value of `192.168.1.15/32` will ONLY allow incoming traffic from a +source IP of `192.168.1.15` and will deny all other traffic. + +#### Step 4 - Save your changes +Click 'Save Changes' and see this take effect immediately. + +#### Conclusion +Limiting IP address inbound access is just one option to improve the security of your Timescale +Cloud database instance. There are many other types of security measures you should take into +account when securing your data. To learn more about security options within managed service for TimescaleDB, +visit the [managed service for TimescaleDB Knowledge Base][mst-kb]. + + +[mst-install]: /how-to-guides/install-timescaledb//mst/installation-mst +[cidr-wiki]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing +[cidr-tool]: http://www.subnet-calculator.com/cidr.php +[mst-kb]: https://kb.timescale.cloud/en/collections/1600092-security +[mst-portal]: http://portal.timescale.cloud +[sign-up]: https://www.timescale.com/cloud-signup +[timescale-features]: https://www.timescale.com/products +[timescale-pricing]: https://www.timescale.com/products#cloud-pricing +[contact]: https://www.timescale.com/contact +[using-timescale]: /overview/core-concepts/ +[hello-timescale]: /tutorials/tutorial-hello-timescale +[install-psql]: /how-to-guides/connecting/psql/ + diff --git a/timescaledb/how-to-guides/install-timescaledb/timescale-cloud.md b/timescaledb/how-to-guides/install-timescaledb/timescale-cloud.md index 14b1903fe932..ef0a11da5ece 100644 --- a/timescaledb/how-to-guides/install-timescaledb/timescale-cloud.md +++ b/timescaledb/how-to-guides/install-timescaledb/timescale-cloud.md @@ -1,183 +1,139 @@ # Exploring Timescale Cloud -Welcome to Timescale Cloud. Timescale Cloud is a managed TimescaleDB service hosted -in 75+ regions in AWS, Azure, or GCP. You can [try Timescale Cloud for free][sign-up], -no credit card required. +Welcome to Timescale Cloud! Timescale Cloud is a cloud-native TimescaleDB +as a service that is easy to get started and powerful enough for the most +demanding scenarios. You can +[try Timescale Cloud for free][cloud-signup], no credit card required. -Powered by [TimescaleDB][timescale-features], you can create database instances in the -cloud and automate many of your most common operational tasks. This allows you -to spend more time focusing on your time-series workloads and less time worrying -about database management. +This tutorial will walk you through setting up your Timescale Cloud account and +completing your first tutorial project. -Before we start, let's review a few core concepts and phrases: +### Step 1: Create a Timescale Cloud account [](step1-create-account) -- **Account**: Your Timescale Cloud account. You can register for a Timescale Cloud account on the [Timescale Cloud signup][sign-up] page. -- **Project**: An empty Project is created for you automatically when you sign-up. Projects organize groups of Services, and have different billing settings. You can use Projects as a way to organize Services in your account and provide access to those Services with other users. -- **Service**: A Service is an instance that corresponds to a cloud service provider tier (e.g., AWS Timescale-Pro-512-IO-Optimized). You can access all your Services from the 'Services' tab for a given Project. -- **Database**: Databases are created within a Service. You can view and create a Database within a Service by selecting one of your Services, and then selecting the 'Databases' tab. -- **Service Plans**: A Service Plan defines the configuration and level of database management that will be performed for a given TimescaleDB deployment. +Sign up for Timescale Cloud by visiting [console.cloud.timescale.com][cloud-signup]. -### Step 1: Sign up for Timescale Cloud +Provide your full name, email address, and a strong password to start: -Visit the [Timescale Cloud signup page][sign-up] and supply your name, email address, and password. +Sign up for Timescale Forge -Once you've submitted the information, verify your account by clicking on the link in the -email you receive. If you don't receive this email shortly after submitting the form, -check your spam folder. +You will need to confirm your account by clicking the link you receive via +email. If you do not receive this link, please first check your spam folder +and, failing that, please [contact us][contact-timescale]. -### Step 2: Create your first service +### Step 2: Create your first service [](step2-create-service) -After you complete account verification, you can visit the [Timescale Cloud portal][timescale-cloud-portal] -and login with your credentials. + After you complete account verification, you can visit the + [Timescale Cloud console][cloud-console] and login with your credentials. -You can create a new service by clicking on the `Create a new service` button. + To begin, click 'Create service'. -In the resulting screen, you'll see several options that enable you to choose: +Set up a Timescale Forge service -- **Service type**. Today, we support TimescaleDB and Grafana services. -- **Cloud provider**. We support Amazon Web Services, Google Cloud, or Microsoft Azure. -- **Cloud region**. We support most cloud regions offered by each cloud provider. -- **Service plan**. We support many common configurations of CPU, memory, storage, backup, and nodes. *If you're still a Timescale Cloud trial user*, we recommend using the `Dev` plan as it will be most cost effective during your evaluation period. +1. First, supply your service name (e.g., `acmecorp-test` or `acmecorp-dev`). +1. Next, choose your CPU and memory configuration, from (0.25 CPU, 1GB RAM) to +(8 CPU, 32 GB RAM). +1. Select your storage requirements, from 10 GB to 1 TB. Note that with TimescaleDB +compression, this is typically equivalent to 170 GB to 67+ TB of uncompressed +storage (although compression rates can vary based on your data). +1. Note the estimated cost of running your chosen configuration. Feel free to +[contact us][contact-timescale] if you would like to discuss pricing and +configuration options best suited for your use case. +1. Click 'Create service' once your configuration is complete. -During your Timescale Cloud trial, you have up to $300 USD in credits to use. -This will be sufficient to complete all our tutorials and run a few test projects. +Don't worry if too much about the size settings that you choose initially. With +Timescale Cloud, it's easy to modify both the compute (CPU/Memory) and storage +associated with the service that you just created. As you get to know +TimescaleDB and how your data processing needs vary, it's easy to +[right-size your service with a few clicks](#cloud-resize)! -If you're interested in learning more about pricing of Timescale Cloud, visit the -[Timescale Cloud pricing calculator][timescale-pricing]. Or, [contact us][contact] -and we will be happy to walk you through the best Timescale Cloud configuration -for your use cases. +After you select 'Create service', you will see confirmation of your service account and +password information. You should save the information in this confirmation screen in +a safe place: -Once you've selected your service options, click `Create Service`. +View Timescale Forge service information -It will take a few minutes for your service to provision in your cloud. Now is -a good time to familiarize yourself with some of the [features of TimescaleDB][using-timescale] -and our [getting started tutorial][getting-started]. - -### Step 3: Install psql - -Nearly all of our tutorials require some working knowledge of `psql`, the command-line -utility for configuring and maintaining PostgreSQL. We recommend -[installing psql][install-psql]. - -### Step 4: Connect to your database using psql - -You will see a green `Running` label and a green dot under the "Nodes" column when -your instance is ready for use. - -Once your instance is ready, navigate to the ‘Overview Tab’ of your Timescale -Cloud dashboard and locate your `host`, `port`, and `password`, as highlighted below. - -NYC Taxis - -Afterward, connect to your Timescale Cloud database from `psql` -by typing the command below into your terminal, -ensuring that you replace the {curly brackets} with your real -password, hostname, and port number found in the overview tab. - -```bash -psql -x "postgres://tsdbadmin:{YOUR_PASSWORD_HERE}@{YOUR_HOSTNAME_HERE}:{YOUR_PORT_HERE}/defaultdb?sslmode=require" -``` - -You should see the following connection message: + + If you forget your password in the future, you can reset your password from the *service dashboard*. + -```bash -psql (12.2, server 11.6) -SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, bits: 256, compression: off) -Type "help" for help. -tsdbadmin@defaultdb=> -``` +It will take a couple minutes for your service to be provisioned. When your database is +ready for connection, you should see a green `Running` label above the service in the +service dashboard. -### Step 5: Verify that TimescaleDB is installed +View all Timescale Forge services -To verify that TimescaleDB is installed, run the `\dx` command -to list all installed extensions to your PostgreSQL database. -You should see something similar to the following output: +Select any service to view *service details*. You can obtain connection, +configuration, and utilization information. In addition, you can reset the +password for your service, power down or power up any service (which stops +or starts your compute, although your storage persists), or delete +a service altogether. -```sql - List of installed extensions -| Name | Version | Schema | Description | -|-------------|---------|------------|----------------------------------------------| -| plpgsql | 1.0 | pg_catalog | PL/pgSQL procedural language | -| timescaledb | 1.6.0 | public | Enables scalable inserts and complex queries | -``` +View Timescale Forge service information -### Step 6: Hello, Timescale! +### Step 3: Complete your first tutorial [](step3-tutorial) Congratulations! You are now up and running with Timescale Cloud. In order to familiarize yourself with the features and capabilities of the product, we recommend that you complete the [Getting Started][getting-started] tutorial. ---- - -## Advanced Timescale Cloud Configuration +To simplify operations with TimescaleDB, each Timescale Cloud service comprises a +single "database" per PostgreSQL terminology, and all Timescale Cloud services +come with TimescaleDB already installed. So skip the `CREATE DATABASE` step +and the "adding the TimescaleDB extension" step of the tutorial and +jump right to the "Define your data schema" section of the [Getting Started][getting-started] +tutorial. Wherever the instructions indicate that you should use the `nyc_data` +database, use `tsdb` instead. `tsdb` is the default database name for every +Timescale Cloud service. And if you need another database, it's just a click away. -### Securing network access to Timescale Cloud +### Step 4: Learn more about TimescaleDB -One very critical piece of securing your database within Timescale Cloud is network protection. +Read about TimescaleDB features in our documentation: -TimescaleDB provides the ability to configure, in a fine-grained manner, the -set of source IP addresses and ranges, as well as connection ports, that can -access your Timescale Cloud services. +- Create your first ”[hypertable][hypertable-info]”. +- Run your first query using [time_bucket()][time-bucket-info]. +- Trying more advanced time-series functions, starting with [gap filling][gap-filling-info] or [real-time aggregates][aggregates-info]. -This tutorial will walk you through how to configure this capability. +### Step 5: Keep testing during your free trial and enter your billing information when you're ready -#### Before you start +You're now on your way to a great start with Timescale! -Be sure to follow the instructions to [setup Timescale Cloud][timescale-cloud-install] in order to -get signed up and create your first database instance. +You will have an unthrottled, 30-day free trial with Timescale Cloud to +continue to test your use case. Before the end of your trial, we encourage you +to add your credit card information. This will ensure a smooth transition after +your trial period concludes. -#### Step 1 - Navigate to your TimescaleDB instance +### Summary -Once you have a database instance setup in the [Timescale Cloud portal][timescale-cloud-portal], -browse to this service and click on the 'Overview' tab. In the 'Connection Information' -section, you will see the port number that is used for database connections. This is -the port we will protect by managing inbound access. +We're excited to play a small part in helping you build a best-in-class +time-series application or monitoring tool. If you have any questions, please +feel free to [join our community Slack group][slack-info] +or [contact us][contact-timescale] directly. -Timescale Cloud Overview tab +Now, it's time to cloud! -#### Step 2 - Find the allowed IP addresses section +## Advanced configuration and multi-node setup -Scroll down to find the 'Allowed IP Addresses' section. By default, this value is set to -`0.0.0.0/0` which is actually wide-open. +Timescale Cloud is a versatile hosting service that provides a growing list of +advanced features for your PostgreSQL and time-series data workloads. - - This wide-open setting simplifies getting started since it will accept incoming - traffic from all sources, but you will absolutely want to narrow this range. - - -If you are curious about how to interpret this [Classless Inter-Domain Routing][cidr-wiki] (CIDR) syntax, -check out [this great online tool][cidr-tool] to help decipher CIDR. - -Allowed IP addresses - -#### Step 3 - Change the allowed IP addresses section - -Click 'Change' and adjust the CIDR value based on where your source traffic will come from. -For example, entering a value of `192.168.1.15/32` will ONLY allow incoming traffic from a -source IP of `192.168.1.15` and will deny all other traffic. +Please see additional documentation on how to: + * [Resize compute and storage][resize] at any time! + * [Customize your database configuration][configuration] easily! + * [Create a TimescaleDB multi-node cluster][multi-node] in Timescale Cloud! -#### Step 4 - Save your changes -Click 'Save Changes' and see this take effect immediately. - -#### Conclusion -Limiting IP address inbound access is just one option to improve the security of your Timescale -Cloud database instance. There are many other types of security measures you should take into -account when securing your data. To learn more about security options within Timescale Cloud, -visit the [Timescale Cloud Knowledge Base][timescale-cloud-kb]. - - -[timescale-cloud-install]: /how-to-guides/install-timescaledb//timescale-cloud/installation-timescale-cloud -[cidr-wiki]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing -[cidr-tool]: http://www.subnet-calculator.com/cidr.php -[timescale-cloud-kb]: https://kb.timescale.cloud/en/collections/1600092-security -[timescale-cloud-portal]: http://portal.timescale.cloud -[sign-up]: https://www.timescale.com/cloud-signup -[timescale-features]: https://www.timescale.com/products -[timescale-pricing]: https://www.timescale.com/products#cloud-pricing -[contact]: https://www.timescale.com/contact -[using-timescale]: /overview/core-concepts/ -[hello-timescale]: /tutorials/tutorial-hello-timescale +[cloud-signup]: https://console.cloud.timescale.com +[billing-info]: /cloud/managing-billing-payments +[slack-info]: https://slack-login.timescale.com [install-psql]: /how-to-guides/connecting/psql/ - +[hello-timescale]: /tutorials/tutorial-hello-timescale +[cloud-console]: https://console.cloud.timescale.com/login +[contact-timescale]: https://www.timescale.com/contact +[hypertable-info]: /how-to-guides/hypertables +[time-bucket-info]: /how-to-guides/query-data/advanced-analytic-queries#time-bucket +[gap-filling-info]: /how-to-guides/query-data/advanced-analytic-queries#gap-filling +[aggregates-info]: https://docs.timescale.com/latest/tutorials/continuous-aggs-tutorial +[resize]: /getting-started/exploring-cloud/cloud-resize +[configuration]: /getting-started/exploring-cloud/cloud-configuration +[multi-node]: /getting-started/exploring-cloud/cloud-multi-node diff --git a/timescaledb/how-to-guides/install-timescaledb/timescale-forge.md b/timescaledb/how-to-guides/install-timescaledb/timescale-forge.md deleted file mode 100644 index 881bd2b90983..000000000000 --- a/timescaledb/how-to-guides/install-timescaledb/timescale-forge.md +++ /dev/null @@ -1,139 +0,0 @@ -# Exploring Timescale Forge - -Welcome to Timescale Forge! Timescale Forge is a cloud-native TimescaleDB -as a service that is easy to get started and powerful enough for the most -demanding scenarios. You can -[try Timescale Forge for free][forge-signup], no credit card required. - -This tutorial will walk you through setting up your Timescale Forge account and -completing your first tutorial project. - -### Step 1: Create a Timescale Forge account [](step1-create-account) - -Sign up for Timescale Forge by visiting [forge.timescale.com][forge-signup]. - -Provide your full name, email address, and a strong password to start: - -Sign up for Timescale Forge - -You will need to confirm your account by clicking the link you receive via -email. If you do not receive this link, please first check your spam folder -and, failing that, please [contact us][contact-timescale]. - -### Step 2: Create your first service [](step2-create-service) - - After you complete account verification, you can visit the - [Timescale Forge console][forge-console] and login with your credentials. - - To begin, click 'Create service'. - -Set up a Timescale Forge service - -1. First, supply your service name (e.g., `acmecorp-test` or `acmecorp-dev`). -1. Next, choose your CPU and memory configuration, from (0.25 CPU, 1GB RAM) to -(8 CPU, 32 GB RAM). -1. Select your storage requirements, from 10 GB to 1 TB. Note that with TimescaleDB -compression, this is typically equivalent to 170 GB to 67+ TB of uncompressed -storage (although compression rates can vary based on your data). -1. Note the estimated cost of running your chosen configuration. Feel free to -[contact us][contact-timescale] if you would like to discuss pricing and -configuration options best suited for your use case. -1. Click 'Create service' once your configuration is complete. - - -Don't worry if too much about the size settings that you choose initially. With -Timescale Forge, it's easy to modify both the compute (CPU/Memory) and storage -associated with the service that you just created. As you get to know -TimescaleDB and how your data processing needs vary, it's easy to -[right-size your service with a few clicks](#forge-resize)! - - -After you select 'Create service', you will see confirmation of your service account and -password information. You should save the information in this confirmation screen in -a safe place: - -View Timescale Forge service information - - - If you forget your password in the future, you can reset your password from the *service dashboard*. - - -It will take a couple minutes for your service to be provisioned. When your database is -ready for connection, you should see a green `Running` label above the service in the -service dashboard. - -View all Timescale Forge services - -Select any service to view *service details*. You can obtain connection, -configuration, and utilization information. In addition, you can reset the -password for your service, power down or power up any service (which stops -or starts your compute, although your storage persists), or delete -a service altogether. - -View Timescale Forge service information - -### Step 3: Complete your first tutorial [](step3-tutorial) - -Congratulations! You are now up and running with Timescale Forge. In order to -familiarize yourself with the features and capabilities of the product, we -recommend that you complete the [Getting Started][getting-started] tutorial. - -To simplify operations with TimescaleDB, each Timescale Forge service comprises a -single "database" per PostgreSQL terminology, and all Timescale Forge services -come with TimescaleDB already installed. So skip the `CREATE DATABASE` step -and the "adding the TimescaleDB extension" step of the tutorial and -jump right to the "Define your data schema" section of the [Getting Started][getting-started] -tutorial. Wherever the instructions indicate that you should use the `nyc_data` -database, use `tsdb` instead. `tsdb` is the default database name for every -Timescale Forge service. And if you need another database, it's just a click away. - -### Step 4: Learn more about TimescaleDB - -Read about TimescaleDB features in our documentation: - -- Create your first ”[hypertable][hypertable-info]”. -- Run your first query using [time_bucket()][time-bucket-info]. -- Trying more advanced time-series functions, starting with [gap filling][gap-filling-info] or [real-time aggregates][aggregates-info]. - -### Step 5: Keep testing during your free trial and enter your billing information when you're ready - -You're now on your way to a great start with Timescale! - -You will have an unthrottled, 30-day free trial with Timescale Forge to -continue to test your use case. Before the end of your trial, we encourage you -to add your credit card information. This will ensure a smooth transition after -your trial period concludes. - -### Summary - -We're excited to play a small part in helping you build a best-in-class -time-series application or monitoring tool. If you have any questions, please -feel free to [join our community Slack group][slack-info] -or [contact us][contact-timescale] directly. - -Now, it's time to forge! - -## Advanced configuration and multi-node setup - -Timescale Forge is a versatile hosting service that provides a growing list of -advanced features for your PostgreSQL and time-series data workloads. - -Please see additional documentation on how to: - * [Resize compute and storage][resize] at any time! - * [Customize your database configuration][configuration] easily! - * [Create a TimescaleDB multi-node cluster][multi-node] in Timescale Forge! - -[forge-signup]: https://forge.timescale.com -[billing-info]: /forge/managing-billing-payments -[slack-info]: https://slack-login.timescale.com -[install-psql]: /how-to-guides/connecting/psql/ -[hello-timescale]: /tutorials/tutorial-hello-timescale -[forge-console]: https://console.forge.timescale.com/login -[contact-timescale]: https://www.timescale.com/contact -[hypertable-info]: /how-to-guides/hypertables -[time-bucket-info]: /how-to-guides/query-data/advanced-analytic-queries#time-bucket -[gap-filling-info]: /how-to-guides/query-data/advanced-analytic-queries#gap-filling -[aggregates-info]: https://docs.timescale.com/latest/tutorials/continuous-aggs-tutorial -[resize]: /getting-started/exploring-forge/forge-resize -[configuration]: /getting-started/exploring-forge/forge-configuration -[multi-node]: /getting-started/exploring-forge/forge-multi-node diff --git a/timescaledb/how-to-guides/multi-node-setup/index.md b/timescaledb/how-to-guides/multi-node-setup/index.md index 0322e91871cf..fd2d5b315400 100644 --- a/timescaledb/how-to-guides/multi-node-setup/index.md +++ b/timescaledb/how-to-guides/multi-node-setup/index.md @@ -24,8 +24,8 @@ instructions in this section. If you would like to give multi-node a try without the management overhead, you can [setup and explore a multi-node cluster in Timescale -Forge][multi_node_forge], our fully managed database -service. [Sign-up for your free](https://forge.timescale.com/signup), 30-day +Cloud][multi_node_cloud], our fully managed database +service. [Sign-up for your free](https://console.cloud.timescale.com/signup), 30-day trial and get started today! @@ -33,4 +33,4 @@ trial and get started today! [install]: /how-to-guides/install-timescaledb [setup]: /how-to-guides/install-timescaledb/post-install-setup [Core Concepts]: /overview/core-concepts/ -[multi_node_forge]: /timescale-forge/:currentVersion:/forge-multi-node +[multi_node_cloud]: /cloud/:currentVersion:/cloud-multi-node diff --git a/timescaledb/how-to-guides/page-index/page-index.js b/timescaledb/how-to-guides/page-index/page-index.js index 21e3af96344d..c3c12f89207a 100644 --- a/timescaledb/how-to-guides/page-index/page-index.js +++ b/timescaledb/how-to-guides/page-index/page-index.js @@ -1,806 +1,941 @@ module.exports = [ - { - title: "How-to Guides", - href: "how-to-guides", + { + title: 'How-to Guides', + href: 'how-to-guides', pageComponents: ['content-list'], children: [ { - title: "Install TimescaleDB", - href: "install-timescaledb", + title: 'Install TimescaleDB', + href: 'install-timescaledb', pageComponents: ['featured-cards'], tags: ['timescaledb', 'install'], keywords: ['install', 'TimescaleDB'], excerpt: 'Install TimescaleDB', children: [ { - title: "Timescale Forge", - href: "installation-forge", - tags: ['tsf', 'install'], - keywords: ['install', 'Timescale Forge'], - excerpt: 'Install Timescale Forge' - }, - { + title: 'Timescale Cloud', + href: 'installation-cloud', title: "Timescale Cloud", href: "installation-cloud", tags: ['tsc', 'install'], keywords: ['install', 'Timescale Cloud'], - excerpt: 'Install Timescale Cloud', + excerpt: 'Install Timescale Cloud' }, { - title: "Self hosted (including containers)", - href: "self-hosted", + title: "Managed Service for TimescaleDB", + href: "installation-mst", + tags: ['mst', 'install'], + keywords: ['install', 'Managed Service for TimescaleDB'], + excerpt: 'Install a managed service for TimescaleDB', + }, + { + title: 'Self hosted (including containers)', + href: 'self-hosted', type: 'react-page', - options: { pg_version: ["12", "11"] }, - component: "InstallationPage", + options: { pg_version: ['12', '11'] }, + component: 'InstallationPage', showNewsletterForm: true, tags: ['install', 'timescaledb'], keywords: ['TimescaleDB', 'install', 'self-hosted'], excerpt: 'Install self-hosted TimescaleDB', children: [ { - title: "Docker", + title: 'Docker', type: 'redirect-to-child-page', - href: "docker", - iconSrc: "//assets.iobeam.com/images/docs/moby.png", + href: 'docker', + iconSrc: '//assets.iobeam.com/images/docs/moby.png', children: [ { - title: "Docker", + title: 'Docker', type: 'non-menu-page', - href: "installation-docker", + href: 'installation-docker', tags: ['install', 'docker', 'timescaledb'], - keywords: ['TimescaleDB', 'install', 'self-hosted', 'Docker'], - excerpt: 'Install self-hosted TimescaleDB with Docker' + keywords: [ + 'TimescaleDB', + 'install', + 'self-hosted', + 'Docker', + ], + excerpt: 'Install self-hosted TimescaleDB with Docker', }, ], }, { - title: "Ubuntu", + title: 'Ubuntu', type: 'redirect-to-child-page', - href: "ubuntu", - iconSrc: "//assets.iobeam.com/images/docs/cof_orange_hex.svg", + href: 'ubuntu', + iconSrc: '//assets.iobeam.com/images/docs/cof_orange_hex.svg', children: [ { - title: "apt", + title: 'apt', type: 'non-menu-page', - href: "installation-apt-ubuntu", + href: 'installation-apt-ubuntu', tags: ['install', 'ubuntu', 'apt', 'timescaledb'], - keywords: ['TimescaleDB', 'install', 'self-hosted', 'Ubuntu'], - excerpt: 'Install self-hosted TimescaleDB on Ubuntu using apt' + keywords: [ + 'TimescaleDB', + 'install', + 'self-hosted', + 'Ubuntu', + ], + excerpt: + 'Install self-hosted TimescaleDB on Ubuntu using apt', }, { - title: "Source (Ubuntu)", + title: 'Source (Ubuntu)', type: 'non-menu-page', - href: "installation-source", + href: 'installation-source', }, ], }, { - title: "Debian", + title: 'Debian', type: 'redirect-to-child-page', - href: "debian", - iconSrc: "//assets.iobeam.com/images/docs/Debian_logo.svg", + href: 'debian', + iconSrc: '//assets.iobeam.com/images/docs/Debian_logo.svg', children: [ { - title: "apt (Debian)", + title: 'apt (Debian)', type: 'non-menu-page', - href: "installation-apt-debian", + href: 'installation-apt-debian', tags: ['install', 'debian', 'apt', 'timescaledb'], - keywords: ['TimescaleDB', 'install', 'self-hosted', 'Debian'], - excerpt: 'Install self-hosted TimescaleDB on Debian using apt' + keywords: [ + 'TimescaleDB', + 'install', + 'self-hosted', + 'Debian', + ], + excerpt: + 'Install self-hosted TimescaleDB on Debian using apt', }, { - title: "Source (Debian)", + title: 'Source (Debian)', type: 'non-menu-page', - href: "installation-source", + href: 'installation-source', tags: ['install', 'debian', 'source', 'timescaledb'], - keywords: ['TimescaleDB', 'install', 'self-hosted', 'Debian'], - excerpt: 'Install self-hosted TimescaleDB on Debian from source' + keywords: [ + 'TimescaleDB', + 'install', + 'self-hosted', + 'Debian', + ], + excerpt: + 'Install self-hosted TimescaleDB on Debian from source', }, ], }, { - title: "RHEL/CentOS", + title: 'RHEL/CentOS', type: 'redirect-to-child-page', - href: "rhel-centos", - iconSrc: "//assets.iobeam.com/images/docs/Centos_Red_Hat_logo.svg", + href: 'rhel-centos', + iconSrc: + '//assets.iobeam.com/images/docs/Centos_Red_Hat_logo.svg', children: [ { - title: "yum/dnf", + title: 'yum/dnf', type: 'non-menu-page', - href: "installation-yum", + href: 'installation-yum', tags: ['install', 'rhel', 'centos', 'yum', 'timescaledb'], - keywords: ['TimescaleDB', 'install', 'self-hosted', 'RHEL', 'CentOS'], - excerpt: 'Install self-hosted TimescaleDB on Red Hat or CentOS using yum or dnf' + keywords: [ + 'TimescaleDB', + 'install', + 'self-hosted', + 'RHEL', + 'CentOS', + ], + excerpt: + 'Install self-hosted TimescaleDB on Red Hat or CentOS using yum or dnf', }, { - title: "Source (Red Hat or CentOS)", + title: 'Source (Red Hat or CentOS)', type: 'non-menu-page', - href: "installation-source", - tags: ['install', 'rhel', 'centos', 'source', 'timescaledb'], - keywords: ['TimescaleDB', 'install', 'self-hosted', 'RHEL', 'CentOS'], - excerpt: 'Install self-hosted TimescaleDB on Red Hat or CentOS from source' + href: 'installation-source', + tags: [ + 'install', + 'rhel', + 'centos', + 'source', + 'timescaledb', + ], + keywords: [ + 'TimescaleDB', + 'install', + 'self-hosted', + 'RHEL', + 'CentOS', + ], + excerpt: + 'Install self-hosted TimescaleDB on Red Hat or CentOS from source', }, ], }, { - title: "Windows", + title: 'Windows', type: 'redirect-to-child-page', - href: "windows", - iconSrc: "//assets.iobeam.com/images/docs/Windows_logo_-_2012.svg", + href: 'windows', + iconSrc: + '//assets.iobeam.com/images/docs/Windows_logo_-_2012.svg', children: [ { - title: "Installer (.zip)", + title: 'Installer (.zip)', type: 'non-menu-page', - href: "installation-windows", + href: 'installation-windows', tags: ['install', 'mswin', 'exe', 'timescaledb'], - keywords: ['TimescaleDB', 'install', 'self-hosted', 'MS Windows',], - excerpt: 'Install self-hosted TimescaleDB on Microsoft Windows using a zipped .exe file' + keywords: [ + 'TimescaleDB', + 'install', + 'self-hosted', + 'MS Windows', + ], + excerpt: + 'Install self-hosted TimescaleDB on Microsoft Windows using a zipped .exe file', }, { - title: "Source (Windows)", + title: 'Source (Windows)', type: 'non-menu-page', - href: "installation-source-windows", + href: 'installation-source-windows', tags: ['install', 'mswin', 'exe', 'source', 'timescaledb'], - keywords: ['TimescaleDB', 'install', 'self-hosted', 'MS Windows'], - excerpt: 'Install self-hosted TimescaleDB on Microsoft Windows from source' + keywords: [ + 'TimescaleDB', + 'install', + 'self-hosted', + 'MS Windows', + ], + excerpt: + 'Install self-hosted TimescaleDB on Microsoft Windows from source', }, ], }, { - title: "AMI", + title: 'AMI', type: 'redirect-to-child-page', - href: "ami", - iconSrc: "//assets.iobeam.com/images/docs/aws_logo.svg", + href: 'ami', + iconSrc: '//assets.iobeam.com/images/docs/aws_logo.svg', children: [ { - title: "Amazon AMI (Ubuntu)", + title: 'Amazon AMI (Ubuntu)', type: 'non-menu-page', - href: "installation-ubuntu-ami", + href: 'installation-ubuntu-ami', tags: ['install', 'aws', 'ami', 'ubuntu', 'Timescaledb'], - keywords: ['TimescaleDB', 'install', 'self-hosted', 'AWS', 'AMI', 'Ubuntu'], - excerpt: 'Install self-hosted TimescaleDB on Amazon with an Ubuntu AMI' + keywords: [ + 'TimescaleDB', + 'install', + 'self-hosted', + 'AWS', + 'AMI', + 'Ubuntu', + ], + excerpt: + 'Install self-hosted TimescaleDB on Amazon with an Ubuntu AMI', }, ], }, { - title: "MacOS", + title: 'MacOS', type: 'redirect-to-child-page', - href: "macos", - iconSrc: "//assets.iobeam.com/images/docs/Apple_logo_black.svg", + href: 'macos', + iconSrc: '//assets.iobeam.com/images/docs/Apple_logo_black.svg', children: [ { - title: "Homebrew", + title: 'Homebrew', type: 'non-menu-page', - href: "installation-homebrew", + href: 'installation-homebrew', tags: ['install', 'macos', 'homebrew', 'timescaledb'], - keywords: ['timescaledb', 'install', 'self-hosted', 'MacOS', 'homebrew'], - excerpt: 'Install self-hosted TimescaleDB on MacOS using homebrew' + keywords: [ + 'timescaledb', + 'install', + 'self-hosted', + 'MacOS', + 'homebrew', + ], + excerpt: + 'Install self-hosted TimescaleDB on MacOS using homebrew', }, { - title: "Source (MacOS)", + title: 'Source (MacOS)', type: 'non-menu-page', - href: "installation-source", + href: 'installation-source', tags: ['install', 'macos', 'source', 'timescaledb'], - keywords: ['TimescaleDB', 'install', 'self-hosted', 'MacOS'], - excerpt: 'Install self-hosted TimescaleDB on MacOS from source' + keywords: [ + 'TimescaleDB', + 'install', + 'self-hosted', + 'MacOS', + ], + excerpt: + 'Install self-hosted TimescaleDB on MacOS from source', }, ], - } + }, ], }, { - title: "Post-install setup", - href: "post-install-setup", + title: 'Post-install setup', + href: 'post-install-setup', tags: ['install', 'setup', 'selfhosted', 'timescaledb'], keywords: ['TimescaleDB', 'install', 'setup', 'self-hosted'], - excerpt: 'Set up self-hosted TimescaleDB after installation' - } - ] + excerpt: 'Set up self-hosted TimescaleDB after installation', + }, + ], }, { - title: "Install TimescaleDB Toolkit", - href: "install-timescaledb-toolkit", + title: 'Install TimescaleDB Toolkit', + href: 'install-timescaledb-toolkit', tags: ['toolkit', 'install', 'timescaledb'], keywords: ['TimescaleDB', 'install', 'toolkit'], - excerpt: 'Install the TimescaleDB toolkit' + excerpt: 'Install the TimescaleDB toolkit', }, { - title: "Connecting to TimescaleDB", - href: "connecting", + title: 'Connecting to TimescaleDB', + href: 'connecting', tags: ['toolkit', 'install', 'timescaledb'], keywords: ['TimescaleDB', 'install', 'toolkit'], excerpt: 'Connect to the TimescaleDB toolkit', children: [ - { - href: "psql", - } - ] + { + href: 'psql', + }, + ], }, { - href: "hypertables", + href: 'hypertables', children: [ { - title: "CREATE", - href: "create", + title: 'CREATE', + href: 'create', tags: ['hypertables', 'create', 'timescaledb'], keywords: ['hypertables', 'TimescaleDB'], - excerpt: 'Create hypertables' + excerpt: 'Create hypertables', }, { - title: "ALTER", - href: "alter", + title: 'ALTER', + href: 'alter', tags: ['hypertables', 'edit', 'timescaledb'], keywords: ['hypertables', 'TimescaleDB'], - excerpt: 'Alter hypertables' + excerpt: 'Alter hypertables', }, { - title: "DROP", - href: "drop", + title: 'DROP', + href: 'drop', tags: ['hypertables', 'delete', 'timescaledb'], keywords: ['hypertables', 'TimescaleDB'], - excerpt: 'Drop hypertables' + excerpt: 'Drop hypertables', }, { - title: "Best practices", - href: "best-practices", - tags: ['hypertables', 'manage', 'configure', 'tshoot', 'timescaledb'], + title: 'Best practices', + href: 'best-practices', + tags: [ + 'hypertables', + 'manage', + 'configure', + 'tshoot', + 'timescaledb', + ], keywords: ['hypertables', 'TimescaleDB'], - excerpt: 'Best practices for managing hypertables' - } - ] + excerpt: 'Best practices for managing hypertables', + }, + ], }, { - href: "distributed-hypertables", + href: 'distributed-hypertables', children: [ { - title: "CREATE", - href: "create", + title: 'CREATE', + href: 'create', tags: ['hypertables', 'create', 'distributed', 'timescaledb'], keywords: ['hypertables', 'distributed', 'TimescaleDB'], - excerpt: 'Create distributed hypertables' + excerpt: 'Create distributed hypertables', }, { - title: "INSERT", - href: "insert", + title: 'INSERT', + href: 'insert', tags: ['hypertables', 'ingest', 'distributed', 'timescaledb'], keywords: ['hypertables', 'distributed', 'TimescaleDB'], - excerpt: 'Insert data into distributed hypertables' + excerpt: 'Insert data into distributed hypertables', }, { - title: "SELECT", - href: "select", + title: 'SELECT', + href: 'select', tags: ['hypertables', 'select', 'distributed', 'timescaledb'], keywords: ['hypertables', 'distributed', 'TimescaleDB'], - excerpt: 'Select data in distributed hypertables' - }, - { - title: "Manage data nodes", - href: "manage-data-nodes", - tags: ['hypertables', 'nodes', 'manage', 'configure', 'distributed', 'timescaledb'], + excerpt: 'Select data in distributed hypertables', + }, + { + title: 'Manage data nodes', + href: 'manage-data-nodes', + tags: [ + 'hypertables', + 'nodes', + 'manage', + 'configure', + 'distributed', + 'timescaledb', + ], keywords: ['hypertables', 'distributed', 'TimescaleDB'], - excerpt: 'Manage data nodes in distributed hypertables' + excerpt: 'Manage data nodes in distributed hypertables', }, { - title: "Native replication", - href: "enable-native-replication", - tags: ['hypertables', 'nodes', 'replicate', 'distributed', 'timescaledb'], - keywords: ['hypertables', 'replicate', 'nodes', 'distributed', 'TimescaleDB'], - excerpt: 'Replicate data to nodes in distributed hypertables' + title: 'Native replication', + href: 'enable-native-replication', + tags: [ + 'hypertables', + 'nodes', + 'replicate', + 'distributed', + 'timescaledb', + ], + keywords: [ + 'hypertables', + 'replicate', + 'nodes', + 'distributed', + 'TimescaleDB', + ], + excerpt: 'Replicate data to nodes in distributed hypertables', }, { - title: "ALTER", - href: "alter", + title: 'ALTER', + href: 'alter', tags: ['hypertables', 'edit', 'distributed', 'timescaledb'], keywords: ['hypertables', 'distributed', 'TimescaleDB'], - excerpt: 'Alter distributed hypertables' + excerpt: 'Alter distributed hypertables', }, { - title: "DROP", - href: "drop", + title: 'DROP', + href: 'drop', tags: ['hypertables', 'delete', 'distributed', 'timescaledb'], keywords: ['hypertables', 'distributed', 'TimescaleDB'], - excerpt: 'Drop distributed hypertables' + excerpt: 'Drop distributed hypertables', }, { - href: "best-practices", - tags: ['hypertables', 'manage', 'configure', 'tshoot', 'distributed', 'timescaledb'], + href: 'best-practices', + tags: [ + 'hypertables', + 'manage', + 'configure', + 'tshoot', + 'distributed', + 'timescaledb', + ], keywords: ['hypertables', 'distributed', 'TimescaleDB'], - excerpt: 'Best practices for managing distributed hypertables' - } - ] + excerpt: 'Best practices for managing distributed hypertables', + }, + ], }, { - href: "write-data", + href: 'write-data', children: [ { - title: "INSERT", - href: "insert", + title: 'INSERT', + href: 'insert', tags: ['hypertables', 'ingest', 'data', 'timescaledb'], keywords: ['hypertables', 'TimescaleDB'], - excerpt: 'Insert data into hypertables' + excerpt: 'Insert data into hypertables', }, { - title: "UPDATE", - href: "update", + title: 'UPDATE', + href: 'update', tags: ['hypertables', 'update', 'data', 'timescaledb'], keywords: ['hypertables', 'TimescaleDB'], - excerpt: 'Update data in hypertables' + excerpt: 'Update data in hypertables', }, { - title: "UPSERT", - href: "upsert", + title: 'UPSERT', + href: 'upsert', tags: ['hypertables', 'update', 'data', 'timescaledb'], keywords: ['hypertables', 'TimescaleDB'], - excerpt: 'Upsert data into hypertables' + excerpt: 'Upsert data into hypertables', }, { - title: "DELETE", - href: "delete", + title: 'DELETE', + href: 'delete', tags: ['hypertables', 'delete', 'data', 'timescaledb'], keywords: ['hypertables', 'TimescaleDB'], - excerpt: 'Delete data hypertables' - } - ] + excerpt: 'Delete data hypertables', + }, + ], }, { - href: "query-data", + href: 'query-data', children: [ { - title: "SELECT", - href: "select", + title: 'SELECT', + href: 'select', tags: ['hypertables', 'select', 'data', 'timescaledb'], keywords: ['hypertables', 'TimescaleDB'], - excerpt: 'Select data in hypertables' + excerpt: 'Select data in hypertables', }, { - title: "Advanced analytic queries", - href: "advanced-analytic-queries", - tags: ['hypertables', 'analytics', 'analyze', 'query', 'timescaledb'], + title: 'Advanced analytic queries', + href: 'advanced-analytic-queries', + tags: [ + 'hypertables', + 'analytics', + 'analyze', + 'query', + 'timescaledb', + ], keywords: ['hypertables', 'hyperfunctions', 'TimescaleDB'], - excerpt: 'Use advanced analytics queries' - } - ] + excerpt: 'Use advanced analytics queries', + }, + ], }, { - title: "Multi-node setup", - href: "multi-node-setup", + title: 'Multi-node setup', + href: 'multi-node-setup', children: [ { - title: "Multi-node environments", - href: "required-configuration", + title: 'Multi-node environments', + href: 'required-configuration', tags: ['multinode', 'distributed', 'nodes', 'timescaledb'], keywords: ['multinode', 'TimescaleDB'], - excerpt: 'Set up a multi-node environment' + excerpt: 'Set up a multi-node environment', }, { - title: "Enable node communication", - href: "node-communication", - tags: ['multinode', 'distributed', 'nodes', 'enable', 'timescaledb'], + title: 'Enable node communication', + href: 'node-communication', + tags: [ + 'multinode', + 'distributed', + 'nodes', + 'enable', + 'timescaledb', + ], keywords: ['multinode', 'TimescaleDB'], - excerpt: 'Enable node communication in a multi-node environment' + excerpt: 'Enable node communication in a multi-node environment', }, { - title: "Multi-node maintenance tasks", - href: "maintenance-tasks", - tags: ['multinode', 'distributed', 'nodes', 'manage', 'timescaledb'], + title: 'Multi-node maintenance tasks', + href: 'maintenance-tasks', + tags: [ + 'multinode', + 'distributed', + 'nodes', + 'manage', + 'timescaledb', + ], keywords: ['multinode', 'TimescaleDB'], - excerpt: 'Maintain a multi-node environment' - } - ] + excerpt: 'Maintain a multi-node environment', + }, + ], }, { - href: "continuous-aggregates", + href: 'continuous-aggregates', children: [ { - title: "About continuous aggregates", - href: "about-continuous-aggregates", + title: 'About continuous aggregates', + href: 'about-continuous-aggregates', tags: ['caggs', 'timescaledb'], keywords: ['caggs', 'TimescaleDB'], - excerpt: 'About continuous aggregates' + excerpt: 'About continuous aggregates', }, { - title: "Create a continuous aggregate", - href: "create-a-continuous-aggregate", + title: 'Create a continuous aggregate', + href: 'create-a-continuous-aggregate', tags: ['caggs', 'create', 'timescaledb'], keywords: ['caggs', 'TimescaleDB'], - excerpt: 'Create continuous aggregates' + excerpt: 'Create continuous aggregates', }, { - title: "Refresh policies for continuous aggregates", - href: "refresh-policies", + title: 'Refresh policies for continuous aggregates', + href: 'refresh-policies', tags: ['caggs', 'manage', 'timescaledb'], keywords: ['caggs', 'TimescaleDB'], - excerpt: 'Manage refresh policies for continuous aggregates' + excerpt: 'Manage refresh policies for continuous aggregates', }, { - title:"Time in continuous aggregates", - href: "time", + title: 'Time in continuous aggregates', + href: 'time', tags: ['caggs', 'manage', 'timescaledb'], keywords: ['caggs', 'TimescaleDB'], - excerpt: 'Manage time in continuous aggregates' + excerpt: 'Manage time in continuous aggregates', }, { - title: "Drop data from continuous aggregates", - href: "drop-data", + title: 'Drop data from continuous aggregates', + href: 'drop-data', tags: ['caggs', 'delete', 'data', 'timescaledb'], keywords: ['caggs', 'TimescaleDB'], - excerpt: 'Drop data from continuous aggregates' + excerpt: 'Drop data from continuous aggregates', }, { - title: "Manage materialized hypertables", - href: "materialized-hypertables", + title: 'Manage materialized hypertables', + href: 'materialized-hypertables', tags: ['caggs', 'hypertables', 'manage', 'timescaledb'], keywords: ['caggs', 'TimescaleDB'], - excerpt: 'Manage materialized hypertables in continuous aggregates' + excerpt: 'Manage materialized hypertables in continuous aggregates', }, { - title: "Real time aggregates", - href: "real-time-aggregates", + title: 'Real time aggregates', + href: 'real-time-aggregates', tags: ['caggs', 'manage', 'timescaledb'], keywords: ['caggs', 'TimescaleDB'], - excerpt: 'Manage real time aggregates in continuous aggregates' + excerpt: 'Manage real time aggregates in continuous aggregates', }, { - title: "Troubleshoot continuous aggregates", - href: "troubleshooting", + title: 'Troubleshoot continuous aggregates', + href: 'troubleshooting', tags: ['caggs', 'tshoot', 'timescaledb'], keywords: ['caggs', 'TimescaleDB'], - excerpt: 'Troubleshoot continuous aggregates' - } - ] + excerpt: 'Troubleshoot continuous aggregates', + }, + ], }, { - href: "compression", + href: 'compression', children: [ { - title: "About compression", - href: "about-compression", + title: 'About compression', + href: 'about-compression', tags: ['compression', 'chunks', 'data', 'timescaledb'], keywords: ['compression', 'chunks', 'TimescaleDB'], - excerpt: 'About data compression' + excerpt: 'About data compression', }, { - title: "Manually compress chunks", - href: "manually-compress-chunks", + title: 'Manually compress chunks', + href: 'manually-compress-chunks', tags: ['compression', 'chunks', 'data', 'timescaledb'], keywords: ['compression', 'chunks', 'TimescaleDB'], - excerpt: 'Manually compress data chunks' + excerpt: 'Manually compress data chunks', }, { - title: "Decompress chunks", - href: "decompress-chunks", + title: 'Decompress chunks', + href: 'decompress-chunks', tags: ['compression', 'chunks', 'data', 'timescaledb'], keywords: ['compression', 'chunks', 'TimescaleDB'], - excerpt: 'Manually decompress data chunks' + excerpt: 'Manually decompress data chunks', }, { - title: "Backfill historical data", - href: "backfill-historical-data", + title: 'Backfill historical data', + href: 'backfill-historical-data', tags: ['compression', 'chunks', 'data', 'timescaledb'], keywords: ['compression', 'chunks', 'TimescaleDB'], - excerpt: 'Backfill historical data to compressed chunks' + excerpt: 'Backfill historical data to compressed chunks', }, { - title: "Modify a schema", - href: "modify-a-schema", + title: 'Modify a schema', + href: 'modify-a-schema', tags: ['compression', 'chunks', 'data', 'timescaledb'], keywords: ['compression', 'chunks', 'TimescaleDB'], - excerpt: 'Change the data schema in compressed chunks' - } - ] + excerpt: 'Change the data schema in compressed chunks', + }, + ], }, { - title: "User-defined actions", - href: "user-defined-actions", + title: 'User-defined actions', + href: 'user-defined-actions', children: [ { - title: "Create and register", - href: "create-and-register", + title: 'Create and register', + href: 'create-and-register', tags: ['action', 'create', 'timescaledb'], keywords: ['action', 'TimescaleDB'], - excerpt: 'Create a user-defined action' + excerpt: 'Create a user-defined action', }, { - title: "Test and debug", - href: "test-and-debug", + title: 'Test and debug', + href: 'test-and-debug', tags: ['action', 'test', 'timescaledb'], keywords: ['action', 'TimescaleDB'], - excerpt: 'Test and debug user-defined actions' + excerpt: 'Test and debug user-defined actions', }, { - title: "Altering and deleting", - href: "alter-and-delete", + title: 'Altering and deleting', + href: 'alter-and-delete', tags: ['action', 'edit', 'delete', 'timescaledb'], keywords: ['action', 'TimescaleDB'], - excerpt: 'Edit and delete user-defined actions' + excerpt: 'Edit and delete user-defined actions', }, { - title: "Example of generic retention", - href: "example-generic-retention", + title: 'Example of generic retention', + href: 'example-generic-retention', tags: ['action', 'example', 'retention', 'timescaledb'], keywords: ['action', 'example', 'TimescaleDB'], - excerpt: 'Example user-defined action for a retention policy' + excerpt: 'Example user-defined action for a retention policy', }, { - title: "Example of tiered storage", - href: "example-tiered-storage", + title: 'Example of tiered storage', + href: 'example-tiered-storage', tags: ['action', 'example', 'timescaledb'], keywords: ['action', 'example', 'TimescaleDB'], - excerpt: 'Example user-defined action for tiered storage' + excerpt: 'Example user-defined action for tiered storage', }, { - title: "Example of downsample and compress", - href: "example-downsample-and-compress", + title: 'Example of downsample and compress', + href: 'example-downsample-and-compress', tags: ['action', 'example', 'compress', 'timescaledb'], keywords: ['action', 'example', 'TimescaleDB'], - excerpt: 'Example user-defined action for downsample and compress' - } - ] + excerpt: 'Example user-defined action for downsample and compress', + }, + ], }, { - href: "data-retention", + href: 'data-retention', children: [ { - title: "Create a retention policy", - href: "create-a-retention-policy", + title: 'Create a retention policy', + href: 'create-a-retention-policy', tags: ['retention', 'data', 'create', 'timescaledb'], keywords: ['retention', 'data', 'TimescaleDB'], - excerpt: 'Create a data retention policy' + excerpt: 'Create a data retention policy', }, { - title: "Manually drop chunks", - href: "manually-drop-chunks", + title: 'Manually drop chunks', + href: 'manually-drop-chunks', tags: ['retention', 'data', 'delete', 'chunks', 'timescaledb'], keywords: ['retention', 'data', 'TimescaleDB'], - excerpt: 'Manually drop chunks' + excerpt: 'Manually drop chunks', }, { - title: "Data retention with continuous aggregates", - href: "data-retention-with-continuous-aggregates", + title: 'Data retention with continuous aggregates', + href: 'data-retention-with-continuous-aggregates', tags: ['retention', 'caggs', 'data', 'timescaledb'], keywords: ['retention', 'data', 'caggs', 'TimescaleDB'], - excerpt: 'Using data retention policies with continuous aggregates' - } - ] + excerpt: 'Using data retention policies with continuous aggregates', + }, + ], }, { - title: "Data Tiering", - href: "data-tiering", + title: 'Data Tiering', + href: 'data-tiering', children: [ { - title: "Move data", - href: "move-data", + title: 'Move data', + href: 'move-data', tags: ['tiering', 'data', 'migrate', 'chunks', 'timescaledb'], keywords: ['tiering', 'data', 'TimescaleDB'], - excerpt: 'Move data with data tiering' - } - ] + excerpt: 'Move data with data tiering', + }, + ], }, { - title: "Replication and HA", - href: "replication-and-ha", + title: 'Replication and HA', + href: 'replication-and-ha', children: [ { - title: "Replication and HA", - href: "replication", + title: 'Replication and HA', + href: 'replication', tags: ['ha', 'replicate', 'timescaledb'], keywords: ['ha', 'replicate', 'TimescaleDB'], - excerpt: 'Replication and high availability' - } - ] + excerpt: 'Replication and high availability', + }, + ], }, { - title: "Backup and restore", - href: "backup-and-restore", + title: 'Backup and restore', + href: 'backup-and-restore', children: [ { - title: "The timescaledb-backup tool", - href: "timescaledb-backup", + title: 'The timescaledb-backup tool', + href: 'timescaledb-backup', tags: ['backup', 'restore', 'timescaledb'], keywords: ['backup', 'TimescaleDB'], - excerpt: 'Backing up and restoring with the timescaledb-backup tool' + excerpt: + 'Backing up and restoring with the timescaledb-backup tool', }, { - title: "Using pg_dump/pg_restore", - href: "pg-dump-and-restore", + title: 'Using pg_dump/pg_restore', + href: 'pg-dump-and-restore', tags: ['backup', 'restore', 'timescaledb'], keywords: ['backup', 'TimescaleDB'], - excerpt: 'Backing up and restoring with the pg_dump and pg_restore' + excerpt: 'Backing up and restoring with the pg_dump and pg_restore', }, { - title: "Docker & WAL-E", - href: "docker-and-wale", + title: 'Docker & WAL-E', + href: 'docker-and-wale', tags: ['backup', 'restore', 'timescaledb'], keywords: ['backup', 'TimescaleDB'], - excerpt: 'Backing up and restoring with Docker and WAL-E' + excerpt: 'Backing up and restoring with Docker and WAL-E', }, { - title: "Physical backups", - href: "physical", + title: 'Physical backups', + href: 'physical', tags: ['backup', 'restore', 'timescaledb'], keywords: ['backup', 'TimescaleDB'], - excerpt: 'Backing up and restoring with physical backups' - } - ] + excerpt: 'Backing up and restoring with physical backups', + }, + ], }, { - title: "Schema management", - href: "schema-management", + title: 'Schema management', + href: 'schema-management', children: [ { - title: "ALTER hypertables", - href: "alter", + title: 'ALTER hypertables', + href: 'alter', tags: ['schema', 'hypertables', 'edit', 'timescaledb'], keywords: ['schema', 'hypertables', 'TimescaleDB'], - excerpt: 'Change the schema of a hypertable' + excerpt: 'Change the schema of a hypertable', }, { - title: "Indexing", - href: "indexing", + title: 'Indexing', + href: 'indexing', tags: ['schema', 'hypertables', 'index', 'timescaledb'], keywords: ['schema', 'hypertables', 'TimescaleDB'], - excerpt: 'Create an index on a hypertable' + excerpt: 'Create an index on a hypertable', }, { - title: "Triggers", - href: "triggers", + title: 'Triggers', + href: 'triggers', tags: ['schema', 'hypertables', 'manage', 'timescaledb'], keywords: ['schema', 'hypertables', 'TimescaleDB'], - excerpt: 'Create an index on a hypertable' + excerpt: 'Create an index on a hypertable', }, { - title: "Constraints", - href: "constraints", + title: 'Constraints', + href: 'constraints', tags: ['schema', 'hypertables', 'manage', 'timescaledb'], keywords: ['schema', 'hypertables', 'TimescaleDB'], - excerpt: 'Create constraints on a hypertable' + excerpt: 'Create constraints on a hypertable', }, { - title: "JSON", - href: "json", + title: 'JSON', + href: 'json', tags: ['schema', 'hypertables', 'json', 'data', 'timescaledb'], keywords: ['schema', 'hypertables', 'json', 'TimescaleDB'], - excerpt: 'Using JSON data types in a hypertable' + excerpt: 'Using JSON data types in a hypertable', }, { - title: "Tablespaces", - href: "tablespaces", + title: 'Tablespaces', + href: 'tablespaces', tags: ['schema', 'hypertables', 'manage', 'data', 'timescaledb'], keywords: ['schema', 'hypertables', 'TimescaleDB'], - excerpt: 'Create tablespaces on a hypertable' - } - ] + excerpt: 'Create tablespaces on a hypertable', + }, + ], }, { - title: "Migrate existing data", - href: "migrate-data", + title: 'Migrate existing data', + href: 'migrate-data', children: [ { - title: "Migrate from the same database", - href: "same-db", + title: 'Migrate from the same database', + href: 'same-db', tags: ['migrate', 'data', 'postgresql', 'timescaledb'], keywords: ['migrate', 'data', 'TimescaleDB'], - excerpt: 'Migrate data from the same PostgreSQL database' + excerpt: 'Migrate data from the same PostgreSQL database', }, { - title: "Migrate from a different database", - href: "different-db", + title: 'Migrate from a different database', + href: 'different-db', tags: ['migrate', 'data', 'postgresql', 'timescaledb'], keywords: ['migrate', 'data', 'TimescaleDB'], - excerpt: 'Migrate data from a different PostgreSQL database' + excerpt: 'Migrate data from a different PostgreSQL database', }, { - title: "Import from CSV", - href: "import-csv", + title: 'Import from CSV', + href: 'import-csv', tags: ['migrate', 'data', 'timescaledb'], keywords: ['migrate', 'data', 'TimescaleDB'], - excerpt: 'Migrate data from a .csv file' + excerpt: 'Migrate data from a .csv file', }, { - title: "Migrate InfluxDB data", - href: "migrate-influxdb", + title: 'Migrate InfluxDB data', + href: 'migrate-influxdb', tags: ['migrate', 'data', 'influxdb', 'timescaledb'], keywords: ['migrate', 'data', 'influxdb', 'TimescaleDB'], - excerpt: 'Migrate data from an existing InfluxDB database' - } - ] + excerpt: 'Migrate data from an existing InfluxDB database', + }, + ], }, { - title: "Update TimescaleDB", - href: "update-timescaledb", + title: 'Update TimescaleDB', + href: 'update-timescaledb', children: [ { - title: "Update from TimescaleDB 1.x to 2.x", - href: "update-timescaledb-2", + title: 'Update from TimescaleDB 1.x to 2.x', + href: 'update-timescaledb-2', tags: ['upgrade', '1-x', '2-x', 'timescaledb'], - keywords: ['upgrade', '1-x', '2-x','TimescaleDB'], - excerpt: 'Upgrade from TimescaleDB 1.x to TimescaleDB 2.x' + keywords: ['upgrade', '1-x', '2-x', 'TimescaleDB'], + excerpt: 'Upgrade from TimescaleDB 1.x to TimescaleDB 2.x', }, { - title: "Update using Docker", - href: "updating-docker", + title: 'Update using Docker', + href: 'updating-docker', tags: ['upgrade', 'docker', '1-x', '2-x', 'timescaledb'], - keywords: ['upgrade', 'docker', '1-x', '2-x','TimescaleDB'], - excerpt: 'Upgrade from TimescaleDB 1.x to TimescaleDB 2.x using Docker' + keywords: ['upgrade', 'docker', '1-x', '2-x', 'TimescaleDB'], + excerpt: + 'Upgrade from TimescaleDB 1.x to TimescaleDB 2.x using Docker', }, { - title: "Upgrade PostgreSQL", - href: "upgrade-postgresql", + title: 'Upgrade PostgreSQL', + href: 'upgrade-postgresql', tags: ['upgrade', 'postregsql', 'timescaledb'], - keywords: ['upgrade', 'postgresql','TimescaleDB'], - excerpt: 'Upgrade the version of PostgreSQL used by TimescaleDB' - } - ] + keywords: ['upgrade', 'postgresql', 'TimescaleDB'], + excerpt: 'Upgrade the version of PostgreSQL used by TimescaleDB', + }, + ], }, { - href: "configuration", + href: 'configuration', children: [ { - title: "Using timescaledb-tune", - href: "timescaledb-tune", + title: 'Using timescaledb-tune', + href: 'timescaledb-tune', tags: ['configure', 'timescaledb'], keywords: ['configure', 'timescaledb'], - excerpt: 'Configure TimescaleDB using timescaledb-tune' + excerpt: 'Configure TimescaleDB using timescaledb-tune', }, { - title: "Manual PostgreSQL configuration", - href: "postgres-config", + title: 'Manual PostgreSQL configuration', + href: 'postgres-config', tags: ['configure', 'postgresql', 'timescaledb'], keywords: ['configure', 'postgresql', 'timescaledb'], - excerpt: 'Configure TimescaleDB using the PostgreSQL configuration file' + excerpt: + 'Configure TimescaleDB using the PostgreSQL configuration file', }, { - title: "TimescaleDB configuration", - href: "timescaledb-config", + title: 'TimescaleDB configuration', + href: 'timescaledb-config', tags: ['configure', 'timescaledb'], keywords: ['configure', 'timescaledb'], - excerpt: 'Configure TimescaleDB using TimescaleDB configuration parameters' + excerpt: + 'Configure TimescaleDB using TimescaleDB configuration parameters', }, { - title: "Docker configuration", - href: "docker-config", + title: 'Docker configuration', + href: 'docker-config', tags: ['configure', 'docker', 'timescaledb'], keywords: ['configure', 'docker', 'timescaledb'], - excerpt: 'Configure TimescaleDB when running within a Docker container' + excerpt: + 'Configure TimescaleDB when running within a Docker container', }, { - title: "Telemetry", - href: "telemetry", + title: 'Telemetry', + href: 'telemetry', tags: ['configure', 'telemetry', 'timescaledb'], keywords: ['configure', 'telemetry', 'timescaledb'], - excerpt: 'Configure telemetry gathered by TimescaleDB' - } - ] + excerpt: 'Configure telemetry gathered by TimescaleDB', + }, + ], }, { - title: "Alerting", - href: "alerting", + title: 'Alerting', + href: 'alerting', tags: ['alert', 'configure', 'timescaledb'], keywords: ['alert', 'configure', 'timescaledb'], - excerpt: 'Configure alerting within TimescaleDB' + excerpt: 'Configure alerting within TimescaleDB', }, { - title: "Ingest data from other sources", - href: "ingest-data", + title: 'Ingest data from other sources', + href: 'ingest-data', tags: ['ingest', 'data', 'timescaledb'], keywords: ['ingest', 'timescaledb'], - excerpt: 'Ingest data into TimescaleDB' + excerpt: 'Ingest data into TimescaleDB', }, { - title: "Troubleshoot TimescaleDB", - href: "troubleshoot-timescaledb", + title: 'Troubleshoot TimescaleDB', + href: 'troubleshoot-timescaledb', tags: ['tshoot', 'timescaledb'], keywords: ['troubleshoot', 'timescaledb'], - excerpt: 'Troubleshooting TimescaleDB' + excerpt: 'Troubleshooting TimescaleDB', }, { - title: "Additional tooling", - href: "tooling", + title: 'Additional tooling', + href: 'tooling', tags: ['manage', 'timescaledb'], keywords: ['manage', 'timescaledb'], - excerpt: 'Additional tooling for managing TimescaleDB' - } - ] - } + excerpt: 'Additional tooling for managing TimescaleDB', + }, + ], + }, ]; diff --git a/timescaledb/overview/core-concepts/deployment-options.md b/timescaledb/overview/core-concepts/deployment-options.md index dbfa43815bb0..2546c958fdef 100644 --- a/timescaledb/overview/core-concepts/deployment-options.md +++ b/timescaledb/overview/core-concepts/deployment-options.md @@ -5,26 +5,26 @@ fully managed hosting options. There are also multiple options for deploying TimescaleDB in your own environment, including Docker images and K8 Helm charts. -## Timescale Forge +## Timescale Cloud -Timescale Forge combines the power and reliability of TimescaleDB with a +Timescale Cloud combines the power and reliability of TimescaleDB with a fully-managed, cloud-native experience that is easy to start and less expensive -to operate. Creating an account in Timescale Forge takes 30 seconds and allows +to operate. Creating an account in Timescale Cloud takes 30 seconds and allows you to quickly deploy instances of many sizes. -[Learn how to create your first instance][timescale-forge] in Timescale Forge. +[Learn how to create your first instance][timescale-cloud] in Timescale Cloud. -## Timescale Cloud +## Managed Service for TimescaleDB -Timescale Cloud is a Database as a Service (DBaaS) offering that provides an easy +Managed Service for TimescaleDB is a Database as a Service (DBaaS) offering that provides an easy way for you to analyze time-series. Powered by TimescaleDB, you can create database instances in the cloud and automate many of your most common operational tasks. This allows you to spend more time focusing on your time-series workloads and less - time worrying about database management. Timescale Cloud is available in 75+ + time worrying about database management. Managed Service for TimescaleDB is available in 75+ regions across AWS, Azure, and GCP. -[Learn how to create your first instance][timescale-cloud] in Timescale Cloud. +[Learn how to create your first instance][timescale-mst] in managed TimescaleDB. ## Self-hosted deployments @@ -35,6 +35,6 @@ distro, or a Docker image for your cluster deployment, we have you covered! [See a listing of current deployment][self-hosted] options for self-hosted installations. -[timescale-forge]: /how-to-guides/install-timescaledb/installation-forge/ -[timescale-cloud]: //how-to-guides/install-timescaledb/installation-cloud/ +[timescale-cloud]: /how-to-guides/install-timescaledb/installation-cloud/ +[timescale-mst]: //how-to-guides/install-timescaledb/installation-mst/ [self-hosted]: /how-to-guides/install-timescaledb/self-hosted/ diff --git a/timescaledb/overview/deployment-options.md b/timescaledb/overview/deployment-options.md index 12c930a08088..fb9490ad345b 100644 --- a/timescaledb/overview/deployment-options.md +++ b/timescaledb/overview/deployment-options.md @@ -5,26 +5,26 @@ fully managed hosting options. There are also multiple options for deploying TimescaleDB in your own environment, including Docker images and K8 Helm charts. -## Timescale Forge +## Timescale Cloud -Timescale Forge combines the power and reliability of TimescaleDB with a +Timescale Cloud combines the power and reliability of TimescaleDB with a fully-managed, cloud-native experience that is easy to start and less expensive -to operate. Creating an account in Timescale Forge takes 30 seconds and allows +to operate. Creating an account in Timescale Cloud takes 30 seconds and allows you to quickly deploy instances of many sizes. -[Learn how to create your first instance][timescale-forge] in Timescale Forge. +[Learn how to create your first instance][timescale-cloud] in Timescale Cloud. -## Timescale Cloud +## Managed Service for TimescaleDB -Timescale Cloud is a Database as a Service (DBaaS) offering that provides an easy +Managed Service for TimescaleDB is a Database as a Service (DBaaS) offering that provides an easy way for you to analyze time-series. Powered by TimescaleDB, you can create database instances in the cloud and automate many of your most common operational tasks. This allows you to spend more time focusing on your time-series workloads and less - time worrying about database management. Timescale Cloud is available in 75+ + time worrying about database management. Managed Service for TimescaleDB is available in 75+ regions across AWS, Azure, and GCP. -[Learn how to create your first instance][timescale-cloud] in Timescale Cloud. +[Learn how to create your first instance][timescale-mst] in managed TimescaleDB. ## Self-hosted deployments @@ -35,6 +35,6 @@ distro, or a Docker image for your cluster deployment, we have you covered! [See a listing of current deployment][self-hosted] options for self-hosted installations. -[timescale-forge]: /how-to-guides/install-timescaledb/installation-forge/ [timescale-cloud]: /how-to-guides/install-timescaledb/installation-cloud/ +[timescale-mst]: /how-to-guides/install-timescaledb/installation-mst/ [self-hosted]: /how-to-guides/install-timescaledb/self-hosted/ diff --git a/timescaledb/overview/faq/faq-products.md b/timescaledb/overview/faq/faq-products.md index 7612ff5386c2..b068bd933ef5 100644 --- a/timescaledb/overview/faq/faq-products.md +++ b/timescaledb/overview/faq/faq-products.md @@ -1,23 +1,23 @@ # FAQs - About our products -## What is the difference between Timescale, TimescaleDB, Timescale Forge, and Timescale Cloud? +## What is the difference between Timescale, TimescaleDB, Timescale Cloud, and Managed Service for TimescaleDB? **Timescale** is the company. Timescale builds an open-source relational database for time-series called **TimescaleDB**. Timescale hosts and manages TimescaleDB on behalf of its customers via -hosted services called **Timescale Forge** and **Timescale Cloud**. +hosted services called **Timescale Cloud** and **Managed Service for TimescaleDB**. -**Timescale Forge** is an easy-to-use, cloud-native relational database for +**Timescale Cloud** is an easy-to-use, cloud-native relational database for collecting and analyzing relentless streams of time-series data on AWS. Featuring enhanced features to help you harness the potential of your data and built on the rock-solid foundation of PostgreSQL and TimescaleDB, -Timescale Forge enables you to measure everything that matters. +Timescale Cloud enables you to measure everything that matters. -**Timescale Cloud** is a time-series database-as-a-service (DBaaS) for deployments +**Managed Service for TimescaleDB** is a time-series database-as-a-service (DBaaS) for deployments on GCP and Azure. Built on PostgreSQL, TimescaleDB is a rock-solid foundation -for your time-series data. Timescale Cloud enables multi-cloud deployments, +for your time-series data. Managed Service for TimescaleDB enables multi-cloud deployments, with the flexibility of 75+ regions. ## What is TimescaleDB? @@ -69,8 +69,8 @@ ensure you have a secure, high availability environment where we manage the infr all the way down to setting up replications, point-in-time recovery, read replicas, backups, and more. -## Which cloud providers and regions are supported by Timescale Cloud? -Timescale Cloud is available in the following Clouds and Regions: +## Which cloud providers and regions are supported by Managed Service for TimescaleDB? +Managed Service for TimescaleDB is available in the following Clouds and Regions: * **Amazon Web Services (AWS)**: N. Virginia (`us-east-1`), Ohio (`us-east-2`), N. California (`us-west-1`), Oregon (`us-west-2`), São Paulo (`sa-east-1`), @@ -93,7 +93,7 @@ Apache license. The Timescale License prohibits cloud providers from offering the "community version" of TimescaleDB-as-a-service. Today, you can deploy the community version of TimescaleDB on-premises or in -your own cloud account, running the software on bare VMs or using our +your own managed service account, running the software on bare VMs or using our [open-source k8s helm charts][timescale-k8s]. TimescaleDB acquired in this manner is totally free to use, and free to even modify for your own use or for services or products you build on TimescaleDB. diff --git a/timescaledb/page-index/page-index.js b/timescaledb/page-index/page-index.js index 4b919730829d..110eb561113f 100644 --- a/timescaledb/page-index/page-index.js +++ b/timescaledb/page-index/page-index.js @@ -7,9 +7,10 @@ const tutorialPageIndex = require('../tutorials/page-index/page-index') module.exports = [ { - title: "TimescaleDB", - href: "timescaledb", - excerpt: 'All you need to know about TimescaleDB architecture, concepts, setup, how-to\'s, tutorials, and management', + title: 'TimescaleDB', + href: 'timescaledb', + excerpt: + "All you need to know about TimescaleDB architecture, concepts, setup, how-to's, tutorials, and management", children: [ ...overviewPageIndex, ...gettingStartedPageIndex, @@ -17,13 +18,17 @@ module.exports = [ ...tutorialPageIndex, ...quickStartPageIndex, { - title: "Contribute to TimescaleDB", - href: "contribute-to-timescaledb" + title: 'Contribute to TimescaleDB', + href: 'contribute-to-timescaledb', }, { - title: "Contribute to documentation", - href: "contribute-to-docs" - } - ] - } -] + title: 'Contribute to documentation', + href: 'contribute-to-docs', + }, + { + title: 'TimescaleDB License Comparison', + href: 'timescaledb-license-comparison', + }, + ], + }, +]; diff --git a/timescaledb/timescaledb-license-comparison.md b/timescaledb/timescaledb-license-comparison.md new file mode 100644 index 000000000000..a1ce34a32410 --- /dev/null +++ b/timescaledb/timescaledb-license-comparison.md @@ -0,0 +1,490 @@ +## On TimescaleDB Licensing + +### TimescaleDB Apache 2 Edition vs TimescaleDB Community Edition + +There are two versions of TimescaleDB available: +TimescaleDB Apache 2 Edition is the version of TimescaleDB that is available under the +[Apache 2.0 license](https://github.com/timescale/timescaledb/blob/master/LICENSE-APACHE). +This is a classic open source license, meaning that it is completely unrestricted - +anyone can take this code and offer it as-a-service. + +### TimescaleDB Apache 2 Edition + +- _Can I install TimescaleDB Apache 2 Edition in my own on-premises or cloud infrastructure and run it for free?_
+ Yes. +- _Can I sell TimescaleDB Apache 2 Edition as a service, even if I’m not the main contributor?_
+ Yes. +- _Can I modify the TimescaleDB Apache 2 Edition source code and run it for production use?_
+ Yes. + +TimescaleDB Apache 2 Edition is available at the following service providers: [Azure Database for PostgreSQL][azure-database], [Digital Ocean][digital-ocean], [Aiven for PostgreSQL][aiven]. + +### TimescaleDB Community Edition + +TimescaleDB Community Edition is the latest, most updated version of TimescaleDB, available under the [Timescale License (TSL)][timescale-license]. [Read more about the Timescale License][license-blog]. + +Many of the most recent features of TimescaleDB are only available in TimescaleDB Community Edition. + +- _Can I install TimescaleDB Community Edition in my own on-premises or cloud infrastructure and run it for free?_
+ Yes. TimescaleDB Community Edition is completely free if you manage your own service. +- _Can I sell TimescaleDB Community Edition as a service, even if I’m not the main contributor?_
+ No. +- _Can I modify the TimescaleDB Community Edition source code and run it for production use?_
+ Yes. Developers using TimescaleDB Community Edition have the “right to repair” and make modifications to the source code and run it in their own on-premises or cloud infrastructure. However, consistent with the previous question, users may not make modifications to the TimescaleDB Community Edition source code and offer it as a service. +- _Is there a hosted version of TimescaleDB Community Edition?_
+ Yes. There are two options for users that want to run TimescaleDB Community Edition as a hosted service in the cloud: [Timescale Cloud][timescale-cloud] and [Managed Service for TimescaleDB (MST)][mst]. Timescale Cloud is a cloud-native platform for time-series, hosted in AWS. MST is a database-as-a-service offering for TimescaleDB. MST is offered in AWS, Azure, and Google Cloud. + +### Feature comparison + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FeaturesTimescaleDB Apache 2 EditionTimescaleDB Community Edition
Hypertables & Chunks
create_hypertable✅✅
show_chunks✅✅
drop_chunks✅✅
reorder_chunk❌✅
move_chunk❌✅
add_reorder_policy❌✅
attach_tablespace✅✅
detach_tablespace()✅✅
detach_tablespaces()✅✅
show_tablespaces✅✅
set_chunk_time_interval✅✅
set_integer_now_func✅✅
add_dimension()✅✅
create_index (Transaction Per Chunk)✅✅
hypertable_size✅✅
hypertable_detailed_size✅✅
hypertable_index_size✅✅
chunks_detailed_size✅✅
Distributed hypertables
create_distributed_hypertable❌✅
add_data_node❌✅
attach_data_node❌✅
detach_data_node❌✅
delete_data_node❌✅
distributed_exec❌✅
set_number_partitions❌✅
set_replication_factor❌✅
copy_chunk❌✅
move_chunk❌✅
Compression
ALTER TABLE (Compression)❌✅
add_compression_policy❌✅
remove_compression_policy❌✅
compress_chunk❌✅
decompress_chunk❌✅
hypertable_compression_stats❌✅
chunk_compression_stats❌✅
Continuous aggregates
CREATE MATERIALIZED VIEW (Continuous Aggregate)❌✅
ALTER MATERIALIZED VIEW (Continuous Aggregate)❌✅
DROP MATERIALIZED VIEW (Continuous Aggregate)❌✅
add_continuous_aggregate_policy()❌✅
refresh_continuous_aggregate❌✅
remove_continuous_aggregate_policy()❌✅
Data retention
add_retention_policy❌✅
remove_retention_policy❌✅
Actions and Automation
add_job❌✅
alter_job❌✅
delete_job❌✅
run_job❌✅
Hyperfunctions
approximate_row_count✅✅
first✅✅
last✅✅
histogram✅✅
time_bucket✅✅
time_bucket_ng (experimental feature)✅ ✅
time_bucket_gapfill❌✅
locf❌✅
interpolate❌✅
percentile_agg❌✅
approx_percentile❌✅
approx_percentile_rank❌✅
rollup❌✅
max_val❌✅
mean❌✅
error❌✅
min_val❌✅
num_vals❌✅
uddsketch❌✅
tdigest❌✅
time_weight❌✅
rollup❌✅
average❌✅
Informational Views
timescaledb_information.chunks✅✅
timescaledb_information.continuous_aggregates✅✅
timescaledb_information.compression_settings✅✅
timescaledb_information.data_nodes✅✅
timescaledb_information.dimension✅✅
timescaledb_information.hypertables✅✅
timescaledb_information.jobs✅✅
timescaledb_information.job_stats✅✅
Administration Functions
timescaledb_pre_restore✅✅
timescaledb_post_restore✅✅
get_telemetry_report✅✅
dump_meta_data✅✅
+ +[azure-database]: https://azure.microsoft.com/en-us/services/postgresql/?&ef_id=CjwKCAjwhOyJBhA4EiwAEcJdcWZ6_o9d5INkZvm1MGsOsinuXgDwV_ySL5vc34z3pyxxrP0R49J_8xoCVvIQAvD_BwE:G:s&OCID=AID2200277_SEM_CjwKCAjwhOyJBhA4EiwAEcJdcWZ6_o9d5INkZvm1MGsOsinuXgDwV_ySL5vc34z3pyxxrP0R49J_8xoCVvIQAvD_BwE:G:s&gclid=CjwKCAjwhOyJBhA4EiwAEcJdcWZ6_o9d5INkZvm1MGsOsinuXgDwV_ySL5vc34z3pyxxrP0R49J_8xoCVvIQAvD_BwE#overview +[digital-ocean]: https://docs.digitalocean.com/products/databases/postgresql/resources/supported-extensions/ +[aiven]: https://aiven.io/postgresql +[timescale-license]: https://github.com/timescale/timescaledb/blob/master/tsl/LICENSE-TIMESCALE +[timescale-cloud]: /cloud/latest +[mst]: /mst/latest +[license-blog]: https://blog.timescale.com/blog/building-open-source-business-in-cloud-era-v2/ diff --git a/timescaledb/tutorials/grafana/setup-alerts.md b/timescaledb/tutorials/grafana/setup-alerts.md index 7f3f00d108cc..6c63ba571adf 100644 --- a/timescaledb/tutorials/grafana/setup-alerts.md +++ b/timescaledb/tutorials/grafana/setup-alerts.md @@ -281,7 +281,7 @@ Complete your Grafana knowledge by following [all the TimescaleDB + Grafana tuto [install-timescale]: /how-to-guides/install-timescaledb/ [install-grafana]: /tutorials/grafana/installation -[tutorial-prometheus]: /tutorials/setting-up-timescale-cloud-endpoint-for-prometheus/ +[tutorial-prometheus]: /tutorials/setting-up-timescale-mst-endpoint-for-prometheus/ [tutorial-grafana]: /tutorials/grafana [slack-webhook-instructions]: https://slack.com/help/articles/115005265063-Incoming-Webhooks-for-Slack [pagerduty-integration-key]: https://support.pagerduty.com/docs/services-and-integrations diff --git a/timescaledb/tutorials/index.md b/timescaledb/tutorials/index.md index 3fd715b171b4..69b51d2b16cb 100644 --- a/timescaledb/tutorials/index.md +++ b/timescaledb/tutorials/index.md @@ -17,7 +17,7 @@ data analysis and make forecasts on your data. ### Observability scenarios - **[Getting started with Promscale][promscale]**: Promscale is the long‑term store for Prometheus data, designed for analytics -- **[Setup a Prometheus endpoint for Timescale Cloud][prometheus-tsc-endpoint]**: Learn how to create a monitoring system to ingest and analyze Prometheus metrics from your Timescale Cloud instance. +- **[Setup a Prometheus endpoint for managed TimescaleDB][prometheus-mst-endpoint]**: Learn how to create a monitoring system to ingest and analyze Prometheus metrics from your Timescale Cloud instance. - **[Monitor a Django application with Prometheus][monitor-django-prometheus]**: Use how to use Prometheus to monitor your Django application. ### Integrating with Grafana @@ -58,7 +58,7 @@ and pick up some valuable `psql` tips and tricks along the way. [Stocks]: /tutorials/analyze-intraday-stocks/ [custom-dashboards]: /tutorials/custom-timescaledb-dashboards/ [tableau]: /tutorials/visualize-with-tableau -[prometheus-tsc-endpoint]: /tutorials/setting-up-timescale-cloud-endpoint-for-prometheus +[prometheus-mst-endpoint]: /tutorials/setting-up-mst-endpoint-for-prometheus [monitor-django-prometheus]: /tutorials/monitor-django-with-prometheus [tutorial-grafana-dashboards]: /tutorials/grafana/create-dashboard-and-panel [tutorial-grafana-geospatial]: /tutorials/grafana/geospatial-dashboards diff --git a/timescaledb/tutorials/monitor-timescale-cloud-with-prometheus.md b/timescaledb/tutorials/monitor-mst-with-prometheus.md similarity index 80% rename from timescaledb/tutorials/monitor-timescale-cloud-with-prometheus.md rename to timescaledb/tutorials/monitor-mst-with-prometheus.md index f5460d4033cb..458a417888fa 100644 --- a/timescaledb/tutorials/monitor-timescale-cloud-with-prometheus.md +++ b/timescaledb/tutorials/monitor-mst-with-prometheus.md @@ -1,19 +1,19 @@ -# How to set up a Prometheus endpoint for a Timescale Cloud database +# How to set up a Prometheus endpoint for a Managed TimescaleDB database -You can get more insights into the performance of your Timescale Cloud +You can get more insights into the performance of your managed TimescaleDB database by monitoring it using [Prometheus][get-prometheus], a popular open-source metrics-based systems monitoring solution. This tutorial will take you through setting up a Prometheus endpoint for a database running -in [Timescale Cloud][timescale-cloud]. To create a monitoring system to ingest and analyze -Prometheus metrics from your Timescale Cloud instance, you can use [Promscale][promscale]! +in a [managed service for TimescaleDB][timescale-mst]. To create a monitoring system to ingest and analyze +Prometheus metrics from your managed TimescaleDB instance, you can use [Promscale][promscale]! This will expose metrics from the [node_exporter][node-exporter-metrics] as well as [pg_stats][pg-stats-metrics] metrics. ### Prerequisites -In order to proceed with this tutorial, you will need a Timescale Cloud database. +In order to proceed with this tutorial, you will need a managed service for TimescaleDB database. To create one, see these instructions for how to -[get started with Timescale Cloud][timescale-cloud-get-started] +[get started with managed service for TimescaleDB][timescale-mst-get-started] ### Step 1: Enable Prometheus service integration @@ -31,11 +31,11 @@ We've named ours `endpoint_dev`. Furthermore, notice that you are given basic authentication information and a port number in order to access the service. This will be used when setting up your Prometheus installation, in the `prometheus.yml` configuration file. This will enable you to make -this Timescale Cloud endpoint a target for Prometheus to scrape. +this managed TimescaleDB endpoint a target for Prometheus to scrape. Here's a sample configuration file you can use when you setup your Prometheus installation, substituting the target port, IP address, username, and password -for those of your Timescale Cloud instance: +for those of your managed TimescaleDB instance: ```yaml # prometheus.yml for monitoring a Timescale Cloud instance @@ -61,7 +61,7 @@ remote_read: ### Step 2: Associate Prometheus Endpoint with Managed Service Next, we want to associate our Prometheus endpoint with our Timescale -Cloud service. Using the navigation menu, select the service we want to +managed service. Using the navigation menu, select the service we want to monitor and click the 'Overview' tab. Navigate down to the 'Service Integrations' section and click the 'Manage Integrations' button. @@ -85,18 +85,18 @@ you associated the service with. Success! Active prometheus endpoint with name Congratulations, you have successfully set up a Prometheus endpoint on your managed -service on Timescale Cloud! +service on managed service for TimescaleDB! ### Next steps Next, [use Promscale][promscale] with Timescale, Grafana, and Prometheus to ingest -and analyze Prometheus metrics from your Timescale Cloud instance. +and analyze Prometheus metrics from your managed TimescaleDB instance. -[timescale-cloud]: https://www.timescale.com/products -[timescale-cloud-install]: /timescale-cloud/:currentVersion:/ +[timescale-mst]: https://www.timescale.com/products +[timescale-mst-install]: /mst/:currentVersion:/ [get-prometheus]: https://prometheus.io -[timescale-cloud-get-started]: /timescale-cloud/:currentVersion:/create-a-service/ +[timescale-mst-get-started]: /mst/:currentVersion:/create-a-service/ [pg-stats-metrics]: https://www.postgresql.org/docs/current/monitoring-stats.html [promscale]: https://github.com/timescale/timescale-prometheus [node-exporter-metrics]: https://github.com/prometheus/node_exporter diff --git a/timescaledb/tutorials/nyc-taxi-cab.md b/timescaledb/tutorials/nyc-taxi-cab.md index 2eeb4e47e765..1718ae10ccfe 100644 --- a/timescaledb/tutorials/nyc-taxi-cab.md +++ b/timescaledb/tutorials/nyc-taxi-cab.md @@ -16,8 +16,8 @@ SQL command, but it will be helpful if you've seen SQL before. ### Accessing Timescale There are multiple options for using Timescale to follow along with this tutorial. **All connection information -and database naming** throughout this tutorial assumes you are connected to **Timescale Forge**, our hosted, -fully-managed database-as-a-service. [Sign up for a free, 30-day demo account][forge-signup], no credit-card +and database naming** throughout this tutorial assumes you are connected to **Timescale Cloud**, our hosted, +fully-managed database-as-a-service. [Sign up for a free, 30-day demo account][cloud-signup], no credit-card required. Once you confirm the account and get logged in, proceed to the **Background** section below. If you would like to follow along with a local or on-prem install, you can follow the [install TimescaleDB][install-timescale] @@ -97,7 +97,7 @@ by typing the command below into your terminal, ensuring that you replace the {curly brackets} with your real password, hostname, and port number. ->:TIP: Remember, this connection string assumes you are connecting to **Timescale Forge**. Change the user and database name as needed depending on how you're connecting. +>:TIP: Remember, this connection string assumes you are connecting to **Timescale Cloud**. Change the user and database name as needed depending on how you're connecting. ```bash psql -x "postgres://tsdbadmin:{YOUR_PASSWORD_HERE}@{YOUR_HOSTNAME_HERE}:{YOUR_PORT_HERE}/tsdb?sslmode=require" @@ -154,7 +154,7 @@ automatically configures your TimescaleDB instance with the appropriate In the command below, be sure to substitute the items in the curly braces with information from your TimescaleDB instance, as you did earlier. Also take -note that this command includes the Timescale Forge database that is automatically created +note that this command includes the Timescale Cloud database that is automatically created for you. If you are running the database locally, replace the database name as needed. ```bash @@ -249,7 +249,7 @@ into the `rides` hypertable. To do this, we'll use the `psql` `\copy` command be >:WARNING: The PostgreSQL `\COPY` command is single-threaded and doesn't support batching inserts into multiple transactions. With nearly 11 million rows of data this import can take 10 minutes or more depending on your Internet connection when copying into a cloud-hosted -database like **Timescale Forge**. +database like **Timescale Cloud**. ```sql \COPY rides FROM nyc_data_rides.csv CSV; @@ -818,6 +818,6 @@ Ready for more learning? Here's a few suggestions: [continuous-aggregates]: /getting-started/create-cagg/ [other-samples]: /tutorials/sample-datasets/ [migrate]: /how-to-guides/migrate-data/ -[forge-signup]: https://console.forge.timescale.com/signup +[cloud-signup]: https://console.cloud.timescale.com/signup [hypertables]: /how-to-guides/hypertables [parallel-copy]: https://github.com/timescale/timescaledb-parallel-copy diff --git a/timescaledb/tutorials/page-index/page-index.js b/timescaledb/tutorials/page-index/page-index.js index d1ac9f247a14..cfe9a2cbfd30 100644 --- a/timescaledb/tutorials/page-index/page-index.js +++ b/timescaledb/tutorials/page-index/page-index.js @@ -7,7 +7,7 @@ module.exports = [ title: 'Introduction to IoT', href: 'nyc-taxi-cab', tags: ['iot', 'query', 'learn', 'tsc'], - keywords: ['IoT', 'tutorial', 'Timescale Forge'], + keywords: ['IoT', 'tutorial', 'Timescale Cloud'], excerpt: 'An introduction to IoT using NYC taxi data', }, { diff --git a/timescaledb/tutorials/setting-up-timescale-cloud-endpoint-for-prometheus.md b/timescaledb/tutorials/setting-up-mst-for-prometheus.md similarity index 83% rename from timescaledb/tutorials/setting-up-timescale-cloud-endpoint-for-prometheus.md rename to timescaledb/tutorials/setting-up-mst-for-prometheus.md index 56c0cc9f0bca..70102e5d85b6 100644 --- a/timescaledb/tutorials/setting-up-timescale-cloud-endpoint-for-prometheus.md +++ b/timescaledb/tutorials/setting-up-mst-for-prometheus.md @@ -1,19 +1,19 @@ -# How to set up a Prometheus endpoint for a Timescale Cloud database +# How to set up a Prometheus endpoint for a managed service for TimescaleDB database -You can get more insights into the performance of your Timescale Cloud +You can get more insights into the performance of your managed service for TimescaleDB database by monitoring it using [Prometheus][get-prometheus], a popular open-source metrics-based systems monitoring solution. This tutorial will take you through setting up a Prometheus endpoint for a database running -in [Timescale Cloud][timescale-cloud]. To create a monitoring system to ingest and analyze -Prometheus metrics from your Timescale Cloud instance, you can use [Promscale][promscale]! +in a [managed service for TimescaleDB][timescale-mst]. To create a monitoring system to ingest and analyze +Prometheus metrics from your managed service for TimescaleDB instance, you can use [Promscale][promscale]! This will expose metrics from the [node_exporter][node-exporter-metrics] as well as [pg_stats][pg-stats-metrics] metrics. ## Prerequisites -In order to proceed with this tutorial, you will need a Timescale Cloud database. +To proceed with this tutorial, you need a Managed Service for TimescaleDB database. To create one, see these instructions for how to -[get started with Timescale Cloud][timescale-cloud-get-started] +[get started with Managed Service for TimescaleDB][timescale-mst-get-started] ## Step 1: Enable Prometheus service integration @@ -31,11 +31,11 @@ We've named ours `endpoint_dev`. Furthermore, notice that you are given basic authentication information and a port number in order to access the service. This will be used when setting up your Prometheus installation, in the `prometheus.yml` configuration file. This will enable you to make -this Timescale Cloud endpoint a target for Prometheus to scrape. +this Managed Service for TimescaleDB endpoint a target for Prometheus to scrape. Here's a sample configuration file you can use when you setup your Prometheus installation, substituting the target port, IP address, username, and password -for those of your Timescale Cloud instance: +for those of your Managed Service for TimescaleDB instance: ```yaml # prometheus.yml for monitoring a Timescale Cloud instance @@ -85,7 +85,7 @@ you associated the service with. Success! Active prometheus endpoint with name Congratulations, you have successfully set up a Prometheus endpoint on your managed -service on Timescale Cloud! +service on Managed Service for TimescaleDB! ## Next steps @@ -93,10 +93,10 @@ Next, [use Promscale][promscale] with Timescale, Grafana, and Prometheus to inge and analyze Prometheus metrics from your Timescale Cloud instance. -[timescale-cloud]: https://www.timescale.com/products -[timescale-cloud-install]: /timescale-cloud/:currentVersion:/ +[timescale-mst]: https://www.timescale.com/products +[timescale-mst-install]: /mst/:currentVersion:/ [get-prometheus]: https://prometheus.io -[timescale-cloud-get-started]: /timescale-cloud/:currentVersion:/ +[timescale-mst-get-started]: /mst/:currentVersion:/ [pg-stats-metrics]: https://www.postgresql.org/docs/current/monitoring-stats.html [promscale]: https://github.com/timescale/timescale-prometheus [node-exporter-metrics]: https://github.com/prometheus/node_exporter