Skip to content

Commit

Permalink
Merge branch 'latest' into 3452-docs-rfc-update-the-contribution-guide
Browse files Browse the repository at this point in the history
  • Loading branch information
atovpeko authored Jan 21, 2025
2 parents 1504f56 + 3ad0945 commit e832315
Show file tree
Hide file tree
Showing 55 changed files with 1,715 additions and 726 deletions.
72 changes: 72 additions & 0 deletions .github/styles/templates/integration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
title: Integrate <third-party tool name> with Timescale Cloud
excerpt: SEO friendly explanation of why the user will do it
keywords: [<third-party tool name>]
---

import IntegrationPrereqs from "versionContent/_partials/_integration-prereqs.mdx";

# Integrate <third-party tool name> with $CLOUD_LONG

// Explain what the third-party tool is and what it does in their own words, link to product docs.

// Provide context for the integration steps, for example, if an additional connector is used.

// See https://docs.timescale.com/use-timescale/latest/integrations/grafana/ for an example.

## Prerequisites

<IntegrationPrereqs />

- Install <third-party tool name> // Mention both server and cloud versions, if present. Link to installation pages.

## Connect your $SERVICE_LONG

To connect to $CLOUD_LONG:

<Procedure>

1. **Log in to <third-party tool name>**

// Sub-steps, code, screenshots if necessary.

1. **Configure the connection**

// Sub-steps, code, screenshots if necessary. Link to [Find your connection details][connection-info].

...

1. **Test the connection**

// Sub-steps, code, screenshots if necessary.

</Procedure>

## Test the integration with $CLOUD_LONG

// Add only if there is a simple way to illustrate how the two solutions work together.

Take the following steps to <whatever the tool must do in conjunction with Timescale Cloud>:

<Procedure>

// Steps to test out the integration using a defined dataset.

</Procedure>

You have successfully integrated <third-party tool> with $CLOUD_LONG.

[connection-info]: /use-timescale/:currentVersion:/integrations/find-connection-details/













