Skip to content

Commit

Permalink
add procedures to mst and cloud sections (github#564)
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobprall authored Oct 29, 2021
1 parent 128c356 commit 6e6e334
Show file tree
Hide file tree
Showing 8 changed files with 69 additions and 16 deletions.
8 changes: 5 additions & 3 deletions cloud/maintenance.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@ impact of a short service interruption. Alternatively, you might prefer to have
your maintenance window occur during office hours, so that you can monitor your
system during the upgrade.

### Procedure: Adjusting your maintenance window
<procedure>

### Adjusting your maintenance window
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
Expand All @@ -45,9 +47,9 @@ system during the upgrade.
1. Check `Apply new maintenance window to all services` if you want to use the
same maintenance window settings for all of your Timescale Cloud services.
1. Click `Apply Changes`.
<img class="main-content__illustration" src="https://s3.amazonaws.com/assets.timescale.com/docs/images/tsc-maintenance-change.png" alt="Timescale Cloud change maintenance window"/>

<img class="main-content__illustration" src="https://s3.amazonaws.com/assets.timescale.com/docs/images/tsc-maintenance-change.png" alt="Timescale Cloud change maintenance window"/>

</procedure>
## Critical updates
Critical upgrades and security fixes are installed outside normal maintenance
windows when necessary, and sometimes require a short outage.
Expand Down
12 changes: 10 additions & 2 deletions cloud/scaling-a-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,9 @@ Changing your compute settings usually requires a short downtime. Make sure you
plan for this before you begin!
</highlight>

### Procedure: Changing resource allocations manually
<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
Expand All @@ -85,6 +87,8 @@ plan for this before you begin!
allocation, your service will go down briefly while the changes are applied.
<img class="main-content__illustration" src="https://s3.amazonaws.com/assets.timescale.com/docs/images/tsc-resources-changed-apply.png" alt="Configure resource allocations"/>

</procedure>

## 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
Expand All @@ -100,7 +104,9 @@ longer, and in some cases this could create a delay longer than six hours.
Autoscaling can only increase disk size, not decrease it. You can have a disk up
to 10&nbsp;TB in size.

### Procedure: Configuring autoscaling for disk 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
Expand All @@ -113,3 +119,5 @@ to 10&nbsp;TB in size.
1. Click `Apply` to save your changes. The new disk size generally becomes
available within a few seconds.
<img class="main-content__illustration" src="https://s3.amazonaws.com/assets.timescale.com/docs/images/tsc-autoscaling.png" alt="Configure autoscaling disk size"/>

</procedure>
6 changes: 5 additions & 1 deletion mst/connection-pools.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,9 @@ 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
<procedure>

### Setting up a connection pool
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
Expand All @@ -87,6 +89,8 @@ connection pooling to.
the list. You can click `Info` next to the pool details to see more
information, including the URI and port details.

</procedure>

<highlight type="note">
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.
Expand Down
12 changes: 10 additions & 2 deletions mst/create-a-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ your projects. Before you begin, make sure you have
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
<procedure>

### Creating a service
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`.
Expand All @@ -29,6 +31,8 @@ TimescaleDB [portal][timescale-mst-portal] and create your first service.
the list to see more information and make changes.
<img class="main-content__illustration" src="https://assets.timescale.com/docs/images/mst-buildservice-timescaledb.png" alt="Building the service"/>

</procedure>

<highlight type="tip">
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
Expand All @@ -45,7 +49,9 @@ The best way to access your new database is using the `psql` command line
utility. If you haven't already installed `psql`, you can follow
[these instructions][install-psql].

### Procedure: Accessing your database
<procedure>

### Accessing your database
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.
Expand All @@ -63,6 +69,8 @@ utility. If you haven't already installed `psql`, you can follow
1. You can verify that TimescaleDB is installed by running the `\dx` command
at the `psql` prompt to see a list of all your PostgreSQL extensions.

</procedure>

Now you have your service up and running, you can try your
[first tutorial][getting-started].

Expand Down
12 changes: 10 additions & 2 deletions mst/ingest-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ Before you begin, make sure you have
can connect to it using `psql`.
</highlight>

## Procedure: Preparing your new database
<procedure>

## 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 Timescale Cloud dashboard:
```sql
Expand Down Expand Up @@ -50,6 +52,8 @@ can connect to it using `psql`.
SELECT create_hypertable('conditions', 'time');
```

</procedure>

When you have successfully set up your new database, you can ingest data using
one of these methods.

Expand All @@ -63,7 +67,9 @@ Before you begin, make sure you have
[prepared your new database](#procedure-preparing-your-new-database).
</highlight>

### Procedure: Bulk uploading from a CSV file
<procedure>

### Bulk uploading from a CSV file
1. Insert data into the new hypertable using the `timescaledb-parallel-copy`
tool. You should already have the tool installed, but you can install it
manually from [our GitHub repository][github-parallel-copy] if you need to.
Expand All @@ -87,6 +93,8 @@ Before you begin, make sure you have
psql '<service_url>/new_db?sslmode=require' -c "\copy conditions FROM <example.csv> WITH (FORMAT CSV, HEADER)"
```
</procedure>
## Insert data directly using a client driver
You can use a client driver such as JDBC, Python, or Node.js, to insert data
directly into your new database.
Expand Down
6 changes: 5 additions & 1 deletion mst/maintenance.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ impact of a short service interruption. Alternatively, you might prefer to have
your maintenance window occur during office hours, so that you can monitor your
system during the upgrade.

### Procedure: Adjusting your maintenance window
<procedure>

### Adjusting your maintenance window
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`.
Expand All @@ -38,6 +40,8 @@ system during the upgrade.
<img class="main-content__illustration" src="https://s3.amazonaws.com/assets.timescale.com/docs/images/mst-maintwindow.png" alt="Adjust maintenance window"/>
1. Click `Save Changes`.

</procedure>

## Critical updates
Critical upgrades and security fixes are installed outside normal maintenance windows when
necessary, and sometimes require a short outage.
Expand Down
18 changes: 15 additions & 3 deletions mst/metrics-datadog.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ Service for TimescaleDB dashboards. You also need a running Managed Service for
TimescaleDB service.
</highlight>

### Procedure: Creating a Datadog API key
<procedure>

### Creating a Datadog API key
1. Log in to your [Datadog dashboard][datadog-login] and navigate to
`Integrations → APIs`. Click `API Keys`.
1. In the `New API key` field, type a name for your new key. For example,
Expand All @@ -32,7 +34,11 @@ TimescaleDB 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 MST
</procedure>

<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,
Expand All @@ -46,10 +52,14 @@ TimescaleDB service.
1. Click `Add endpoint` to save the integration.
<img class="main-content__illustration" src="https://s3.amazonaws.com/assets.timescale.com/docs/images/add-datadog-integration.png" alt="Add Datadog endpoint"/>

</procedure>

## Activate Datadog integration for a 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
<procedure>

### Activating Datadog integration for a service
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
Expand All @@ -59,6 +69,8 @@ When you have successfully added the endpoint, you can set up one of your servic
integration shows with a green `active` symbol.
<img class="main-content__illustration" src="https://s3.amazonaws.com/assets.timescale.com/docs/images/active-datadog-integration.png" alt="Successful Datadog integration"/>

</procedure>

## Datadog dashboards
When you have your Datadog integration set up successfully, you can use the
Datadog dashboard editor to configure your visualizations. See the
Expand Down
11 changes: 9 additions & 2 deletions mst/user-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ several roles available for project members:
|Developer||||||
|Read-only||||||

### Procedure: Adding project members
<procedure>

### Adding project members
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,
Expand All @@ -29,14 +31,18 @@ several roles available for project members:
list. You can edit a member role by selecting a new role in the list. You
can delete a member by clicking the delete icon in the list.

</procedure>

## Service users
You can create user accounts for accessing your services.

<highlight type="important">
Your service must be running before you can manage users.
</highlight>

### Procedure: Adding service users
<procedure>

### Adding service users
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
Expand All @@ -49,5 +55,6 @@ Your service must be running before you can manage users.

<img class="main-content__illustration" src="https://s3.amazonaws.com/assets.timescale.com/docs/images/mst-serviceuser.png" alt="Add a new MST service user"/>

</procedure>

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

0 comments on commit 6e6e334

Please sign in to comment.