Skip to content

Commit

Permalink
[new] Aiven Client Install instructions for MST (github#1502)
Browse files Browse the repository at this point in the history
* aiven-install

* renamed the folder

* updated the child pages

* indented the child pages

* indents, mostly

* Trying with just a single page instead

Co-authored-by: Lana Brindley <github@lanabrindley.com>
  • Loading branch information
Rajakavitha1 and Loquacity authored Sep 5, 2022
1 parent 57a9346 commit 204d316
Show file tree
Hide file tree
Showing 3 changed files with 118 additions and 0 deletions.
95 changes: 95 additions & 0 deletions mst/aiven-client-install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
---
title: Aiven Client for Managed Service for TimescaleDB
excerpt: Install and configure Aiven Command Line tool for fully managed services on AWS, Azure, or GCP.
product: mst
---

# Aiven Client for fully managed services

Aiven Client is a command line tool for fully managed services. To use Aiven
Client you need to first create an authentication token and then configure it to
connect to your Managed Service for TimescaleDB using the command line.

## Create an authentication token in Managed Service for TimescaleDB

To connect to Managed Service for TimecaleDB using Aiven Client you need to
create an authentication token.

<procedure>

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

1. Log in to your [Managed Service for TimescaleDB portal][mst-login].
1. Click `User Information` in the top right corner.
1. In the `User Profile` page, navigate to the `Authentication`tab.
1. Click `Generate Token`.
1. In the `Generate access token` dialog, type a descriptive name for the
token and leave the rest of the fields blank.
1. Copy the generated authentication token and save it.

</procedure>

## Install the Aiven Client

[Aiven Client][aiven-github] is provided as a Python package, so you can install
it on a Linux, MacOS, or Windows system using `pip`, if you have already installed Python.

Use this command:

```bash
pip install aiven-client
```

For more information about installing the Aiven Client, see the
[Aiven][aiven-github] documentation.

## Configure Aiven Client to connect to Managed Service for TimescaleDB

To access Managed Service for TimescaleDB with the Aiven Client, you need an
authentication token. Aiven Client uses this authentication token to access your
services on Managed Service for TimescaleDB.

<procedure>

### Configuring Aiven Client to connect to Managed Service for TimescaleDB

1. Change to the install directory that contains the configuration files:

```bash
cd ~/.config/aiven/
```

1. Open the `aiven-credentials.json` using any editor and update these
lines with your Managed Service for TimescaleDB `User email`, and the
`authentication token` that you generated :

```bash
{
"auth_token": "ABC1+123...TOKEN==",
"user_email": "your.email@timescale.com"
}
```

1. Save the `aiven-credentials.json` file.

1. To verify that you can access your services on Managed Service for
TimescaleDB, type:

```bash
avn project list
```

This command shows a list of all your projects:

```bash
PROJECT_NAME DEFAULT_CLOUD CREDIT_CARD
============= ======================= ===================
project-xxxx timescale-aws-us-east-1 xxxx-xxxx-xxxx-xxxx
project-yyyy timescale-aws-us-east-1 xxxx-xxxx-xxxx-xxxx
project-zzzz timescale-aws-us-east-1 xxxx-xxxx-xxxx-xxxx
```

</procedure>

[aiven-github]: https://github.com/aiven/aiven-client
[mst-login]: https://portal.managed.timescale.com
19 changes: 19 additions & 0 deletions mst/aiven-client/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Aiven Client for Managed Service for TimescaleDB
excerpt: A Command Line tool for fully managed TimescaleDB service on AWS, Azure, or GCP.
product: mst
---

# Aiven Client for Managed Service for TimescaleDB

You can use [Aiven Client][aiven-client] to manage your services on Managed
Service for TimescaleDB.

You can use the Aiven Client tool to:

* Connect to Managed Service for TimescaleDB
* Create a service
* Create a fork
* Add authentication plugins to your attached Grafana service

[aiven-client]: /mst/:currentVersion:/aiven-client/aiven-client-install/
4 changes: 4 additions & 0 deletions mst/page-index/page-index.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ module.exports = [
title: "About Managed Service for TimescaleDB",
href: "about-mst",
},
{
title: "Aiven Client for Managed Service for TimescaleDB",
href: "aiven-client-install",
},
{
title: "Clouds and regions",
href: "cloud-regions",
Expand Down

0 comments on commit 204d316

Please sign in to comment.