Skip to content

Commit 0b40a0e

Browse files
authored
1 parent 7af2e11 commit 0b40a0e

File tree

14 files changed

+29
-35
lines changed

14 files changed

+29
-35
lines changed

docs/admin/audit_log.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Here's a word-by-word breakout to demonstrate how the captured entry aligns with
5353

5454
- **Security Events** - [A list of events](./security_event_logs) such as logins, site configuration updates, code host configuration updates (_These logs can be sent to the database for easier collection as well as to the standard output_).
5555
- **Gitserver Access** - Requests to the [`gitserver`](./deploy/scale.mdx#gitserver) component that is responsible for brokering transactions between the git repos on disk and all other Sourcegraph components.
56-
- **GraphQL Requests** - Requests To The Sourcegraph [`frontend`](./deploy/scale.mdx#frontend) component that is usually named `sourcegraph-frontend-{DYNAMICALLY CREATED ALPHANUMERIC}`
56+
- **GraphQL Requests** - Requests To The Sourcegraph [`frontend`](./deploy/scale.mdx#frontend) component that is usually named `sourcegraph-frontend-{DYNAMICALLY CREATED ALPHANUMERIC}`
5757

5858
This list is expected to grow in the future.
5959

@@ -89,7 +89,7 @@ Audit logs are structured logs. As long as one can ingest logs, we assume one ca
8989

9090
### On Premises
9191

92-
All logs mentioned are delivered to the standard output (stdout) for each individual [component](./deploy/scale.mdx#core-components).
92+
All logs mentioned are delivered to the standard output (stdout) for each individual [component](./deploy/scale.mdx#core-components).
9393

9494

9595
There are two easy approaches to filtering the audit logs:
@@ -103,7 +103,7 @@ For Sourcegraph Cloud customers, please refer to Cloud [documentations](/cloud/#
103103

104104
## Developing
105105

106-
The single entry point to the audit logging API is made via the [`audit.Log`](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/internal/audit/audit.go?L19) function. This internal function can be used from any place in the app, and nothing else needs to be done for the logged entry to appear in the audit log.
106+
The single entry point to the audit logging API is made via the `audit.Log` function. This internal function can be used from any place in the app, and nothing else needs to be done for the logged entry to appear in the audit log.
107107

108108
Example call:
109109
```

docs/admin/config/advanced_config_file.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,6 @@ Where `extsvc.json` contains a JSON object that specifies _all_ of your code hos
9090
}
9191
```
9292

93-
You can find a full list of [valid top-level keys here](https://sourcegraph.com/github.com/sourcegraph/sourcegraph-public-snapshot@b7ebb9024e3a95109fdedfb8057795b9a7c638bc/-/blob/cmd/frontend/graphqlbackend/schema.graphql#L1104-1110).
94-
9593
If you want to _allow_ edits to be made through the web UI (which will be overwritten with what is in the file on a subsequent restart), you may additionally set `EXTSVC_CONFIG_ALLOW_EDITS=true`. **Note** that if you do enable this, it is your responsibility to ensure the configuration on your instance and in the file remain in sync.
9694

9795
## Global settings

docs/admin/enterprise_getting_started_guide/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ If you're deploying a new Enterprise instance, this page covers our most frequen
1818
- [GitHub integration](/integration/github)
1919
- [All code host integrations (not GitLab or GitHub)](/integration/#integrations)
2020
- [Full guide to site config options](/admin/config/site_config#auth-sessionExpiry)
21-
- [Changelog](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/CHANGELOG) to track releases and updates
21+
- [Changelog](https://sourcegraph.com/changelog) to track releases and updates
2222

2323
### Docker-compose
2424
- [Basic installation guide](/admin/deploy/docker-compose/)

docs/admin/executors/deploy_executors_binary.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ If you use the systemd service, simply run `systemctl start executor`, otherwise
155155
## Upgrading executors
156156

157157
Upgrading executors is relatively uninvolved. Simply follow the instructions below.
158-
Also, check the [changelog](https://sourcegraph.com/github.com/sourcegraph/sourcegraph@main/-/blob/CHANGELOG) for any Executors related breaking changes or new features that you might want to configure.
158+
Also, check the [changelog](https://sourcegraph.com/changelog) for any Executors related breaking changes or new features that you might want to configure.
159159

160160
### **Step 1:** First, grab the executor binary for the new target Sourcegraph version.
161161

docs/admin/executors/deploy_executors_binary_offline.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ To install the Firecracker sandbox image, import the image using `docker`.
168168
$ docker pull <docker repository image for sourcegraph/ignite:v0.10.5>
169169
```
170170

171-
> Note: Check the [version](https://sourcegraph.com/github.com/sourcegraph/sourcegraph@main/-/blob/cmd/executor/internal/config/consts.go?L15) against the version of executors being installed.
171+
> Note: Check the version against the version of executors being installed.
172172
173173
If you are using a custom image instead of the Sourcegraph image, you will need to set the environment variable
174174
`EXECUTOR_FIRECRACKER_SANDBOX_IMAGE` to match the image name.
@@ -181,7 +181,7 @@ To install the Firecracker Kernel image, import the image (`sourcegraph/ignite-k
181181
$ ignite kernel import --runtime docker <docker repository image for sourcegraph/ignite-kernel:5.10.135-amd64>
182182
```
183183

184-
> Note: Check the [version](https://sourcegraph.com/github.com/sourcegraph/sourcegraph@main/-/blob/cmd/executor/internal/config/consts.go?L18) against the version of executors being installed.
184+
> Note: Check the version against the version of executors being installed.
185185
186186
If you are using a custom image instead of the Sourcegraph image, you will need to set the environment variable
187187
`EXECUTOR_FIRECRACKER_KERNEL_IMAGE` to match the image name.

docs/admin/executors/deploy_executors_kubernetes.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,4 @@ The Executor Docker image is available on Docker Hub at [`sourcegraph/executor-k
134134

135135
### Example Configuration YAML
136136

137-
See
138-
the [local development YAMLs](https://sourcegraph.com/github.com/sourcegraph/sourcegraph-public-snapshot@main/-/blob/cmd/executor/kubernetes)
139-
for an example of how to configure the Executor in Kubernetes.
137+
See the local development YAMLs for an example of how to configure the Executor in Kubernetes.

docs/admin/executors/firecracker.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@ Executor can be fined tuned with the following environment variables,
4141

4242
## Known caveats
4343

44-
We [configure iptables](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/cmd/executor/internal/run/install.go?L229-255) to prevent Firecracker-isolated processes from talking on [Private IPv4 Addresses](https://en.wikipedia.org/wiki/Private_network#Private_IPv4_addresses) (providing network-level isolation). They can talk to DNS and Sourcegraph only, which prevents users from talking to a 10.x.x.x, 172.x.x.x, or 192.168.x.x range IP.
44+
We configure iptables to prevent Firecracker-isolated processes from talking on [Private IPv4 Addresses](https://en.wikipedia.org/wiki/Private_network#Private_IPv4_addresses) (providing network-level isolation). They can talk to DNS and Sourcegraph only, which prevents users from talking to a 10.x.x.x, 172.x.x.x, or 192.168.x.x range IP.

docs/admin/how-to/dirty_database_pre_3_37.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ _Note: for codeintel the schema version table is called `codeintel_schema_migrat
5151

5252
### 2. Run the sql queries to finish incomplete migrations
5353

54-
Sourcegraph's migration files take for form of `sql` files following the snake case naming schema `<version>_<description>.<up or down>.sql` and can be found [here](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/tree/migrations) in subdirectories for the specific database. _Note frontend is the pgsql database_.
54+
Sourcegraph's migration files take for form of `sql` files following the snake case naming schema `<version>_<description>.<up or down>.sql` in subdirectories for the specific database. _Note frontend is the pgsql database_.
5555

5656
1. **Find the up migration starting with the migration's version number identified in [step 1](#1-identify-incomplete-migration):** making sure to go to \<YOUR-SOURCEGRAPH-VERSION\>
5757

docs/admin/how-to/monorepo-issues.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The following bullets provide a general guidline to which service may require mo
1818

1919
If you are regularly seeing the `Processing symbols is taking longer than expected. Try again in a while` warning in your sidebar, its likely that your symbols and/or gitserver services are underprovisioned and need more CPU/mem resources.
2020

21-
The [symbols sidebar](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/client/web/src/repo/RepoRevisionSidebarSymbols.tsx?L42) is dependent on the symbols and gitserver services. Upon opening the symbols sidebar, a search query is made to the GraphQL API to retrieve the symbols associated with the current git commit. You can read more about the [symbol search behavior and performance](/code-search/types/symbol#symbol-search-behavior-and-performance).
21+
The symbols sidebar is dependent on the symbols and gitserver services. Upon opening the symbols sidebar, a search query is made to the GraphQL API to retrieve the symbols associated with the current git commit. You can read more about the [symbol search behavior and performance](/code-search/types/symbol#symbol-search-behavior-and-performance).
2222

2323
To address this concern, allocate more resources to the symbols service (to provide more processing power for indexing operations) and allocate more resources to the gitserver (to provide for the extra load associated with responding to fetch requests from symbols, and speed up sending the large repo).
2424

docs/admin/how-to/redis_configmap.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Reference Materials
4444

4545

4646

47-
1. Locate the original redis-cache configuration file: [https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/docker-images/redis-cache/redis.conf](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/docker-images/redis-cache/redis.conf) Use this as the “Default redis.conf file” content in the ConfigMap. Adding `requirepass` sets the password for Redis authentication.
47+
1. Locate the original redis-cache configuration file. Use this as the “Default `redis.conf` file” content in the ConfigMap. Adding `requirepass` sets the password for Redis authentication.
4848
2. Create the redis-cache-conf ConfigMap:
4949

5050
```
@@ -110,9 +110,9 @@ spec:
110110
```
111111

112112

113-
4. Locate the original redis-store configuration file. [https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/docker-images/redis-store/redis.conf](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/docker-images/redis-store/redis.conf) Use this as the “Default redis.conf file” content in the ConfigMap.
113+
1. Locate the original redis-store configuration file. Use this as the “Default `redis.conf` file” content in the ConfigMap.
114114

115-
5. Create the redis-store-conf ConfigMap:
115+
2. Create the redis-store-conf ConfigMap:
116116

117117
```
118118
apiVersion: v1

0 commit comments

Comments
 (0)