Creating a Custom Cluster

To create a custom cluster, use the Oracle Event Hub Cloud Service — Dedicated Create New Instance wizard as described in the following procedure.

Before You Begin

When you create a cluster, you may need to provide information about other resources:

  • 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.

Procedure

To create a cluster:

  1. Open the Oracle Event Hub Cloud Service — Dedicated console. See Accessing the Oracle Event Hub Cloud Service Console.

  2. Click Create Instance.

    The Oracle Event Hub Cloud Service — Dedicated Create New Instance wizard starts and the Instance page is displayed.

  3. On the Instance page, provide the following basic service instance information.

    Element Description

    Instance Name

    Specify a name for the cluster. Choose a name that is unique within the tenant domain that will be used to identify the new cluster. The name:

    • Must contain one or more characters.

    • Must not exceed 30 characters.

    • Must start with an ASCII letter: a to z , or A to Z.

    • Must contain only ASCII letters or numbers.

    • Must not contain a hyphen.

    • Must not contain any other special characters.

    • Must be unique within the identity domain.

    Description

    (Optional) Enter a short description of the new cluster.

    Notification E-mail

    (Optional) Specify an E-mail address where you would like updates about the cluster creation operation to be sent.

    Region

    (Available only if your identity domain is enabled for regions.)

    The region for the Cluster. 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.

    Select region us-seattle-1, us-phoenix-1 or us-ashburn-1 for Oracle Cloud Infrastructure. If you select any other region, the cluster will be created in Oracle Cloud Infrastructure Classic.

    Choose No Preference to let the Oracle Event Hub Cloud Service — Dedicated choose an Oracle Cloud Infrastructure Classic region for you.

    Availability Domain

    (Available only on Oracle Cloud Infrastructure)

    Select the availability domains. You can also use Multiple Availability Domains based on requirement. You need to select multiple availability domains using the multi-checkbox input present there. to A region can have multiple isolated availability domains, each with separate power and cooling. The availability domains within a region are interconnected using a low-latency network.

    Oracle Event Hub Cloud Service - Dedicated provides HA (High Availability) by providing the ability to have Kafka Brokers, Zookeepers, REST Proxy, and Connect across multiple availability domains. You can select the multiple availability domains at the time of provisioning to leverage this High Availability feature.

    When the cluster is created, each node of Kafka, Zookeeper, REST Proxy, and Connect are placed evenly across the selected availability domains. For example, if you have selected 3 availability domains, and if you select a 3 node REST proxy, then each REST Proxy node is placed in separate availability domains.

    It is recommended to choose the number of nodes of Kafka, Zookeeper, REST Proxy, and Connect as multiple of number of availability domains selected so that services are evenly placed across availability domains. The service to availability domain placement is dome in round robin allocation.

    When a topic is created on a cluster with replication factor >1, then Kafka’s Broker Rack Awareness feature ensures that the topic leader and its replica partitions are created on brokers across the availability domains. As a result, in case of one availability domain failure, the other availability domains are still available and user can continue to use the topic from other availability domains as long as replication factor is > 1.

    Subnet

    (Available only on Oracle Cloud Infrastructure)

    Select the Oracle Cloud Infrastructure subnet to which the nodes of your instance must be attached.

    Select the subnet from a virtual cloud network (VCN) that you had created previously in Oracle Cloud Infrastructure. See Prerequisites for Oracle Platform Services on Oracle Cloud Infrastructure in the Oracle Cloud Infrastructure documentation.

    This field provides a No Preference option and a list of the available subnets. The Subnet menu lists the available subnets in the form compartmentName | vcnName | subnetName. For each selection on the menu, a tooltip details the compartment name, VCN name, subnet name, and subnet ID.
    • To have the subnet assigned automatically, select No Preference. The subnet ManagedCompartmentForPaaS | svc-vcn | svc-subnet-... is used for your instance

      .
    • To assign a subnet explicitly, select a suitable subnet from the available options. Don’t select ManagedCompartmentForPaaS | svc-vcn | lb-subnet-... even if it is displayed

    • If none of the available subnets meets your networking requirements, then cancel the Create Instance wizard. In Oracle Cloud Infrastructure, create the required VCN and subnets, create policies to allow Oracle Event Hub Cloud Service — Dedicated clusters to use the VCN, and select the appropriate subnet while creating your instance. See Prerequisites for Oracle Platform Services on Oracle Cloud Infrastructure in the Oracle Cloud Infrastructure documentation.

    In case, you choose multiple Availability Domain, then you need to select the subnet separately for each Availability domain that you selected.

    Tags

    (Optional) Select existing tags or add tags to associate with the cluster.

    To select existing tags, select one or more check boxes from the list of tags that are displayed on the pull-down menu.

    To create tags, click Click to create a tag to display the Create Tags dialog box. In the New Tags field, enter one or more comma-separated tags that can be a key or a key:value pair.

    If you do not assign tags during provisioning, you can create and manage tags after the service instance is created. See Creating, Assigning, and Unassigning Tags

    Software Release

    Select a Kafka Release for creating this cluster. This software release version controls the features provided by the service.

    Below are the currently available software releases.

    • Kafka Release 2.0.x
    • Kafka Release 1.1.x

    • Kafka Release 0.10.2.x
  4. On the Service Details page, provide additional configuration parameters for Oracle Event Hub Cloud Service - Dedicated. Complete the Configuration section.

    Element Description

    Deployment Type

    Type of deployment for the service. There are two types:

    1. Basic deployment runs Kafka broker and Zookeeper on same node(s). Choose this configuration if you need a minimal cluster footprint. This is typical for development/test clusters.

    2. Recommended deployment runs Kafka brokers and Zookeeper on different nodes. When you choose this type, the Zookeeper section also loads. Choose this configuration if you need high availability. This is the recommended configuration for production clusters.

    You can scale out to add dedicated Kafka brokers in both cases. For high availability, minimum of 3 Zookeeper and 2 Kafka broker nodes are recommended.

    SSH Public Key

    Edit

    The SSH public key to be used for authentication when using an SSH client to connect to a node associated with your cluster.

    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.

    Enable authentication with Oracle Identity Cloud Service

    Select to authenticate Oracle Event Hub Cloud Service requests against Oracle Identity Cloud Service. Enabling this option also creates an Oracle managed load balancer for the service and topic instances. If not selected, you need to authenticate using the basic authentication.

  5. On the Service Details page, complete the Kafka section.

    Element Description

    Number of Nodes/Brokers

    Number of Kafka brokers to be allocated to the cluster. You can choose 1 or 3 nodes for Basic deployment type. The 3 node configuration provides high availability by running 1 Zookeepers and 2 Kafka brokers. You can scale out additional dedicated Kafka VMs as needed. For the Recommended deployment type, the number of Kafka brokers must be at least 2 and not more than 20.

    Compute Shape

    Number of Oracle Compute Units (OCPUs) and amount of memory (RAM) for each node of the new cluster. The compute shape is the number of Oracle Compute Units (OCPUs) and amount of memory (RAM) that you want to allocate to these nodes. The VM.Standard and BM.Standard shapes are supported.

    For complete list of Compute Shapes, see Service Limits — Oracle Event Hub Cloud Service — Dedicated.

    Usable Topic Storage (GB)

    Amount of topic storage to be allocated to the cluster.

    Total Allocated Storage (GB)

    Total allocated storage for the cluster. You are billed for this amount. This is determined based on the Usable Topic Storage specified by the user. Actual allocated physical storage will be twice the value specified in Usable Topic Storage as topic data is replicated.

    Network Type

    (Available only on Oracle Cloud Infrastructure)

    The network type decides how the Kafka listeners are configured whether using public IP or private host names. You can choose between Public or Private (default) network.

  6. On the Service Details page, complete the Credentials section. This section is displayed only when Enable authentication with Oracle Identity Cloud Service is not selected.

    Element Description

    User Name

    User name to authenticate requests to Topic URL and/or Connect URL. The User Name:

    • Must be between 2 to 25 characters.

    • Must start with a letter.

    • Must contain only letters or numbers.

    Password

    User password to authenticate requests to Topic URL and/or Connect URL. The Password:

    • Must be at least 8 characters.

    • Must have at least one lower case letter.

    • Must have at least one upper case letter.

    • Must have at least one number.

    • Must have at least one special character.

    Confirm Password

    Enter the password again to confirm.

  7. On the Service Details page, complete the REST Proxy section.

    Element Description

    Number of Nodes

    Number of REST Proxy nodes. Running multiple REST proxy servers ensures high availability. Recommended number for REST proxy nodes is 2. You can choose between 1, 2, 3, and 4.

    Compute Shape

    Number of Oracle Compute Units (OCPUs) and amount of memory (RAM) to be used for REST proxy servers. The compute shape is the number of Oracle Compute Units (OCPUs) and amount of memory (RAM) that you want to allocate to these REST proxy servers. The VM.Standard and BM.Standard shapes are supported.

    For complete list of Compute Shapes, see Service Limits — Oracle Event Hub Cloud Service — Dedicated.

  8. On the Service Details page, complete the Zookeeper section. This is displayed only when the Deployment Type is selected as Basic.

    Element Description

    Number of Nodes

    Number of nodes to be allocated to the Zookeeper. Recommended number for Zookeeper nodes is 3. Zookeeper requires that you have a quorum of servers up, where quorum is ceil (N/2), where N is the total number of nodes. This means that for a 3 server cluster (N=3), the quorum is 2. That is 2 servers must be up at any time. For a 5 server cluster (N=5), the quorum is 3. You can choose between 1, 3 and 5.

    Compute Shape

    Number of Oracle Compute Units (OCPUs) and amount of memory (RAM) to be used for Zookeeper nodes. Several OCPU/RAM combinations are offered.

  9. On the Service Details page, complete the Kafka Connect section.

    Element Description

    Enable Kafka Connect

    Enabling Kafka Connect creates the Kafka Connect Service.

    Number of Connect Nodes

    Number of Kafka Connect nodes. You can choose between 1, 2, 3, and 4.

    Compute Shape

    Several OCPU/RAM combinations are offered.

    Number of Oracle Compute Units (OCPUs) and amount of memory (RAM) to be used for Kafka Connect nodes. The compute shape is the number of Oracle Compute Units (OCPUs) and amount of memory (RAM) that you want to allocate to these Kafka Connect nodes. The VM.Standard and BM.Standard shapes are supported.

    For complete list of Compute Shapes, see Service Limits — Oracle Event Hub Cloud Service — Dedicated.

  10. Click Next to advance to the Confirmation page.

  11. On the Confirmation page, review the information listed.

    Download the Instance Attributes in JSON Format: Click JSON download icon to download a JSON-format file containing the parameters you specified in the provisioning wizard. You can use the JSON-formatted file as a sample to construct the request body for creating instances using the REST API. Note that the file contains placeholders for passwords.

    If you're satisfied with what you see, click Create to create the Oracle Event Hub Cloud Service — Dedicated 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.