OneConnect Deployment and Configuration

OneConnect Deployment and Configuration

One Connect Platform: Kubernetes Azure Deployment Manual for Private Network

This manual outlines the steps required to deploy the One Connect system on a Kubernetes cluster within a Private Network (meaning the OneConnect Platform will not be accessible from the internet) using an automated script. The process configures the necessary services, deployments, and resources to ensure the system functions properly.

Prerequisites

Before you begin, ensure the following requirements are met:

  • The database has been deployed (refer to the following manual: Establishment of the Database and Requirements)

  • You have access to the Kubernetes cluster where the system will be deployed.

  • You have downloaded the deployment package: OneConnect Kubernetes

  • A Bash shell is available to run the script.

  • You have the necessary permissions to execute scripts in the deployment environment.


Installation Steps

1. Extract the Deployment Archive

First, extract the contents of the .zip file in the data and control panel in Kubernetes:

unzip oneconnectkubernetes.zip

Navigate to the extracted directory:

cd oneconnect-kubernetes

2. Configure the .env file 

Open the oneconnect.env file and update the environment variables according to your deployment needs.


# Indicates whether to enable or disable the use of an Ingress resource in the Kubernetes cluster.
export KUBERNETES_ISINGRESSACTIVE=false

# Specifies the password used to authenticate access to the database.
export DBPASS=rootpassword

# Defines the connection URL for the database where the system's data is stored (JDBC syntax).
export DBURL=3.138.246.179:3306

# Specifies the username with permissions to access the database.
export DBUSER=root

# Determines the port on which the system's frontend will be accessible.
export FRONTENDPORT=5050

# Specifies the port used by the API Gateway.
export APIGATEWAYPORT=80

# Specifies the Docker token used for authentication.
export DOCKERHUB_TOKEN=

NotesInfo
Note
The DOCKERHUB_TOKEN variable will be provided by the Onibex Sales team. Make sure to request it in advance, as it is required to download the Docker images before starting the deployment.

3. Run the setup.sh Script

Grant execution permissions to the script (if not already set):
chmod +x setup.sh

Run the script
./setup.sh

Notes
 If you are unable to execute the script, make sure to install dos2unix and then run the script again. You can install it and convert the script using the following commands:
sudo apt-get install dos2unix
sudo yum install dos2unix
dos2unix setup.sh
./setup.sh

4. Viewing and Using External IP

After creating the Internal Load Balancer, a service named internal-frontend will appear in your system (make sure to check "Services"). In this row, an additional IP address will be displayed in the "External IP" column, next to the internal IP. This external IP should be used to access the portal on port 5050.
QuoteInfo

Welcome to OneConnect Cloud!

Your new OneConnect Cloud access portal in Azure, available on port 5050, is ready for use.

Example IP:http://00.00,000:5050



OneConnect Configuration Manual

Add a new user to the OneConnect Cloud Platform

To log in to the One Connect Cloud platform, request the password from the Onibex team.



Once logged into the One Connect Cloud platform, navigate to the upper-left corner and click the menu button (the icon with three horizontal lines).





When the sidebar is expanded, go to the "Users" option, select it, and then click the "ADD" button in the upper-right corner.


The process of adding a new user requires the following information:
  1. First name
  2. Last name
  3. Email
  4. Phone number
  5. Company
  6. Country
Fill all the fields and click "ADD".



The new user will appear in the "USERS" section with a "PENDING" status, meaning the user must be approved in order to be activated.


To activate the user, you must click ACTIONS.


Click ACCEPT on the top right side of the screen to activate the new user.


 Your new user has been successfully approved. You can verify the status change to "ACTIVE" in the "USERS" section.

Creating SAP Connectors on the OneConnect Cloud Platform


Notes
Note
Each account and user will have the ability to create SAP connectors. The following will show how a SAP Connector is created from an Administrator account, non-administrator users can also create SAP Connectors following these steps.

