Skip to content

Commit 7bea6e9

Browse files
authored
cloud: update logpush docs (#1267)
<!-- Explain the changes introduced in your PR --> ## Pull Request approval You will need to get your PR approved by at least one member of the Sourcegraph team. For reviews of docs formatting, styles, and component usage, please tag the docs team via the #docs Slack channel.
1 parent 3c2a469 commit 7bea6e9

File tree

3 files changed

+55
-5
lines changed

3 files changed

+55
-5
lines changed

docs/cloud/index.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,7 @@ To learn more about how the Sourcegraph team operates managed SMTP internally, r
154154

155155
### Audit Logs
156156

157-
Our Cloud instances provide [audit logs](/admin/audit_log#cloud) to help you monitor and investigate actions taken by users and the system. These logs are available to download by request and are also sent to a [centralized logging service](https://about.sourcegraph.com/security#logging) for 30 day retention. Should you wish to
158-
extend this period, please be aware that additional charges will apply.
157+
Our Cloud instances provide [audit logs](/admin/audit_log#cloud) to help you monitor and investigate actions taken by users and the system. These logs are available to download by request and are also sent to a [centralized logging service](https://about.sourcegraph.com/security#logging) for 30 day retention. Should you wish to extend this period, please be aware that additional charges will apply.
159158
To request an extension, please contact your assigned Customer Engineer (CE) or send an email to Sourcegraph Support at [email protected].
160159

161160
#### Download audit logs
@@ -164,12 +163,12 @@ For requesting audit logs, please contact your our support team.
164163

165164
#### Deliver audit logs to customer-managed destination (LogPush)
166165

167-
Sourcegraph LogPush is an optional add-on to deliver audit logs to a customer provided destination. To enable this feature, please contact your assigned Customer Engineer (CE) or support team.
166+
Sourcegraph LogPush is an optional add-on to deliver audit logs to a customer provided destination. To enable this feature, please contact your assigned Customer Engineer (CE) or support team to obtain the setup instructions for your destination.
168167

169168
Supported destinations:
170169

171-
- Google Cloud Storage (GCS)
172-
- Amazon S3 (AWS)
170+
- [Google Cloud Storage (GCS)](./logpush_gcs)
171+
- [Amazon Web Services S3 (AWS)](./logpush_s3)
173172

174173
## Requirements
175174

docs/cloud/logpush_gcs.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# LogPush for Google Cloud Storage (GCS)
2+
3+
## Overview
4+
5+
Our services will periodically push audit logs to customer-managed GCS bucket. Authentication and authorization are securely handled by GCP IAM service.
6+
7+
## Steps
8+
9+
To enable this feature, please contact your assigned Customer Engineer (CE) or support team to obtain the specific instruction. Below is a high level overview of the steps.
10+
11+
- Sourcegraph provides below information to customer:
12+
- email of a Sourcegraph-owned GCP Service Account (GSA)
13+
- a unique file to prove bucket ownership
14+
- Customer to perform the following:
15+
- creates a GCS bucket
16+
- grants the Sourcegraph-owned GSA sufficient IAM roles to access the bucket
17+
- uploads the ownership file to prove bucket ownership
18+
- Customer to inform Sourcegraph of the bucket name
19+
20+
Once completed, Sourcegraph will complete the LogPush configuration and start sending logs to the customer-managed GCS bucket.

docs/cloud/logpush_s3.mdx

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# LogPush for Amazon S3 (AWS)
2+
3+
## Overview
4+
5+
Our services will periodically push audit logs to customer-managed AWS S3 bucket. Authentication and authorization are securely handled by AWS Security Token Service with an explicit trust relationship between Sourcegraph-owned GCP identity (GCP Service Account) and the customer-managed AWS S3 bucket.
6+
7+
## Steps
8+
9+
To enable this feature, please contact your assigned Customer Engineer (CE) or support team to obtain the specific instruction. Below is a high level overview of the steps.
10+
11+
- Sourcegraph provides below information to customer:
12+
- GCP identity (GCP Service Account)
13+
- a unique file to prove bucket ownership
14+
- Customer to perform the following:
15+
- creates a S3 bucket
16+
- configures the trust relationship with AWS IAM
17+
- uploads the ownership file to prove bucket ownership
18+
- Customer to inform Sourcegraph of the S3 bucket ARN and the AWS IAM role ARN
19+
20+
Once completed, Sourcegraph will complete the LogPush configuration and start sending logs to the customer-managed S3 bucket.
21+
22+
## FAQ
23+
24+
### How does the authentication work?
25+
26+
Sourcegraph will provide instructions on how to configure the trust relationship between the Sourcegraph-owned GCP identity (GCP Service Account) and the customer-managed AWS S3 bucket. We will also provide the example configuration in Terraform. At a high level:
27+
28+
- Customer creates a AWS IAM role:
29+
- with a policy to permit such role to access the S3 bucket
30+
- with a policy to permit the Sourcegraph-owned GSA to assume such role
31+
- Sourcegraph assumes the provisioned AWS IAM role to access the bucket

0 commit comments

Comments
 (0)