Skip to content

Commit e5b6a9c

Browse files
committed
add specific section for oidc config
1 parent 535394e commit e5b6a9c

File tree

1 file changed

+28
-5
lines changed

1 file changed

+28
-5
lines changed

docs/guides/modules/security/pages/audit-logs.adoc

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,33 @@ The setup steps vary by provider. At a high level you will:
233233
+
234234

235235

236-
==== 2. Configure CircleCI to stream to your S3-compatible service
236+
==== 2. Authentication and authorization considerations
237+
238+
**Key OIDC configuration details**:
239+
240+
When setting up the OIDC Identity Provider to trust CircleCI, use these parameters:
241+
242+
* **OpenID Configuration URL (Issuer URL):**
243+
`https://oidc.circleci.com/org/**<YOUR_CIRCLECI_ORG_ID>/**.well-known/openid-configuration`
244+
*(Remember to substitute your actual CircleCI Organization ID.)*
245+
246+
* **OpenID Client ID (Audience):**
247+
Your **CircleCI Organization ID** (the `<YOUR_CIRCLECI_ORG_ID>` value).
248+
249+
* **Scope:**
250+
Use the standard required scope: `openid`.
251+
252+
**Validation and network requirements**:
253+
254+
* **Server Endpoint Connectivity:**
255+
The **AWS S3 compatible server**, acting as the token validator, **must be able to reach** the CircleCI OIDC Provider endpoint to fetch the public keys required to **validate the token's cryptographic signature**.
256+
257+
* **Provider Validation:**
258+
Your OIDC provider configuration must be set up to accept and successfully validate CircleCI's OIDC tokens for the configured **role or principal** you intend to grant access to within your storage solution.
259+
260+
NOTE: Ensure your **AWS S3 compatible server's** network configuration allows necessary outgoing connections to the internet, specifically to `oidc.circleci.com`, for token validation to succeed.
261+
262+
==== 3. Configure CircleCI to stream to your S3-compatible service
237263

238264
. Go to the link:https://app.circleci.com/[CircleCI web app] and navigate to menu:Organization Settings[Security].
239265
. In menu:Audit Logs[Streaming audit logs], select btn:[Stream audit logs].
@@ -242,7 +268,7 @@ The setup steps vary by provider. At a high level you will:
242268
+
243269
image::guides:ROOT:setup-s3-compatible-audit-logs.png[Set up S3-compatible storage for streaming]
244270
. Fill out the fields as follows:
245-
.. **Region**: Optional. Many s3-compatible providers default to `us-east-1` if not set.
271+
.. **Region**: Optional. Many S3-compatible providers default to `us-east-1` if not set.
246272
.. **S3 Bucket Name**: The exact name of the bucket you created.
247273
.. **Role ARN**: The role identifier recognized by your provider (for example, a provider-specific role ID/ARN).
248274
.. **Endpoint**: The HTTPS endpoint of your S3-compatible API (for example, `https://s3.<region>.<provider-domain>` or your custom host and port).
@@ -253,9 +279,6 @@ image::guides:ROOT:form-s3-compatible-audit-logs.png[Connect CircleCI to S3-comp
253279

254280
When the connection is validated, the **Status** will show image:guides:ROOT:icons/passed.svg[passed icon, role="no-border"] **Connected**. Creating a streaming configuration pushes an empty file named `circleci_connectivity_test_<timestamp>` to the configured bucket to verify permissions.
255281

256-
NOTE: Ensure your endpoint is reachable from CircleCI and that your provider accepts and validates CircleCI OIDC tokens for the configured role/principal. Network policies, firewalls, TLS, and trust configuration must allow secure access from CircleCI to your endpoint.
257-
258-
259282
=== Manage active streams
260283

261284
Once configured, you can view and manage audit log streams. The following options are available to you in the CircleCI web app:

0 commit comments

Comments
 (0)