20 changes: 20 additions & 0 deletions .github/workflows/deploy-lambdas.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Deploy redirects to lambda
on:
push:
paths:
- lambda/**

permissions: {}

jobs:
trigger:
name: Update changed lambda redirects
runs-on: ubuntu-latest
steps:
- name: Repository Dispatch
uses: peter-evans/repository-dispatch@26b39ed245ab8f31526069329e112ab2fb224588
with:
token: ${{ secrets.ORG_AUTOMATION_TOKEN }}
repository: timescale/web-documentation
event-type: build-lambda
client-payload: '{ "branch": "${{ github.ref_name }}" }'
4 changes: 2 additions & 2 deletions _partials/_cloud-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ Quick recap. You:
[portal-data-mode]: https://console.cloud.timescale.com/dashboard/services?popsql
[account-portal]: https://console.cloud.timescale.com/dashboard/account
[services-portal]: https://console.cloud.timescale.com/dashboard/services
[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
[install-psql]: /use-timescale/:currentVersion:/integrations/psql/
[popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-mode
[run-sqleditor]: /getting-started/:currentVersion:/run-queries-from-console/#sql-editor
[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
[install-psql]: /use-timescale/:currentVersion:/integrations/psql/
[hypertables]: /use-timescale/:currentVersion:/hypertables/about-hypertables/#hypertable-partitioning
2 changes: 1 addition & 1 deletion _partials/_cloud-create-connect-tutorials.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ command-line utility. If you've used PostgreSQL before, you might already have
</Procedure>
[timescale-portal]: https://console.cloud.timescale.com/
[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
[install-psql]: /use-timescale/:currentVersion:/integrations/psql/
4 changes: 2 additions & 2 deletions _partials/_create-hypertable.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ To create a hypertable:
</Procedure>

[services-portal]: https://console.cloud.timescale.com/dashboard/services
[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
[install-psql]: /use-timescale/:currentVersion:/integrations/psql/
[popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-mode
[run-sqleditor]: /getting-started/:currentVersion:/run-queries-from-console/#sql-editor
[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
[install-psql]: /use-timescale/:currentVersion:/integrations/psql/
[hypertables]: /use-timescale/:currentVersion:/hypertables/about-hypertables/#hypertable-partitioning
33 changes: 13 additions & 20 deletions _partials/_grafana-connect.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
## Prerequisites

* [Create a target $SERVICE_LONG][create-service]
* Install [self-managed Grafana][grafana-self-managed], or sign up for [Grafana Cloud][grafana-cloud]
import IntegrationPrereqs from "versionContent/_partials/_integration-prereqs.mdx";

## Add your $SERVICE_LONG as a data source
<IntegrationPrereqs />

To connect the data in your $SERVICE_LONG to Grafana:
* Install [self-managed Grafana][grafana-self-managed] or sign up for [Grafana Cloud][grafana-cloud].

## Add your $SERVICE_SHORT as a data source

To connect the data in your $SERVICE_SHORT to Grafana:

<Procedure>

Expand All @@ -14,27 +17,16 @@ To connect the data in your $SERVICE_LONG to Grafana:
In your browser, log in to either:
- Self-hosted Grafana: at `http://localhost:3000/`. The default credentials are `admin`, `admin`.
- Grafana Cloud: use the URL and credentials you set when you created your account.
1. **Add your $SERVICE_LONG as a data source**
1. **Add your $SERVICE_SHORT as a data source**
1. Open `Connections` > `Data sources`, then click `Add new data source`.
1. Select `PostgreSQL` from the list.
1. Configure the following fields:
- `Host URL`: the host and port for your $SERVICE_SHORT, in this format: `<HOST>:<PORT>`.
- `Database name`: the name to use for the dataset.
- `Username`: `tsdbadmin`, or another privileged user.
- `Password`: the password for `User`.
- `Database`: `tsdb`.
1. Configure the connection:
- `Host URL`, `Username`, `Password`, and `Database`: configure using your [connection details][connection-info].
- `Database name`: provide the name for your dataset.
- `TLS/SSL Mode`: select `require`.
- `PostgreSQL options`: enable `TimescaleDB`.
- Leave the default setting for all other fields.

Get the values for `Host URL` and `Password` from the connection string generated when you created your $SERVICE_LONG. For example, in the following connection string:

```bash
postgres://tsdbadmin:[email protected]:39941/tsdb?sslmode=require
```

`krifchuf3r8c5onn` is the password and `s5pq0es2cy.vfbtkqzhtm.tsdb.cloud.timescale.com:39941` is the host URL in the required format.

1. **Click `Save & test`**

Grafana checks that your details are set correctly.
Expand All @@ -44,4 +36,5 @@ To connect the data in your $SERVICE_LONG to Grafana:
[grafana-self-managed]: https://grafana.com/get/?tab=self-managed
[grafana-cloud]: https://grafana.com/get/
[cloud-login]: https://console.cloud.timescale.com/
[create-service]: /getting-started/:currentVersion:/services/
[create-service]: /getting-started/:currentVersion:/services/
[connection-info]: /use-timescale/:currentVersion:/integrations/find-connection-details/
9 changes: 9 additions & 0 deletions _partials/_integration-prereqs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Before integrating:

* Create a [target $SERVICE_LONG][create-service]. You need [your connection details][connection-info] to follow this procedure.

This procedure also works for [self-hosted $TIMESCALE_DB][enable-timescaledb].

[create-service]: /getting-started/:currentVersion:/services/
[enable-timescaledb]: /self-hosted/:currentVersion:/install/
[connection-info]: /use-timescale/:currentVersion:/integrations/find-connection-details/
2 changes: 1 addition & 1 deletion _partials/_usage-based-storage-intro.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Timescale charges are based on how much storage you use. You don't pay for a
$CLOUD_LONG charges are based on the amount of storage you use. You don't pay for
fixed storage size, and you don't need to worry about scaling disk size as your
data grows; We handle it all for you. To reduce your data costs further,
use [compression][compression], a [data retention policy][data-retention], and
Expand Down
2 changes: 1 addition & 1 deletion _troubleshooting/cloud-jdbc-authentication-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: JDBC authentication type is not supported
section: troubleshooting
products: [cloud]
topics: [integrations/query admin]
topics: [integrations]
errors:
- language: text
message: |-
Expand Down
15 changes: 14 additions & 1 deletion about/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,19 @@ keywords: [changelog, upgrades, updates, releases]

All the latest features and updates to Timescale products.

## 🎅 Postgres 17, Feature Requests, and Postgres Livesync
## 🇮🇳 New region in India, PostgreSQL 17 upgrades, and TimescaleDB on AWS Marketplace
<Label type="date">January 10, 2025</Label>

### Welcome India! (Support for a new region: Mumbai)
Timescale Cloud now supports the Mumbai region. Starting today, you can run Timescale Cloud services in Mumbai, bringing our database solutions closer to users in India.

### PostgreSQL major version upgrades to PG 17
Timescale Cloud services can now be upgraded directly to PostgreSQL 17 from versions 14, 15, or 16. Users running versions 12 or 13 must first upgrade to version 15 or 16, before upgrading to 17.

### Timescale Cloud available on AWS Marketplace
Timescale Cloud is now available in the [AWS Marketplace][aws-timescale]. This allows you to keep billing centralized on your AWS account, use your already committed AWS Enterprise Discount Program spend to pay your Timescale Cloud bill and simplify procurement and vendor management.

## 🎅 Postgres 17, feature requests, and Postgres Livesync
<Label type="date">December 20, 2024</Label>

### Postgres 17
Expand Down Expand Up @@ -664,3 +676,4 @@ To learn more, see the [postgresql-unit documentation](https://github.com/df7cb/
[pgvectorscale]: https://github.com/timescale/pgvectorscale/
[signup]: https://console.cloud.timescale.com/signup
[sql-editor]: /getting-started/:currentVersion:/run-queries-from-console/#sql-editor
[aws-timescale]: https://aws.amazon.com/marketplace/seller-profile?id=seller-wbtecrjp3kxpm
4 changes: 2 additions & 2 deletions getting-started/run-queries-from-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,11 +229,11 @@ To use SQL editor with Timescale:
[readreplica]: /use-timescale/:currentVersion:/ha-replicas/read-scaling/
[run-popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-mode
[run-sqleditor]: /getting-started/:currentVersion:/run-queries-from-console/#sql-editor
[integrations]: /use-timescale/:currentVersion:/integrations/query-admin/
[integrations]: /use-timescale/:currentVersion:/integrations/
[timescale-console]: https://console.cloud.timescale.com/
[portal-ops-mode]: https://console.cloud.timescale.com/dashboard/services
[pricing-plan-features]: https://www.timescale.com/pricing#features
[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
[install-psql]: /use-timescale/:currentVersion:/integrations/psql/
[create-cloud-account]: /getting-started/:currentVersion:/services/#create-a-timescale-cloud-account
[portal-data-mode]: https://console.cloud.timescale.com/dashboard/services?popsql
[services-portal]: https://console.cloud.timescale.com/dashboard/services
Expand Down
2 changes: 1 addition & 1 deletion getting-started/services.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ And that is it, you are up and running. Enjoy developing with $COMPANY.

[tsc-portal]: https://console.cloud.timescale.com/
[services-how-to]: /use-timescale/:currentVersion:/services/
[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
[install-psql]: /use-timescale/:currentVersion:/integrations/psql/
[create-an-account]: /getting-started/:currentVersion:/services/#create-a-timescale-cloud-account
[create-a-service]: /getting-started/:currentVersion:/services/#create-a-timescale-cloud-service
[connect-to-your-service]: /getting-started/:currentVersion:/services/#connect-to-your-service
Expand Down
Loading

0 comments on commit e832315

Please sign in to comment.