Enter the One Connect Cloud platform with your username and password:



Go to the "USERS" section, presented on the menu button (upper-left corner and click the icon with three horizontal lines).
Click on the name of user you want to assign the new SAP Connector to, or click the right-pointing arrow in the "Actions" section.


Select the "SAP Connectors" option and click the "Add SAP Connector" button.


The process of creating workspace consists of 4 instances:

It begins with the creation and definition of the SAP Connector, you will need to fill the following information:

  1. SAP Connector Name (Topic Prefix): This is the name used to identify the connector and will also serve as the prefix for every topic sent through it.

  2. SAP Environment: Specify the SAP environment to which this connector will be added.

  3. SAP Connector Username: Assign a username that will be used in the SAP RFC configuration.

  4. SAP Connector Password: Assign a password for the previously created user; this password will be used in the SAP RFC configuration.

Warning

Be sure to save the username and password information, as these cannot be changed later. Neither you nor the Onibex team will be able to access the password once it has been created.

There is an option to download the password in .txt format — we strongly recommend doing so to ensure you have a secure copy.


After adding the required information, click Next.

In the Connection Details section, select the deployment type: Confluent Cloud or Confluent Platform.

If you select Confluent Cloud, enter the following information:

  • Bootstrap Server number

  • Schema Registry URL

  • API Key and API Secret

  • Schema Registry Key and Schema Registry Secret


If you select Confluent Platform, enter the following information:

  • Security protocol: select between "Without security", "Plain Text" or "SASL_SSL"

  • Bootstrap Server number

  • Schema Registry URL

  • API Key and API Secret - only in "Plain Text" or "SASL_SSL"

  • Schema Registry Key and Schema Registry Secret - only in "Plain Text" or "SASL_SSL"

Info
For more information, refer to this video

Next, in the Topic Settings section, enter the required information and click Next.
The system will automatically populate some default values, which can be modified as needed. These include:

  • Number of partitions

  • Number of replicas

  • Retention period (in days)



Finally, in the Advanced Settings section, select the desired resources for the SAP Connector container. The available resource settings are:

  • Request CPU

  • Request Memory

  • Limit CPU

  • Limit Memory



After that, click on "Finish," and you will be redirected to the "Users" section where the SAP Connector will be created.

To access your new SAP Connector, click on the username or the action button, then navigate to the "SAP Connectors" section.

You will now see a list with your new connector. To access it, click the "GO" button.


Here, you can access information related to your SAP Connector and retrieve the URL needed for the RFC connection in SAP.





    • Related Articles

    • One Connect Cloud Deployment

      Prerequisites Download the required .zip folders attached at the end of the document: sql.zip one-connect.zip kafka-compose.zip Requirements for the Virtual Machine System: Linux Architecture: 64-bit processors (x86_64) support Instance ...

    • Establishment of the Database and Requirements

      One Connect Manual in Azure Establishment of the Database and Requirements Prerequisites For the SQL database, the following are recommended: MariaDB MySQL Download the following sql.zip file - Database Deployment Deployment Steps 1. Extract the SQL ...

    • OneConnect General Architecture

      The following representation shows a general architecture diagram for OneConnect, considering SAP ECC or S4HANA as the producer and destinations such as Clickhouse, Snowflake, and Databricks as subscribers. The OneConnect structure consists of 3 main ...

    • Onibex Snowflake Sink Connector for Confluent Platform and Cloud

      The JDBC snowflake connector sends real-time data from Confluent Platform and Cloud for writing to the theme-subscription Snowflake Tables. It is possible to achieve idempotent writings with elevators. Self-creation of tables and self-evolution is ...

    • Onibex Databricks JDBC Connector for Confluent Cloud

      JDBC Onibex Connector for Databricks The JDBC Onibex connector for Databricks sends real-time data from Kafka to write into live DeltaLake tables. Idempotent writes can be achieved using upserts. Automatic table creation and schema evolution are ...