Skip to content

Commit b673f7c

Browse files
committed
Spruce up docs
1 parent 41545c8 commit b673f7c

33 files changed

+710
-270
lines changed

docs/cloud.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<!--
22
{
3-
"name": "Cloud",
3+
"name": "Cloud Quickstart",
44
"category": "5eeba6a6c5230e48eea60f18",
55
"priority": 800
66
}
77
-->
88

9-
# BuildBuddy Cloud
9+
# Cloud Quickstart
1010

1111
[Cloud BuildBuddy](https://app.buildbuddy.io/) is a fully managed SaaS solution for Enterprise Bazel features. It provides a results store & UI, remote build caching, remote build execution, and more.
1212

@@ -38,8 +38,7 @@ INFO: Streaming build results to: https://app.buildbuddy.io/invocation/24a37b8f-
3838
INFO: Build completed successfully, 1 total action
3939
```
4040

41-
You can ⌘ + double-click on these urls to quickly view the invocation's details.
42-
41+
You can ⌘ + double-click on these urls to quickly view the invocation's details.
4342

4443
## Authentication
4544

docs/config-api.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,24 @@
77
-->
88

99
# API Configuration
10+
1011
The API is only configurable in the [Enterprise version](enterprise.md) of BuildBuddy.
1112

1213
## Section
1314

14-
```api:``` The API section enables the BuildBuddy API over both gRPC(s) and REST HTTP(s). **Optional**
15+
`api:` The API section enables the BuildBuddy API over both gRPC(s) and REST HTTP(s). **Optional**
1516

1617
## Options
1718

1819
**Optional**
1920

20-
* ```enable_api:``` Whether or not to enable the BuildBuddy API.
21+
- `enable_api:` Whether or not to enable the BuildBuddy API.
2122

22-
* ```api_key:``` The default API key to use for on-prem enterprise deploys with a single organization/group.
23+
- `api_key:` The default API key to use for on-prem enterprise deploys with a single organization/group.
2324

2425
## Example section
2526

2627
```
2728
api:
2829
enable_api: true
29-
```
30+
```

docs/config-app.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,28 @@
55
"priority": 800
66
}
77
-->
8-
# App Configuration
98

9+
# App Configuration
1010

1111
## Section
1212

13-
```app:``` The app section contains app-level options. **Required**
13+
`app:` The app section contains app-level options. **Required**
1414

1515
## Options
1616

1717
**Required**
1818

19-
* ```build_buddy_url``` Configures the external URL where your BuildBuddy instance can be found. (Does not actually change the server address or port, see [flags docs](config-flags.md) for information on how to configure ports)
19+
- `build_buddy_url` Configures the external URL where your BuildBuddy instance can be found. (Does not actually change the server address or port, see [flags docs](config-flags.md) for information on how to configure ports)
2020

2121
**Optional**
2222

23-
* ```events_api_url``` Overrides the default build event protocol gRPC address shown by BuildBuddy on the configuration screen. (Does not actually change the server address)
23+
- `events_api_url` Overrides the default build event protocol gRPC address shown by BuildBuddy on the configuration screen. (Does not actually change the server address)
2424

25-
* ```cache_api_url``` Overrides the default remote cache protocol gRPC address shown by BuildBuddy on the configuration screen. (Does not actually change the server address)
25+
- `cache_api_url` Overrides the default remote cache protocol gRPC address shown by BuildBuddy on the configuration screen. (Does not actually change the server address)
2626

27-
* ```remote_execution_api_url``` Overrides the default remote execution protocol gRPC address shown by BuildBuddy on the configuration screen. (Does not actually change the server address)
27+
- `remote_execution_api_url` Overrides the default remote execution protocol gRPC address shown by BuildBuddy on the configuration screen. (Does not actually change the server address)
2828

29-
* ```default_to_dense_mode``` Enables Dense UI mode by default.
29+
- `default_to_dense_mode` Enables Dense UI mode by default.
3030

3131
## Example section
3232

docs/config-auth.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,23 @@
55
"priority": 300
66
}
77
-->
8+
89
# Auth Configuration
910

1011
Auth is only configurable in the [Enterprise version](enterprise.md) of BuildBuddy.
1112

1213
## Section
1314

14-
```auth:``` The Auth section enables BuildBuddy authentication using an OpenID Connect provider that you specify. **Optional**
15-
15+
`auth:` The Auth section enables BuildBuddy authentication using an OpenID Connect provider that you specify. **Optional**
1616

