Administering Oracle Data Hub Cloud Service

Oracle® Cloud
Administering Oracle Data Hub Cloud Service
Release 18.1.2
E87994-04
January 2018
Oracle Cloud Administering Oracle Data Hub Cloud Service, Release 18.1.2
E87994-04
Copyright © 2017, 2018, Oracle and/or its affiliates. All rights reserved.
This software and related documentation are provided under a license agreement containing restrictions on
use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your
license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify,
license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.
Reverse engineering, disassembly, or decompilation of this software, unless required by law for
interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If
you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on
behalf of the U.S. Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software,
any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are
"commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agencyspecific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the
programs, including any operating system, integrated software, any programs installed on the hardware,
and/or documentation, shall be subject to license terms and license restrictions applicable to the programs.
No other rights are granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management applications.
It is not developed or intended for use in any inherently dangerous applications, including applications that
may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you
shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its
safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this
software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of
their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are
used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron,
the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro
Devices. UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information about content, products,
and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly
disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise
set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be
responsible for any loss, costs, or damages incurred due to your access to or use of third-party content,
products, or services, except as set forth in an applicable agreement between you and Oracle.
Contents
Preface
1
2
Audience
vi
Documentation Accessibility
vi
Related Resources
vi
Conventions
vii
Getting Started with Oracle Data Hub Cloud Service
About Oracle Data Hub Cloud Service
1-1
Before You Begin with Oracle Data Hub Cloud Service
1-1
How to Begin with Oracle Data Hub Cloud Service Subscriptions
1-2
About Oracle Data Hub Cloud Service Roles and Users
1-3
Accessing the Oracle Data Hub Cloud Service Console
1-3
Typical Workflow for Oracle Data Hub Cloud Service
1-4
About Oracle Data Hub Cloud Service Clusters in Oracle Cloud Infrastructure
1-5
Managing the Life Cycle of Oracle Data Hub Cloud Service
Creating a Cluster
2-1
Creating a Cluster by Using a QuickStart Template
2-7
Viewing All Clusters
2-8
Viewing Details for a Cluster
2-8
Viewing Activities for Clusters
2-8
Monitoring the Health of a Cluster
2-9
Stopping, Starting, and Restarting a Cluster
2-9
Deleting a Cluster
2-10
Restarting a Node
2-10
Managing IP Reservations for a Cluster
2-10
Creating an IP Reservation
2-11
Deleting an IP Reservation
2-12
iii
3
4
Managing Network Access
About Network Access
3-1
Enabling, Disabling, and Deleting an Access Rule
3-2
Creating Access Rules
3-2
Generating a Secure Shell (SSH) Public/Private Key Pair
3-3
Generating an SSH Key Pair on UNIX and UNIX-Like Platforms Using the sshkeygen Utility
3-4
Generating an SSH Key Pair on Windows Using the PuTTYgen Program
3-4
Administering Oracle Data Hub Cloud Service
Updating or Adding a New SSH Public Key
4-1
Extending Node Storage
4-2
Scaling Up/Down a Node
4-3
Scaling Out a Cluster
4-3
Scaling In a Cluster
4-4
Connecting to a Cluster Node Through Secure Shell (SSH)
4-4
Connecting to a Node by Using SSH on UNIX
4-5
Connecting to a Node by Using PuTTY on Windows
4-6
Managing Certificates Used for the Service Console
5
6
4-7
Accessing Oracle Data Hub Cloud Service
Accessing the Oracle Data Hub Cloud Service Service Console
5-1
Accessing Oracle Data Hub Cloud Service Using the REST API
5-2
Accessing Oracle Data Hub Cloud Service Using the CLI
5-2
Backing Up and Restoring Databases on Oracle Data Hub Cloud
Service
About Backing Up and Restoring Databases
6-1
Adding Backup Configuration for a Cluster
6-2
Creating an On-Demand Backup
6-4
Viewing Available Backups
6-5
Deleting a Backup
6-5
Disabling or Enabling Backups
6-6
Customizing the Current Backup Configuration
6-6
Restoring from a Specific Backup
6-7
iv
7
A
B
Patching Oracle Data Hub Cloud Service
About Patching an Oracle Data Hub Cloud Service Cluster
7-1
Viewing Available Patches
7-2
Checking Prerequisites Before Applying a Patch
7-2
Applying a Patch
7-3
Rolling Back a Patch
7-4
Characteristics of a Newly Created Cluster
Cluster Components
A-1
Linux User Accounts
A-1
Locations of Installed Software
A-3
Oracle Cloud Pages for Administering Oracle Data Hub Cloud
Service
Instances Page
B-1
Activity Page
B-3
SSH Access Page
B-5
IP Reservations Page
B-6
QuickStarts Page
B-7
Overview Page
B-8
Access Rules Page
B-11
Backup Page
B-12
Patching Page
B-13
Create New Instance: Instance Page
B-14
Create New Instance: Service Details Page
B-16
Create New Instance: Confirmation Page
B-20
v
Preface
Preface
This document describes how to administer and use Oracle Data Hub Cloud Service
and provides references to related documentation.
Topics:
•
Audience
•
Documentation Accessibility
•
Related Resources
•
Conventions
Audience
This document is intended for Oracle Cloud users who want to manage and monitor
Oracle Data Hub Cloud Service.
Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle
Accessibility Program website at http://www.oracle.com/pls/topic/lookup?
ctx=acc&id=docacc.
Access to Oracle Support
Oracle customers that have purchased support have access to electronic support
through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/
lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs
if you are hearing impaired.
Related Resources
For related information, see these Oracle resources:
•
About Oracle Cloud in Getting Started with Oracle Cloud
•
REST API for Oracle Data Hub Cloud Service
•
REST API for Managing Oracle Data Hub Cloud Service Cluster
•
PSM CLI Reference
•
Oracle Data Hub Cloud Service on the Oracle Cloud website
vi
Preface
Conventions
The following text conventions are used in this document:
Convention
Meaning
boldface
Boldface type indicates graphical user interface elements
associated with an action, or terms defined in text or the glossary.
italic
Italic type indicates book titles, emphasis, or placeholder variables
for which you supply particular values.
monospace
Monospace type indicates commands within a paragraph, URLs,
code in examples, text that appears on the screen, or text that you
enter.
vii
1
Getting Started with Oracle Data Hub
Cloud Service
This section describes how to get started with Oracle Data Hub Cloud Service.
Topics
•
About Oracle Data Hub Cloud Service
•
Before You Begin with Oracle Data Hub Cloud Service
•
How to Begin with Oracle Data Hub Cloud Service Subscriptions
•
About Oracle Data Hub Cloud Service Roles and Users
•
Accessing the Oracle Data Hub Cloud Service Console
•
Typical Workflow for Oracle Data Hub Cloud Service
•
About Oracle Data Hub Cloud Service Clusters in Oracle Cloud Infrastructure
See Oracle Cloud Terminology in Getting Started with Oracle Cloud for definitions of
terms found in this and other documents in the Oracle Cloud library.
About Oracle Data Hub Cloud Service
Oracle Data Hub Cloud Service enables you to consistently provision and manage
NoSQL database clusters such as Apache Cassandra on Oracle Cloud.
Oracle Data Hub Cloud Service leverages Oracle’s Infrastructure Cloud Services to
deliver a secure, elastic, and integrated platform. You can:
•
Spin up multiple clusters in minutes
•
Create small clusters or extremely large ones based on your workload and usecases
•
Elastically scale the cluster for compute and storage without compromising
performance and availability
•
Seamlessly integrate your cluster with other Oracle Cloud services or third-party
tools to analyze your data
•
Use REST APIs and CLIs to monitor, manage, and utilize the service
For information about the open source components used in Oracle Data Hub Cloud
Service, see Cluster Components.
Before You Begin with Oracle Data Hub Cloud Service
Before you start using Oracle Data Hub Cloud Service, you should be familiar with the
following technologies:
•
Oracle Cloud
1-1
Chapter 1
How to Begin with Oracle Data Hub Cloud Service Subscriptions
See Getting Started with Oracle Cloud.
•
Apache Cassandra
Before you create a cluster:
•
On Oracle Cloud, sign up for a free credit promotion or purchase a subscription.
You cannot create an Oracle Data Hub Cloud Service cluster until you do so.
•
If your Cloud account supports Oracle Cloud Infrastructure, you must create
certain networking and storage resources before you create your first cluster. See
Prerequisites for Oracle Platform Services in the Oracle Cloud Infrastructure
documentation.
For step-by-step instructions to create these resources, see
Creating the Infrastructure Resources Required for Oracle Platform Services.
•
(Optional) Create a Secure Shell (SSH) public/private key pair to provide when
you create a cluster. See Generating a Secure Shell (SSH) Public/Private Key
Pair.
•
(Optional) Subscribe to a cloud storage backup location for backing up data on the
cloud.
If you want to automatically back up your database to cloud storage, you must
associate it with a cloud storage backup location. The type of location you specify
depends on the infrastructure the deployment is built on:
–
Oracle Cloud Infrastructure: cloud backups are stored in an Oracle Cloud
Infrastructure Object Storage bucket. You must create a storage bucket before
you create the cluster configured to back up to cloud storage.
–
Oracle Cloud Infrastructure Classic: cloud backups are stored in an Oracle
Cloud Infrastructure Object Storage Classic container. You can create the
container beforehand and provide the wizard with information about it, or you
can have the wizard create the container for you.
Note:
Do not use the Oracle Cloud Infrastructure Object Storage Classic
container that you are using to back up Oracle Data Hub Cloud Service
databases for any other purpose. For example, do not also use it to back
up Oracle Java Cloud Service instances. Using the container for multiple
purposes can result in billing errors.
How to Begin with Oracle Data Hub Cloud Service
Subscriptions
Here’s how to get started with Oracle Data Hub Cloud Service free promotions and
subscriptions:
1.
Sign up for a free credit promotion or purchase a subscription.
See Requesting and Managing Free Oracle Cloud Promotions or Buying an
Oracle Cloud Subscription in Getting Started with Oracle Cloud.
1-2
Chapter 1
About Oracle Data Hub Cloud Service Roles and Users
2.
Open the Oracle Data Hub Cloud Service console.
See Accessing the Oracle Data Hub Cloud Service Console.
Note:
Be sure to review Before You Begin with Oracle Data Hub Cloud Service
before you create your first cluster.
You can optionally create additional Oracle Cloud users and grant them access to your
Oracle Data Hub Cloud Service subscription. See:
•
About Oracle Data Hub Cloud Service Roles and Users
•
Adding Users and Assigning Roles in Getting Started with Oracle Cloud
About Oracle Data Hub Cloud Service Roles and Users
Oracle Data Hub Cloud Service uses roles to control access to tasks and resources. A
role assigned to a user gives certain privileges to that user.
In addition to the roles and privileges described in Oracle Cloud User Roles and
Privileges in Getting Started with Oracle Cloud, the following role is created for Oracle
Data Hub Cloud Service: DHCS_Administrator.
When the Oracle Data Hub Cloud Service account is first set up, the service
administrator is given the DHCS_Administrator role. User accounts with this role must
be added before anyone else can access and use the service.
A user with the DHCS_Administrator role has complete administrative control over the
service. This user can create and terminate clusters, add and delete nodes, monitor
cluster health, stop and start clusters, and manage other life cycle events. In a typical
workflow, the administrator spins up a cluster, and then provides users with the
credentials they need to access the cluster and store data. When the cluster is no
longer needed, the administrator terminates it.
The identity domain administrator can create more Oracle Data Hub Cloud Service
administrators by creating user accounts and assigning the role to the user. Only the
identity domain administrator is allowed to create user accounts and assign roles. See
Managing User Accounts in Managing and Monitoring Oracle Cloud.
Accessing the Oracle Data Hub Cloud Service Console
Oracle Data Hub Cloud Service can be accessed through the web-based Oracle Data
Hub Cloud Service console. Access to this console is limited to administrators.
To access the Oracle Data Hub Cloud Service console:
1.
Sign in to your Oracle Cloud Account and navigate to the My Services Dashboard.
See Signing in to Your Cloud Account in Getting Started with Oracle Cloud.
2.
Click the
navigation menu in the top corner of the My Services Dashboard and
then click Oracle Data Hub Cloud Service.
1-3
Chapter 1
Typical Workflow for Oracle Data Hub Cloud Service
The Oracle Data Hub Cloud Service console opens on the Instances page. For
information about the details on the page, see Instances Page. If this is the first
time Oracle Data Hub Cloud Service has been accessed for the account, a
Welcome page is displayed.
Typical Workflow for Oracle Data Hub Cloud Service
To start using Oracle Data Hub Cloud Service, refer to the following tasks as a guide.
Some of these tasks are performed only by administrators.
Task
Description
More Information
Sign up for a free credit
promotion or purchase a
subscription
Provide your information, and sign
up for a free credit promotion or
purchase a subscription to Oracle
Data Hub Cloud Service.
How to Begin with Oracle
Data Hub Cloud Service
Subscriptions
Add and manage users
and roles
Optionally create additional accounts Adding Users and
for your cloud users and assign them Assigning Roles in Getting
appropriate privileges and roles.
Started with Oracle Cloud
About Oracle Data Hub
Cloud Service Roles and
Users
Access the service console Access the service console.
Accessing the Oracle Data
Hub Cloud Service
Console
Create an SSH key pair
Create SSH public/private key pairs
to facilitate secure access to all
virtual machines in your service.
Generating a Secure Shell
(SSH) Public/Private Key
Pair
Create a cluster
Create a QuickStart cluster based on Creating a Cluster
a standard template, or a custom
Creating a Cluster by Using
cluster that meets your precise
a QuickStart Template
requirements.
About Oracle Data Hub
Cloud Service Clusters in
Oracle Cloud Infrastructure
Enable network access
Permit access to network services
associated with your clusters.
About Network Access
For clusters in Oracle Cloud
Infrastructure, the required access
rules are enabled automatically.
Monitor clusters
Check on the health and
performance of individual clusters.
Monitoring the Health of a
Cluster
Monitor the service
Check on the day-to-day operation of Managing and Monitoring
your service, monitor performance,
Oracle Cloud Services in
and review important notifications.
Managing and Monitoring
Oracle Cloud
Patch the cluster
Apply a patch or roll back a patch.
Patching Oracle Data Hub
Cloud Service
Rolling Back a Patch
Back up the cluster
Initiate on-demand backups,
Backing Up and Restoring
schedule automated backups, set up Databases on Oracle Data
retention policies and storage for
Hub Cloud Service
backups, download backups, and
manage backups (restore, archive
and delete).
1-4
Chapter 1
About Oracle Data Hub Cloud Service Clusters in Oracle Cloud Infrastructure
Task
Description
More Information
Scale the cluster
Add or remove nodes in preparation
for increased or reduced load on a
cluster.
Scaling Out a Cluster
Change the shape of a node or add
storage to a node.
Scaling In a Cluster
Scaling Up/Down a Node
Extending Node Storage
Stop, start, or restart the
cluster
Stop, start, or restart the cluster.
Stopping, Starting, and
Restarting a Cluster
Delete the cluster
Delete a cluster when it’s no longer
necessary.
Deleting a Cluster
About Oracle Data Hub Cloud Service Clusters in Oracle
Cloud Infrastructure
You can create Oracle Data Hub Cloud Service clusters in Oracle Cloud Infrastructure
and in Oracle Cloud Infrastructure Classic.
The platform that your cluster provides in either type of infrastructure is substantially
the same. A few differences exist in the underlying infrastructure components and in
the supported capabilities. Awareness of these differences will help you choose an
appropriate infrastructure when creating a cluster.
•
Prerequisite steps before creating your first cluster: Oracle Data Hub Cloud
Service clusters in Oracle Cloud Infrastructure require certain networking and
storage resources that you must create in Oracle Cloud Infrastructure before you
create your first cluster.
To learn about these resources, see Prerequisites for Oracle Platform Services in
the Oracle Cloud Infrastructure documentation.
For step-by-step instructions to create these resources, see
Creating the Infrastructure Resources Required for Oracle Platform Services.
•
Regions and availability domains: While creating a cluster, you select a region
in Oracle Cloud Infrastructure Classic or Oracle Cloud Infrastructure. If you select
a region in Oracle Cloud Infrastructure, then you also select an Availability
Domain. A region in Oracle Cloud Infrastructure has multiple isolated availability
domains, each with separate power and cooling. The availability domains within a
region are interconnected using a low-latency network.
•
Compute shapes: The range of compute shapes that you can select from when
creating a cluster is different for Oracle Cloud Infrastructure and Oracle Cloud
Infrastructure Classic.
•
Subnets and IP networks: In Oracle Cloud Infrastructure, you must attach each
cluster to a subnet, which is a part of a virtual cloud network that you create in
Oracle Cloud Infrastructure. In Oracle Cloud Infrastructure Classic, you can
optionally attach a cluster to an IP network that you define beforehand.
•
IP address reservation: For clusters that you create in Oracle Cloud
Infrastructure Classic, you can assign pre-reserved public IP addresses to the
cluster nodes. IP reservations aren’t supported for clusters created in Oracle
Cloud Infrastructure.
1-5
Chapter 1
About Oracle Data Hub Cloud Service Clusters in Oracle Cloud Infrastructure
•
Backups to cloud storage: In Oracle Cloud Infrastructure, an Oracle Cloud
Infrastructure Object Storage bucket is used to store backups to cloud storage.
You must create a storage bucket before you create the cluster configured to back
up to cloud storage. In Oracle Cloud Infrastructure Classic, an Oracle Cloud
Infrastructure Object Storage Classic container is used to store backups to cloud
storage. You can create a storage container before you create the cluster
configured to back up to cloud storage, or you can have a storage container
created at the same time as the cluster.
•
Network access to clusters: Regardless of the infrastructure that you create your
cluster in, the rules to provide network access to the clusters are preconfigured for
you. The interfaces that you use to manage these rules depend on the
infrastructure that the cluster is created in:
–
For clusters in Oracle Cloud Infrastructure, you configure the rules, called
security rules, in the Oracle Cloud Infrastructure interfaces.
–
For clusters in Oracle Cloud Infrastructure Classic, you configure the rules,
called access rules, in the Oracle Data Hub Cloud Service interfaces. Note
that these access rules prohibit access by default (with the exception of SSH
access on port 22), and you must enable them to provide access to other
ports.
•
Scaling nodes: In Oracle Cloud Infrastructure, you cannot scale the shape of the
nodes in the cluster; you can scale only the storage. The minimum size of a new
storage volume in Oracle Cloud Infrastructure is 50 GB.
•
QuickStart template: You can create a cluster by using a QuickStart template in
Oracle Cloud Infrastructure Classic. QuickStart templates cannot be used to
create clusters in Oracle Cloud Infrastructure.
1-6
2
Managing the Life Cycle of Oracle Data
Hub Cloud Service
This section describes tasks to manage the life cycle of Oracle Data Hub Cloud
Service.
Topics
•
Creating a Cluster
•
Creating a Cluster by Using a QuickStart Template
•
Viewing All Clusters
•
Viewing Details for a Cluster
•
Viewing Activities for Clusters
•
Monitoring the Health of a Cluster
•
Stopping, Starting, and Restarting a Cluster
•
Deleting a Cluster
•
Restarting a Node
•
Managing IP Reservations for a Cluster
Creating a Cluster
To create a cluster, use the Oracle Data Hub Cloud Service wizard as described in the
following procedure.
Before You Begin
When you create a cluster, you may need to provide information about other
resources, such as the following:
•
(Optional) An SSH public/private key pair
An SSH public key is used for authentication when you use an SSH client to
connect to a node associated with the cluster. When you connect, you must
provide the private key that matches the public key.
You can have the wizard create a public/private key pair for you, or you can create
one beforehand and upload or paste its private key value. If you want to create a
key pair beforehand, you can use a standard SSH key generation tool. See
Generating a Secure Shell (SSH) Public/Private Key Pair for instructions.
•
(Optional) A cloud storage backup location
If cloud backup is enabled, data stored in the Oracle Data Hub Cloud Service is
backed up in the cloud storage backup location associated with the cluster when
the cluster is created. The type of location you specify depends on the
infrastructure the cluster is built on:
2-1
Chapter 2
Creating a Cluster
–
Oracle Cloud Infrastructure: cloud backups are stored in an Oracle Cloud
Infrastructure Object Storage bucket. You must create a storage bucket before
you create the cluster configured to back up to cloud storage. See
Prerequisites for Oracle Platform Services on Oracle Cloud Infrastructure in
the Oracle Cloud Infrastructure documentation.
–
Oracle Cloud Infrastructure Classic: cloud backups are stored in an Oracle
Cloud Infrastructure Object Storage Classic container. You can create the
container beforehand and provide the wizard with information about it, or you
can have the wizard create the container for you. If you want to create the
container beforehand, see Creating Containers in Using Oracle Cloud
Infrastructure Object Storage Classic for instructions.
Whether you create the container beforehand or have the wizard do it for you,
you are prompted for the following information about the container:
*
The URL and name of the container
*
The user name and password of a user who has read/write access to the
container
Note:
Do not use the Oracle Cloud Infrastructure Object Storage Classic
container that you are using to back up Oracle Data Hub Cloud Service
databases for any other purpose. For example, do not also use it to back
up Oracle Java Cloud Service instances. Using the container for multiple
purposes can result in billing errors.
Procedure
To create a cluster:
1.
Open the Oracle Data Hub Cloud Service console. See Accessing the Oracle Data
Hub Cloud Service Console.
2.
Click Create Instance.
The Oracle Data Hub Cloud Service Create New Instance wizard starts and the
Instance page is displayed. For information about the details on this page, see
Instances Page.
3.
On the Instance page, provide cluster information, then click Next to advance to
the Service Details page.
Element
Instance Name
Description
Name for the new cluster. The name:
•
•
•
•
•
Description
Must not exceed 50 characters.
Must start with a letter.
Must contain only letters, numbers, or hyphens.
Must not contain any other special characters.
Must be unique within the identity domain.
(Optional) Description for the new cluster.
The description is only used during cluster list display and is
not used internally by Service Manager.
2-2
Chapter 2
Creating a Cluster
Element
Description
Notification Email
(Optional) Email address provisioning status updates should
be sent to.
Region
(Available only if your identity domain is enabled for regions.)
The region for the cluster deployment. If you choose a region
that supports Oracle Cloud Infrastructure, the Availability
Domain and Subnet fields are displayed, and the deployment
will be created on Oracle Cloud Infrastructure. Otherwise, the
deployment will be created on Oracle Cloud Infrastructure
Classic.
Choose No Preference to let Oracle Data Hub Cloud Service
choose an Oracle Cloud Infrastructure Classic region for you.
Availability Domain
(Available only on Oracle Cloud Infrastructure)
The availability domain (within the region) where the cluster
will be deployed.
Subnet
(Available only on Oracle Cloud Infrastructure)
The subnet (within the availability domain) that will determine
network access to the cluster.
IP Network
(Only if a region is selected) Select an IP network if you want
to create the cluster in an IP network that you’ve defined.
See Creating an IP Network in Oracle Cloud Infrastructure
Classic.
By default, each node in your cluster is auto-assigned a public
and a private IP address. The IP addresses might change
each time the cluster is restarted. You can reserve and assign
fixed public IP addresses.
This field is not relevant to Oracle Cloud Infrastructure.
Software Release
Specify the version of Data Hub software and release you wish
to use. Select from the following options:
•
•
Metering Frequency
4.
Release 3.0.15
Release 3.11.1
Metering frequency used to determine the billing for resources
used by the cluster.
On the Service Details page, complete the Cluster Configuration section. For
information about the details on this page, see Create New Instance: Service
Details Page.
Element
Description
Compute Shape
Number of Oracle Compute Units (OCPUs) and amount of
memory (RAM) for each node of the new cluster. Oracle Data
Hub Cloud Service offers several OCPU/RAM combinations.
Number of Nodes
Number of nodes to be allocated to the cluster. Specify three
or more nodes to provide high availability (HA).
2-3
Chapter 2
Creating a Cluster
Element
Description
Reserved IPs
(This option is displayed only if you selected a
specific Region for this cluster.)
Select reserved IP addresses for the nodes in your cluster, or
leave the default value as Assign Automatically if you want
Oracle to automatically assign IP addresses to these nodes.
The number of IP addresses that you select must equal the
number of nodes in the cluster.
You create IP reservations by using the IP Reservations tab
in the Oracle Data Hub Cloud Service Console. If you do not
see this tab on the console, click the gear icon next to this field
and follow the instructions to create your first IP reservation.
After creating IP reservations, you need to restart the instance
creation wizard. See Managing IP Reservations for a Cluster.
Usable Data Storage in
GB
Amount of usable data storage to be allocated per node.
Use High Performance
Storage
Select this to use high performance storage. With this option
the storage attached to nodes uses SSDs (solid state drives)
instead of HDDs (hard disk drives). Use this option for
performance-critical workloads. An additional cost is
associated with this type of storage.
Allocated Data Storage
per Node in GB
The data storage allocated per node is calculated and
displayed.
Note:
The Allocated Data Storage per node is calculated by
multiplying the replication factor and compaction
overhead to the entered Usable Data Storage value
and then dividing the resulting value by the number of
nodes specified for the cluster. If the cluster size is 1 or
2 nodes, the replication factor is 1 or 2 respectively. If
the cluster size is 3 or more nodes, the replication
factor is 3. The compaction overhead applies a factor
of 2 assuming Apache Cassandra’s
SizeTieredCompactionStrategy. For example, if you
create a cluster of 3 nodes specifying Usable Data
Storage of 10 GB, then the Allocated Data Storage per
node will be (3 * 2 * 10) / 3 giving 20 GB.
5.
On the Service Details page, complete the Backup and Recovery Configuration
section for storing backups in the cloud. You can specify an existing storage
container, or have one created.
2-4
Chapter 2
Creating a Cluster
Element
Description
Backup Destination
Controls how backups for the clusters are to be configured:
•
•
Both Cloud Storage and Local Storage — backups are
configured to be created automatically and stored both on
local and cloud storage.
If this choice is selected, the Cloud Storage Container,
Username and Password fields are displayed.
Cloud Storage Only — backups are configured to be
created automatically and stored on cloud storage.
If this choice is selected, the Cloud Storage Container,
Username and Password fields are displayed.
•
None — no automatic backups are configured.
For more information about backups and backup
configurations, see About Backing Up and Restoring
Databases.
Cloud Storage
Container
The URL where backups to cloud storage are to be stored:
•
For clusters in Oracle Cloud Infrastructure, enter the URL
of an existing Oracle Cloud Infrastructure Object Storage
bucket. The URL is of the form:
https://swiftobjectstorage.region.oraclecloud.com/
account/bucket
For example:
https://swiftobjectstorage.usphoenix-1.oraclecloud.com/mycompany/mybucket
•
You must create this storage bucket before you begin
creating the cluster. See Object Storage API in Oracle
Cloud Infrastructure documentation.
For clusters in Oracle Cloud Infrastructure Classic, enter
the URL of an Oracle Cloud Infrastructure Object Storage
Classic container. The URL is of the general form:
https://storage-instance-specifier/container
To determine the storage-instance-specifier value for
your account, see About REST URLs for Oracle Storage
Cloud Service Resources in Using Oracle Cloud
Infrastructure Object Storage Classic. If this container
doesn’t exist, use the Create Cloud Storage Container
checkbox to create it.
Note:
Do not use the Oracle Cloud Infrastructure Object
Storage Classic container that you are using to back
up Oracle Data Hub Cloud Service databases for any
other purpose. For example, do not also use it to back
up Oracle Java Cloud Service instances. Using the
container for multiple purposes can result in billing
errors.
2-5
Chapter 2
Creating a Cluster
Element
Description
Cloud Storage
Username
A user with read/write (and creation, if necessary) access to
the location specified in Cloud Storage Container:
•
•
Cloud Storage
Password
The password necessary to access the location specified in
Cloud Storage Container:
•
•
Create Cloud Storage
Container
For clusters in Oracle Cloud Infrastructure, enter the user
name you use to sign in to the Oracle Cloud Infrastructure
console.
For clusters in Oracle Cloud Infrastructure Classic, enter
the Oracle Cloud user name of the administrator of the
Oracle Cloud Infrastructure Object Storage Classic
container specified in Cloud Storage Container. Usually,
this is your Oracle Cloud user name.
For clusters in Oracle Cloud Infrastructure, enter your
Swift password.
For clusters in Oracle Cloud Infrastructure Classic, enter
the Oracle Cloud password for the user specified in Cloud
Storage Username.
(Not available on Oracle Cloud Infrastructure)
Select this to create a new Oracle Cloud Infrastructure Object
Storage Classic container as part of cluster creation. Specify
the container name, username, and password in the preceding
fields.
The user specified in Cloud Storage Username and Cloud
Storage Password must have the privileges needed to create
storage containers.
If you select this option, the new storage container is created
when you click Next on the Service Details page, and the
storage container remains even if you cancel out of the wizard
without creating a new cluster. If this happens, you can use the
container in the future or manually delete it. See Deleting
Containers in Using Oracle Cloud Infrastructure Object
Storage Classic.
6.
On the Service Details page, complete the Credentials section. The username
and password credentials are used to monitor the cluster.
Element
Description
SSH Public Key
The SSH public key to be used for authentication when using
an SSH client to connect to a node associated with your
cluster.
Edit
Click Edit to specify the public key. You can upload a file
containing the public key value, paste in the value of a public
key, or have the wizard generate a key pair for you.
If you paste in the value, make sure the value does not contain
line breaks or end with a line break.
If you have the wizard generate a key pair for you, make sure
you download the zip file containing the keys that the wizard
generated.
Administrative
Username
Username used to log in to the tools, such as cqlsh,
nodetool, and service console.
Password
Password of the user specified in Administrative Username.
Confirm Password
2-6
Chapter 2
Creating a Cluster by Using a QuickStart Template
7.
On the Confirmation page, review the information listed. If you're satisfied with
what you see, click Create to create the cluster.
If you need to change something, click Previous at the top of the wizard to step
back through the pages, or click Cancel to cancel out of the wizard without
creating a new cluster.
Creating a Cluster by Using a QuickStart Template
This topic does not apply to Oracle Cloud Infrastructure.
To rapidly provision an Oracle Data Hub Cloud Service cluster, you
can select one of the QuickStart templates. The template uses
Oracle Cloud Stack Manager to quickly provision a cluster.
1.
Navigate to the QuickStarts page by using one of these methods:
•
Access your service console. Click the QuickStarts link.
•
From the My Services Dashboard, click Create Instance. Click the Create
button for Data Hub Cloud Service from the Quick Start Services tab.
2.
On the QuickStarts page, in the Instance Name field, enter a name for this service
instance.
3.
Below the template that you want to provision, click Create.
4.
Click Download. When prompted by your web browser, save the archive file to
your computer.
This archive file contains:
•
A text file with the credentials that you need to administer the resources in this
service instance
•
A copy of the Secure Shell (SSH) public key that is associated with each of the
nodes in this service instance
•
The corresponding SSH private key, which is necessary to access any of the
nodes in this service instance
The Create button is enabled.
5.
Click Create.
Your new cloud stack is named instance-nameQS.
6.
On the Stacks page, click the name of the stack.
7.
To monitor the progress of the resources in your stack, on the Stack Details page,
periodically click Refresh
8.
.
Click the name of your new Data Hub Cloud Service instance.
Note:
By default, access to the monitoring consoles is disabled in your new cluster for
security purposes. See Enabling, Disabling, and Deleting an Access Rule.
2-7
Chapter 2
Viewing All Clusters
To delete this service instance, you must use Oracle Cloud Stack Manager. See
Deleting a Cloud Stack in Using Oracle Cloud Stack Manager.
To access the Oracle Cloud Stack Manager console, click Navigation Menu
upper-left of the page, and then select Oracle Cloud Stack.
in the
Viewing All Clusters
From the Oracle Data Hub Cloud Service Console, you can:
•
View the total resources allocated across all Oracle Data Hub Cloud Service
clusters.
•
View the details for each cluster.
•
Use the search field to filter the list to include only the clusters that contain a given
string in their name.
To view all clusters:
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
The Oracle Data Hub Cloud Service console opens on the Instances page,
showing a list of all clusters.
For information about the details on the page, see Instances Page.
Viewing Details for a Cluster
From the Oracle Data Hub Cloud Service Overview page, you can:
•
View a summary of details for an Oracle Data Hub Cloud Service cluster, such as
description, subscription mode, and so on.
•
View the total resources allocated to the cluster.
•
View the details and status information for each node associated with the cluster.
To view details for a cluster:
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
Click the name of the cluster for which you want to view more information.
An overview page with cluster details is displayed. For information about the
details on this page, see Overview Page.
Viewing Activities for Clusters
Use the Activity page to view activities for Oracle Data Hub Cloud Service clusters.
You can restrict the list of activities displayed using search filters.
To view activities for clusters:
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
Click Activity.
2-8
Chapter 2
Monitoring the Health of a Cluster
The Activity page is displayed, showing the list of all activities started within the
past 24 hours. You can use the Start Time Range field to specify a start time
range other than the default of the previous 24 hours. For information about the
details on this page, see Activity Page.
3.
Use the options in the Search Activity Log section to filter the results to meet your
needs. You can search on start time range, full or partial service name, activity
status, and operation type. Click Search. View the results in the table that follows.
Monitoring the Health of a Cluster
You can view metrics and monitor the health of a cluster by using the Oracle Data Hub
Cloud Service Service Console.
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
From the
menu for the cluster, select Service Console.
The Oracle Data Hub Cloud Service Service Console opens on the Cluster page
and displays metrics and other information for the cluster.
Stopping, Starting, and Restarting a Cluster
You can stop, start, and restart a cluster from the Oracle Data Hub Cloud Service
Console.
To stop, start, or restart a cluster:
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
From the
•
menu for the cluster, select and confirm the desired action.
Stop: When you stop a cluster, you can’t access the cluster and you can’t
perform management operations on it except to start the cluster or delete it.
Stopping a cluster is like pausing it. You won’t be billed for compute resources,
but you will be billed for storage.
On stopping a cluster, the deployment first has a status of Maintenance and
then Stopped in the Oracle Data Hub Cloud Service console.
•
Start: When you start a cluster, you can access it again and perform
management operations. Starting a cluster is like taking it off pause. Billing for
compute resources resumes.
The deployment has a status of Maintenance in the Oracle Data Hub Cloud
Service console until it is fully started.
•
Restart: When you restart a cluster, the cluster is stopped and then
immediately started again. The information about stopping and starting a
cluster applies to restarting a cluster as well, just in immediate succession.
2-9
Chapter 2
Deleting a Cluster
Deleting a Cluster
You can delete (terminate) a cluster when it’s no longer needed.
Note:
It is not possible to recover a cluster after deleting it. When a cluster is deleted,
all data stored in the Data Hub database is deleted as well. Backup the data in
the Data Hub database over to Oracle Cloud Infrastructure Object Storage
Classic container or Oracle Cloud Infrastructure Object Storage bucket before
deleting the cluster.
To delete a cluster:
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
From the
menu for the cluster, select Delete, and then confirm the action.
Once deleted, the entry is removed from the list of clusters displayed in the
console.
Restarting a Node
On occasions, you might find it necessary to restart a node associated with the Oracle
Data Hub Cloud Service cluster.
To restart a node:
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
Click the name of the cluster with the node you want to restart.
An overview page with cluster details is displayed. Nodes are listed under
Resources.
3.
From the
menu for the node, select Restart and confirm the desired action.
The connection to this node is closed and the node restarts.
Managing IP Reservations for a Cluster
This topic does not apply to Oracle Cloud Infrastructure.
You can optionally create IP reservations prior to provisioning an
Oracle Data Hub Cloud Service cluster. If you create a cluster that
2-10
Chapter 2
Managing IP Reservations for a Cluster
uses a reserved IP address, you can reuse the same IP address
again later, but only after you delete the cluster.
Topics:
•
Creating an IP Reservation
•
Deleting an IP Reservation
Creating an IP Reservation
This topic does not apply to Oracle Cloud Infrastructure.
When you create a cluster, Oracle Cloud automatically reserves and assigns public IP
addresses to the nodes in the cluster. Alternatively, you can create your own IP
reservations prior to creating a cluster. You can reserve IP addresses, and assign
them to nodes within your Oracle Data Hub Cloud Service clusters. These reserved IP
addresses are persistent.
If you intend to create a cluster in multiple regions, then you must create separate IP
reservations for each region.
The number of IP reservations that you create must be equal to or greater than the
number of nodes that you expect to create in your cluster.
Note:
If you are creating your first IP reservation, then you must access the IP
Reservations page from the Create New Instance: Service Details Page of the
instance creation wizard. Locate the Reserved IPs field and click the gear icon.
1.
Access your service console.
2.
Click the IP Reservations tab.
3.
Click Create.
4.
In the Name field, enter a name for the IP reservation.
5.
In the Region field, select the Oracle Cloud region in which you want to use this IP
reservation.
6.
If you intend to use this reservation for an instance that you attach to an IP
network, select the On IP Network check box.
If you leave this check box deselected, the IP reservation can be assigned to only
an instance that you attach to the shared network.
7.
Click OK.
8.
To verify if an IP address is successfully reserved, click Refresh
.
The IP reservation is ready to use when its status is UNUSED.
2-11
Chapter 2
Managing IP Reservations for a Cluster
Deleting an IP Reservation
This topic does not apply to Oracle Cloud Infrastructure.
You can delete reserved IP addresses that are no longer needed for
Oracle Data Hub Cloud Service.
When you delete an IP reservation, the IP address returns to the pool of available IP
addresses in Oracle Cloud. You cannot delete an IP reservation that is in use. If you
assign an IP reservation to a cluster, then you must delete the cluster before you can
delete the IP reservation.
1.
Access your service console.
2.
Click the IP Reservations tab.
3.
Locate the IP reservation that you want to delete.
To find an IP reservation, enter a full or partial name of the reservation or its
region, and then click Search
.
.
4.
Beside the IP reservation, click Delete
5.
When prompted for confirmation, click OK.
2-12
3
Managing Network Access
By default, strict security restrictions limit network access to the cluster. To open
access to applications and tools, you may need to perform additional configuration
tasks, such as enabling access to a network port or creating an SSH tunnel.
When you create an Oracle Data Hub Cloud Service cluster in Oracle Cloud
Infrastructure, network access to the deployment is provided and managed by the
Oracle Cloud Infrastructure network components according to rules specified when
you followed the instructions in Prerequisites for Oracle Platform Services on Oracle
Cloud Infrastructure in the Oracle Cloud Infrastructure documentation.
When you create an Oracle Data Hub Cloud Service cluster in Oracle Cloud
Infrastructure Classic, network access to the cluster is provided and managed using
access rules in the Oracle Data Hub Cloud Service console.
Topics
•
About Network Access
•
Enabling, Disabling, and Deleting an Access Rule
•
Creating Access Rules
•
Generating a Secure Shell (SSH) Public/Private Key Pair
About Network Access
Access rules are used to provide secure network access to service components.
Access rules control which ports can be accessed on the VMs that are part of a
cluster.
By default, network access to Oracle Data Hub Cloud Service is provided by using
SSH. The SSH connection uses the SSH key specified when the cluster was created.
By default, port 22 is used for SSH connections.
When a cluster is created, the following access rules are created by default:
•
ora_p2cass_ssh: Controls SSH access to a cluster. Disabled by default.
•
ora_trusted_hosts_cp: Controls client connection to the port. Enabled by default.
•
ora_p2cass_https: Enables secure access to the web-based service console.
Enabled by default.
•
sys_infra2cc_admin_ssh: Enables PSM to ssh to admin host. Enabled by
default.
To enable access to a port, you enable the appropriate rule. System rules cannot be
modified.
When you enable one of the predefined rules, the given port on the cluster is opened
to the public internet. To enable access to a different port, or to restrict access to a
port, you must create an access rule. For general information about access rules, see
About Security Rules in Using Oracle Compute Cloud Service (for PaaS).
3-1
Chapter 3
Enabling, Disabling, and Deleting an Access Rule
Enabling, Disabling, and Deleting an Access Rule
This topic does not apply to Oracle Cloud Infrastructure.
For clusters created in Oracle Cloud Infrastructure Classic, administrators can enable,
disable, and delete access rules from the Oracle Data Hub Cloud Service console.
To enable, disable, or delete an access rule:
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
menu for the cluster for which you want to manage access, select
From the
Access Rules.
The Access Rules page is displayed. For information about the details on this
page, see Access Rules Page.
3.
Locate the rule you want to enable, disable, or delete.
4.
From the
menu for the rule, select and confirm the desired action.
•
Enable: When you enable an access rule, the given port on the compute node
is opened to the public internet.
•
Disable: When you disable an access rule, the given port on the compute
node is restricted to the public internet.
•
Delete: Deleting an access rule removes the access rule from the access
rules list.
Creating Access Rules
This topic does not apply to Oracle Cloud Infrastructure.
For clusters created in Oracle Cloud Infrastructure Classic, administrators can create
access rules to enable ports not associated with predefined access rules, or to restrict
access to ports to only permit connections from specific IP addresses.
To create an access rule:
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
From the
menu for the cluster for which you want to manage access, select
Access Rules.
The Access Rules page is displayed. For information about the details on this
page, see Access Rules Page.
3.
Click Create Rule. In the Create Access Rule dialog, enter the following
information:
•
Rule Name: Any name to identify this rule. Must start with a letter, followed by
letters, numbers, hyphens, or underscores. Cannot start with ora_ or sys_.
3-2
Chapter 3
Generating a Secure Shell (SSH) Public/Private Key Pair
•
Description: (Optional) Any description of your choice.
•
Source: The hosts from which traffic should be allowed. Choices are:
•
4.
–
CASSANDRA_ADMIN_HOST: The security list consisting of all Oracle
Data Hub Cloud Service ADMIN hosts.
–
CASSANDRA_MAIN_SERVER: The security list consisting of all Oracle
Data Hub Cloud Service SERVER hosts.
–
PAAS_INFRA: Internal for platform services. Used for various life cycle
operations including provisioning, patching, and scaling.
–
PUBLIC-INTERNET: The public-internet Security IP List. For information
about this and other security IP lists, see About Security IP Lists in Using
Oracle Compute Cloud Service (for PaaS).
–
custom: A custom list of addresses from which traffic should be allowed.
In the field that displays below when you select this option, enter a
comma-separated list of the subnets (in CIDR format) or IPv4 addresses
for which you want to permit access.
Destination: The service component to which traffic should be allowed.
Choices are as follows (see the previous descriptions):
–
CASSANDRA_ADMIN_HOST
–
CASSANDRA_MAIN_SERVER
•
Destination Port(s): The port or range of ports you want to open. Specify a
single port, such as 5001, or a range of ports separated by a hyphen, such as
5001-5010.
•
Protocol: The protocol for the access rule.
Click Create.
The Create Access Rule dialog closes and the rule is displayed in the list of rules.
New rules are enabled by default. If necessary, adjust the number of results
displayed on the Access Rules page so you can see the newly created rule.
Generating a Secure Shell (SSH) Public/Private Key Pair
An SSH public key is used for authentication when you use an SSH client to connect
to a node associated with a cluster. When you connect, you must provide the private
key that matches the public key.
Several tools exist to generate SSH public/private key pairs. The following sections
show how to generate an SSH key pair on UNIX, UNIX-like, and Windows platforms.
Note:
Alternatively, when creating a cluster, you can have the wizard generate a key
pair for you. See Creating a Cluster.
3-3
Chapter 3
Generating a Secure Shell (SSH) Public/Private Key Pair
Generating an SSH Key Pair on UNIX and UNIX-Like Platforms Using
the ssh-keygen Utility
UNIX and UNIX-like platforms (including Solaris and Linux) include the ssh-keygen
utility to generate SSH key pairs.
To generate an SSH key pair on UNIX and UNIX-like platforms using the ssh-keygen
utility:
1.
Navigate to your home directory:
$ cd $HOME
2.
Run the ssh-keygen utility, providing as filename your choice of file name for the
private key:
$ ssh-keygen -b 2048 -t rsa -f filename
The ssh-keygen utility prompts you for a passphrase for the private key.
3.
Enter a passphrase for the private key, or press Enter to create a private key
without a passphrase:
Enter passphrase (empty for no passphrase): passphrase
Note:
While a passphrase is not required, you should specify one as a security
measure to protect the private key from unauthorized use. When you
specify a passphrase, a user must enter the passphrase every time the
private key is used.
The ssh-keygen utility prompts you to enter the passphrase again.
4.
Enter the passphrase again, or press Enter again to continue creating a private
key without a passphrase:
Enter the same passphrase again: passphrase
5.
The ssh-keygen utility displays a message indicating that the private key has been
saved as filename and the public key has been saved as filename.pub. It also
displays information about the key fingerprint and randomart image.
Generating an SSH Key Pair on Windows Using the PuTTYgen
Program
The PuTTYgen program is part of PuTTY, an open source networking client for the
Windows platform.
To generate an SSH key pair on Windows using the PuTTYgen program:
1.
Download and install PuTTY or PuTTYgen.
To download PuTTY or PuTTYgen, go to http://www.putty.org/ and click the You
can download PuTTY here link.
3-4
Chapter 3
Generating a Secure Shell (SSH) Public/Private Key Pair
2.
Run the PuTTYgen program.
The PuTTY Key Generator window is displayed.
3.
Set the Type of key to generate option to SSH-2 RSA.
4.
In the Number of bits in a generated key box, enter 2048.
5.
Click Generate to generate a public/private key pair.
As the key is being generated, move the mouse around the blank area as directed.
6.
(Optional) Enter a passphrase for the private key in the Key passphrase box and
reenter it in the Confirm passphrase box.
Note:
While a passphrase is not required, you should specify one as a security
measure to protect the private key from unauthorized use. When you
specify a passphrase, a user must enter the passphrase every time the
private key is used.
7.
Click Save private key to save the private key to a file. To adhere to file-naming
conventions, you should give the private key file an extension of .ppk (PuTTY
private key).
Note:
The .ppk file extension indicates that the private key is in PuTTY's
proprietary format. You must use a key of this format when using PuTTY as
your SSH client. It cannot be used with other SSH client tools. Refer to the
PuTTY documentation to convert a private key in this format to a different
format.
8.
Select all of the characters in the Public key for pasting into OpenSSH
authorized_keys file box.
Make sure you select all the characters, not just the ones you can see in the
narrow window. If a scroll bar is next to the characters, you aren't seeing all the
characters.
9.
Right click somewhere in the selected text and select Copy from the menu.
10. Open a text editor and paste the characters, just as you copied them. Start at the
first character in the text editor, and do not insert any line breaks.
11. Save the text file in the same folder where you saved the private key, using
the .pub extension to indicate that the file contains a public key.
12. If you or others are going to use an SSH client that requires the OpenSSH format
for private keys (such as the ssh utility on Linux), export the private key:
a.
On the Conversions menu, choose Export OpenSSH key .
b.
Save the private key in OpenSSH format in the same folder where you saved
the private key in .ppk format, using an extension such as .openssh to indicate
the file's content.
3-5
4
Administering Oracle Data Hub Cloud
Service
This section describes tasks for administering Oracle Data Hub Cloud Service.
Topics
•
Updating or Adding a New SSH Public Key
•
Extending Node Storage
•
Scaling Up/Down a Node
•
Scaling Out a Cluster
•
Scaling In a Cluster
•
Connecting to a Cluster Node Through Secure Shell (SSH)
•
Managing Certificates Used for the Service Console
Updating or Adding a New SSH Public Key
Should the need arise, you can add an SSH public key to your Oracle Data Hub Cloud
Service cluster. After you add the public key, you can provide the matching private key
to connect to a node associated with the cluster as either the opc or the oracle user.
To add an SSH public key:
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
From the
menu of the cluster, select SSH Access.
The Add New Key overlay is displayed with its Key value field displaying the
most recent SSH public key.
3.
4.
Specify the new public key using one of the following methods:
•
Select Upload a new SSH Public Key value and click Choose File to select
a file that contains the public key.
•
Select Key value. Delete the current key value and paste the new public key
into the text area. Make sure the value does not contain line breaks or end
with a line break.
Click Add New Key.
You can also add SSH public keys to one or more deployments on the SSH Access
Page.
4-1
Chapter 4
Extending Node Storage
Extending Node Storage
If a cluster on Oracle Data Hub Cloud Service is running out of storage, you can
extend the existing storage volumes.
Extending a storage volume does not add the new value to the existing value, but sets
the storage volume to the defined value. For example, if your current storage volume
is 50GB and you define the new value as 100GB, the storage volume is extended to
100GB, not 150GB.
Note:
For nodes of clusters provisioned in Oracle Cloud Infrastructure, the scaling
increment for the storage volumes is 50 GB.
To extend node storage:
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
Click the name of the cluster with the node you want to add the storage.
An overview page with cluster details is displayed. Nodes are listed under
Resources.
3.
From the
menu for the node, select Add Storage.
The Add Storage overlay is displayed.
4.
Add storage to the node as desired:
•
Data Storage in GB: The node’s current data volume storage value appears
in this field. Increase this number to the desired data storage value for this
node.
•
Storage for commit log volume in GB: The node’s current commit log
volume storage value appears in this field. Increase this number to the desired
commit log volume for this node.
•
Storage for backup volume in GB: The node’s current backup volume
storage value appears in this field. Increase this number to the desired backup
volume for this node.
Note:
If you enter a value which is larger than the defined limits, or lower than the
current value, the field is highlighted in red and a tooltip is displayed
explaining the error.
5.
Click Yes, Add Storage.
The cluster restarts.
4-2
Chapter 4
Scaling Up/Down a Node
Node is updated with the new storage size and the updated values are displayed in
the Service Overview.
Note:
It is not possible to shrink a storage volume.
Scaling Up/Down a Node
This topic does not apply to Oracle Cloud Infrastructure.
For clusters created in Oracle Cloud Infrastructure Classic, if a cluster is performing
poorly, administrators can scale a node compute by modifying the compute shape.
To scale a node compute:
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
Click the name of the cluster with the node you want to scale the compute.
An overview page with cluster details is displayed. Nodes are listed under
Resources.
3.
From the
menu for the node, select Scale Up/Down.
The Scale Up/Down overlay is displayed.
4.
Scale Up/Down the node as desired:
•
5.
Compute shape: Choose from the available compute shapes to use for the
node.
Click Yes, Scale Up/Down VM.
The scaling operation begins. The cluster is in Maintenance status and unavailable
while the scaling operation is in progress.
Scaling Out a Cluster
You can scale out a cluster by adding nodes to increase capacity and handle
increasing workloads.
To scale out a cluster:
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
Click the name of the cluster you want to scale out.
An overview page with cluster details is displayed.
3.
From the
menu for the cluster at the top of the page, select Scale Out.
The Scale Out window is displayed.
4-3
Chapter 4
Scaling In a Cluster
4.
Scale out the cluster as desired:
•
5.
Number of Cassandra Nodes to Add: Number of nodes you want to add,
between 0 and 20.
Click Scale Out.
Nodes are added. During this process the cluster goes into Maintenance mode
and, once the scale-out operation is complete, becomes operational again.
Scaling In a Cluster
You can scale in an Oracle Data Hub Cloud Service cluster by removing a selected
node from the cluster.
To scale in a cluster:
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
Click the name of the cluster you want to scale in.
An overview page with cluster details is displayed. Nodes are listed under
Resources.
3.
From the
action.
menu for the node, select Remove Node, and then confirm the
The cluster goes into Maintenance mode and, once the scale-in operation is
complete, becomes operational again.
Connecting to a Cluster Node Through Secure Shell (SSH)
To gain local access to the tools, utilities, and other resources on a cluster node
associated with Oracle Data Hub Cloud Service, you use Secure Shell (SSH) client
software to establish a secure connection and log in as the user opc.
To run the cqlsh and nodetool command line, you must be logged in as the oracle
user. To login as the oracle user, enter the following at command prompt as the opc
user:
$ sudo su oracle
# whoami
# oracle
For more information, see Linux User Accounts.
By default, network access to cluster nodes associated with Oracle Data Hub Cloud
Service is provided by Secure Shell (SSH) connections on port 22. Port 22 is the
standard TCP/IP port that is assigned to SSH servers.
Several SSH clients are freely available. The following sections describe how to use
SSH clients on UNIX, UNIX-like, and Windows platforms to connect to a cluster node
associated with Oracle Data Hub Cloud Service.
4-4
Chapter 4
Connecting to a Cluster Node Through Secure Shell (SSH)
Note:
The ora_p2cass_ssh access rule controls SSH access to a cluster. The rule is
created automatically when a cluster is created and is disabled by default.
Before you can connect to a cluster node through SSH, you must enable the
ora_p2cass_ssh access rule.
Connecting to a Node by Using SSH on UNIX
UNIX and UNIX-like platforms (including Solaris and Linux) include the ssh utility, an
SSH client.
Before You Begin
Before you use the ssh utility to connect to a node, you need the following:
•
The public IP address of the node
The IP address of the node is listed on the details page of the cluster that contains
the node. To display this page, see Viewing Details for a Cluster.
•
The SSH private key file that pairs with the public key associated with the cluster
The public key was associated with your cluster when it was created. If you don’t
have the private key that’s paired with the public key, contact your administrator.
Procedure
To connect to a node using the ssh utility on UNIX and UNIX-like platforms:
1.
In a command shell, set the file permissions of the private key file so that only you
have access to it:
$ chmod 600 private-key-file
private-key-file is the path to the SSH private key file that matches the public key
that is associated with the cluster.
2.
Run the ssh utility:
$ ssh -i private-key-file opc@node-ip-address
where:
•
private-key-file is the path to the SSH private key file.
•
opc is the opc operating system user. As opc, you can use the sudo -s
command to gain root access to the node, as described in the next step.
•
node-ip-address is the IP address of the node in x.x.x.x format.
If this is the first time you are connecting to the node, the ssh utility prompts you to
confirm the public key. In response to the prompt, enter yes.
3.
To perform operations that require root access to the node, open a root command
shell. Enter sudo -s at the command prompt:
$ sudo -s
# whoami
# root
4-5
Chapter 4
Connecting to a Cluster Node Through Secure Shell (SSH)
Connecting to a Node by Using PuTTY on Windows
PuTTY is a freely available SSH client program for Windows.
Before You Begin
Before you use the PuTTY program to connect to a node, you need the following:
•
The IP address of the node
The IP address of the node is listed on the details page of the cluster that contains
the node. To display this page, see Viewing Details for a Cluster.
•
The SSH private key file that pairs with the public key associated with the cluster
The public key was associated with your cluster when it was created. If you don’t
have the private key that’s paired with the public key, contact your administrator.
The private key file must be of the PuTTY .ppk format. If the private key file was
originally created on the Linux platform, you can use the PuTTYgen program to
convert it to the .ppk format.
Procedure
1.
Download and install PuTTY.
To download PuTTY, go to http://www.putty.org/ and click the You can
download PuTTY here link.
2.
Run the PuTTY program.
The PuTTY Configuration window is displayed, showing the Session panel.
3.
In Host Name (or IP address) box, enter the IP address of the node.
4.
Confirm that the Connection type option is set to SSH.
5.
In the Category tree, expand Connection if necessary and then click Data.
The Data panel is displayed.
6.
In the Auto-login username box, enter opc. As the opc user, you can use the sudo
-s command to gain root access to the node, as described in the last step, below.
7.
Confirm that the When username is not specified option is set to Prompt.
8.
In the Category tree, expand SSH and then click Auth.
The Auth panel is displayed.
9.
Click the Browse button next to the Private key file for authentication box.
Then, in the Select private key file window, navigate to and open the private key
file that matches the public key that is associated with the cluster.
10. In the Category tree, click Session.
The Session panel is displayed.
11. In the Saved Sessions box, enter a name for this connection configuration. Then,
click Save.
12. Click Open to open the connection.
The PuTTY Configuration window is closed and the PuTTY window is displayed.
4-6
Chapter 4
Managing Certificates Used for the Service Console
If this is the first time you are connecting to the VM, the PuTTY Security Alert
window is displayed, prompting you to confirm the public key. Click Yes to
continue connecting.
13. To perform operations that require root access to the node, open a root command
shell. Enter sudo -s at the command prompt:
$ sudo -s
# whoami
# root
Managing Certificates Used for the Service Console
You can change the certificate used for the Oracle Data Hub Cloud Service Service
Console (also known as the cluster or monitoring console).
To change the certificate associated with a cluster:
1.
Enable SSH access. See About Network Access.
2.
SSH to all the nodes in the cluster as the oracle user and replace /u01/data/
conf/jdk/certs/dhcs.crt and /u01/data/conf/jdk/certs/dhcs.key with your
certificate files.
3.
Change the file permissions for the certificate files to 600.
4.
On each node, as the oracle user edit the /u01/data/conf/nginx/nginx.conf file.
5.
Locate the ssl_certificate and ssl_certificate_key entries in the server section
and update the values to reflect your certificate path.
6.
Save the nginx.conf file and run the following command to restart NGINX on each
node:
$ service dhcs restart
4-7
5
Accessing Oracle Data Hub Cloud Service
This section describes how to access the consoles and interfaces available for Oracle
Data Hub Cloud Service.
Topics
•
Accessing the Oracle Data Hub Cloud Service Service Console
•
Accessing Oracle Data Hub Cloud Service Using the REST API
•
Accessing Oracle Data Hub Cloud Service Using the CLI
Accessing the Oracle Data Hub Cloud Service Service
Console
Specific clusters in Oracle Data Hub Cloud Service can be accessed through a webbased console.
The Oracle Data Hub Cloud Service Service Console (also referred to as the service
console in this document), is used to monitor the cluster status, storage usage, CPU
and memory usage, performance, latency, resource utilization, and activity on a realtime basis.
After administrators create a cluster, they give users the connection information and
credentials they need to connect to the service console and monitor it.
The service console can be accessed in a couple of different ways, depending on
whether you have administrator privileges.
Accessing the Oracle Data Hub Cloud Service Service Console —
Administrators
To access the service console if you have administrator privileges:
1.
Open the Oracle Data Hub Cloud Service console. See Accessing the Oracle Data
Hub Cloud Service Console.
2.
From the
menu for the cluster you want to access, select Service Console and
log in using the user name and password specified for the cluster when the cluster
was created.
After the service console opens, make note of the URL. This is the URL you’ll provide
to users who need to access the cluster, along with the credentials specified for the
cluster when the cluster was created. The URL is in the form of https://address:8081/,
where address is the public IP address of a node in the cluster.
5-1
Chapter 5
Accessing Oracle Data Hub Cloud Service Using the REST API
Note:
The console can be accessed on port 8081 on all nodes in a cluster. If you
can't access the console on one node, try accessing it on another node.
Accessing the Oracle Data Hub Cloud Service Cluster — Cluster Users
To access the console if you don’t have administrator privileges:
1.
Obtain the cluster URL and credentials from the administrator who created the
cluster.
2.
Access the URL in your browser and log in with the user name and password
provided to you by your administrator.
The Oracle Data Hub Cloud Service Service Console opens, and you can use it to
monitor the cluster.
Accessing Oracle Data Hub Cloud Service Using the REST
API
You can use the REST API to create and manage Oracle Data Hub Cloud Service
clusters and perform many other tasks you can perform using the web-based
consoles. See:
•
REST API for Oracle Data Hub Cloud Service
•
REST API for Managing Oracle Data Hub Cloud Service Cluster
Accessing Oracle Data Hub Cloud Service Using the CLI
You can use a command line interface (CLI) to create and manage Oracle Data Hub
Cloud Service clusters and perform many other tasks you can perform using the webbased consoles.
The Oracle PaaS Service Manager (PSM) CLI enables you to manage the lifecycle of
various Oracle Public Cloud Services, including Oracle Data Hub Cloud Service. See
PSM CLI Reference.
5-2
6
Backing Up and Restoring Databases on
Oracle Data Hub Cloud Service
This section explains how to backup and restore databases on Oracle Data Hub Cloud
Service.
Topics
•
About Backing Up and Restoring Databases
•
Adding Backup Configuration for a Cluster
•
Creating an On-Demand Backup
•
Viewing Available Backups
•
Deleting a Backup
•
Disabling or Enabling Backups
•
Customizing the Current Backup Configuration
•
Restoring from a Specific Backup
About Backing Up and Restoring Databases
By backing up your Oracle Data Hub Cloud Service databases, you can protect the
clusters and databases against loss if a failure occurs. By restoring from a backup, you
can restore the cluster configuration and database to its state at the time of the
backup.
Oracle Data Hub Cloud Service provides a backup feature that backs up:
•
The database
•
Cluster configuration files
Default Backup Configuration
When you create a cluster, you choose one of the following backup destinations:
•
Both Cloud Storage and Local Storage — backups are configured to be created
automatically and stored both on local and cloud storage.
•
Cloud Storage Only — backups are configured to be created automatically and
stored on cloud storage.
•
None — no automatic backups are configured.
The backup configuration created when you choose a destination other than None
follows a set of Oracle best-practice guidelines:
•
Full backup of the database followed by rolling incremental backups on a sevenday cycle (a 30-day cycle for the Cloud Storage Only destination)
•
Full backup of the cluster configuration files
6-1
Chapter 6
Adding Backup Configuration for a Cluster
•
Automatic backups daily at a time between 11 PM (23:00) and 3 AM (03:00)
•
Retention period:
–
Both Cloud Storage and Local Storage: 30 days, with the most recent 1 day
backup available on local storage
–
Cloud Storage Only: 30 days
If the defaults do not suit your needs, you can customize the backup configuration for
your deployment. For information, see Customizing the Current Backup Configuration.
About Local Storage for Backups
When a cluster is created on Oracle Data Hub Cloud Service, Oracle Cloud
Infrastructure Compute Classic or Oracle Cloud Infrastructure Compute storage
volumes are created and associated with the compute nodes.
The space allocated for the local storage used for backups is twice the space allocated
for data storage. For example, if you chose 100 GB for Usable Database Storage
when creating the cluster, 200 GB are allocated for backups.
Adding Backup Configuration for a Cluster
If you do not configure backups when you create an Oracle Data Hub Cloud
Service cluster, you can manually add a backup configuration to the existing cluster
after it’s provisioned.
Backups are configured on a cluster if you set the Backup Destination to a value
other than “None” when creating it.
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
Click the name of the cluster for which you want to add backup configuration.
The Oracle Data Hub Cloud Service Overview page is displayed.
3.
Click Manage this service
next to the cluster name, and then select Add Backup.
The Add Backup dialog box opens.
4.
Complete the following fields:
6-2
Chapter 6
Adding Backup Configuration for a Cluster
Element
Description
Backup Destination
Controls how backups for the clusters are to be configured:
•
•
Both Cloud Storage and Local Storage — backups are
configured to be created automatically and stored both on
local and cloud storage.
If this choice is selected, the Cloud Storage Container,
Username and Password fields are displayed.
Cloud Storage Only — backups are configured to be
created automatically and stored on cloud storage.
If this choice is selected, the Cloud Storage Container,
Username and Password fields are displayed.
•
None — no automatic backups are configured.
For more information about backups and backup
configurations, see About Backing Up and Restoring
Databases.
Cloud Storage
Container
The URL where backups to cloud storage are to be stored:
•
For clusters in Oracle Cloud Infrastructure, enter the URL
of an existing Oracle Cloud Infrastructure Object Storage
bucket. The URL is of the form:
https://swiftobjectstorage.region.oraclecloud.com/
account/bucket
For example:
https://swiftobjectstorage.usphoenix-1.oraclecloud.com/mycompany/mybucket
•
You must create this storage bucket before you begin
creating the cluster. See Object Storage API in Oracle
Cloud Infrastructure documentation.
For clusters in Oracle Cloud Infrastructure Classic, enter
the URL of an Oracle Cloud Infrastructure Object Storage
Classic container. The URL is of the general form:
https://storage-instance-specifier/container
To determine the storage-instance-specifier value for
your account, see About REST URLs for Oracle Storage
Cloud Service Resources in Using Oracle Cloud
Infrastructure Object Storage Classic. If this container
doesn’t exist, use the Create Cloud Storage Container
checkbox to create it.
Note:
Do not use the Oracle Cloud Infrastructure Object
Storage Classic container that you are using to back
up Oracle Data Hub Cloud Service databases for any
other purpose. For example, do not also use it to back
up Oracle Java Cloud Service instances. Using the
container for multiple purposes can result in billing
errors.
6-3
Chapter 6
Creating an On-Demand Backup
Element
Description
Username
A user with read/write (and creation, if necessary) access to
the location specified in Cloud Storage Container:
•
•
Password
The password necessary to access the location specified in
Cloud Storage Container:
•
•
Create Cloud Storage
Container
For clusters in Oracle Cloud Infrastructure, enter the user
name you use to sign in to the Oracle Cloud Infrastructure
console.
For clusters in Oracle Cloud Infrastructure Classic, enter
the Oracle Cloud user name of the administrator of the
Oracle Cloud Infrastructure Object Storage Classic
container specified in Cloud Storage Container. Usually,
this is your Oracle Cloud user name.
For clusters in Oracle Cloud Infrastructure, enter your
Swift password.
For clusters in Oracle Cloud Infrastructure Classic, enter
the Oracle Cloud password for the user specified in
Username.
(Not available on Oracle Cloud Infrastructure)
Select this to create a new Oracle Cloud Infrastructure Object
Storage Classic container as part of cluster creation. Specify
the container name, username, and password in the preceding
fields.
The user specified in Username and Password must have the
privileges needed to create storage containers.
If you select this option, the new storage container is created
when you click Next on the Service Details page, and the
storage container remains even if you cancel out of the wizard
without creating a new cluster. If this happens, you can use the
container in the future or manually delete it. See Deleting
Containers in Using Oracle Cloud Infrastructure Object
Storage Classic.
5.
Click Add Backup.
If you need to customize the backup configuration for this cluster at a later time, see
Customizing the Current Backup Configuration.
Creating an On-Demand Backup
You can create an on-demand backup of an Oracle Data Hub Cloud Service cluster by
using the Oracle Data Hub Cloud Service console.
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
Click the name of the cluster for which you want to create a backup.
The Oracle Data Hub Cloud Service Overview page is displayed.
3.
Click the Administration tile.
The Oracle Data Hub Cloud Service Backup page is displayed. If the Backup page
is not displayed, you must Add Backup Configuration to the cluster. See Adding
Backup Configuration for a Cluster.
6-4
Chapter 6
Viewing Available Backups
4.
Click Manage backups for this service
, and then select Backup Now.
The Backup Now dialog box opens.
5.
Enter notes for this backup and click Back Up.
The Backup page is updated to show that the backup is in progress.
While the backup is in progress, you cannot start any other management operation on
the service instance. Similarly, if the administration server is not running at the time a
backup is started, do not attempt to start this server until the backup completes.
When the backup is complete, it is added to the list of available backups on
the Backup page.
Viewing Available Backups
You can view available backups of an Oracle Data Hub Cloud Service cluster by using
the Oracle Data Hub Cloud Service console.
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
Click the name of the cluster for which you want to view available backups.
The Oracle Data Hub Cloud Service Overview page is displayed.
3.
Click the Administration tile.
The Oracle Data Hub Cloud Service Backup page is displayed. If the Backup page
is not displayed, you must Add Backup Configuration to the cluster. See Adding
Backup Configuration for a Cluster.
4.
The list of available backups is shown in the Backup tab.
Deleting a Backup
You cannot delete backups that are part of the automatic backup configuration. These
backups are deleted automatically based on the retention period of the automatic
backup configuration.
You can, however, delete an on-demand backup by using the Oracle Data Hub Cloud
Service console.
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
Click the name of the cluster for which you want to delete a backup.
The Oracle Data Hub Cloud Service Overview page is displayed.
3.
Click the Administration tile.
The Oracle Data Hub Cloud Service Backup page is displayed. If the Backup page
is not displayed, you must Add Backup Configuration to the cluster. See Adding
Backup Configuration for a Cluster.
4.
From the
menu for the backup, select Delete, and then confirm the action.
6-5
Chapter 6
Disabling or Enabling Backups
The backup is deleted.
Disabling or Enabling Backups
Backups in Oracle Data Hub Cloud Service are enabled by default on a new cluster
but you can disable and enable this feature as required.
Backups are enabled on a cluster if you set the Backup Destination to a value other
than “None” when creating it.
After disabling backups for a cluster:
•
Scheduled backups will not run.
•
Automated backups will not run prior to patching or scaling operations.
•
You cannot take an on-demand backup.
Disabling backups for a cluster does not affect any backups that were taken
previously.
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
Click the name of the cluster for which you want to disable or enable a backup.
The Oracle Data Hub Cloud Service Overview page is displayed.
3.
Click the Administration tile.
The Oracle Data Hub Cloud Service Backup page is displayed. If the Backup page
is not displayed, you must Add Backup Configuration to the cluster. See Adding
Backup Configuration for a Cluster.
4.
Click Manage backups on this service
Disable Backups.
, and then select Enable Backups or
When prompted, confirm that you want to enable or disable backups.
Customizing the Current Backup Configuration
The backup configuration can be customized from the Oracle Data Hub Cloud Service
Console. The following tasks are possible:.
•
Defining the schedule for a full backup — By default, full backup is performed once
a week.
•
Defining the schedule for an incremental backup — By default, incremental
backups are performed daily.
•
Defining the default retention period — This defines for how many days the
backups are kept in the cloud storage. Backups older than the defined number of
days are deleted.
To customize the backup configuration:
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
Click the name of the cluster for which you want to customize the backup
configuration.
6-6
Chapter 6
Restoring from a Specific Backup
The Oracle Data Hub Cloud Service Overview page is displayed.
3.
Click the Administration tile.
The Oracle Data Hub Cloud Service Backup page is displayed. If the Backup page
is not displayed, you must Add Backup Configuration to the cluster. See Adding
Backup Configuration for a Cluster.
4.
Click Manage backups for this service
, and then select Configure Backups.
The Configure Backups dialog box opens.
5.
In the Configure Backups dialog box, set the options to configure automated
backups for the cluster.
a.
In the Schedule section, set options to configure when automated backups are
performed:
Note:
All times must be for the Coordinated Universal Time (UTC) time zone,
not your local time zone.
b.
Option
Description
Full Backup
From the drop-down lists, select the day of the week and
the time of day UTC when you want full backups to be
performed.
Incremental Backup
From the drop-down list, select the time of day UTC when
you want incremental backups to be performed.
In the Set new retention period to field, enter the number of days that you
want new incremental backups and full on-demand backups to be retained.
Note:
If you decrease the retention period, any existing backups that are
older than this period will automatically be deleted during the next
scheduled backup.
Full scheduled backups are retained until their last linked incremental backup
is no longer available. The additional retention period for full scheduled
backups is fixed and you cannot change it.
6.
Click Save.
Restoring from a Specific Backup
You can restore from a specific backup and perform recovery to that backup on an
Oracle Data Hub Cloud Service deployment by using the Oracle Data Hub Cloud
Service console.
6-7
Chapter 6
Restoring from a Specific Backup
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
Click the name of the cluster you want to restore and recover.
The Oracle Data Hub Cloud Service Overview page is displayed.
3.
Click the Administration tile.
The Oracle Data Hub Cloud Service Backup page is displayed. If the Backup page
is not displayed, you must Add Backup Configuration to the cluster. See Adding
Backup Configuration for a Cluster.
4.
In the list of backups, locate the backup you want to restore from. Click the
menu for the backup, choose Restore, and then confirm the action.
The restore process performs these steps:
•
Shuts down the cluster
•
Prepares for restore
•
Performs the restore
•
Restarts the cluster after restore
6-8
7
Patching Oracle Data Hub Cloud Service
This section explains how to patch Oracle Data Hub Cloud Service clusters, and roll
back the patch as necessary.
Topics
•
About Patching an Oracle Data Hub Cloud Service Cluster
•
Viewing Available Patches
•
Checking Prerequisites Before Applying a Patch
•
Applying a Patch
•
Rolling Back a Patch
About Patching an Oracle Data Hub Cloud Service Cluster
You can quickly and easily apply patches to an Oracle Data Hub Cloud Service cluster
from the user interface.
About Operating System (OS) Patching
Oracle Data Hub Cloud Service does not provide cloud tooling for OS patching. You
are responsible for installing OS patches to existing clusters.
If you have an Oracle Linux support subscription, you can obtain Oracle Linux OS
patches from Oracle’s Unbreakable Linux Network. You can also obtain Linux OS
patches from the Oracle Linux Public yum server: http://public-yum.oracle.com.
When to Apply Patches
New approved patches are available and displayed on the Patching page roughly on a
quarterly basis. Apply the most recent patches promptly. Delaying patches could
cause your service to be unsupported for future patching and upgrade.
What Happens When Patching Starts
As patching starts, the patching operation first performs internal prechecks. If the
prechecks fail, the patching operation fails and leaves the cluster untouched.
The following prechecks are performed:
•
Disk space shortage
•
Servers not running
•
Storage access failure
The prechecks do not check whether another administration task (backup, restoration,
or scaling) is in progress, which would prevent patching.
You can perform prechecks without attempting to patch, and first remedy any
problems found. See Checking Prerequisites Before Applying a Patch.
7-1
Chapter 7
Viewing Available Patches
An automatic backup to use for rollback and restoration is created only after patching
prechecks succeed. If you need to restore the state of the cluster, use the backup and
run patching again.
Note:
If automatic backup fails, then the patching operation fails and does not apply
the patch.
What Happens During Patching
The Oracle Data Hub Cloud Service cluster is stopped for the duration of the patching
operation. The cluster is restarted when the patching operation is finished.
Viewing Available Patches
You can view a list of available patches you can apply to an Oracle Data Hub Cloud
Service cluster by using the Oracle Data Hub Cloud Service console.
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
Click the name of the cluster for which you want to view available patches.
The Oracle Data Hub Cloud Service Overview page is displayed.
3.
Click the Administration tile.
The Oracle Data Hub Cloud Service Administration page is displayed.
4.
Select the Patching tab to view the list of available patches.
Checking Prerequisites Before Applying a Patch
Before you apply a patch, you can check its prerequisites to make sure that it can be
successfully applied by using the Oracle Data Hub Cloud Service console.
The prerequisites-checking operation:
•
Confirms that the patch is available for download.
•
Verifies that there is enough space in the /u01 directory to apply the patch.
•
Compares the patch’s prerequisites to the cluster.
Note:
Before checking patch prerequisites, make sure the cluster has the latest cloud
tooling. Some patches require a certain minimum level of cloud tooling.
To perform prechecks:
1.
Open the Oracle Data Hub Cloud Service Console.
7-2
Chapter 7
Applying a Patch
See Accessing the Oracle Data Hub Cloud Service Console.
2.
Click the name of the cluster for which you want to check patching.
The Oracle Data Hub Cloud Service Overview page is displayed.
3.
Click the Administration tile.
The Oracle Data Hub Cloud Service Administration page is displayed.
4.
Select the Patching tab.
5.
In the entry for the patch whose prerequisites you want to check, click the
menu and then select Precheck.
If you have previously checked prerequisites for the selected patch, the Patch
Precheck Service window displays, showing the results of the previous check and
asking you to perform another set of prerequisite checks. In this case,
click Precheck to continue.
The Patching page redisplays, showing a status message indicating that
prerequisite checks are in progress.
6.
Refresh the Patching page occasionally to update the status message.
Note that prerequisite checking can take several minutes to complete.
7.
When the prerequisite checks are completed, the Precheck results link is
displayed.
Click Precheck results to display the results of the prerequisite checks.
Applying a Patch
You can apply a patch to an Oracle Data Hub Cloud Service cluster by using the
Oracle Data Hub Cloud Service console.
To apply a patch to a cluster:
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
Click the name of the cluster to which you want to apply a patch.
The Oracle Data Hub Cloud Service Overview page is displayed.
3.
Click the Administration tile.
The Oracle Data Hub Cloud Service Administration page is displayed.
4.
Select the Patching tab.
5.
In the entry for the patch you want to apply, click the
select Patch.
menu and then
The Patch Service window closes and the patching operation begins. The patch
process first performs a full backup before patching the database.
The Administration tile shows the starting time of the patching operation and a
Patching... message replaces the Patch button.
When the patching operation completes, the Patching page shows the completion time
of the patching operation, and a log of the operation’s activities appears in the Details
of Last Patching Activity section. If the operation was successful, the patch is removed
7-3
Chapter 7
Rolling Back a Patch
from the list of patches in the Available Patches. If the operation failed, the patch
remains in the list. In this case, check the Details of Last Patching Activity section for
information about the failure.
Note:
Patching operations are performed with minimum impact on the functioning of
the cluster. However, during part of the operation the cluster restarts, making it
inaccessible for a period of time.
Rolling Back a Patch
You can roll back a patch on an Oracle Data Hub Cloud Service cluster by using the
Oracle Data Hub Cloud Service console.
1.
Open the Oracle Data Hub Cloud Service Console.
See Accessing the Oracle Data Hub Cloud Service Console.
2.
Click the name of the cluster on which you want to roll back a patch.
The Oracle Data Hub Cloud Service Overview page is displayed.
3.
Click the Administration tile.
The Oracle Data Hub Cloud Service Administration page is displayed.
4.
Select the Patching tab.
5.
Click Rollback.
The Patching page redisplays, showing a status message that your request has
been submitted, the Administration tile shows the starting time of the rollback
operation, and a Rolling back... message replaces the Rollback button.
6.
Refresh the Patching page occasionally to update the status message.
Note that the rollback operation can take several minutes to complete.
When the rollback operation completes, the Administration tile shows the
completion time of the operation, and a log of the operation’s activities appears in
the Details of Last Patching Activity section.
Note:
Rollback operations are performed with minimum impact on the functioning of
the cluster. However, during part of the operation the cluster is shut down,
making it inaccessible. The cluster restarts when that portion of the rollback
operation completes.
7-4
A
Characteristics of a Newly Created Cluster
This section provides information about the content and configuration of a newly
created cluster on Oracle Data Hub Cloud Service.
Topics
•
Cluster Components
•
Linux User Accounts
•
Locations of Installed Software
Cluster Components
The following table lists the open source components deployed in Oracle Data Hub
Cloud Service clusters and provides pointers to more information.
Component
Version
More Information
Apache Cassandra
3.0.15, 3.11.1
Cassandra documentation
Linux User Accounts
This section provides information about Linux user accounts that are provisioned on
an Oracle Data Hub Cloud Service cluster.
The Oracle Data Hub Cloud Service compute node is provisioned with the following
operating system user accounts.
User
Description
opc
The system administrator account you use with
the sudo command to perform operations that require root-user
access.
A-1
Appendix A
Linux User Accounts
User
Description
oracle
The database administrator account you use to access the
system and perform non-root, database administration tasks. A
home directory, /u01/app/oracle/tools/home/oracle, is
created for this user. This user cannot use the sudo command to
perform operations that require root-user access.
Note:
Apache Cassandra, and all associated
process, run under the oracle user. To
run the cqlsh or nodetool command
line, you must be logged in as the
oracle user.
root
The root administrator for the system. You do not have direct
access to this account. To perform operations that require rootuser access, use the sudo command as the opc user.
The following environment variables are created for the opc and oracle users.
Variable
Description
HOME
The home directory of the user, either /home/opc or /u01/app/
oracle/tools/home/oracle.
HOSTNAME
The host name of the compute node.
JAVA_HOME
The Java home directory: /u01/dhcs/bin/jdk. Set for the oracle
user, only.
CASSANDRA_HOME
The Apache Cassandra home directory: /u01/dhcs/bin/
cassandra. Set for the oracle user, only.
PATH
The paths to search for executables; set to include:
•
$JAVA_HOME/bin
•
$CASSANDRA_HOME/bin
•
/usr/local/bin
•
/sbin
•
/bin
•
/usr/sbin
•
/usr/bin
cqlsh and nodetool are available to the oracle user only. To
invoke the cqlsh or nodetool command line, enter cqlsh or
nodetool respectively in the command line terminal as the oracle
user.
SHELL
The default shell, /bin/bash.
USER
The user name, either opc or oracle.
A-2
Appendix A
Locations of Installed Software
Locations of Installed Software
This section provides information about the locations of installed software on a newly
created Oracle Data Hub Cloud Service cluster.
When a cluster is created, software is installed in the following locations.
Software
Installation Location
Apache Cassandra
$CASSANDRA_HOME: /u01/dhcs/bin/cassandra
DHCS Nodetool
/u01/dhcs/bin/dhcs-nodetool
Java SE Development Kit
$JAVA_HOME: /u01/dhcs/bin/jdk
Python
/u01/dhcs/bin/Python-2.7.10
A-3
B
Oracle Cloud Pages for
Administering Oracle Data Hub Cloud
Service
This section provides information about what you can do and what you see on each of
the Oracle Cloud pages for administering Oracle Data Hub Cloud Service.
Topics
•
Instances Page
•
Activity Page
•
SSH Access Page
•
IP Reservations Page
•
QuickStarts Page
•
Overview Page
•
Access Rules Page
•
Backup Page
•
Patching Page
•
Create New Instance: Instance Page
•
Create New Instance: Service Details Page
•
Create New Instance: Confirmation Page
Instances Page
The Oracle Data Hub Cloud Service Instances page displays all clusters on Oracle
Data Hub Cloud Service.
Topics
•
What You Can Do From the Instances Page
•
What You See on the Instances Page
What You Can Do From the Instances Page
Use the Oracle Data Hub Cloud Service Instances page to perform the tasks
described in the following topics:
•
Accessing the Oracle Data Hub Cloud Service Service Console
•
Creating a Cluster
•
Creating a Cluster by Using a QuickStart Template
•
Viewing All Clusters
B-1
Appendix B
Instances Page
•
Stopping, Starting, and Restarting a Cluster
•
Deleting a Cluster
What You See on the Instances Page
The following table describes the key information shown on the Oracle Data Hub
Cloud Service Instances page.
Element
Description
Navigation menu providing access to My Services and other
Oracle Cloud services in the identity domain.
Click to go to the My Services Dashboard page.
Click to go to the My Services Users page.
Click to go to the My Services Notifications page.
Click to open the Help Drawer.
Username menu
User menu providing access to help, accessibility options, console
version information, and sign-out.
QuickStarts
Click to go to the QuickStarts page
Welcome!
Click to go to the Oracle Data Hub Cloud Service console
Welcome page.
Menu that provides access to Platform Services and Oracle Cloud
Stack.
Activity
Click to go to the Activity Page.
SSH Access
Click to go to the SSH Access Page.
REST APIs
Click to go to the API Catalog Cloud Service.
Refreshes the page.
Instances, OCPUs,
Memory, Storage, and
Public IPs
Summary of resources being used:
•
•
•
•
•
Instances — Total number of configured clusters.
OCPUs — Total number of Oracle CPUs allocated across all
clusters.
Memory — Total amount of compute node memory allocated
across all clusters.
Storage — Total amount of block storage allocated across all
clusters.
Public IPs — Number of public IP addresses allocated
across all clusters.
Enter a full or partial cluster name to filter the list of clusters to
include only those that contain the string in their name.
Create Instance
Click to create a new Oracle Data Hub Cloud Service cluster. See
Creating a Cluster.
Click to view details for the cluster.
Status
Status of the cluster if it is not running. Status value includes “In
Progress”, “Maintenance”, “Stopped”, and “Terminating”.
Version
Version of the Oracle Data Hub Cloud Service configured on the
cluster. For example: 3.10.1706152252.
B-2
Appendix B
Activity Page
Element
Description
Nodes
The number of nodes assigned to the cluster.
Created On or Submitted
On
Date when the cluster was created. During the creation process,
the date when the creation request was submitted.
OCPUs
Number of Oracle CPUs associated with the cluster.
Memory
Amount of compute node memory in GBs associated with the
cluster.
Storage
Amount of storage in GBs associated with the cluster.
Menu that provides the following options:
(menu for each
deployment)
•
•
•
•
•
•
•
Instance Create and
Delete History
Service Console — Open the Data Hub Service Console.
Start — Start a stopped cluster. See Stopping, Starting, and
Restarting a Cluster.
Stop — Stop a cluster. See Stopping, Starting, and
Restarting a Cluster.
Restart — Restart a cluster. See Stopping, Starting, and
Restarting a Cluster.
SSH Access — Add another SSH public key or replace the
existing SSH public key associated with the cluster. See
Updating or Adding a New SSH Public Key.
Access Rules — Go to the Access Rules Page to manage
the access rules that control network access to the cluster.
Delete — Click to delete the cluster from the list of clusters
displayed in the console. See Deleting a Cluster.
Listing of attempts to create or delete a cluster. Click the triangle
icon next to the title to view the history listing.
Activity Page
The Activity page displays activities for all Oracle Data Hub Cloud Service clusters in
your identity domain. You can restrict the list of activities displayed using search filters.
Topics
•
What You Can Do From the Activity Page
•
What You See on the Activity Page
What You Can Do From the Activity Page
Use the Oracle Data Hub Cloud Service Activity page to view operations for all Oracle
Data Hub Cloud Service clusters in your identity domain.
You can use the page’s Search Activity Log section to filter the list of displayed
operations based on:
•
The time the operation was started
•
The status of the operation
•
The name of the cluster on which the operation was performed
•
The type of the operation
In the table of results, you can:
B-3
Appendix B
Activity Page
•
Click any column heading to sort the table by that column.
•
Click the triangle at the start of an operation’s row to see more details about the
operation.
What You See on the Activity Page
The following table describes the key information shown on the Oracle Data Hub
Cloud Service Activity page.
Element
Description
Displays Search Activity Log to search and review activities of
Oracle Cloud Services in your identity domain.
Start Time Range
Filters activity results to include only operations started within a
specified time range. The range defaults to the previous 24 hours.
Operation Status
Filters operations by status of the operation:
•
All
•
Scheduled
•
Running
•
Succeeded
•
Failed
You can select any subset of status types. The default value
is All.
Instance Name
Filters the activity results to include operations only for the
specified cluster. You can enter a full or partial cluster name.
Instance Type
Filters the activity results to include operations only for instances
of the specified service type. The default value is the current cloud
service.
Operation
Filters the activity results to include selected types of operations.
You can select any subset of the given operations. The default
value is All.
Search
Searches for activities by applying the filters specified by the Start
Time Range, Status, Service Name, Service Type and Operation
fields, and displays activity results in the table.
Reset
Clears the Start Time Range and Service Name fields, and
returns the Status and Operation fields to their default values.
Results per page
Specifies the number of results you want to view per page. The
default value is 10.
Refreshes the page.
Displays status messages for the given operation. Clicking on the
resulting downward arrow hides the status messages.
Operation
Shows the type of operation performed on the cluster.
Instance Name
Shows the name of the cluster.
You can sort this column in ascending or descending order.
Instance Type
Shows the type of cloud service for this cluster.
You can sort this column in ascending or descending order.
Operation Status
Shows the status of the operation performed on the cluster.
You can sort this column in ascending or descending order.
B-4
Appendix B
SSH Access Page
Element
Description
Start Time
Shows the time the operation started.
You can sort this column in ascending or descending order.
End Time
Shows the time the operation ended, if the operation is complete.
You can sort this column in ascending or descending order.
Initiated By
Shows the user that initiated the operation. The user can be any
user in the identity domain who initiated the operation or, for
certain operations such as automated backup, System.
You can sort this column in ascending or descending order.
SSH Access Page
The SSH Access page enables you to view and add SSH public keys to Oracle Data
Hub Cloud Service clusters in your identity domain. You can restrict the list of clusters
displayed using search filters.
Topics
•
What You Can Do From the SSH Access Page
•
What You See on the SSH Access Page
What You Can Do From the SSH Access Page
Use the Oracle Data Hub Cloud Service SSH Access page to view and add SSH
public keys to Oracle Data Hub Cloud Service clusters in your identity domain.
You can use the page’s search section to filter the list of displayed clusters based on
the cluster name. In the table of results, you can:
•
Click any column heading to sort the table by that column.
•
Click the triangle at the start of a cluster’s row to see more details.
What You See on the SSH Access Page
The following table describes the key information shown on the Oracle Data Hub
Cloud Service SSH Access page.
Element
Description
Instance Name
Filters the results to include SSH keys only for the specified
clusters. You can enter a full or partial cluster name.
Instance Type
Filters the results to include SSH keys only for clusters of the
specified service type. The default value is the current cloud
service.
Search
Searches for SSH keys by applying the filters specified by the
Service Name and Service Type fields, and displays the results in
the table.
Results per page
Specifies the number of results you want to view per page. The
default value is 10.
Refreshes the page.
B-5
Appendix B
IP Reservations Page
Element
Description
Displays a description of an item in the results table. Clicking on
the resulting downward arrow hides the description.
Instance Name
Shows the name of the cluster.
Instance Type
Shows the type of cloud service for this cluster.
Last Update
Shows the most recent time the SSH keys for this cluster were
updated.
Actions
Click the Add New Key button to associate another SSH public
key to this cluster, or to replace the existing SSH public key for
the cluster.
The Add New Key overlay is displayed with its Key value field
displaying the cluster’s most recent SSH public key.
Specify the public key using one of the following methods:
•
Select Upload a new SSH Public Key value from file and
click Choose File to select a file that contains the public key.
•
Select Key value. Delete the current key value and paste the
new public key into the text area. Make sure the value does
not contain line breaks or end with a line break.
The Add New Key button is enabled only if the service is running.
IP Reservations Page
This topic does not apply to Oracle Cloud Infrastructure.
The Oracle Data Hub Cloud Service IP Reservations page displays
the IP Reservations you have created. You use the page to view,
manage, and create Oracle Cloud Infrastructure Compute Classic
security rules.
Topics
•
What You Can Do From the IP Reservations Page
•
What You See on the IP Reservations Page
What You Can Do From the IP Reservations Page
Use the Oracle Data Hub Cloud Service IP Reservations page to perform the tasks
described in the following topics:
•
Creating an IP Reservation
•
Deleting an IP Reservation
What You See on the IP Reservations Page
The following table describes the key information shown on the Oracle Data Hub
Cloud Service IP Reservations page.
B-6
Appendix B
QuickStarts Page
Element
Description
Create
Launches the IP reservation creation process. Clicking this button
will open the Create dialog box wherein you can create an IP
reservation and allocate it to a region.
Search
Searches for IP reservations either by name or by region. You can
enter a full or partial name and search will return all IP
reservations that meet the specified criteria.
IP Reservations list
Lists, by name, all IP reservations created for your cluster and
specific details about each reservation. These details are:
•
•
•
•
Region
Status
IP address
Date the IP reservation was created.
Clicking this icon deletes the IP Reservation. If the icon is
disabled (grayed-out), the reservation is in use and you cannot
delete it.
QuickStarts Page
This topic does not apply to Oracle Cloud Infrastructure.
The Oracle Data Hub Cloud Service QuickStarts page is used to
rapidly provision an Oracle Data Hub Cloud Service cluster.
Topics
•
What You Can Do From the QuickStarts Page
•
What You See on the QuickStarts Page
What You Can Do From the QuickStarts Page
Use the QuickStarts page to perform the tasks described in the following topics:
•
Creating a Cluster by Using a QuickStart Template
What You See on the QuickStarts Page
The following table describes the elements and options available in the QuickStarts
section of the page.
Element
Description
Cancel
Click to cancel and go to the My Services Dashboard page.
Custom
Goes to the Create New Instance: Instance Page, where you can
create a customized cluster instead of using one of the QuickStart
templates.
B-7
Appendix B
Overview Page
Element
Description
Instance Name
Name for the new cluster. The name:
•
•
•
•
•
Create (below each
template)
Must not exceed 50 characters.
Must start with a letter.
Must contain only letters, numbers, or hyphens.
Must not contain any other special characters.
Must be unique within the identity domain.
Displays the Confirmation window, where you download a zip file
containing information needed to access the cluster and then click
Create to begin creation of the cluster.
Overview Page
The Oracle Data Hub Cloud Service Overview page displays overview information for
an Oracle Data Hub Cloud Service cluster.
Topics
•
What You Can Do From the Overview Page
•
What You See in the Banner Area
•
What You See in the Tiles Area
•
What You See in the Page Content Area
What You Can Do From the Overview Page
Use the Oracle Data Hub Cloud Service Overview page to perform the tasks described
in the following topics:
•
Restarting a Node
•
Extending Node Storage
•
Scaling In a Cluster
•
Scaling Out a Cluster
•
Scaling Up/Down a Node
What You See in the Banner Area
The following table describes the elements and options available in the banner area at
the top of the page.
Element
Description
Navigation menu providing access to My Services and other
Oracle Cloud services in the identity domain.
Click to go to the My Services Dashboard page.
Click to go to the My Services Users page.
Click to go to the My Services Notifications page.
B-8
Appendix B
Overview Page
Element
Description
Click to open the Help Drawer.
Username menu
User menu providing access to help, accessibility options, console
version information, and sign-out.
Action menu that provides the following options:
(next to the cluster’s name) •
•
•
•
•
•
•
•
•
Oracle Data Hub Cloud
Service link
Service Console — Open the Data Hub Service Console.
Start — Start a stopped cluster. See Stopping, Starting, and
Restarting a Cluster.
Stop — Stop a cluster. See Stopping, Starting, and
Restarting a Cluster.
Restart — Restart a cluster. See Stopping, Starting, and
Restarting a Cluster.
Scale Out — Add nodes to this cluster. See Scaling Out a
Cluster.
Access Rules — Go to the Access Rules Page to manage
the access rules that control network access to the cluster.
SSH Access — Add another SSH public key or replace the
existing SSH public key associated with the cluster. See
Updating or Adding a New SSH Public Key.
Add Backup — Click to add backup destination. See Adding
Backup Configuration for a Cluster.
View Activity — Go to the Activity Page to view activities
performed on this cluster.
Click to return to the Instances Page.
Click to start a stopped cluster.
Click to stop a cluster.
Click to restart a cluster.
Click to add nodes to this cluster.
Click to poll the status of the cluster’s compute nodes and display
the results on this page.
What You See in the Tiles Area
The following table describes the elements and options available in the tiles area at
the side of the page.
Element
Description
Overview tile
The current tile, highlighted to indicate that you are viewing the
Overview page.
Administration tile
Click to access these pages for the cluster:
•
•
Backup Page
Patching Page
What You See in the Page Content Area
The following table describes the elements and options available in the main content
area of the page.
B-9
Appendix B
Overview Page
Element
Description
Instance Overview
Displays overview information for the cluster.
Refreshes the page.
Nodes, OCPUs, Memory,
and Storage
Summary of resources being used:
•
•
•
•
Nodes — Total number of nodes in this cluster.
OCPUs — Total number of Oracle CPUs allocated across all
clusters.
Memory — Total amount of compute node memory allocated
across all clusters.
Storage — Total amount of block storage allocated across all
clusters.
Click to hide resource summary.
Status
Status of the Oracle Data Hub Cloud Service cluster. Status value
includes “In Progress”, “Maintenance”, “Stopped”, and
“Terminating”.
Backup Destination
Backup destination associated with the cluster. See About
Backing Up and Restoring Databases.
Instance Name
Name of the cluster.
Use High Performance
Storage
Boolean value. If true, it indicates that SSDs (solid state drives)
are used for storage.
Version
Version of the Oracle Data Hub Cloud Service configured on the
cluster. For example: 3.10.1706152252.
Client Connection Port
Port that a client uses to connect to the cluster.
Node List
Comma-separated string containing public IPs of all the nodes in
the cluster.
Displays resource information for the cluster.
(for Resources)
Host Name
Name of an individual node in the cluster.
Public IP
IP Address of an individual node in the cluster.
Instance
The kind of node within the Oracle Data Hub Cloud Service
cluster.
OCPUs
Number of Oracle CPUs associated with the cluster.
Memory
Amount of compute node memory in GBs associated with the
cluster.
Storage
Amount of storage in GBs associated with the cluster.
Action menu that provides the following options:
(for each resource)
•
•
•
•
Remove Node — Remove a node. See Scaling In a Cluster.
Restart — Restart a node. See Restarting a Node.
Scale Up/Down — Scale node compute up or down. See
Scaling Up/Down a Node.
Add Storage — Extend storage of a node. See Extending
Node Storage.
B-10
Appendix B
Access Rules Page
Access Rules Page
This topic does not apply to Oracle Cloud Infrastructure.
The Oracle Data Hub Cloud Service Access Rules page displays rules used to control
network access to Oracle Data Hub Cloud Service clusters. You can use the page to
view, manage, and create Oracle Cloud Infrastructure Compute Classic security rules.
Topics
•
What You Can Do From the Access Rules Page
•
What You See on the Access Rules Page
What You Can Do From the Access Rules Page
Use the Oracle Data Hub Cloud Service Access Rules page to perform the tasks
described in the following topics:
•
Creating Access Rules
•
Enabling, Disabling, and Deleting an Access Rule
What You See on the Access Rules Page
The following table describes the key information shown on the Oracle Data Hub
Cloud Service Access Rules page.
Element
Description
Action menu that provides the following options:
(next to the cluster’s name) •
•
•
•
•
•
•
•
•
Service Console — Open the Data Hub Service Console.
Start — Start a stopped cluster. See Stopping, Starting, and
Restarting a Cluster.
Stop — Stop a cluster. See Stopping, Starting, and
Restarting a Cluster.
Restart — Restart a cluster. See Stopping, Starting, and
Restarting a Cluster.
Scale Out — Add nodes to this cluster. See Scaling Out a
Cluster.
Access Rules — Go to the Access Rules Page to manage
the access rules that control network access to the cluster.
SSH Access — Add another SSH public key or replace the
existing SSH public key associated with the cluster. See
Updating or Adding a New SSH Public Key.
Add Backup — Click to add backup destination. See Adding
Backup Configuration for a Cluster.
View Activity — Go to the Activity Page to view activities
performed on this cluster.
Create Rule
Click to create a new rule. See Creating Access Rules.
Results per page
Specifies the number of results you want to view per page. The
default value is 10.
Refreshes the page.
B-11
Appendix B
Backup Page
Element
Description
Status
Displays an icon that indicates where a rule is enabled or
disabled.
Indicates the rule is enabled.
Indicates the rule is disabled.
Rule Name
Name of the access rule. When creating an access rule, this must
start with a letter, followed by letters, numbers, hyphens, or
underscores. The name cannot start with ora_ or sys_.
Source
Hosts from which traffic is allowed. See Creating Access Rules for
possible values.
Destination
Security list to which traffic is allowed. See Creating Access Rules
for possible values.
Ports
Port or range of ports for the rule.
Protocol
Protocol for the access rule.
Description
Description of the access rule (optional).
Rule Type
Types of rule. Rule types are:
•
•
•
DEFAULT — Rules created automatically when the cluster was
created. Can be enabled or disabled, but not deleted.
SYSTEM — Rules created by the system. Cannot be enabled,
disabled, or deleted.
USER — Rules created by you or another user. Can be
enabled, disabled, or deleted.
Menu that provides the following options:
(for rule)
•
Enable: When you enable an access rule, the given port on
the compute node is opened to the public internet.
•
Disable: When you disable an access rule, the given port on
the compute node is restricted to the public internet.
•
Delete: Deleting an access rule removes the access rule
from the access rules list.
See Enabling, Disabling, and Deleting an Access Rule.
Backup Page
You use the Backup page to manage backup and restore of a particular cluster.
Topics
•
What You Can Do From the Backup Page
•
What You See on the Backup Page
What You Can Do From the Backup Page
Use the Oracle Data Hub Cloud Service Backup page to perform the tasks described
in the following topics:
•
Viewing Available Backups
•
Creating an On-Demand Backup
•
Restoring from a Specific Backup
B-12
Appendix B
Patching Page
•
Customizing the Current Backup Configuration
•
Disabling or Enabling Backups
•
Deleting a Backup
What You See on the Backup Page
The following table describes the key information shown on the Oracle Data Hub
Cloud Service Backup page.
Element
Description
Summary
Displays a summary of backup activities. The following
information is displayed:
•
•
•
•
•
•
Incremental Backups — Displays the incremental backup
schedule.
Full Backups — Displays the full backup schedule.
Last Successful Backup — Displays the date and time of
the last successful backup.
Backups on Cloud Storage — Displays the amount of
storage used by the backup in the configured cloud storage.
Backup Volume Used — Displays the amount of local
storage used by the backup.
Backup Volume Used (%) — Displays the amount of local
storage used by the backup in percentage.
Available Backups
List of available backups. By default, only backups for the last
seven days are listed. Use the search field to specify a range of
dates for which you want backups returned.
Manage backup on this
service
Click the menu icon for the following options:
•
•
•
Configure Backups
Backup now: Select this option to create an on-demand
backup of the cluster. See Creating an On-Demand Backup.
Configure Backups: Select this option to update the backup
schedule. See Customizing the Current Backup
Configuration.
Disable Backups or Enable Backups: Select this option to
disable/enable automated and on-demand backups. See
Disabling or Enabling Backups.
Click to open the Configure Backups dialog. For more
information, see Customizing the Current Backup Configuration.
Menu that provides the Restore and Delete options. Choose
Restore to recover to the given backup. Choose Delete to delete
(for each available backup)
the backup.
Restore History
Listing of restore operations on the cluster. Click
(next to the title) to view the listing.
Patching Page
You can use the Patching page to patch Oracle Data Hub Cloud Service clusters.
Topics
•
What You Can Do From the Patching Page
•
What You See on the Patching Page
B-13
Appendix B
Create New Instance: Instance Page
What You Can Do From the Patching Page
Use the Oracle Data Hub Cloud Service Patching page to perform the tasks described
in the following topics:
•
Viewing Available Patches
•
Checking Prerequisites Before Applying a Patch
•
Applying a Patch
•
Rolling Back a Patch
What You See on the Patching Page
The following table describes the key information shown on the Oracle Data Hub
Cloud Service Patching page.
Element
Description
Available Patches
A list of patches you can apply to the cluster.
Description
Description of the cluster.
Menu icon provides the following options for the patch:
(for each listed patch)
•
•
Precheck — Check whether the patch can be successfully
applied to the cluster.
Patch — Apply the patch to the cluster.
Patch and Rollback
History
Expand to see a description of the actions taken during the last
patching operation.
Rollback
Click to roll back the last patching operation. See Rolling Back a
Patch.
Create New Instance: Instance Page
The Oracle Data Hub Cloud Service Create New Instance: Instance page is used to
create a new Oracle Data Hub Cloud Service cluster.
Topics
•
What You See in the Navigation Area
•
What You See in the Service Section
What You See in the Navigation Area
The following table describes the elements and options available in the navigation
area of the page.
Element
Description
Cancel
Click to cancel creating an Oracle Data Hub Cloud Service
cluster.
Next >
Click to advance to the Oracle Data Hub Cloud Service Create
New Instance: Service Details
B-14
Appendix B
Create New Instance: Instance Page
What You See in the Service Section
The following table describes the elements and options available in the service section
of the page.
Element
Description
Instance Name
Name for the new cluster. The name:
•
•
•
•
•
Description
Must not exceed 50 characters.
Must start with a letter.
Must contain only letters, numbers, or hyphens.
Must not contain any other special characters.
Must be unique within the identity domain.
(Optional) Description for the new cluster.
The description is only used during cluster list display and is not
used internally by Service Manager.
Notification Email
(Optional) Email address provisioning status updates should be
sent to.
Region
(Available only if your identity domain is enabled for regions.)
The region for the cluster deployment. If you choose a region that
supports Oracle Cloud Infrastructure, the Availability Domain
and Subnet fields are displayed, and the deployment will be
created on Oracle Cloud Infrastructure. Otherwise, the
deployment will be created on Oracle Cloud Infrastructure Classic.
Choose No Preference to let Oracle Data Hub Cloud Service
choose an Oracle Cloud Infrastructure Classic region for you.
Availability Domain
(Available only on Oracle Cloud Infrastructure)
The availability domain (within the region) where the cluster will
be deployed.
Subnet
(Available only on Oracle Cloud Infrastructure)
The subnet (within the availability domain) that will determine
network access to the cluster.
IP Network
(Only if a region is selected) Select an IP network if you want to
create the cluster in an IP network that you’ve defined.
See Creating an IP Network in Oracle Cloud Infrastructure
Classic.
By default, each node in your cluster is auto-assigned a public
and a private IP address. The IP addresses might change each
time the cluster is restarted. You can reserve and assign fixed
public IP addresses.
This field is not relevant to Oracle Cloud Infrastructure.
Software Release
Specify the version of Data Hub software and release you wish to
use. Select from the following options:
•
•
Metering Frequency
Release 3.0.15
Release 3.11.1
Metering frequency used to determine the billing for resources
used by the cluster.
B-15
Appendix B
Create New Instance: Service Details Page
Create New Instance: Service Details Page
The Oracle Data Hub Cloud Service Create New Instance: Service Details page is
used to provide more details about the new Oracle Data Hub Cloud Service cluster
that you are about to create.
Topics
•
What You See in the Navigation Area
•
What You See in the Cluster Configuration Section
•
What You See in the Backup and Recovery Configuration Section
•
What You See in the Credentials Section
What You See in the Navigation Area
The following table describes the elements and options available in the navigation
area of the page.
Element
Description
< Previous
Click to navigate to the Oracle Data Hub Cloud Service Create
New Instance: Instance page.
Cancel
Click to cancel creating an Oracle Data Hub Cloud Service
cluster.
Next >
Click to advance to the Oracle Data Hub Cloud Service Create
New Instance: Confirmation page.
Selection Summary
Click to see a summary of the service being created.
What You See in the Cluster Configuration Section
The following table describes the elements and options available in the cluster
configuration section of the page.
Element
Description
Compute Shape
Number of Oracle Compute Units (OCPUs) and amount of
memory (RAM) for each node of the new cluster. Oracle Data Hub
Cloud Service offers several OCPU/RAM combinations.
Number of Nodes
Number of nodes to be allocated to the cluster. Specify three or
more nodes to provide high availability (HA).
B-16
Appendix B
Create New Instance: Service Details Page
Element
Description
Reserved IPs
(This option is displayed only if you selected a specific Region for
this cluster.)
Select reserved IP addresses for the nodes in your cluster, or
leave the default value as Assign Automatically if you want
Oracle to automatically assign IP addresses to these nodes. The
number of IP addresses that you select must equal the number of
nodes in the cluster.
You create IP reservations by using the IP Reservations tab in
the Oracle Data Hub Cloud Service Console. If you do not see
this tab on the console, click the gear icon next to this field and
follow the instructions to create your first IP reservation. After
creating IP reservations, you need to restart the instance creation
wizard. See Managing IP Reservations for a Cluster.
Usable Data Storage in
GB
Amount of usable data storage to be allocated per node.
Use High Performance
Storage
Select this to use high performance storage. With this option the
storage attached to nodes uses SSDs (solid state drives) instead
of HDDs (hard disk drives). Use this option for performancecritical workloads. An additional cost is associated with this type of
storage.
Allocated Data Storage
per Node in GB
The data storage allocated per node is calculated and displayed.
Note:
The Allocated Data Storage per node
is calculated by multiplying the
replication factor and compaction
overhead to the entered Usable Data
Storage value and then dividing the
resulting value by the number of nodes
specified for the cluster. If the cluster
size is 1 or 2 nodes, the replication
factor is 1 or 2 respectively. If the
cluster size is 3 or more nodes, the
replication factor is 3. The compaction
overhead applies a factor of 2
assuming Apache Cassandra’s
SizeTieredCompactionStrategy. For
example, if you create a cluster of 3
nodes specifying Usable Data Storage
of 10 GB, then the Allocated Data
Storage per node will be (3 * 2 *
10) / 3 giving 20 GB.
What You See in the Backup and Recovery Configuration Section
The following table describes the elements and options available in the backup and
recovery configuration section of the page.
B-17
Appendix B
Create New Instance: Service Details Page
Element
Description
Backup Destination
Controls how backups for the clusters are to be configured:
•
•
Both Cloud Storage and Local Storage — backups are
configured to be created automatically and stored both on
local and cloud storage.
If this choice is selected, the Cloud Storage Container,
Username and Password fields are displayed.
Cloud Storage Only — backups are configured to be
created automatically and stored on cloud storage.
If this choice is selected, the Cloud Storage Container,
Username and Password fields are displayed.
•
None — no automatic backups are configured.
For more information about backups and backup configurations,
see About Backing Up and Restoring Databases.
Cloud Storage Container
The URL where backups to cloud storage are to be stored:
•
For clusters in Oracle Cloud Infrastructure, enter the URL of
an existing Oracle Cloud Infrastructure Object Storage
bucket. The URL is of the form:
https://swiftobjectstorage.region.oraclecloud.com/
account/bucket
For example:
https://swiftobjectstorage.usphoenix-1.oraclecloud.com/mycompany/mybucket
•
You must create this storage bucket before you begin
creating the cluster. See Object Storage API in Oracle Cloud
Infrastructure documentation.
For clusters in Oracle Cloud Infrastructure Classic, enter the
URL of an Oracle Cloud Infrastructure Object Storage Classic
container. The URL is of the general form:
https://storage-instance-specifier/container
To determine the storage-instance-specifier value for
your account, see About REST URLs for Oracle Storage
Cloud Service Resources in Using Oracle Cloud
Infrastructure Object Storage Classic. If this container doesn’t
exist, use the Create Cloud Storage Container checkbox to
create it.
Note:
Do not use the Oracle Cloud
Infrastructure Object Storage Classic
container that you are using to back up
Oracle Data Hub Cloud Service
databases for any other purpose. For
example, do not also use it to back up
Oracle Java Cloud Service instances.
Using the container for multiple
purposes can result in billing errors.
B-18
Appendix B
Create New Instance: Service Details Page
Element
Description
Cloud Storage Username A user with read/write (and creation, if necessary) access to the
location specified in Cloud Storage Container:
•
•
For clusters in Oracle Cloud Infrastructure, enter the user
name you use to sign in to the Oracle Cloud Infrastructure
console.
For clusters in Oracle Cloud Infrastructure Classic, enter the
Oracle Cloud user name of the administrator of the Oracle
Cloud Infrastructure Object Storage Classic container
specified in Cloud Storage Container. Usually, this is your
Oracle Cloud user name.
Cloud Storage Password The password necessary to access the location specified in
Cloud Storage Container:
•
•
Create Cloud Storage
Container
For clusters in Oracle Cloud Infrastructure, enter your Swift
password.
For clusters in Oracle Cloud Infrastructure Classic, enter the
Oracle Cloud password for the user specified in Cloud
Storage Username.
(Not available on Oracle Cloud Infrastructure)
Select this to create a new Oracle Cloud Infrastructure Object
Storage Classic container as part of cluster creation. Specify the
container name, username, and password in the preceding fields.
The user specified in Cloud Storage Username and Cloud
Storage Password must have the privileges needed to create
storage containers.
If you select this option, the new storage container is created
when you click Next on the Service Details page, and the storage
container remains even if you cancel out of the wizard without
creating a new cluster. If this happens, you can use the container
in the future or manually delete it. See Deleting Containers in
Using Oracle Cloud Infrastructure Object Storage Classic.
What You See in the Credentials Section
The following table describes the elements and options available in the credentials
section of the page.
Element
Description
SSH Public Key
The SSH public key to be used for authentication when using an
SSH client to connect to a node associated with your cluster.
Edit
Click Edit to specify the public key. You can upload a file
containing the public key value, paste in the value of a public key,
or have the wizard generate a key pair for you.
If you paste in the value, make sure the value does not contain
line breaks or end with a line break.
If you have the wizard generate a key pair for you, make sure you
download the zip file containing the keys that the wizard
generated.
Administrative Username Username used to log in to the tools, such as cqlsh, nodetool,
and service console.
Password
Password of the user specified in Administrative Username.
Confirm Password
B-19
Appendix B
Create New Instance: Confirmation Page
Create New Instance: Confirmation Page
The Oracle Data Hub Cloud Service Create New Instance: Confirmation page is the
final page that you use to create a new Oracle Data Hub Cloud Service cluster.
What You See on the Oracle Data Hub Cloud Service Create New Instance:
Confirmation Page
The Oracle Data Hub Cloud Service Create New Instance: Confirmation page
presents a summary list of all the choices you made on the preceding pages of the
wizard. In addition, it provides the controls described in the following table.
Element
Description
< Previous
Click to navigate to the Oracle Data Hub Cloud Service Create
New Instance: Service Details page.
Cancel
Click to cancel creating an Oracle Data Hub Cloud Service
cluster.
Create >
Click to begin the process of creating an Oracle Data Hub Cloud
Service cluster.
The Oracle Data Hub Cloud Service Create New Instance wizard
closes and the Oracle Data Hub Cloud Service Instances page is
displayed, showing the new cluster with a status of Creating
Service...
B-20