Skip to content

Update README.md #144

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.

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 3 commits into from
Sep 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,8 @@ Oracle strongly recommends that you ensure your system meets the following [Prer
```sh
kubectl apply -f rbac/node-rbac.yaml
```
# Installation
## Install Oracle DB Operator
## Installation
### Install Oracle DB Operator

After you have completed the preceding prerequisite changes, you can install the operator. To install the operator in the cluster quickly, you can apply the modified `oracle-database-operator.yaml` file from the preceding step.

Expand All @@ -154,7 +154,7 @@ Oracle strongly recommends that you ensure your system meets the following [Prer
You should see that the operator is up and running, along with the shipped controllers.

For more details, see [Oracle Database Operator Installation Instructions](./docs/installation/OPERATOR_INSTALLATION_README.md).

## Documentation
## Getting Started with the Operator (Quickstart)

The following quickstarts are designed for specific database configurations:
Expand All @@ -170,6 +170,7 @@ The following quickstarts are designed for specific database configurations:
The following quickstart is designed for non-database configurations:
* [Oracle Database Observability](./docs/observability/README.md)

## Examples
YAML file templates are available under [`/config/samples`](./config/samples/). You can copy and edit these template files to configure them for your use cases.

## Uninstall the Operator
Expand Down Expand Up @@ -221,15 +222,15 @@ YAML file templates are available under [`/config/samples`](./config/samples/).

## Contributing

See [Contributing to this Repository](./CONTRIBUTING.md)
This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)

## Support
## Help

You can submit a GitHub issue, oir submit an issue and then file an [Oracle Support service](https://support.oracle.com/portal/) request. To file an issue or a service request, use the following product ID: 14430.

## Security

Secure platforms are an important basis for general system security. Ensure that your deployment is in compliance with common security practices.
Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process

### Managing Sensitive Data

Expand All @@ -244,10 +245,6 @@ The following is an example of a YAML file fragment for specifying Oracle Cloud

Examples in this repository where passwords are entered on the command line are for demonstration purposes only.

### Reporting a Security Issue

See [Reporting security vulnerabilities](./SECURITY.md)

## License

Copyright (c) 2022, 2024 Oracle and/or its affiliates.
Expand Down
6 changes: 3 additions & 3 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Oracle's instructions for reporting security vulnerabilities
# Reporting security vulnerabilities

Oracle values the independent security research community and believes that
responsible disclosure of security vulnerabilities helps us ensure the security
Expand All @@ -21,7 +21,7 @@ security features are welcome on GitHub Issues.

Security updates will be released on a regular cadence. Many of our projects
will typically release security fixes in conjunction with the
[Oracle Critical Patch Update][3] program. Additional
Oracle Critical Patch Update program. Additional
information, including past advisories, is available on our [security alerts][4]
page.

Expand All @@ -35,4 +35,4 @@ sufficiently hardened for production use.
[1]: mailto:secalert_us@oracle.com
[2]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
[3]: https://www.oracle.com/security-alerts/encryptionkey.html
[4]: https://www.oracle.com/security-alerts/
[4]: https://www.oracle.com/security-alerts/