1. Consider the requirements for the creation of the virtual machine2. Creation of the database3. Deployment of Kafka4. One Connect deployment and configuration
Enabled ports in Kafka
9093:Broker9102:Broker8086:Schemaregistry8083 : Connect8085:Controlcenter center8089 : KsqlDBOne Connect enabled ports5050:Frontend9000:Apigateway707070:Metrics7072:Logs50501: ProducerDatabase-enabled ports3306:MandSQL
1.Data base creation
Select an instance from the cloud infrastructure provider of your choice.Make sure of assign a storage and resources appropriate for withstand the load of work of the database.2.Installation of MySQL
Onece launched the instance, make sure MySQL is running inside a Docker container following the specific commands for its Linux distribution (e.g. Amazon Linux or Ubuntu).3.Configuration of the Security Group
Configure the rules of the security group associated to the instance to allow access to the standard MySQL/Aurora port(3306).
- Important note on Database Compatibility. The JPA standard with Hibernate allows the use of databases such as PostgreSQL or SQL Server. However, Onibex OneConnect is not officially certified for these options. Although they should work technically, all functionalities are not guaranteed to behave as expected. Comprehensive testing is recommended if it is decided to use a database other than MariaDB or MySQL to ensure a stable experience.
1 Download the Scripts
Download the file scripts.zip, attached to the end of the document.2 Content of the files
- .env
- run-sql.sh
- scripts
3 Configuring the .env file
Locate the file.env inside the folder. Before you run the script, you need to configure the following variables in the file to establish the connection to the database.
- Dp: IP address of the database server.
- Spring_datasource: Name of the database user.
- Spring_datasource: Password of the database user.
- Mysql_container: MySQL container name.
4 Execution to run-sql.sh file
Assign execution permissions to the file run-sql.sh. Run the following command in the directory where the file is located: chmod +x run-sql.sh.Once the permissions are granted, the script is ready to run with the following command:./run-sql.sh.With this, the database will be ready to be used.The credentials of the administrator account in their initial state are:Password: mzve$JQ@bg#zWmiDC3G$JtThe default user account credentials in their initial status are:User:poc@onibex.comPassword: mzve$JQ@bg#zWmiDC3G$Jt
1 Download the folder kafka-compose attached at the end of the document, that contains the files necessary for the deployment of Kafka and its components. Inside you will find:
- Archive docker-compose.yml
- Onescript setup_kafka_dirs.sh
- Archive.env
- Foldercontrol-center
If you want to know the credentials configured, you can review the file password.properties located in the folder control-center.
2 Configurethefile file .env entering the address of the server where where we deploy Kafka.
3 Once configured the files, transfer the folder kafka-compose to server in the Location desired.
1 Inside of tthe folder kafka-compose, bestow permits of implementation to script setup_kafka_dirs.sh with the following command: +x setup_kafka_dirs.sh
Run the script to create the folders of volumes and deploy Kafka with Docker Compose with the command: ./setup_kafka
2 Once executed, Kafka and the next components will be deployed with their respective ports:
9093, 9102: kafka broker8086:Schema Registry8083:Kafka Connect8085:Proxy9022:Control Center
1 Access to Control Center from your browser of preference introducing the ip of the server where we made the deployment of Kafka next to the port 9022, in the following format:<Ipfrom the server with Kafka deployed>:9022
2Enter the credentials configured in password.properties.3
Once authenticated, you will be able to view all components Kafka deployed.
Requirements:
4.1.Deployment configuration
1Download the file one-connect-compose.zip attached to the end of the document which will include three internal folders:
- Frontend
- Platform
- Workspace
And the following files:
- .env
- run_compose.sh
Before uploading the folder in the server, is necessary perform the configuration of the file .env that will contain the variables of environment required for the operation of the system. It is recommended to use a code editor to carry out this task.2 In the file .env we will see the information detailed below and in it will change the value of these variables to the following:
- Kafka_machine_ip: Ip of the machine with Kafka.
- Kafka_brokerSchema_registry_port: Port sassigned for broker, schema registry and Kafka Connect.
- Host_machine: Ip of the machine where One Connect will be displayed.
- Db_ip,Spring_datasource_username: IP of the data base, user and password respectively.
- Docker_password: password/access token provided by Onibex.
Configuration of email services:Enable_log_email_notification
Enable the option to send alerts via email.3 To enable the email services, it is necessary to set up the following variables with the details of your own SMTP server:
- Email_password
- AuthEmail_smtp
- Email_smtphost
- Email_smtpport
- Email_smtpsslprotocols
- Email_smtpstarttls
- Email_sourceaddress email_user
4.2.Deployment of One Connect Platform
- Subathefolderone-connect-composewiththefilesconfiguredtoserverofdestiny.
- OneoncethatthefolderThatintheserver,navigateayourinterior.
- Runthenext nextcommandforgrantpermitsofimplementationtoscript:chmod +x run_compose.sh.
- Startdeployment of containers by running:./run_compose.
- Oneoncecompletedthedeployment,verifythestateofthecontainerswiththecommand:Dockerps ps psand you see something similar to the following image:
4.3 Access the Interface
Wait about a minute for the startup to complete all the containers. Then, in a browser open the IP address of the server where OneConnect was deployed and point it to to port 5050 using the following format:ip address:5050.
The credentials of the administrator account in their initial state are:Password: mzve$JQ@bg#zWmiDC3G$JtThe default user account credentials in their initial status are:Note:If you present problems running the script using the command./run_compose.sh, the file may have changed its original format due to modifications made to a Windows-based device.To correct this inconvenience, run the following commands to install and apply theconversion tool:
- sudo yum install - and dos2unix
- dos2unix run_compose.sh
This will convert the file to the format compatible with Linux systems, allowing it tocorrect implementation.