1717
## Options
18-
* ```oauth_providers:``` A list of configured OAuth Providers.
19-
* ```issuer_url: ``` The issuer URL of this OIDC Provider.
20-
* ```client_id: ``` The oauth client ID.
21-
* ```client_secret: ``` The oauth client secret.
22-
* ```enable_anonymous_usage:``` If true, unauthenticated build uploads will still be allowed but won't be associated with your organization.
18+
19+
- `oauth_providers:` A list of configured OAuth Providers.
20+
- `issuer_url: ` The issuer URL of this OIDC Provider.
21+
- `client_id: ` The oauth client ID.
22+
- `client_secret: ` The oauth client secret.
23+
- `enable_anonymous_usage:` If true, unauthenticated build uploads will still be allowed but won't be associated with your organization.
24+
2325
## Google auth provider
2426

2527
If you'd like to use Google as an auth provider, you can easily obtain your client id and client secret [here](https://console.developers.google.com/apis/credentials).
@@ -32,4 +34,4 @@ auth:
3234
- issuer_url: "https://accounts.google.com"
3335
client_id: "12345678911-f1r0phjnhbabcdefm32etnia21keeg31.apps.googleusercontent.com"
3436
client_secret: "sEcRetKeYgOeShErE"
35-
```
37+
```

docs/config-cache.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,32 @@
55
"priority": 500
66
}
77
-->
8+
89
# Cache Configuration
910

1011
## Section
1112

12-
```cache:``` The cache section enables the BuildBuddy cache and configures how and where it will store data. **Optional**
13+
`cache:` The cache section enables the BuildBuddy cache and configures how and where it will store data. **Optional**
1314

1415
## Options
1516

1617
**Optional**
1718

18-
* ```max_size_bytes:``` How big to allow the cache to be (in bytes).
19+
- `max_size_bytes:` How big to allow the cache to be (in bytes).
20+
21+
- `in_memory:` Whether or not to use the in_memory cache.
1922

20-
* ```in_memory:``` Whether or not to use the in_memory cache.
23+
- `disk:` The Disk section configures a disk-based cache.
2124

22-
* ```disk:``` The Disk section configures a disk-based cache.
25+
- `root_directory` The root directory to store cache data in, if using the disk cache. This directory must be readable and writable by the BuildBuddy process. The directory will be created if it does not exist.
2326

24-
- ```root_directory``` The root directory to store cache data in, if using the disk cache. This directory must be readable and writable by the BuildBuddy process. The directory will be created if it does not exist.
27+
- `redis_target`: A redis target for improved RBE performance. ** Enterprise only **
2528

2629
## Example section
30+
2731
```
2832
cache:
2933
max_size_bytes: 10000000000 # 10 GB
3034
disk:
3135
root_directory: /tmp/buildbuddy-cache
32-
```
36+
```

docs/config-database.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,18 @@
55
"priority": 700
66
}
77
-->
8+
89
# Database Configuration
910

1011
## Section
1112

12-
```database:``` The database section configures the database that BuildBuddy stores metadata in. **Required**
13+
`database:` The database section configures the database that BuildBuddy stores metadata in. **Required**
1314

1415
## Options
1516

1617
**Required**
1718

18-
* ```data_source``` This is a connection string used by the database driver to connect to the database. MySQL and SQLite databases are supported.
19+
- `data_source` This is a connection string used by the database driver to connect to the database. MySQL and SQLite databases are supported.
1920

2021
## Example sections
2122

@@ -31,4 +32,4 @@ database:
3132
```
3233
database:
3334
data_source: "mysql://buildbuddy_user:pAsSwOrD@tcp(12.34.56.78)/buildbuddy_db"
34-
```
35+
```

docs/config-flags.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,11 @@
55
"priority": 100
66
}
77
-->
8+
89
# BuildBuddy Flags
910

1011
There are several configuration options that are not in the BuildBuddy configuration file. These are:
1112

12-
* ```--listen``` The interface that BuildBuddy will listen on. Defaults to 0.0.0.0 (all interfaces)
13-
* ```--port``` The port to listen for HTTP traffic on. Defaults to 8080.
14-
* ```--grpc_port``` The port to listen for gRPC traffic on. Defaults to 1985.
13+
- `--listen` The interface that BuildBuddy will listen on. Defaults to 0.0.0.0 (all interfaces)
14+
- `--port` The port to listen for HTTP traffic on. Defaults to 8080.
15+
- `--grpc_port` The port to listen for gRPC traffic on. Defaults to 1985.

