Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs/update add GCE custom image deployment type #42911

Merged
merged 14 commits into from
Oct 21, 2022
6 changes: 3 additions & 3 deletions doc/admin/deploy/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ In general:

## Deployment types

To start, you will need to decide your on deployment method, including Kubernetes with or without Helm, as they are noninterchangeable it. In short, you **cannot** change your deployment type of a running instance.
To start, you will need to decide your on deployment method, including Kubernetes with or without Helm, as they are noninterchangeable. In short, you **cannot** change your deployment type of a running instance.

Each of the deployment types listed below provides a different level of capability. As mentioned previously, you shall pick a deployment type based on the needs of your business. However, you should also consider the technical expertise available for your deployment. The sections below provide more detailed recommendations for each deployment type.

Expand Down Expand Up @@ -66,11 +66,11 @@ If you are unable to use Helm to deploy, but still want to use Kubernetes, follo

Sourcegraph provides reference repositories with branches corresponding to the version of Sourcegraph you wish to deploy. The reference repository contains everything you need to spin up and configure your instance depending on your deployment type, which also assists in your upgrade process going forward.

For more information, follow the install and configuration docs for your specific deployment type.
For more information, follow the installation and configuration docs for your specific deployment type.

## Configuration

Configuration at the deployment level focuses on ensuring your Sourcegraph runs optimally, based on the size of your repositories and the number of users. Configuration options will vary based on the type of deployment you choose. Consult the specific configuration deployment sections for additional information.
Configuration at the deployment level focuses on ensuring your Sourcegraph deployment runs optimally, based on the size of your repositories and the number of users. Configuration options will vary based on the type of deployment you choose. Consult the specific configuration deployment sections for additional information.

In addition you can review our [Configuration docs](../config/index.md) for overall Sourcegraph configuration.

Expand Down
8 changes: 4 additions & 4 deletions doc/admin/deploy/machine-images/gce.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Following these docs will provision the following resources:
<img class="screenshot" src="./assets/gcp-bucket.png"/>

1. In the [instance size chart](#instance-size-chart) below, download the image (`tar.gz`) file that matches your deployment size
2. Nevigate to [Google Cloud Storage](https://console.cloud.google.com/storage) and select a project where you will store the image and deploy the instance in
2. Navigate to [Google Cloud Storage](https://console.cloud.google.com/storage) and select a project where you will store the image and deploy the instance in
3. **Upload** the `tar.gz` file to a bucket (create one if needed)
4. Copy the **URL**

Expand All @@ -48,7 +48,7 @@ Following these docs will provision the following resources:
1. Create a new VM instance from your [GCE Console](https://console.cloud.google.com/compute)
2. Name the instance
3. Select a **machine type** (see [instance size chart](#instance-size-chart))
4. Under the **Boot disk** section, click **CHANGE** and nevigate to the **CUSTOM IMAGES** tab
4. Under the **Boot disk** section, click **CHANGE** and navigate to the **CUSTOM IMAGES** tab
- Image: Select the Sourcegraph image created in the previous step
- Boot disk type: SSD persistent disk
5. Under the **Firewall** section
Expand All @@ -73,7 +73,7 @@ To SSH into the instance as user `sourcegraph`, add the username in front of you
# sourcegraph is the username
$ gcloud compute ssh sourcegraph@your-instance-name --zone=us-central1-a
```
Your can also switch user in the terminal with the command below:
Your can also switch users in the terminal with the command below:

```bash
$ sudo su sourcegraph
Expand Down Expand Up @@ -138,7 +138,7 @@ helm upgrade -i -f /home/sourcegraph/deploy/install/override.yaml --version 4.0.
<img class="screenshot" src="./assets/gcp-edit.png"/>

1. *Stop* your current Sourcegraph GCP Image instance from the [GCE Console](https://console.cloud.google.com/compute)
2. Nevigate to your instance console after your instance is stopped
2. Navigate to your instance console after your instance is stopped
3. Detach the local disk
- Click the **EDIT** button located on top of the page in your instance console
- Remove the **Existing disk** under **Additional disks**
Expand Down