Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add links to mst portal and update screenshots. #3277

8 changes: 5 additions & 3 deletions _partials/_cloud-mst-comparison.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
<Highlight
type="cloud"
header="Timescale or Managed Service for TimescaleDB (MST)?"
header="Timescale Cloud or MST?"
>

If you need to run TimescaleDB on GCP or Azure, you're in the right place — keep reading.
Timescale Cloud is a high-performance developer focused cloud that provides PostgreSQL services enhanced
with our blazing fast vector search. You can securely integrate Timescale Cloud with your AWS, GCS or Azure
infrastructure. [Create a Timescale Cloud service][timescale-service] and try for free.

If you want Timescale to manage our own software on AWS for you, [Create a Timescale Service][timescale-service].
If you need to run TimescaleDB on GCP or Azure, you're in the right place — keep reading.

</Highlight>

Expand Down
4 changes: 2 additions & 2 deletions _partials/_mst-intro.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
Timescale for Azure and GCP is offered in partnership with Aiven
under the name Managed Service for TimescaleDB (MST).
Managed Service for TimescaleDB (MST) is [TimescaleDB](https://github.com/timescale/timescaledb) hosted on Azure and GCP.
MST is offered in partnership with Aiven.
23 changes: 23 additions & 0 deletions _troubleshooting/mst/forgotten-password.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Reset password
section: troubleshooting
products: [mst]
topics: [security]
keywords: [password]
tags: [alter]
---

It happens to us all, you want to login to MST Console, and the password is somewhere
next to your keys, wherever they are.

To reset your password:

1. Open [MST Portal][mst-login].
2. Click `Forgot password`.
3. Enter your email address, then click `Reset password`.

A secure reset password link is sent to the email associated with this account. Click the link
and update your password.


[mst-login]:https://portal.managed.timescale.com/login
33 changes: 16 additions & 17 deletions mst/about-mst.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,32 +19,30 @@ projects, services, and databases.

## Projects

When you sign up for Managed Service for TimescaleDB, an empty project is
When you [sign up for Managed Service for TimescaleDB][mst-signup], an empty project is
created for you automatically. Projects are the highest organization level, and
they contain all your services and databases. You can use projects to organize
groups of services. Each project can also have its own billing settings.

To create a new project, click the project name in the navigation menu, and
click `Create a new project`.
To create a new project: In [MST Console][mst-login], click `Projects` > `Create project`.

<img class="main-content__illustration"
width={1375} height={944}
src="https://assets.timescale.com/mst-empty-project.webp"
alt="Managed Service for TimescaleDB new empty project"/>
src="https://assets.timescale.com/docs/images/mst/create-project.png"
alt="MST projects"/>

## Services

Each project contains one or more services. You can have multiple services under
each project, and each service corresponds to a cloud service provider tier. You
can access all your services from the `Services` tab within your projects.

<img class="main-content__illustration"
src="https://assets.timescale.com/docs/images/mst/services.png"
alt="MST services list"/>

For more information about getting your first service up and running, see the
[Managed Service for Timescale installation section][mst-install].

<img class="main-content__illustration"
width={1375} height={944}
src="https://assets.timescale.com/mst-services.webp"
alt="Managed Service for TimescaleDB services list"/>

<Highlight type="important">
When you have created, and named, a new Managed Service for TimescaleDB service,
Expand All @@ -60,13 +58,12 @@ For information about billing on Managed Service for TimescaleDB, see the
## Databases

Each service can contain one or more databases. To view existing databases, or
to create a new database, click the name of the service in the services list,
and navigate to the `Databases` tab.
to create a new database, select a service in the services list,
click `Databases`, then click `Create database`.

<img class="main-content__illustration"
width={1375} height={944}
src="https://assets.timescale.com/mst-databases.webp"
alt="Managed Service for TimescaleDB databases list"/>
src="https://assets.timescale.com/docs/images/mst/create-database.png"
alt="MST databases list"/>

## Service level agreement

Expand Down Expand Up @@ -120,8 +117,8 @@ Within each configuration plan option, there are several plan types available:

<img class="main-content__illustration"
width={1375} height={944}
src="https://assets.timescale.com/mst-service-plans.webp"
alt="Managed Service for TimescaleDB selecting a service configuration plan"/>
src="https://assets.timescale.com/docs/images/mst/service-plans.png"
alt="MST selecting a service configuration plan"/>

## High availability

Expand Down Expand Up @@ -291,3 +288,5 @@ SET statement_timeout = <milliseconds>
[pg-keepalive]: http://www.postgresql.org/docs/9.5/static/libpq-connect.html#LIBPQ-KEEPALIVES
[connection-pooling]: /mst/:currentVersion:/connection-pools/
[mst-billing]: /mst/:currentVersion:/billing/
[mst-signup]: https://www.timescale.com/mst-signup
[mst-login]:https://portal.managed.timescale.com/login
6 changes: 3 additions & 3 deletions mst/aiven-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@ To connect to Managed Service for TimescaleDB using Aiven Client, create an auth

#### Creating an authentication token in Managed Service for TimescaleDB

1. Sign in to your Managed Service for TimescaleDB portal.
1. Click `User Information` in the top right corner.
1. In [MST Portal][mst-login], click `User Information` in the top right corner.
1. In the `User Profile` page, navigate to the `Authentication`tab.
1. Click `Generate Token`.
2. In the `Generate access token` dialog, type a descriptive name for the token. Leave the rest of the fields blank.
Expand Down Expand Up @@ -459,4 +458,5 @@ avn service list

[Fork services with Aiven client]: /mst/:currentVersion:/aiven-client/#fork-services-with-aiven-client
[Configure Grafana authentication plugins]: /mst/:currentVersion:/aiven-client/#configure-grafana-authentication-plugins
[Send Grafana emails]: /mst/:currentVersion:/aiven-client/#send-grafana-emails
[Send Grafana emails]: /mst/:currentVersion:/aiven-client/#send-grafana-emails
[mst-login]:https://portal.managed.timescale.com/login
6 changes: 5 additions & 1 deletion mst/connection-pools.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ connection pooling to.

### Setting up a connection pool

1. In the MST portal, navigate to the `Services` list, and click the name of

1. In [MST Portal][mst-login], 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.
Expand All @@ -117,3 +118,6 @@ connection pooling to.
Pooled servers use a different port number than regular servers. This allows you
to use both pooled and un-pooled connections at the same time.
</Highlight>


[mst-login]:https://portal.managed.timescale.com/login
7 changes: 5 additions & 2 deletions mst/ingest-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,15 @@ and can connect to it using `psql`.

## Preparing your new database

1. Use `psql` to connect to your service. You can retrieve the service URL,
port, and login credentials from the service overview in the MST dashboard:
1. Use `psql` to connect to your service.

```sql
psql -h <HOSTNAME> -p <PORT> -U <USERNAME> -W -d <DATABASE_NAME>
```

You retrieve the service URL,
port, and login credentials from the service overview in the [MST dashboard][mst-login].

1. Create a new database for your data. In this example, the new database is
called `new_db`:

Expand Down Expand Up @@ -157,3 +159,4 @@ See [these instructions][gh-kafkaconnector] for using the Kafka connector.
[github-parallel-copy]: https://github.com/timescale/timescaledb-parallel-copy
[postgres-odbc]: https://odbc.postgresql.org/
[create-managed-service]: /mst/:currentVersion:/installation-mst/
[mst-login]:https://portal.managed.timescale.com/login
19 changes: 10 additions & 9 deletions mst/installation-mst.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,13 @@ cloud provider, which you can install your database on.

### Creating your first service

1. Sign in to your Managed Service for TimescaleDB portal.
1. Click `Create a new service`, and complete these details:
* In the `Select Your Service` field, click `TimescaleDB`.
1. [Sign in][mst-login] to your Managed Service for TimescaleDB portal.
1. Click `Create service` and choose `TimescaleDB`, and update your preferences:

<img class="main-content__illustration"
src="https://assets.timescale.com/docs/images/mst/new-service.png"
alt="Create a new service in the Managed Service for TimescaleDB portal"/>

* In the `Select Your Cloud Service Provider` field, click your
preferred provider.
* In the `Select Your Cloud Service Region` field, click your preferred
Expand All @@ -43,11 +47,6 @@ cloud provider, which you can install your database on.
have selected for your service, and click `Create Service`. The service
takes a few minutes to provision.

<img class="main-content__illustration"
width={1375} height={944}
src="https://assets.timescale.com/docs/images/mst-new-service.webp"
alt="Create a new service in the Managed Service for TimescaleDB portal"/>

</Procedure>

## Connect to your service from the command prompt
Expand All @@ -61,7 +60,7 @@ check out the [installing psql][install-psql] section.

### Connecting to your service from the command prompt

1. Sign in to your Managed Service for TimescaleDB portal.
1. [Sign in][mst-login] to your Managed Service for TimescaleDB portal.
1. In the `Services` tab, find the service you want to connect to, and check
it is marked as `Running`.
1. Click the name of the service you want to connect to see the connection
Expand Down Expand Up @@ -126,3 +125,5 @@ if you want to have a chat.
[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/about-psql/
[mst-docs]: /mst/:currentVersion:/
[tutorials]: /tutorials/:currentVersion:/
[mst-signup]: https://www.timescale.com/mst-signup
[mst-login]:https://portal.managed.timescale.com/login
4 changes: 3 additions & 1 deletion mst/integrations/grafana-mst.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ to query and visualize the data from the database.

### Configuring Managed Service for TimescaleDB as a data source

1. Sign in to your Managed Service for TimescaleDB portal, and click the
1. In [MST Portal][mst-login], click the
service that you want to add as a data source for the Grafana service.
1. In the `Overview` tab for the service go to the `Service Integrations`
section.
Expand All @@ -51,3 +51,5 @@ to query and visualize the data from the database.

When you have configured Managed Service for TimescaleDB as a data source in
Grafana, you can create panels that are populated with data using SQL.

[mst-login]:https://portal.managed.timescale.com/login
17 changes: 10 additions & 7 deletions mst/integrations/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,15 @@ integrate a third-party service, such as [SolarWinds Loggly][loggly-site].

## Native logging

To see the most recent logged events for your service, in the `Services` tab,
find the service you want to review, and check it is marked as `Running`.
Navigate to the `Logs` tab to see a constantly updated list of logged events.
To see the most recent logged events for your service.

<img class="main-content__illustration"
width={1375} height={944}
src="https://assets.timescale.com/docs/images/mst-view-logs.webp"
alt="Managed Service for TimescaleDB native logging"/>
1. In [MST Portal][mst-login], in the `Services` tab, find the service you want to review, and check it is
marked as `Running`.
2. Navigate to the `Logs` tab to see a constantly updated list of logged events.

<img class="main-content__illustration"
src="https://assets.timescale.com/docs/images/mst/view-logs.png"
alt="Managed Service for TimescaleDB native logging"/>

## Dump logs to a text file with the Aiven CLI

Expand Down Expand Up @@ -89,3 +90,5 @@ Service for TimescaleDB.

[loggly-site]: https://www.loggly.com/
[aiven-cli]: /mst/:currentVersion:/aiven-client/#install-and-configure-the-aiven-client

[mst-login]:https://portal.managed.timescale.com/login
10 changes: 5 additions & 5 deletions mst/integrations/metrics-datadog.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,18 @@ TimescaleDB.

<Procedure>

1. Sign in to your Managed Service for TimescaleDB portal.
1. Check that you are in the project that you want to connect to Datadog,
1. In [MST Portal][mst-login], choose the project you want to connect to Datadog,
and click `Integration Endpoints`.
1. In the `Datadog` section, click `Add new endpoint`, and complete these details:
1. Select `Datadog`, then choose `Create new`.
2. In `Add new Datadog service integration`. complete these details:
* In the `Endpoint integration` section, give your endpoint a name, and
paste the API key from your Datadog dashboard. Ensure you choose the
site location that matches where your Datadog service is hosted.
* _Optional_: In the `Endpoint tags` section, you can add custom tags
to help you manage your integrations.
1. Click `Add endpoint` to save the integration.
<img class="main-content__illustration"
width={1375} height={944}
src="https://assets.timescale.com/docs/images/add-datadog-integration.webp"
src="https://assets.timescale.com/docs/images/mst/add-datadog-integration.png"
alt="Add Datadog endpoint"/>

</Procedure>
Expand Down Expand Up @@ -88,3 +87,4 @@ see the [Datadog Dashboard documentation][datadog-dashboard-docs].

[datadog-login]: https://app.datadoghq.com/
[datadog-dashboard-docs]: https://docs.datadoghq.com/dashboards/
[mst-login]:https://portal.managed.timescale.com/login
4 changes: 2 additions & 2 deletions mst/integrations/prometheus-mst.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ Before you begin, make sure you have:

### Enabling Prometheus service integration

1. Sign in to your Managed Service for TimescaleDB portal, and
navigate to `Integration Endpoints`.
1. In [MST Portal][mst-login], choose a project and navigate to `Integration Endpoints`.
1. In the `Integration endpoints` page, navigate to `Prometheus`, and click
`Create new`.
1. In the `Create new Prometheus endpoint` dialog, complete these fields:
Expand Down Expand Up @@ -75,3 +74,4 @@ Before you begin, make sure you have:
</Procedure>

[get-prometheus]: https://prometheus.io
[mst-login]:https://portal.managed.timescale.com/login
11 changes: 6 additions & 5 deletions mst/maintenance.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,13 @@ system during the upgrade.

### Adjusting your maintenance window

1. Sign in to your Managed Service for TimescaleDB portal, and 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 [MST Portal][mst-login], click the service that you want to manage the maintenance window for.
1. Click the ellipses (...) to the right of `Maintenance`, then click `Change maintenence window`.
1. In the `Service Maintenance Window` dialog, select the day of the week and
the time (in Universal Coordinated Time) you want the maintenance window to
start. Maintenance windows can run for up to four hours.
<img class="main-content__illustration"
width={1375} height={944}
src="https://assets.timescale.com/docs/images/mst-maintwindow.webp"
src="https://assets.timescale.com/docs/images/mst/change-service-mainenence-window.png"
alt="Adjust maintenance window"/>
1. Click `Save Changes`.

Expand All @@ -78,3 +76,6 @@ retired automatically after the new servers have taken over. The controlled
failover is a very quick and safe operation and it takes less than a minute to
get clients connected again. In most cases, there is five to ten second outage
during this process.


[mst-login]:https://portal.managed.timescale.com/login
2 changes: 2 additions & 0 deletions mst/manage-backups.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,14 @@ of backups stored and the retention time of the backup depend on the service
plan.

<Highlight type="important">

The size of logical backups can be different from the size of the Managed
Service for TimescaleDB backup that appears on the web console. In some cases,
the difference is significant. Backup sizes that appear in the Managed Service
for TimescaleDB web console are for daily backups, before encryption and
compression. To view the size of each database, including space consumed by
indexes, you can use the `\l+` command at the psql prompt.

</Highlight>

## Logical and binary backups
Expand Down
10 changes: 6 additions & 4 deletions mst/postgresql-read-replica.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ node.

## Creating a replica of PostgreSQL

1. Sign in to your Managed Service for TimescaleDB portal, and click the
service for which you want to create a remote replica.
1. In [MST Portal][mst-login], click the
service you want to create a remote replica for.

1. In the `Overview` tab, click `Create a read replica`.
1. In `Overview`, click `Create a read replica`.

1. In the `Create a PostgreSQL read replica` page, type a name for the remote replica,
1. In `Create a PostgreSQL read replica`, type a name for the remote replica,
select the cloud provider, location, plan that you want to use, and click
`Create`.

Expand Down Expand Up @@ -73,3 +73,5 @@ replica.
</Highlight>

[read-replica-cli]: /mst/:currentVersion:/aiven-client/#create-a-read-only-replica-with-aiven-client

[mst-login]:https://portal.managed.timescale.com/login
Loading
Loading