Skip to content

Commit 72fec9b

Browse files
committed
Add feedback from team
1 parent 494ad7e commit 72fec9b

File tree

1 file changed

+35
-9
lines changed

1 file changed

+35
-9
lines changed

docs/admin/architecture.mdx

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,9 @@ Read the [Batch Changes](/batch-changes) docs to learn more.
7272
- src-cli: Batch changes are currently executed client-side through the `src` CLI
7373
- Search: Repositories in which batch specs need to be executed are resolved through the search API
7474

75-
## Code insights
75+
## Code Insights
7676

77-
Code insights surface higher-level, aggregated information to leaders in engineering organizations in dashboards. For example, code insights can track the number of matches of a search query over time, the number of code navigation diagnostic warnings in a codebase, or the usage of different programming languages. Sample use cases for this are tracking migrations, the usage of libraries across an organization, tech debt, code base health, and much more.
77+
Code Insights surface higher-level, aggregated information to leaders in engineering organizations in dashboards. For example, code insights can track the number of matches of a search query over time, the number of code navigation diagnostic warnings in a codebase, or the usage of different programming languages. Sample use cases for this are tracking migrations, the usage of libraries across an organization, tech debt, code base health, and much more.
7878

7979
Code Insights persist in a separate database called `codeinsights-db`. The web application interacts with the backend through a [GraphQL API](/api/graphql).
8080

@@ -156,28 +156,54 @@ Instead of requiring a browser extension, native integrations inject a script by
156156

157157
## Deployment
158158

159-
Sourcegraph is deployable via three supported methods:
159+
Sourcegraph's recommended deployment methods are:
160160

161-
- **[Kubernetes](/admin/deploy/kubernetes)** is intended for all medium to large-scale production deployments that require fault tolerance and high availability. For advanced users only with significant kubernetes experience required. This deployment method is developed in deploy-sourcegraph
162-
- **[Docker Compose](/admin/deploy/docker-compose)** is intended to be used for small to medium production deployments, with some customization available. Easy to set up with basic infrastructure and docker knowledge required. A variation on this is the pure-Docker option. Both of these deployment methods are developed in deploy-sourcegraph-docker
161+
1. Sourcegraph Cloud: This provides a fully managed solution where Sourcegraph handles all of the maintenance, monitoring, and upgrading tasks to give you an optimal Sourcegraph experience while immediately getting the latest features into your users' hands. This solution does require your code hosts to be connected to the Sourcegraph managed environment.
162+
2. Kubernetes Helm: Sourcegraph's Kubernetes deployment provides the most robust, scalable, and vetted self-hosted solution. This solution is ideal across many self-hosted customers capable of deploying a multi-node instance, and can be supported by all mainstream managed Kubernetes platforms.
163+
3. Docker Compose: Docker Compose provides the preferred single-node deployment solution for Sourcegraph. It can be a good option when the complexities and flexibility provided by Kubernetes Helm are not needed.
164+
4. Kubernetes Kustomize: Helm is Sourcegraph's more standardized and vetted approach to deploying with Kubernetes, but if Kustomize is your preferred deployment method it is a viable and supported approach.
165+
5. Machine Images: Sourcegraph can be deployed using dedicated Machine Images for specific Cloud providers. This can be a simple solution in specific circumstances, though has its own considerations. If you are considering this path, please discuss with your account team.
163166

164167
The [resource estimator](/admin/deploy/resource_estimator#sourcegraph-resource-estimator) can guide you on the requirements for each deployment type.
165168

169+
<Callout type="note">Learn more in the [deployment docs](/admin/deploy)</Callout>
170+
166171
## Observability
167172

168173
Observability encapsulates the monitoring and debugging of Sourcegraph deployments. Sourcegraph is designed and ships several observability tools and out-of-the-box capabilities to enable visibility into the health and state of a Sourcegraph deployment.
169174

170175
Monitoring includes [metrics and dashboards](/admin/observability/metrics), [alerting](/admin/observability/alerting), and [health checking](/admin/observability/health_checks) capabilities.
171176

172-
- grafana is the frontend for service metrics and ships with customized dashboards for Sourcegraph services
177+
- `grafana` is the frontend for service metrics and ships with customized dashboards for Sourcegraph services
173178
- prometheus handles the scraping of service metrics and ships with recording rules, alert rules, and alerting capabilities
174-
- cadvisor provides per-container performance metrics (scraped by Prometheus) in most Sourcegraph environments
179+
- `cadvisor` provides per-container performance metrics (scraped by Prometheus) in most Sourcegraph environments
175180
- Each Sourcegraph service provides health checks
176181

177182
Debugging includes [tracing](/admin/observability/tracing) and [logging](/admin/observability/logs).
178183

179184
- jaeger is the distributed tracing service used by Sourcegraph
180-
- jaeger-agent is a sidecar used in Kubernetes deployments for collecting traces from services
181185
- Each Sourcegraph service provides logs
182186

183-
Learn more in our [Observability docs](/admin/observability).
187+
<Callout type="note">Learn more in the [Observability docs](/admin/observability).</Callout>
188+
189+
## Cody
190+
191+
This section covers the Enterprise architecture of our AI assistant, Cody. [Cody Enterprise](/cody/clients/enable-cody-enterprise) can be deployed via the Sourcegraph Cloud or on your self-hosted infrastructure.
192+
193+
### Cody with Sourcegraph Cloud deployment
194+
195+
This is a recommended deployment for Cody Enterprise. It uses the Sourcegraph Cloud infrastructure and Cody gateway.
196+
197+
<img src="https://sourcegraphstatic.com/docs/enterprise-architecture-cloud-v2.png" />
198+
199+
### Sourcegraph Enterprise Server (self-hosted) on Amazon Bedrock
200+
201+
This is an example of a more complex deployment that uses Sourcegraph Enterprise Server (self-hosted) and Amazon Bedrock.
202+
203+
<img src="https://sourcegraphstatic.com/docs/enterprise-architecture-aws-v0.png" />
204+
205+
### Data flow
206+
207+
The following diagram describes the data flow between the different components of Cody Enterprise.
208+
209+
<img src="https://sourcegraphstatic.com/docs/enterprise-architecture-data-flow-v0.png" />

0 commit comments

Comments
 (0)