Skip to content

Commit 23e8945

Browse files
authored
Update README.md
1 parent e9642ea commit 23e8945

File tree

1 file changed

+13
-11
lines changed
  • security/security-design/shared-assets/fn-datasafe-dbaudit-to-oci-logging

1 file changed

+13
-11
lines changed

security/security-design/shared-assets/fn-datasafe-dbaudit-to-oci-logging/README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ Oracle Functions is a serverless, highly scalable, fully managed Functions-as-a-
1111
This Reference Architecture describes OCI Logging based solution for collecting Oracle Datasafe Oracle DB Audit Logs for continuous monitoring and troubleshooting. An OCI Function pulls audit logs from Data Safe REST API Endpoints regularly and ingest them in OCI Logging.
1212
From OCI Logging Data Safe DB Audit Logs, can be send to OCI Logging Analytics, external SIEM and OCI Object Storage. See [Design Guidance for SIEM Integration](https://docs.oracle.com/en-us/iaas/Content/cloud-adoption-framework/siem-integration.htm)
1313

14-
## Prerequisites
14+
Reviewed: 01.02.2024
15+
16+
# Prerequisites
1517

1618
- Configure Data Safe to get Database Audit Events from Oracle DataBase.
1719

@@ -25,7 +27,7 @@ From OCI Logging Data Safe DB Audit Logs, can be send to OCI Logging Analytics,
2527

2628
If you don't have the required permissions and quota, contact your tenancy administrator. See [Policy Reference](https://docs.cloud.oracle.com/en-us/iaas/Content/Identity/Reference/policyreference.htm), [Service Limits](https://docs.cloud.oracle.com/en-us/iaas/Content/General/Concepts/servicelimits.htm), [Compartment Quotas](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcequotas.htm).
2729

28-
## Deploy Using Oracle Resource Manager
30+
# Deploy Using Oracle Resource Manager
2931

3032
1. Click [![Deploy to Oracle Cloud](https://oci-resourcemanager-plugin.plugins.oci.oraclecloud.com/latest/deploy-to-oracle-cloud.svg)](https://cloud.oracle.com/resourcemanager/stacks/create?region=home&zipUrl=https://github.com/oracle-devrel/technology-engineering/releases/download/fn-datasafe-to-oci-logging/fn-datasafe-dbaudit-to-oci-logging.zip)
3133

@@ -47,14 +49,14 @@ If you don't have the required permissions and quota, contact your tenancy admin
4749

4850
## Deploy Using the Terraform CLI
4951

50-
### Clone the Module
52+
## Clone the Module
5153
Now, you'll want a local copy of this repo. You can make that with the commands:
5254

5355
git clone https://github.com/oracle-devrel/technology-engineering.git
5456
cd security/security-design/fn-datasafe-dbaudit-to-oci-logging
5557
ls
5658

57-
### Prerequisites
59+
## Prerequisites
5860
First off, you'll need to do some pre-deploy setup for Docker and Fn Project inside your machine:
5961

6062
```
@@ -84,7 +86,7 @@ curl -LSs https://raw.githubusercontent.com/fnproject/cli/master/install | sh
8486
Also, please follow this [note](https://docs.oracle.com/en-us/iaas/Content/Functions/Tasks/functionsinstalldocker.htm#Install_Docker_for_Use_with_Oracle_Functions__section_podman_instead_of_docker). By default, Fn Project (and by extension, OCI Functions) assumes the use of Docker to build and deploy function images. However, Fn Project also supports Podman as an alternative to Docker. When using Fn Project CLI version 0.6.12 and above, you can set a configuration setting to specify that you want to use Podman instead of Docker.
8587

8688

87-
### Set Up and Configure Terraform
89+
## Set Up and Configure Terraform
8890

8991
1. Complete the prerequisites described [here](https://github.com/cloud-partners/oci-prerequisites).
9092

@@ -114,31 +116,31 @@ deployment_name="<deployment name>"
114116

115117
Please note that the `terraform.tfvars` file will include sensitive information and needs to be protected from unauthorized usage.
116118

117-
### Create the Resources
119+
## Create the Resources
118120
Run the following commands:
119121

120122
terraform init
121123
terraform plan
122124
terraform apply
123125

124-
### Test the stack
126+
## Test the stack
125127

126128
You can test the stack by login/logout in the DB already integrated with Data Safe that generates DB audit log. The function will load the logs in 1 minutes and you can see it in Logging Console.
127129
In Logging Console will be present a new Log Group (ex. loggr-test-eu-milan-1-fn_ds_to_ol-d54e) and relative 2 logs:
128130
- Log with data from Data Safe: Log Type Custom (example log name: log-test-eu-milan-1-fn_ds_to_ol-d54e)
129131
- Log execution function: Log Type Service (example log name: fn-datasafe-dbaudit-test-eu-milan-1-fn_ds_to_ol-d54e)
130132

131-
### Destroy the Deployment
133+
## Destroy the Deployment
132134
When you no longer need the deployment, you can run this command to destroy the resources:
133135

134136
terraform destroy
135137

136138
If there is error in destroying the object storage bucket, manually delete the bucket and run "terraform destroy" again.
137139

138-
### Test Environment
140+
## Test Environment
139141
We tested the terraform script in [Oracle Linux Cloud Developer Image](https://docs.oracle.com/en-us/iaas/oracle-linux/developer/index.htm) and Oracle Resource Manager.
140142

141-
### Architecture Diagram
143+
## Architecture Diagram
142144
![](./images/DatasafetoOCILoggingArchitecture.jpg)
143145

144146
# License
@@ -147,4 +149,4 @@ Copyright (c) 2024 Oracle and/or its affiliates.
147149

148150
Licensed under the Universal Permissive License (UPL), Version 1.0.
149151

150-
See [LICENSE](https://github.com/oracle-devrel/technology-engineering/blob/main/LICENSE) for more details.
152+
See [LICENSE](https://github.com/oracle-devrel/technology-engineering/blob/main/LICENSE) for more details.

0 commit comments

Comments
 (0)