-
Notifications
You must be signed in to change notification settings - Fork 107
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'latest' into 3452-docs-rfc-update-the-contribution-guide
- Loading branch information
Showing
55 changed files
with
1,715 additions
and
726 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,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/ | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,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 }}" }' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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> | ||
|
||
|
@@ -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. | ||
|
@@ -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/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,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/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.