Scripts for deploying DataStax Enterprise (DSE) to Oracle Compute Cloud (OCC)
These scripts use the Oracle Compute Cloud (OCC) CLI to deploy a DataStax Enterprise cluster in an OCC environment:
The DataStax Oracle Cloud Deployment Guide is a good place to learn about best practices for Oracle Cloud.
| Directory | Description |
|---|---|
| extensions | Common scripts that are used by OCC instance's bootstrapping process. In OCC terminology, this process is referred as "Automating Instance Configuration Using opc-init". You can learn more about this here. |
| root | Python and bash scripts to generate OCC CLI compliant json templates to stand up a DataStax Enterprise cluster in an OCC environment. |
This document describes the required steps to deploy a DataStax Enterprise (DSE) cluster in an Oracle Compute Cloud (OCC) environment. Below is the high level sequence of steps you will need to follow in order to successfully deploy your DSE cluster.
- Obtain your Oracle Compute Cloud (OCC) account
- Set up your workstation with Oracle Compute Cloud Service Command Line Tool
- Install our assets on your workstation to provision DSE cluster in OCC
- Update the clusterParameters.json to reflect your own settings
- Run the deploy.sh to deploy a DSE cluster in your OCC environment
If you do not have an account with OCC yet, please follow this link to apply for one.
With regards to where you want your workstation to be, you have two options. The first option is to create a local Oracle Enterprise Linux 6.7 virtual machine on your destktop. The second option is to create an OEL 6.7 instance in your OCC account.
Once you got this virtual machine or OCC instance up and running, you can follow this link to set up your Oracle Compute Cloud Service CLI and the required environment variables and files.
At this point, you should have your OCC CLI environment variables namely OPC_API, OPC_USER, and a plain-text file storing your OCC account's password all setup already. For the environment variables, I would highly recommend you to store them in your .bash_profile file if you have not done so already.
In your local root or user account of your workstation, please do the followings:
Follow this link to generate an SSH key pair so you can use the private key to log in to your DataStax cluster instances using SSH.
Clone the repo localy using the command:
git clone https://github.com/DSPN/oracle-public-cloud-dse.git
Run the command
cd oracle-public-cloud-dse
In that directory is a file called 'clusterParameters.json' that looks like the following.
{
"locations": {
"Oracle_Public_Cloud_DC_us1": "https://api-z27.compute.us6.oraclecloud.com/"
},
"OPC_DOMAIN" : "/Compute-usoracle19809",
"OPC_USER" : "/Compute-usoracle19809/gilbert.lau@datastax.com",
"nodeCount" : 2,
"vmType" : "oc4",
"osImage": "/oracle/public/OL_6.7_3GB-1.3.0-20160411",
"bootDriveSizeInBytes" : "10737418240",
"appDataDriveSizeInBytes" : "42949672960",
"networkPrefix" : "DSE_IP_",
"sshKey": "DSE_opc_key",
"securityList": "DSE_Seclist",
"securityRules": "DSE_Rules"
}In the clusterParameters.json template, you will need to edit the following:
- "us1" is a label to decribe your Oracle data center. You can change it to any name best describes your data center location.
- "https://api-z27.compute.us6.oraclecloud.com/" is the API endpoint of your specific OCC data center which is the same value of your OPC_API environment variable. Again, this link shows you how to find your API endpoint information. Replace it with your own value.
- "locations" element is a list. This means you can specify as many data centers as required for your deployment. Our current release will support a single data center entry only.
- OPC_DOMAIN is your OCC's Compute-identity domain.
- OPC_USER is of the same value of your OPC_USER environment variable.
- nodeCount is the number of Cassandra cluster nodes you want to deploy in each data center you specify above.
- vmType is the Oracle Public Cloud instance type. For DataStax Enterprise, the minimum requirement is 2 CPU cores and 8 GB Memory. Please refer to this link for different compute shapes.
- osImage is the OS image type supported by OCC. For this integration, you need to keep this value: "/oracle/public/OL_6.7_3GB-1.3.0-20160411".
- bootDriveSizeInBytes is the size of the boot volumne where you would store your operating system. In OCC, this is defaulted to a HDD.
- appDataDriveSizeInBytes is the size of your low latency drive for storing your Cassandra database data.
- networkPrefix is the prefix you can define for your static IPs' names.
- sshKey is the label of your sshkey in your OCC environment. You can assign any name your want. You will later use this value as the first argument for "deploy.sh" script in step 5 below.
- securityList is name of your security list used for your DataStax Enterprise cluster deployment. Our current release will ignore this iput. We use OCC default security list instead.
- securityRules is the name of your security rules used for your DataStax Enterprise cluster deployment. Our current release will ignore it since we use OCC default security list.
At this point, you can run the following command to deploy your DataStax Enterprise cluster:
./deploy.sh \<sshKey> \<public ssh-key's full filename> \<full filename of the plain-text file storing your OCC password>
For example:
./deploy.sh DSE_opc_key ~opc/.sshd/dse_opc_key.pub ~/opc/oracle-compute-cloud-dse-master/pwdFile
It typically takes about 25 minutes to provision a cluster comprising four DataStax Enterprise nodes and one OpsCenter instance. When all your DataStax OCC instances are all up and running, you can point your web browser to your OpsCenter instance. When the provision is complete, OpsCenter will be accessible on port 8888 of the OpsCenter node as shown below:
