Skip to content

Update README.md #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 11, 2025
+0 −44
Merged

Update README.md #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 0 additions & 44 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,50 +17,6 @@ You can emit the following types of audit log events:

Official CAP documentation can be found [here](https://pages.github.tools.sap/cap/docs/java/auditlog).

# Consumption

To consume the Audit Log Service NG, follow these steps:

1. Complete the onboarding [process](https://jira.tools.sap/browse/ALSREQ-163).
2. Create a [user-provided service instance](https://docs.cloudfoundry.org/devguide/services/user-provided.html) in Cloud Foundry with the following credentials:

```json
{
"url": "als-endpoint",
"region": "als-region",
"namespace": "registered namespace",
"cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
"key": "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----",
"passphrase": "private key pass phrase" // optional
}
```

Example command:
```sh
cf cups auditlog-ng -p '{
"url": "https://your-als-endpoint",
"region": "your-region",
"namespace": "your-namespace",
"cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
"key": "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----",
"passphrase": "your-passphrase"
}' -t auditlog-ng
```

3. Bind the user-provided service instance to your application:
```
cf bind-service <your-app-name> auditlog-ng
```

4. Add the Maven Dependency
```xml
<dependency>
<groupId>com.sap.cds</groupId>
<artifactId>cds-feature-auditlog-ng</artifactId>
<version>auditlog-ng.version</version> <!-- e.g 1.0.4-SNAPSHOT -->
</dependency>
```

# Testing

For both local and cloud testing, refer to the [cloud-cap-samples-java](https://github.com/SAP-samples/cloud-cap-samples-java) repository and follow the instructions provided in its README.
Expand Down