Skip to content
This repository has been archived by the owner on Jul 2, 2024. It is now read-only.

Commit

Permalink
dotcom: clean up operational docs (#8779)
Browse files Browse the repository at this point in the history
Wanted to address [this
feedback](https://sourcegraph.slack.com/archives/C04MYFW01NV/p1711482601481429),
but ended up in a bit of a rabbit hole. Years of dotcom changes,
ownership transfers, etc etc have left some pretty gnarly sprawl and
outdated docs - this PR doesn't fix everything, but just tries to fix
some things I saw today and some stuff that have bothered me for a
while. My dream is that one day, this is a Cloud instance, and
go/cloud-ops takes care of life for us.

1. Delete all Grafana Cloud and Loki references (except an old DevX
newsletter entry), this has been gone for at least a year now
2. Add a new `Logs` and `Metrics` section for Sourcegraph.com.
3. Added some more backlinks to dotcom observability, and the kubernetes
cheatsheet
4. Migrate the Postgres guide to the dotcom playbooks page. This has
annoyed me for a while -the two pages have similar but
not-quite-the-same content and the latter was a bit broken, this just
keeps things in one place. I'm not sure I'm a huge fan of a monolith
playbooks page because header uniqueness becomes hard, but it's better
than the sprawl we have right now. I didn't fully check everything 100%
works all the time starting from various setups, but at least this lives
in one place now, and we can follow up more easily.
5. Fix a whole lot of broken page links and anchor links (so many
renamed and deleted sections) with best-effort replacements.
6. Add a mention of the Cloudflare logs Elasticsearch instance because I
happen to know about it from
[this](https://docs.google.com/document/d/1tkCSCqcw5mdLRvdCzmVALPLFI0xIO9PXxC2_Se1YP5Q/edit)

Closes sourcegraph/devx-support#743
  • Loading branch information
bobheadxi authored Mar 27, 2024
1 parent ab70df5 commit 8057a2d
Show file tree
Hide file tree
Showing 9 changed files with 212 additions and 227 deletions.
29 changes: 14 additions & 15 deletions content/departments/engineering/dev/process/deployments/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,19 @@

For a complete list of Sourcegraph instances we manage, see our [instances documentation](instances.md).

- [Deployments](#deployments)
- [Deployment basics](#deployment-basics)
- [Images](#images)
- [Renovate](#renovate)
- [ArgoCD](#argocd)
- [Infrastructure](#infrastructure)
- [deploy-sourcegraph](#deploy-sourcegraph)
- [Merging changes from deploy-sourcegraph](#merging-changes-from-deploy-sourcegraph)
- [Relationship between deploy-sourcegraph repositories](#relationship-between-deploy-sourcegraph-repositories)
- [Merging upstream `deploy-sourcegraph` into `deploy-sourcegraph` forks](#merging-upstream-deploy-sourcegraph-into-deploy-sourcegraph-forks)
- [Sourcegraph Cloud](#sourcegraph-cloud)
- [Continuous Deployment Process](#continuous-deployment-process)
- [Deployment observability](#deployment-observability)
- [Deployment traces](#deployment-traces)
- [Deployment basics](#deployment-basics)
- [Images](#images)
- [Renovate](#renovate)
- [ArgoCD](#argocd)
- [Infrastructure](#infrastructure)
- [deploy-sourcegraph](#deploy-sourcegraph)
- [Merging changes from deploy-sourcegraph](#merging-changes-from-deploy-sourcegraph)
- [Relationship between deploy-sourcegraph repositories](#relationship-between-deploy-sourcegraph-repositories)
- [Merging upstream `deploy-sourcegraph` into `deploy-sourcegraph` forks](#merging-upstream-deploy-sourcegraph-into-deploy-sourcegraph-forks)
- [DotCom](#dotcom)
- [Continuous Deployment Process](#continuous-deployment-process)
- [Deployment observability](#deployment-observability)
- [Deployment traces](#deployment-traces)

Additional resources:

Expand All @@ -37,7 +36,7 @@ Each Sourcegraph service is provided as a Docker image. Every commit to `main` i

When [a new semver release](../releases/index.md) is cut the pipelines, will build a release image with the same tag as the latest [release version](https://github.com/sourcegraph/sourcegraph/tags) as well. These are used by customer deployments.

For pushing custom images, refer to [building Docker images for specific branches](#building-docker-images-for-a-specific-branch).
For pushing custom images, see `sg ci docs`.

### Renovate

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,15 @@ Also see [playbooks](./playbooks.md) for common actions related to operating our

[![Build status](https://badge.buildkite.com/ef1289610fdd05b606bf1e57a034af2365c7b09c95ac6121f9.svg)](https://buildkite.com/sourcegraph/deploy-sourcegraph-cloud)

This deployment is also colloquially referred to as 'DotCom' and 'sourcegraph.com'. It is the public deployment available to the public at [sourcegraph.com/search](https://sourcegraph.com/search).
This deployment is also colloquially referred to as 'DotCom' and 'sourcegraph.com'.
It is the public deployment available to the public at [sourcegraph.com/search](https://sourcegraph.com/search), and is currently operated by the [Core Services team](../../../teams/core-services/index.md).

`sourcegraph.com` deploys the latest changes from [`sourcegraph/sourcegraph`](https://github.com/sourcegraph/sourcegraph) on a [daily basis](index.md#continuous-deployment-process).

This deployment also includes our [documentation](https://docs.sourcegraph.com/) and [about](https://about.sourcegraph.com/) sites.
This deployment **does not** include the [about](https://about.sourcegraph.com/) site and the [new documentation site at sourcegraph.com/docs](https://sourcegraph.com/docs).
It currently still includes the legacy [docs.sourcegraph.com](https://docs.sourcegraph.com/) site, however.

> 🐶 For dogfooding changes, use [k8s.sgdev.org](#k8ssgdevorg) instead, which generally receives updates faster.
> [!NOTE] 🐶 For dogfooding changes, use [sourcegraph.sourcegraph.com](#sourcegraphsourcegraphcom-s2) instead, which generally receives updates faster.
- [DotCom cluster on GCP](https://console.cloud.google.com/kubernetes/clusters/details/us-central1-f/cloud?project=sourcegraph-dev)
```
Expand All @@ -34,12 +36,14 @@ This deployment also includes our [documentation](https://docs.sourcegraph.com/)
- [Infrastructure configuration](https://github.com/sourcegraph/infrastructure/tree/main/cloud)
- Alerts: #alerts-cloud and [OpsGenie](../incidents/on_call.md)
- [Playbooks](./playbooks.md#sourcegraphcom)
- [Observability](../../tools/observability/dotcom.md)
- [Domain routing rules](https://sourcegraph.sourcegraph.com/github.com/sourcegraph/infrastructure/-/blob/gfe/envs/prod/project/routes.tf)

## k8s.sgdev.org

[![Build status](https://badge.buildkite.com/65c9b6f836db6d041ea29b05e7310ebb81fa36741c78f207ce.svg?branch=release)](https://buildkite.com/sourcegraph/deploy-sourcegraph-dogfood-k8s-2)

**NO LONGER PRIMARY DOGFOODING INSTANCE, SEE [S2](#sourcegraphsourcegraphcom-s2) BELOW**
> [!WARNING] **THIS IS NO LONGER PRIMARY DOGFOODING INSTANCE, SEE [S2](#sourcegraphsourcegraphcom-s2) BELOW**
This deployment is also colloquially referred to as "dogfood", "dogfood-k8s", or just "k8s".
This is the Sourcegraph instance to use for dogfooding changes to Sourcegraph.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Kubernetes
# Working with Kubernetes deployments

This section contains tips and advice for interacting with our Kubernetes deployments (most notably [sourcegraph.com](#sourcegraph-cloud) and [k8s.sgdev.org](#k8s-sgdev-org)).

Expand Down
Loading

0 comments on commit 8057a2d

Please sign in to comment.