Adding Cloudera SQL Stream Builder as a Service

You need to use the Add Service wizard in Cloudera Manager to have the Cloudera SQL Stream Builder service on your cluster.

Make sure that the Cloudera SQL Stream Builder CSD file is in the /opt/cloudera/csd folder.
Make sure that the Cloudera Streaming Analytics parcel is added to Cloudera Manager.
Make sure that you have installed and configured the Cloudera SQL Stream Builder databases correctly, and installed the required Java drivers as well.

Check that the following components are installed on your cluster:


Mandatory components	Optional components
Flink	Schema Registry
Kafka	Kudu
	Hive
	KNOX

Open Cloudera Manager.
If KNOX is installed in the cluster, enable the async support flag.
note
If your cluster is secure but doesn't contain the KNOX service, you must install it first. For more information, see Apache Knox Gateway Overview.
1. In Cloudera Manager, navigate to KNOX service > Configuration.
2. Add the following property to the conf/gateway-site.xml_role_safety_valve configuration:
```
<property>
    <name>gateway.servlet.async.supported</name>
    <value>true</value>
</property>
```
3. Restart the KNOX service.
On the Home screen, select the drop-down menu to the right of your cluster.
Select Add Service.
From the list, select Cloudera SQL Stream Builder as the type of service, then click Continue.
The Add Service wizard launches.
Assign the SQL Stream Engine and Materialized View Engine service roles to hosts, then click Continue.
You need to assign the service roles based on where you have created the databases, and where you have assigned the Flink and Kafka roles.
Connect the Cloudera SQL Stream Builder service to a database.

important
You must install and configure MySQL/MariaDB, PostgreSQL or Oracle database before adding Cloudera SQL Stream Builder as a service. In case you did not set up any database for your cluster, see the Configuring databases for Cloudera SQL Stream Builder documentation.
1. Select MySQL, PostgreSQL, or Oracle as the type of database.
  
  important
  If you plan to use Materialized Views in Cloudera SQL Stream Builder, you must install a PostgreSQL database.
2. Choose the host on which you want to add the database.
  You must add the databases to the same host where you have assigned the service roles.
3. Provide a name to the database.
4. Provide the user and password of the created database.
5. Click Test connection.
Review the changes needed for your service.
In case you are using MySQL or Oracle for the Streaming SQL Engine, and PostgreSQL for Materialized Views, you will be prompted to provide information about the database for Materialized View Engine. Provide the database hostname with the default port, your user and password in the Materialized View Engine fields.

note
You can configure the security properties for Cloudera SQL Stream Builder in this step, or after adding the service in the Configuration page. For more information about configuring security, see the Manage security documentation for Cloudera SQL Stream Builder.
Click Continue and wait until the first run of the Cloudera SQL Stream Builder service is completed.
Click Continue and then Finish.

Enabling High Availability for Cloudera SQL Stream Builder🔗

High Availability for Cloudera SQL Stream Builder can be enabled using load-balancing through KNOX. To be able to use load-balancing for Cloudera SQL Stream Builder after the service is installed, you need to have a KNOX service installed in the SSB cluster.

Using KNOX for load-balancing Cloudera SQL Stream Builder🔗

From Cloudera Streaming Analytics 1.14.0, Cloudera SQL Stream Builder uses KNOX as a load-balancer for multiple instances.

KNOX handles load-balancing automatically when multiple instances are added. For more information on KNOX, see Apache Knox Gateway Overview.