-
Notifications
You must be signed in to change notification settings - Fork 1
feat: oracle db documentation #85
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
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| import Zoom from "react-medium-image-zoom"; | ||
| import "react-medium-image-zoom/dist/styles.css"; | ||
| import { FiExternalLink } from "react-icons/fi"; | ||
|
|
||
| # AWS Oracle | ||
|
|
||
| SleakOps facilitates the integration of Oracle databases through Amazon RDS (Relational Database Service). Amazon RDS for Oracle is a fully managed service that simplifies database setup, operation, and scaling. By leveraging SleakOps for this integration, you can efficiently manage Oracle databases within your EKS (Elastic Kubernetes Service) environment, ensuring robust, scalable, and reliable data storage solutions for your applications. | ||
|
|
||
|
|
||
| ## FAQs | ||
| <details> | ||
| <summary> | ||
| ### License | ||
| </summary> | ||
| When creating an Oracle DB using Sleakops License Included (LI). Currently Bring Your Own License (BYOL) is not supported, however, contact support for more information. | ||
|
agustinoli marked this conversation as resolved.
|
||
| </details> | ||
|
|
||
|
|
||
| <details> | ||
| <summary> | ||
| ### How does SleakOps manage Oracle credentials? | ||
| </summary> | ||
| When you create an Oracle dependency in SleakOps, it automatically generates a Vargroup for your database. This Variable Group securely stores the Oracle credentials and other important configuration details, such as the database endpoint and user access information. You'll be able of manage them from [Vargroups](/project/vargroup/index.mdx) section. | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary> | ||
| ### What is Multi-AZ deployment and should I enable it? | ||
| </summary> | ||
| Multi-AZ (Availability Zone) deployment ensures high availability and failover support by replicating your database in another availability zone. It's recommended for production environments to prevent downtime. Keep in mind that it increases costs. | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary> | ||
| ### Can I change the Oracle version after the database is deployed? | ||
| </summary> | ||
| No, the database engine version cannot be changed after deployment. You would need to create a new Oracle instance with the desired version and migrate your data. Or change it manually into the AWS Console. | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary> | ||
| ### What happens if I need more storage for my Oracle database? | ||
| </summary> | ||
| You can adjust the storage size when configuring your database. If you need more storage after deployment, you can scale modifying the settings in AWS as at the moment SleakOps does not support it. | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary> | ||
| ### How do I create a Oracle database dump? | ||
| </summary> | ||
| :::warning | ||
| The client is only available for x86-64 Linux distributions. | ||
| ::: | ||
| :::tip | ||
| Follow this link to install the [client <FiExternalLink/>](https://www.oracle.com/es/database/technologies/instant-client/linux-x86-64-downloads.html) | ||
| ::: | ||
| To create a dump of your Oracle database, use the following command: | ||
| ``` | ||
| exp ${ORACLE_USERNAME}/${ORACLE_PASSWORD}@${ORACLE_ENDPOINT}/${ORACLE_NAME} FILE=exp_file.dmp LOG=exp_file.log | ||
| ``` | ||
| Replace `ORACLE_USERNAME`, `ORACLE_ENDPOINT`, `ORACLE_NAME` and `ORACLE_PASSWORD` with the appropriate values. | ||
|
|
||
| For additional information on creating an Oracle dump, refer to the [official Oracle documentation <FiExternalLink/>](https://docs.oracle.com/en/database/oracle/oracle-database/19/sutil/oracle-original-export-utility.html). | ||
|
|
||
| Another option is creating it directly from the AWS Console and then import it. See [Restoring to a DB instance](https://docs.aws.amazon.com/es_es/AmazonRDS/latest/UserGuide/USER_RestoreFromSnapshot.html). | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary> | ||
| ### How do I import an existent dump ? | ||
| </summary> | ||
| :::warning | ||
| The client is only available for x86-64 Linux distributions. | ||
| ::: | ||
| :::tip | ||
| Follow this link to install the [client <FiExternalLink/>](https://www.oracle.com/es/database/technologies/instant-client/linux-x86-64-downloads.html) | ||
| ::: | ||
| You can use a Oracle client installed on your local machine to import the dump. | ||
| ``` | ||
| imp ${ORACLE_USERNAME}/${ORACLE_PASSWORD}@${ORACLE_ENDPOINT}/${ORACLE_NAME} FROMUSER=cust_schema TOUSER=cust_schema FILE=exp_file.dmp LOG=imp_file.log | ||
| ``` | ||
| Replace `ORACLE_USERNAME`, `ORACLE_ENDPOINT`, `ORACLE_NAME` and `ORACLE_PASSWORD` with the appropriate values. | ||
|
|
||
| For additional information on importing an Oracle dump, refer to the [official Oracle documentation <FiExternalLink/>](https://docs.oracle.com/en/database/oracle/oracle-database/19/sutil/oracle-original-import-utility.html). | ||
|
|
||
| Another option is creating it directly from the AWS Console and then import it. See [Restoring to a DB instance](https://docs.aws.amazon.com/es_es/AmazonRDS/latest/UserGuide/USER_RestoreFromSnapshot.html). | ||
|
|
||
| </details> | ||
|
|
||
| <details> | ||
| <summary> | ||
| ### What should I do if I encounter connection issues with my Oracle database? | ||
| </summary> | ||
| - Ensure the database endpoint, username, and password are correct. | ||
| - Verify that your security groups and firewall rules allow access. | ||
| - Ensure the database is running and has enough resources (CPU, memory). | ||
| Otherwise, contact us. | ||
| </details> | ||
|
agustinoli marked this conversation as resolved.
|
||
|
|
||
| :::info | ||
| AWS documentation: [Amazon RDS Oracle Documentation](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Oracle.html) | ||
| ::: | ||
|
|
||
| ## Set up your Oracle | ||
| ### 1. Add Oracle as a Dependency | ||
| To integrate Oracle with SleakOps: | ||
| 1. In the SleakOps console, go to the "Dependencies" section | ||
| 2. Choose "Oracle" from the list of available dependency types. | ||
| For more detail see [Dependencies: Integrating Databases, Caching, and Messaging Services](/project/dependency/index.mdx). | ||
|
|
||
| ### 2. Set up your Oracle. | ||
| You will access the following form: | ||
|
|
||
| <Zoom overlayBgColorEnd="rgba(255, 255, 255, 0.8)"> | ||
| <img | ||
| src="/img/dependency/Oracle/Oracle-create-p1.png" | ||
| alt="Oracle-create-p1" | ||
| /> | ||
| </Zoom> | ||
|
|
||
| Here the parameters that SleakOps allows you to customize during the creation: | ||
|
|
||
| | **Attribute** | **Description** | | ||
| | --- | --- | | ||
| | **Database Engine Version** | Select the specific version of the Oracle database engine you wish to use. This ensures compatibility with your application requirements. Example: `19.0.0.0.ru-2024-01.rur-2024-01.r1`| | ||
| | **Database Instance Class** | Define the instance class that specifies the hardware configuration for your Oracle database. This controls CPU, memory, and network performance. Example: `db.m6g.large`, `db.t3.medium`. See [AWS detail](https://aws.amazon.com/es/rds/instance-types/). | | ||
| | **Database Storage** | Specify the amount of storage allocated for the database. Example: 100 GB, 500 GB. | | ||
| | **Username** | Provide the master username for the Oracle database. This is the main user with administrative privileges. Example: admin, root. | | ||
| | **Password** | Password for the master user to access the database. | | ||
| | **Multi-Availability Zone** | Enable or disable Multi-AZ deployment. This ensures high availability and failover support by replicating the database across multiple availability zones. Recommended for production environments. | | ||
| | **Automated Backup** | Configure automated backups for the Oracle database. This ensures data protection by enabling daily snapshots and transaction log backups. Set up the _Backup Retention Period_ and the _Backup Window_. Recommended for production environments. | | ||
| | **Backup Retention Period** | Set the number of days to retain automated backups. | | ||
| | **Backup Window** | Period of time while the backup will be done. | | ||
|
|
||
| ### 3. Customize your variable's name for your Oracle data base. | ||
|
|
||
| As explained, when a dependency is created, SleakOps generates a vargroup to hold all the needed attributes. | ||
| In this step you can change the name of the attributes in case it is needed. | ||
| SleakOps completes the values automatically. | ||
| After this step, your dependency is created. | ||
|
|
||
| <Zoom overlayBgColorEnd="rgba(255, 255, 255, 0.8)"> | ||
| <img | ||
| src="/img/dependency/Oracle/Oracle-create-outputs.png" | ||
| alt="Oracle-create-outputs" | ||
| /> | ||
| </Zoom> | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.