Oracle Database Sharding on OCI Marketplace
-
Deploying Oracle Database Sharding on Oracle Cloud Marketplace
- Finding Oracle Database Sharding on Oracle Cloud (OCI) Marketplace
- Pre-Requisites for creating an Oracle Database Sharding instance on OCI marketplace
- Fill in the required Stack information
- Fill in the Sharding configuration details
- Oracle Database Sharding Deployment job
- Managing Oracle Database Sharding previously created from OCI Marketplace
- Terminating Oracle Database Sharding created from Oracle Cloud Marketplace
- Oracle Database Sharding Resources
- Choose Products->IaaS
- Choose Oracle Cloud Infrastructure
- Select Oracle Database Sharding from the list of Featured Apps.
- If you don't find Oracle Database Sharding in the Featured Apps section for some reason, then just search for it in the products search bar.
Oracle Database Sharding can be found on the featured list right at the top of the OCI applications on Oracle public marketplace.
- Go directly to the following listing link at :
Oracle Database Sharding Listing on Oracle Cloud Public Marketplace
- Once you login to the OCI console, Click on the left hamburger navigation menu.
- Next, select OCI marketplace under solutions & marketplace section in the left navigation menu.
- Next, you should be able to immediately find Oracle Database Sharding in the Featured Apps.
- If you don't find Oracle Database Sharding for some reason in the featured apps section, then just search for it in the marketplace search bar.
- Click on the Oracle Database Sharding Tile which will bring up the product listing for Oracle Database Sharding.
Oracle Database Sharding Listing
As specified in the system requirements section of the Oracle Database Sharding listing, the following pre-requisites are recommended to be checked before deploying sharded database.
Since automatic and uniform distribution of Sharded database resources within a region is employed, users are recommended to check if they have sufficient number of the below listed resources/services in each availability domain within the region selected, before initial deployment/scaling of Sharded Database.
The resources/services to check for limits, quotas and availability in the Governance section of the hamburger menu on the left navigation pane are :
-
Database service for Shard and Catalog databases (based on the shape that user wants to select).
-
Compute service for Shard Directors (based on the shape that user wants to select).
After clicking on Launch instance on the Oracle Database Sharding Marketplace product page, Fill in the required Stack information.
- Name - Name of the Stack. It has a default name and provides a date time stamp. You can edit this detail, if required.
- Description - Description that you provide while creating the Stack.
- Create In Compartment – It defaults to the compartment you had selected on the Oracle Database Sharding Marketplace page before clicking on Launch stack.
- Terraform Version - It defaults to 0.12x.
- Tags (optional) – Tags are a convenient way to assign a tracking mechanism but are not mandatory. You can assign a tag of your choice for easy tracking. You have to assign a tag for some environments for cost analysis purposes.
Click Next.
Oracle Sharded Database General Configuration
- SHARDED DATABASE NAME - The name is used as the sharded database name as well as a prefix for all sharded database resource display names. The name specified must be unique within the subnet.
- SHARDING METHOD
- DATABASE SOFTWARE EDITION
- CHOOSE STORAGE MANAGEMENT SOFTWARE
- CHOOSE A LICENSE TYPE
- DATABASE VERSION
Shard configuration
- SHARD SHAPE
- NUMBER OF PRIMARY SHARDS - The number of primary shard catalog databases. The total number of Shard catalog databases provisioned is determined by the value of the Replication Factor chosen. Shard Catalogs will be uniformly distributed across all availability domains in the current region and across fault domains within each availability domain.
- SHARD DATABASE AVAILABLE STORAGE SIZE IN GB
Shard Catalog configuration
- SHARD CATALOG SHAPE
- NUMBER OF PRIMARY SHARD CATALOGS
- SHARD CATALOG DATABASE AVAILABLE STORAGE SIZE IN GB
Replication configuration
- REPLICATION FACTOR - Choose a replicaton factor. The total number of shard databases provisioned will be equal to the number of primary shards selected above multiplied by the chosen Replication Factor. The total number of primary catalog databases that will be provisioned will be equal to the Replication Factor chosen.
Shard Director configuration
- SHARD DIRECTOR SHAPE
- NUMBER OF SHARD DIRECTORS - Choose the number of shard directors to be deployed.
Network Settings
- CREATE NEW NETWORK - Check this to create a new regional network (recommended if this is your first sharded database) or Uncheck to use an existing regional network from a previously created sharded database
- VCN NETWORK COMPARTMENT- Compartment for new or existing Virtual Cloud Network (VCN)
- VCN - Existing VCN to use for sharded database if not creating a new network
- SUBNET NETWORK COMPARTMENT - Compartment for new or existing Subnet
- CHOOSE A REGIONAL SUBNET - Existing Regional Subnet to use for sharded database if not creating a new network.
ssh configuration
- SSH PUBLIC KEY - Public key for allowing SSH access to the sharded database hosts.
- On the Review page, review the information you provided and then click Create.
- After clicking Create, you will be navigated to the Stacks Job Details page. You can monitor the creation of the Oracle Database Sharding using this page.
- Upon completion, you can now view the output pane on the left for connection information to Oracle Sharded Database.
Once you click create on the review page show above, an Oracle Resource Manager (ORM) job is automatically created which starts deploying Oracle Sharded Database.
After, about 15 minutes for deployments with Replication Factor set to 1 or 45 minutes for deployments with Replication Factor set to 2, the Oracle Sharded Database deployment job would have succeeded as show below.
All resources that are provisioned for the successful deployment of Oracle Sharded Database are listed in the associated resources pane on the left menu within the job page, as shown below.
Shard Director which is a compute can be directly accessed by clicking on the sd resource link.
- Click on the shard director resource selected below.
2. A new tab opens up with the details of the compute on which the Shard Director runs and is as shown below
Shard which is a Oracle database can be directly accessed by clicking on the sh resource link.
- Click on the shard resource selected below.
- A new tab opens up with the details of the database db system on which the Shard lives and is as shown below
The initial random credentials for Oracle Database Sharding is available in the view state which is securely stored within Oracle Resource Manager. Users are recommended to change this on their first attempt to use these initial random passwords.
- Click on the left hamburger navigation Menu. Choose Resource Manager under Solutions and Marketplace.
- Select the stack that you created from marketplace.
- Click on Edit Stack.
Shards can be scaled in (decreased) or out (decreased) based on user requirements and as needed without affecting performance of queries per second(qps) or transactions per second (tps) and with zero downtime.
-
Update the number of Shard Directors
-
Review and Save changes
- Next click on Terraform Actions → Apply
After clicking on apply job, a confirmation dialog pops up to make sure that the user wants to indeed apply the changes to the existing sharded database deployment.
Depending upon the changes requested in the sharding edit stack, the apply job will make the necessary changes in the sharded database resources. Once the changes are successfully applied, the job status would be as shown below :
The apply job details which is responsible for making the changes to the sharded database is as shown below :
Once the edit stack apply job has completed successfully, the outputs section on the left pane of the apply job page would contain the details on how to access the sharded database as show below :
Shard directors can be scaled in (decreased) or out (decreased) based on user requirements and as needed without affecting performance and with zero downtime.
The steps for scaling are the same as scaling shards as shown in the previous section. Change the shard director configuration as show below before saving changes and running an apply job to deploy the changes.
To terminate an Oracle Sharded Database created from OCI marketplace in the past, follow the steps below :
- Click on the left hamburger Menu. Choose Resource Manager under Solutions and Marketplace.
- Select the stack that you created from marketplace.
- Click on Terraform Actions → Destroy. Once you click this all Sharded database resources including any user data will be deleted from OCI.
- Once the destroy has completed the jobs section will show that the destroy job has been successfully completed.
For more details on Oracle Database Sharding and usage please refer to the Product page.
For product documentation, please refer to the product release documentation
For GDSCTL CLI commands to manage sharded database manually once deployed on OCI, please refer to the Sharding GDSCTL CLI command reference