aiven/devportal

Resources for users of the projects on the Aiven platform

devportal's Issues

OpenSearch connecting article

Detail how to find and use the connection details for this service

PostgreSQL overview

Add the initial product page, following existing template/conventions.

Redis getting started

Create a getting started guide for the product

Grafana overview

Add initial product content following existing templates/conventions

EPIC: Identify and adapt PostgreSQL content from help.aiven.io

The starting point for this is the sphinx-ready exported content in #15 The page title from that data set are used in the issues/PRs below, with the PR that already made use of the content indicated where it's been migrated (this will help with redirects later)

• Getting started
  • Migrating data to Aiven for PostgreSQL #28
  • Migrating an existing PostgreSQL database to Aiven manually #28
  • Migrating to Aiven for PostgreSQL using Bucardo #297
• Replication
  • High availability in Aiven for PostgreSQL #48
  • Setting up PostgreSQL logical replication #33
  • Using PostgreSQL read-only replicas #33
  • Aiven for PostgreSQL remote replica #33
  • Detecting and addressing inactive or lagging PostgreSQL replication slots #33
  • Failover proxy #33
• Using and managing services
  • Basic PostgreSQL best practices #298
  • PostgreSQL superuser access #49
  • Built-in Aiven PostgreSQL Grafana dashboard #44
  • How PostgreSQL upgrades and failovers work #48
  • Perform a PostgreSQL major version upgrade #48
  • Implementing failover-resilient PostgreSQL applications #35
  • Idle connections #301
  • PostgreSQL connection limits #25
  • Backups #35
• Extensions and integration
  • Supported PostgreSQL extensions #11
  • How to upgrade PostgreSQL extensions #11
  • Integrating Google Data Studio with Aiven for PostgreSQL #292
  • Getting started with TimescaleDB in Aiven for PostgreSQL #143
  • Using the pg_repack extension #295
  • Enable JIT in PostgreSQL 11 #299
  • Using the PostgreSQL dblink extension #294
  • Automated Debezium Kafka PostgreSQL test environment deployment #296
• Troubleshooting
  • PostgreSQL transaction ID wraparound #302
  • Identifying and repairing issues with PostgreSQL indexes #303
  • Preventing PostgreSQL full disk issues #293
  • Handling pg_restore errors #35
  • Missing PostgreSQL Datadog Metrics #304
  • I imported my PostgreSQL database and I’m getting poor performance #291
  • Getting access to the PostgreSQL “public” schema #49
  • Terminating long-running queries #300
  • PostgreSQL initial disk usage #21
  • PostgreSQL connection pooling #25
  • Using TSL-licensed TimescaleDB features #143

• Connecting #21
• Getting started #29
• Migrating #28
• Connection pools #25
• Upgrades #32
• Replication #33
• Admin/internal features #34
• Backups #35
• Grafana #36
• TimescaleDB #143
• #291
• #292
• #293
• #294
• #295
• #296
• #297
• #300
• #301
• #302
• #303
• #304

PostgreSQL getting started

Create a getting started guide for the product

PG Connect Go

Add Connection details to PG from Go

InfluxDB overview

Add initial product content following existing templates/conventions

Cassandra getting started

Create a getting started guide for the product

Cassandra connecting article

Detail how to find and use the connection details for this service

Update make.bat to support `make spell`

What's wrong?

The *nix Makefile supports use of command line Vale with make spell.

Add the same functionality to make.bat for our Windows users, and add (or link) Windows installation instructions including how to add the executable to the path, for Vale.

PG Replication

Let's inform users why they might like to replicate, how to set up replicas, and everything else they need to know. Split the PR if it ends up bigger than 3 articles though!

Candidate content from the previous docs site:

• Replication
  • High availability in Aiven for PostgreSQL
  • Setting up PostgreSQL logical replication
  • Using PostgreSQL read-only replicas
  • Aiven for PostgreSQL remote replica
  • Detecting and addressing inactive or lagging PostgreSQL replication slots
  • Failover proxy

Grafana getting started

Create a getting started guide for the product

Cassandra overview

Add initial product content following existing templates/conventions

PG Getting Started Page

Create a page, similar to the M3 one, showing how to create a PG instance

Add a Vale rule to check sentence case on titles

Ensure that new content uses sentence case for titles by adding a vale configuration

[PG] PostgreSQL Getting Started page improvements

Let's flesh out this page a bit, a lot of users will come through here. My suggestions:

• Put the psql example on this page, so that people can immediately find it
• Add a sample database example such as Pagila as well, again to get people started
• End with links to some code examples, sample projects, or some other call to action to go to next

PG connect with pgAdmin

Connect to PG with the PgAdmin4

M3DB: Add concept docs for resource usage and tradeoffs

source: https://help.aiven.io/en/articles/4601105-scaling-m3

Add favicon to devportal tab

Hi there, can we please add the Aiven favicon to the browser tab for dev portal?