docs/config-github.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,35 +7,39 @@
77
-->
88

99
# Github Configuration
10+
1011
In order to configure BuildBuddy's GitHub integration, you'll either need to:
12+
1113
- [create an access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) with the `repo:status` scope. This is the supported method for BuildBuddy open source.
12-
- or [create a Github Oauth app](https://docs.github.com/en/developers/apps/creating-an-oauth-app). In the `Authorization callback URL` field - you'll need to enter your BuildBuddy application url, followed by the path `/auth/`. For example: `https://https://app.buildbuddy.io/auth/`. This is the recommended method for BuildBuddy Enterprise.
14+
- or [create a Github Oauth app](https://docs.github.com/en/developers/apps/creating-an-oauth-app). In the `Authorization callback URL` field - you'll need to enter your BuildBuddy application url, followed by the path `/auth/`. For example: `https://https://app.buildbuddy.io/auth/`. This is the recommended method for BuildBuddy Enterprise.
1315

1416
## Section
1517

16-
```github:``` The Github section enables the posting of BuildBuddy Github commit statuses for CI runs. **Optional**
18+
`github:` The Github section enables the posting of BuildBuddy Github commit statuses for CI runs. **Optional**
1719

1820
## Options
1921

2022
**Optional**
2123

22-
* ```access_token:``` The GitHub access token used to post GitHub commit statuses.
24+
- `access_token:` The GitHub access token used to post GitHub commit statuses.
2325

24-
* ```client_id:``` The client ID of your Github Oauth App. [ENTERPRISE ONLY]
26+
- `client_id:` The client ID of your Github Oauth App. [ENTERPRISE ONLY]
2527

26-
* ```client_secret:``` The client secret of your Github Oauth App. [ENTERPRISE ONLY]
28+
- `client_secret:` The client secret of your Github Oauth App. [ENTERPRISE ONLY]
2729

2830
## Example section
2931

3032
Open source with access token:
33+
3134
```
3235
github:
3336
access_token: abc123
3437
```
3538

3639
Enterprise with Oauth app:
40+
3741
```
3842
github:
3943
client_id: abc123
4044
client_secret: def456
41-
```
45+
```

docs/config-integrations.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,20 @@
55
"priority": 300
66
}
77
-->
8+
89
# Integration Configuration
910

1011
## Section
1112

12-
```integrations:``` A section configuring optional external services BuildBuddy can integrate with, like Slack. **Optional**
13+
`integrations:` A section configuring optional external services BuildBuddy can integrate with, like Slack. **Optional**
1314

1415
## Options
1516

1617
**Optional**
1718

18-
* ```slack:``` A section configuring Slack integration.
19+
- `slack:` A section configuring Slack integration.
1920

20-
* ```webhook_url``` A webhook url to post build update messages to.
21+
- `webhook_url` A webhook url to post build update messages to.
2122

2223
## Getting a webhook url
2324

@@ -29,4 +30,4 @@ For more instructions on how to get a Slack webhook url, see the [Slack webhooks
2930
integrations:
3031
slack:
3132
webhook_url: "https://hooks.slack.com/services/AAAAAAAAA/BBBBBBBBB/1D36mNyB5nJFCBiFlIOUsKzkW"
32-
```
33+
```

docs/config-misc.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,24 @@
55
"priority": 200
66
}
77
-->
8+
89
# Miscellaneous Configuration
910

1011
## BuildEventProxy Section
11-
```build_event_proxy:``` The BuildEventProxy section configures proxy behavior, allowing BuildBuddy to forward build events to other build-event-protocol compatible servers. **Optional**
12+
13+
`build_event_proxy:` The BuildEventProxy section configures proxy behavior, allowing BuildBuddy to forward build events to other build-event-protocol compatible servers. **Optional**
1214

1315
## Options
1416

1517
**Optional**
1618

17-
* ```hosts``` A list of host strings that BuildBudy should connect and forward events to.
19+
- `hosts` A list of host strings that BuildBudy should connect and forward events to.
1820

1921
## Example section
22+
2023
```
2124
build_event_proxy:
2225
hosts:
2326
- "grpc://localhost:1985"
2427
- "grpc://events.buildbuddy.io:1985"
2528
```
26-
27-

0 commit comments

Comments
 (0)