paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 38 Packages Projects Releases Wiki Activity

Added Docker to Database Getting Started

Browse Source 
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
This commit is contained in:
Andre Wanlin
2024-11-01 18:51:53 -05:00
parent e260b8438e
commit 2c9c97db74
1 changed files with 21 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/getting-started/config/database.md
+21 -10
View File
@@ -6,13 +6,13 @@ description: How to set up PostgreSQL for your Backstage instance.
Audience: Admins
### Summary
## Summary
This guide walks through how to set up a PostgreSQL database to host your Backstage data. It assumes you've already have a scaffolded Backstage app from following the [Standalone Install](../index.md) guide.
By the end of this tutorial, you will have a working PostgreSQL database hooked up to your Backstage install.
### Prerequisites
## Prerequisites
This guide assumes a basic understanding of working on a Linux based operating system and have some experience with the terminal, specifically, these commands: `apt-get`, `psql`, `yarn`.
@@ -23,7 +23,7 @@ This guide assumes a basic understanding of working on a Linux based operating s
- If the database is not hosted on the same server as the Backstage app, the
PostgreSQL port needs to be accessible (the default is `5432` or `5433`)
### 1. Install and configure PostgreSQL
## 1. Install and configure PostgreSQL
:::tip Already configured your database?
@@ -68,17 +68,27 @@ That's enough database administration to get started. Type `\q`, followed by
pressing the enter key. Then again type `exit` and press enter. Next, you need
to install and configure the client.
### 2. Configuring Backstage `pg` Client
### Docker Alternative
Go to the root directory of your freshly installed Backstage
App. Run the following to install the PostgreSQL client into your backend:
Alternatively you can run Postgres in a Docker container, this is great for local development or getting a Backstage POC up and running quickly, here's how:
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add pg
First we need to pull down the container image, we'll use Postgres 17, check out the [Postgres Version Policy](../../overview/versioning-policy.md#postgresql-releases) to learn which versions as supported.
```shell
docker pull postgres:17.0-bookworm
```
Use your favorite editor to open `app-config.yaml` and add your PostgreSQL
configuration in the root directory of your Backstage app using the credentials from the previous steps.
Then we just need to start up the container.
```shell
docker run -d --name postgres --restart=always -p 5432:5432 -e POSTGRES_PASSWORD=<secret> postgres:17.0-bookworm
```
This will run Postgres in the background for you, but remember to start it up again when you reboot your system.
## 2. Configuring Backstage `pg` Client
Use your favorite editor to open `app-config.yaml` and add your PostgreSQL configuration in the root directory of your Backstage app using the credentials from the previous steps.
```yaml title="app-config.yaml"
backend:
@@ -136,3 +146,4 @@ If you want to read more about the database configuration, here are some helpful
- [Configuring Plugin Databases](../../tutorials/configuring-plugin-databases.md#privileges)
- [Read more about Knex](http://knexjs.org/), the database wrapper that we use.
- [Install pgAdmin 4](https://www.pgadmin.org/), a helpful tool for querying your database.