Add documentation for license keys (#112)

sourcegraph · Oct 16, 2018 · 9f69b3d · 9f69b3d
1 parent 8efd8bb
commit 9f69b3d
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
 > 🚨 If you are updating from a 2.10.x or previous deployment, follow the migration steps in [docs/migrate.md](docs/migrate.md).
+> 🚨 If you are updating from a 2.11.x or previous deployment, you will need to add an Enterprise license key. Follow the steps in [docs/configure.md](docs/configure.md#add-a-license-key).
 
 # Sourcegraph Data Center
 [![sourcegraph: search](https://img.shields.io/badge/sourcegraph-search-brightgreen.svg)](https://sourcegraph.com/github.com/sourcegraph/deploy-sourcegraph)

diff --git a/docs/configure.md b/docs/configure.md
@@ -505,3 +505,21 @@ Simply edit the relevant PostgreSQL environment variables (e.g. PGHOST, PGPORT,
 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.
 
 If using RBAC is not an option, then you will not want to apply `*.Role.yaml` and `*.RoleBinding.yaml` files.
+
+## Add license key
+
+Beginning in version 2.12.0, Sourcegraph's Kubernetes deployment [requires an Enterprise license key](https://about.sourcegraph.com/pricing).
+
+1. Create an account on or sign in to sourcegraph.com, and go to https://sourcegraph.com/users/subscriptions/new to buy a license key.
+
+1. Once you have a license key, add it to your configuration by editing `base/config-file.ConfigMap.yaml`.
+
+```yaml
+# base/config-file.ConfigMap.yaml
+config.json: |-
+  {
+    "licenseKey": "YOUR_LICENSE_KEY"
+  }
+```
+
+1. Run `./kubectl-apply-all.sh` to apply the changes to your cluster.
diff --git a/docs/install.md b/docs/install.md
@@ -34,6 +34,8 @@
 
 1. If you want to add a large number of repositories to your instance, you should [configure the number of gitserver replicas](configure.md#configure-gitserver-replica-count) _before_ you continue with the next step.
 
+1. Beginning with version 2.12.0, Sourcegraph's Kubernetes deployment requires an Enterprise license key. See ["Add a license key"](./configure.md#add-a-license-key) for instructions.
+
 1. Deploy the desired version of Sourcegraph to your cluster:
 
    ```bash
-Original file line number
+Diff line change
@@ Expand Up / @@ -34,6 +34,8 @@ @@
 . If you want to add a large number of repositories to your instance, you should [configure the number of gitserver replicas](configure.md#configure-gitserver-replica-count) _before_ you continue with the next step.
+. Beginning with version 2.12.0, Sourcegraph's Kubernetes deployment requires an Enterprise license key. See ["Add a license key"](./configure.md#add-a-license-key) for instructions.
 . Deploy the desired version of Sourcegraph to your cluster:
        ```bash
@@ Expand Down @@