Skip to content
This repository was archived by the owner on Jun 9, 2025. It is now read-only.

Commit 516c634

Browse files
authored
Note docs about secondary lsif database. (#386)
1 parent 57e04f5 commit 516c634

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

docs/configure.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ There are a few approaches, but using an ingress controller is recommended.
7171
For production environments, we recommend using the [ingress-nginx](https://kubernetes.github.io/ingress-nginx/) [ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/).
7272

7373
As part of our base configuration we install an ingress for [sourcegraph-frontend](../base/frontend/sourcegraph-frontend.Ingress.yaml). It installs rules for the default ingress, see comments to restrict it to a specific host.
74-
74+
7575
In addition to the sourcegraph-frontend ingress, you'll need to install the NGINX ingress controller (ingress-nginx). Follow the instructions at https://kubernetes.github.io/ingress-nginx/deploy/ to create the ingress controller. Add the files to [configure/ingress-nginx](../configure/ingress-nginx), including an [install.sh](configure/ingress-nginx/install.sh) file which applies the relevant manifests. We include sample generic-cloud manifests as part of this repository, but please follow the official instructions for your cloud provider.
7676

7777
Add the [configure/ingress-nginx/install.sh](configure/ingress-nginx/install.sh) command to [create-new-cluster.sh](../create-new-cluster.sh) and commit the change:
@@ -272,7 +272,7 @@ your fork is private **and** you are okay with storing secrets in it).
272272

273273
## Configure language servers
274274

275-
Code intelligence is provided through [Sourcegraph extensions](https://docs.sourcegraph.com/extensions). These language extensions communicate with language servers that are deployed inside your Sourcegraph cluster. See the README.md for each language for configuration information:
275+
Code intelligence is provided through [Sourcegraph extensions](https://docs.sourcegraph.com/extensions). These language extensions communicate with language servers that are deployed inside your Sourcegraph cluster. See the README.md for each language for configuration information:
276276

277277
- Go: [configure/lang/go/README.md](../configure/lang/go/README.md)
278278
- JavaScript/TypeScript: [configure/lang/typescript/README.md](../configure/lang/typescript/README.md)
@@ -485,6 +485,8 @@ You may prefer to configure Sourcegraph to store data in an external PostgreSQL
485485
486486
Simply edit the relevant PostgreSQL environment variables (e.g. PGHOST, PGPORT, PGUSER, [etc.](http://www.postgresql.org/docs/current/static/libpq-envars.html)) in [base/frontend/sourcegraph-frontend.Deployment.yaml](../base/frontend/sourcegraph-frontend.Deployment.yaml) to point to your existing PostgreSQL instance.
487487
488+
Note: Sourcegraph will create a secondary database in the same PostgreSQL instance with a name of the form `{PGDATABASE}_lsif`. It is assumed the PostgreSQL instance is dedicated solely to Sourcegraph.
489+
488490
## Install without RBAC
489491
490492
Sourcegraph Data Center communicates with the Kubernetes API for service discovery. It also has some janitor DaemonSets that clean up temporary cache data. To do that we need to create RBAC resources.
@@ -501,6 +503,6 @@ Sourcegraph's Kubernetes deployment [requires an Enterprise license key](https:/
501503
502504
## Use non-default namespace
503505
504-
If you're deploying Sourcegraph into a non-default namespace,
505-
refer to [base/prometheus/README.md#Namespaces](../base/prometheus/README.md#Namespaces) and
506+
If you're deploying Sourcegraph into a non-default namespace,
507+
refer to [base/prometheus/README.md#Namespaces](../base/prometheus/README.md#Namespaces) and
506508
[base/grafana/README.md#Namespaces](../base/grafana/README.md#Namespaces) for further configuration instructions.

0 commit comments

Comments
 (0)