Skip to content

Commit f200ae2

Browse files
authored
docs: self-hosted improvements (#1222)
1 parent 94e0a60 commit f200ae2

File tree

3 files changed

+26
-10
lines changed

3 files changed

+26
-10
lines changed

docs/reference/self-hosted.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ Our [full installation guide](../self-hosted/installation.md) provides a complet
4242
#### Development-Only Options
4343
For quick testing or development, the chart can deploy internal instances of Postgres and MinIO. These are enabled with the ```dev.deployPostgres``` and ```dev.deployMinio flags```.
4444

45-
:warning: **Warning:** These development services are not suitable for production use. They lack persistence, backup, and security configurations.
45+
!!! warning
46+
These development services are not suitable for production use. They lack persistence, backup, and security configurations.
4647

4748
### Installation
4849

docs/self-hosted/installation.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Installation of the self-hosted **Logfire** requires that you have a few prerequisites before installing.
44

5-
## Gathering Prerequisites
5+
## Prerequisites
66

77
### Helm CLI
88

@@ -14,20 +14,21 @@ When running the helm chart, you will be required to create resources within a K
1414

1515
### Image Pull Secrets
1616

17-
You will require image pull secrets to pull down the docker images from our private repository. Get in contact with us to get a copy of them.
17+
You will require image pull secrets to pull down the docker images from our private repository. Contact us at [[email protected]](mailto:[email protected]) to get a copy.
1818

1919
### Postgres Database
2020

2121
The Helm chart does not include a production-ready Postgres Database (only a development instance). You will be required to connect to, and create databases on a Postgres instance.
2222

23-
You will need to create 3 databases, that are used for different things.
23+
You will need to create 4 databases, that are used for different things.
2424

2525
While we are currently working on running **Logfire** on one database, for now they *must* be separated.
2626

27-
The 3 database in question are:
27+
The 4 database in question are:
2828

2929
* Standard Postgres Database, i.e, `crud`
3030
* Object Storage/File Metadata, i.e, `ff`
31+
* Ingest Database, i.e, `ingest`
3132
* Dex i.e, `dex`
3233

3334
While they can be named anything, we will refer to them with these identifiers in this guide.
@@ -91,7 +92,7 @@ Here's a checklist you can use to ensure you have all your prerequisites:
9192
- [ ] Helm CLI Installed
9293
- [ ] Image Pull Secrets
9394
- [ ] Access to a Kubernetes cluster
94-
- [ ] The 3 PostgreSQL database set up
95+
- [ ] The 4 PostgreSQL database set up
9596
- [ ] Identity Provider Configuration
9697
- [ ] Object Storage Configuration
9798
- [ ] HTTP Ingress information (i.e, hostname etc.)
@@ -107,10 +108,11 @@ adminEmail: [email protected]
107108
imagePullSecrets:
108109
- logfire-image-key
109110
110-
# Configure Postgres Databases
111+
# Configure Logfire Postgres Databases
111112
112113
postgresDsn: postgres://postgres:[email protected]:5432/crud
113114
postgresFFDsn: postgres://postgres:[email protected]:5432/ff
115+
postgresIngestDsn: postgres://postgres:[email protected]:5432/ingest
114116
115117
# Configure Dex Postgres & Identity Provider
116118
@@ -156,7 +158,7 @@ This uses Amazon S3 as an Object Store, and Github as an Identity Provider, but
156158

157159
### Image Pull Secrets
158160

159-
You will require image pull secrets to pull down the docker images from our private repository. Get in contact with us to get a copy of them.
161+
You will require image pull secrets to pull down the docker images from our private repository. Contact us at [[email protected]](mailto:[email protected]) to get a copy.
160162

161163
When you have the `key.json` file you can load it in as a secret like so:
162164

@@ -179,16 +181,21 @@ imagePullSecrets:
179181

180182
With the 4 databases configured, you will need to configure Logfire & Dex within `values.yaml`.
181183

182-
The 2 databases for logfire (`crud` and `ff`) can be configured either via the DSNs in `values.yaml` or as a secret.
184+
The 3 databases for logfire (`crud`, `ff` and `ingest`) can be configured either via the DSNs in `values.yaml` or as a secret.
183185

184186
I.e,
185187

186188
```yaml
187189
postgresDsn: postgres://postgres:[email protected]:5432/crud
188190
postgresFFDsn: postgres://postgres:[email protected]:5432/ff
191+
postgresIngestDsn: postgres://postgres:[email protected]:5432/ingest
189192
```
190193

191-
Or if you have a secret containing `postgresDsn` and `postgresFFDsn` keys:
194+
Or if you have a secret containing postgresDsn and postgresFFDsn keys:
195+
196+
!!! note
197+
For ArgoCD users, it is highly recommended to [use an existing Kubernetes secret](https://argo-cd.readthedocs.io/en/stable/operator-manual/secret-management/) to manage your database credentials.
198+
To do so, ensure you set `enabled: true` and provide the name of your secret.
192199

193200
```yaml
194201
postgresSecret:

docs/self-hosted/troubleshooting.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
There are occasions when you need to troubleshoot the installation. Since Logfire sends its own internal logs to the `logfire-meta` organisation, this is a good place to start.
44

5+
## ErrImagePull / ImagePullBackOff
6+
7+
If you are seeing Image pull issues on your logfire pods, make sure you have:
8+
9+
* Created the required Image Pull Secret as described at the [Installation](./installation.md#image-pull-secrets_1) section
10+
* You set the right secret name at `Values.imagePullSecrets`
11+
* Both secret and the release are installed on the same namespace
12+
513
## Accessing the Meta Organization
614

715
Logfire will send internal traces to a meta organisation that is created upon first install. This meta organisation is helpful in troubleshooting any issues that might arise when running Logfire.

0 commit comments

Comments
 (0)