Kafka connecting article

Detail how to find and use the connection details for this service

Adjust titles to use sentence case

We started out with title case, and now have a mix. Please check titles and ensure continuity

Cassandra getting started

Create a getting started guide for the product

PG Upgrades

What's an upgrade and how do you do it on Aiven?

Possible source content:

• How PostgreSQL upgrades and failovers work
• Perform a PostgreSQL major version upgrade

sphinxcontrib-mermaid broken on Sphinx >= 4.0

Hi there!

sphinxcontrib-mermaid is currently broken for Sphinx >= 4.0, here is the PR fixing it.

For now, trying to run make livehtml returns the following error:

Extension error:
Could not import extension sphinxcontrib.mermaid (exception: cannot import name 'ENOENT' from 'sphinx.util.osutil' (/Users/jonatasbaldin/aiven/devportal/venv/lib/python3.8/site-packages/sphinx/util/osutil.py))
Command exited with exit code: 2
The server will continue serving the build folder, but the contents being served are no longer in sync with the documentation sources. Please fix the cause of the error above or press Ctrl+C to stop the server.

And I got 404 on the index page on the live server,

Disabling out the sphinxcontrib.mermaid from conf.py:extensions fixes the issue temporarily.

We have a couple of options:

1. Disable it for now until the PR is merged.
2. Use an earlier version of Sphinx.

What do you think?

PostgreSQL connecting article

Detail how to find and use the connection details for this service

MySQL getting started

Create a getting started guide for the product

M3 connecting article

Detail how to find and use the connection details for this service

PG Grafana

How can a user integrate Grafana with Postgres to visualise their data? We also have a built-in dashboard available.

Possible source content to use as a starting point:

• Built-in Aiven PostgreSQL Grafana dashboard

MySQL overview

Add initial product content following existing templates/conventions

HowTo: Migrate using logical replication and pg_dump and pg_restore

A couple of howTos about migration including

• logical replication
• pg_dump and pg_restore

Concept: Connection Pooling

Adding the concept of connection pooling from https://help.aiven.io/en/articles/964730-postgresql-connection-pooling

PG Connection with psql

Connect to PG with psql

PG Backups

Let's explain how users can work with backups

Possible content to include/use as a basis:

• Backups
• Handling pg_restore errors

Redis connecting article

Detail how to find and use the connection details for this service

Redis overview

Add initial product content following existing templates/conventions

Check product names

The old official product names ("Aiven Kafka" etc) were changed to the new ("Aiven for Apache Kafka") sometime in 2020. When transferring (or editing) content, check that product names follow the new format and the conventions as specified here: https://docs.google.com/document/d/1PklbdRuxSUycQ2vtSkYfdZZY7MokdR-sGkQYcZnzr-E/edit?usp=sharing
NOTE: M3 is the only product new enough to only have a new format name.

PG Admin and internal access

You can't be root on a hosted service, so how do you perform those more DBA-type tasks? What's different about Aiven PostgreSQL for this sort of thing?

Candidate content from the export:

• Getting access to the PostgreSQL “public” schema
• PostgreSQL superuser access

M3 overview

Add initial product content following existing templates/conventions

Concept: PostgreSQL Connection Limits

Adding page about connection limits

[PG] Document all the supported PostgreSQL configuration parameters

We don't have (or I couldn't find) documentation related to all supported "Advanced Configuration" parameters.

We support a huge part of the postgresql.conf, but we might not support all of them (or have different ones).

Would be nice to have a page/table with:

• Name of the parameter
• Short description
• Range of acceptable values
• Warning if changing the parameter triggers a service restart

Kafka getting started

Create a getting started guide for the product

Add a feedback mechanism

We need to collect feedback from users on whether they found the content helpful or not. This should be in the form of a 👍 and 👎 button pair, and an optional comment. Users need to understand that we can't identify them on devportal so they need to contact support if they need a response (or open a GitHub issue).

Each data point should have:

• the URL of the page that the form was on
• whether the user chose 👍 or 👎
• their comment, if any
• the date and time that the data was submitted

Tech Info

Implementation details are open for discussion but my suggestion:

• netlify form
• netlify function (can also inspect this data via netlify console and/or integrate with Slack easily)
• Aiven postgresql, in the same workspace as our postgresql

Example implementations

• https://docs.newrelic.com/docs/apis/intro-apis/introduction-new-relic-apis/

Next steps

A follow-on issue will be needed for reporting on the collected data - create it as the final step in this task once we know how this issue chose to store data.

MySQL connecting article

Detail how to find and use the connection details for this service

Add API docs

The API docs currently live somewhere else but could they come here to be part of the site?

Kafka overview

Add initial product content following existing templates/conventions

M3 getting started

Create a getting started guide for the product

PG Connect with Python

How to connect with python similar to M3 one

OpenSearch overview

Add initial product content following existing templates/conventions

InfluxDB getting started

Create a getting started guide for the product