Use standard nomenclature for Beckn-ONIX
This commit is contained in:
Venkatesh Babu
@@ -2,9 +2,9 @@
|
||||
|
||||
### Objective
|
||||
|
||||
ONIX - Open Network In A Box. This install utility is designed to effortlessly set up all BECKN components on a machine using a one-click installer. This tool serves as a valuable resource for developers and network participants eager to explore BECKN protocols or join open networks supported by the BECKN protocol. By simplifying the installation process, ONIX streamlines the onboarding experience.
|
||||
Beckn-ONIX - Open Network In A Box. This install utility is designed to effortlessly set up all Beckn components on a machine using a one-click installer. This tool serves as a valuable resource for developers and network participants eager to explore Beckn protocols or join open networks supported by the Beckn protocol. By simplifying the installation process, Beckn-ONIX streamlines the onboarding experience.
|
||||
|
||||
Experience the convenience and efficiency of ONIX as you embark on your journey with BECKN protocols and open networks.
|
||||
Experience the convenience and efficiency of Beckn-ONIX as you embark on your journey with Beckn protocols and open networks.
|
||||
|
||||
| Version | Release Date |
|
||||
| ------------------------------------------------------------------------------------------ | ------------ |
|
||||
@@ -14,9 +14,9 @@ Experience the convenience and efficiency of ONIX as you embark on your journey
|
||||
|
||||
### New Features
|
||||
|
||||
- This release focuses on enabling the installation of individual components with user-provided configurations.
|
||||
- It extends support to the Windows operating system, specifically Windows 10.
|
||||
- Additionally, it now supports the Mac operating system.
|
||||
- This release focuses on enabling the installation of individual components with user-provided configurations.
|
||||
- It extends support to the Windows operating system, specifically Windows 10.
|
||||
- Additionally, it now supports the Mac operating system.
|
||||
|
||||
This release is specifically designed to facilitate the deployment of individual components, offering users the flexibility to customize configurations. Furthermore, it ensures seamless compatibility with both Windows and Mac operating systems.
|
||||
|
||||
@@ -24,28 +24,28 @@ For a comprehensive summary of the features, refer [here](https://github.com/bec
|
||||
|
||||
### Enhancements
|
||||
|
||||
- Support for Windows operating system.
|
||||
- Support for Mac operating system.
|
||||
- Can be used to install specific components with custom configuration.
|
||||
- Support for Windows operating system.
|
||||
- Support for Mac operating system.
|
||||
- Can be used to install specific components with custom configuration.
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- None
|
||||
- None
|
||||
|
||||
### Known Issues
|
||||
|
||||
- None
|
||||
- None
|
||||
|
||||
### Limitations
|
||||
|
||||
- The current installer is tested only for Linux (Ubuntu) / Windows (windows 10) / Mac, it might support other flavors also.
|
||||
- The current version supports only vertical scaling, horizontal scaling (ECS / EKS) is planned for an upcoming release
|
||||
- When installing individual components, registration with the registry has to be done manually, this is explicitly done to avoid confusion and to prevent the network from incorrect or wrong registrations.
|
||||
- The current installer is tested only for Linux (Ubuntu) / Windows (windows 10) / Mac, it might support other flavors also.
|
||||
- The current version supports only vertical scaling, horizontal scaling (ECS / EKS) is planned for an upcoming release
|
||||
- When installing individual components, registration with the registry has to be done manually, this is explicitly done to avoid confusion and to prevent the network from incorrect or wrong registrations.
|
||||
|
||||
### Upcoming Version
|
||||
|
||||
- Support for horizontal scaling using Elastic Kubernetes Cluster.
|
||||
- Support for horizontal scaling using Elastic Kubernetes Cluster.
|
||||
|
||||
### Release Date
|
||||
|
||||
- 2024-03-01
|
||||
- 2024-03-01
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# ONIX Setup Script
|
||||
# Beckn-ONIX Setup Script
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -8,84 +8,84 @@ This shell script, `start_beckn_v2.sh`, automates the setup of Beckn components,
|
||||
|
||||
1. **Clone the Repository:**
|
||||
|
||||
```bash
|
||||
git clone -b main https://github.com/beckn/onix.git
|
||||
```
|
||||
```bash
|
||||
git clone -b main https://github.com/beckn/onix.git
|
||||
```
|
||||
|
||||
2. **Navigate to the Script Directory:**
|
||||
|
||||
```bash
|
||||
cd onix/install
|
||||
```
|
||||
```bash
|
||||
cd onix/install
|
||||
```
|
||||
|
||||
3. **Run the Setup Script:**
|
||||
|
||||
```bash
|
||||
./start_beckn_v2.sh
|
||||
```
|
||||
```bash
|
||||
./start_beckn_v2.sh
|
||||
```
|
||||
|
||||
The script will guide you through the installation.
|
||||
The script will guide you through the installation.
|
||||
|
||||
## Installation Sequence - Design
|
||||
|
||||
1. **Install Required Packages:**
|
||||
It will install Docker, Docker-Compose, and jq packages which are required for this setup.
|
||||
|
||||
```bash
|
||||
./package_manager.sh
|
||||
```
|
||||
```bash
|
||||
./package_manager.sh
|
||||
```
|
||||
|
||||
2. **Install Registry Service:**
|
||||
|
||||
```bash
|
||||
./start_container registry
|
||||
```
|
||||
```bash
|
||||
./start_container registry
|
||||
```
|
||||
|
||||
3. **Install Gateway Service:**
|
||||
|
||||
```bash
|
||||
./update_gateway_details.sh registry
|
||||
./start_container gateway
|
||||
./register_gateway.sh
|
||||
```
|
||||
```bash
|
||||
./update_gateway_details.sh registry
|
||||
./start_container gateway
|
||||
./register_gateway.sh
|
||||
```
|
||||
|
||||
4. **Start Supporting Services:**
|
||||
|
||||
- MongoDB
|
||||
- RabbitMQ
|
||||
- Redis
|
||||
- MongoDB
|
||||
- RabbitMQ
|
||||
- Redis
|
||||
|
||||
```bash
|
||||
./start_support_services
|
||||
```
|
||||
```bash
|
||||
./start_support_services
|
||||
```
|
||||
|
||||
5. **Install Protocol Server for BAP:**
|
||||
|
||||
```bash
|
||||
./update_bap_config.sh
|
||||
./start_container "bap-client"
|
||||
./start_container "bap-network"
|
||||
```
|
||||
```bash
|
||||
./update_bap_config.sh
|
||||
./start_container "bap-client"
|
||||
./start_container "bap-network"
|
||||
```
|
||||
|
||||
6. **Install Sandbox:**
|
||||
|
||||
```bash
|
||||
./start_container "sandbox-api"
|
||||
```
|
||||
```bash
|
||||
./start_container "sandbox-api"
|
||||
```
|
||||
|
||||
7. **Install Webhook:**
|
||||
|
||||
```bash
|
||||
./start_container "sandbox-webhook"
|
||||
```
|
||||
```bash
|
||||
./start_container "sandbox-webhook"
|
||||
```
|
||||
|
||||
8. **Install Protocol Server for BPP:**
|
||||
|
||||
```bash
|
||||
./update_bpp_config.sh
|
||||
./start_container "bpp-client"
|
||||
./start_container "bpp-network"
|
||||
```
|
||||
```bash
|
||||
./update_bpp_config.sh
|
||||
./start_container "bpp-client"
|
||||
./start_container "bpp-network"
|
||||
```
|
||||
|
||||
## Post-Installation Details
|
||||
|
||||
|
||||
@@ -148,11 +148,11 @@ install_bpp_protocol_server(){
|
||||
# MAIN SCRIPT STARTS HERE
|
||||
#!/bin/bash
|
||||
|
||||
echo "Welcome to Beckn Onix!"
|
||||
echo "Welcome to Beckn-ONIX!"
|
||||
if [ -f ./onix_ascii_art.txt ]; then
|
||||
cat ./onix_ascii_art.txt
|
||||
else
|
||||
echo "[Display Beckn ONIX ASCII Art]"
|
||||
echo "[Display Beckn-ONIX ASCII Art]"
|
||||
fi
|
||||
|
||||
echo "Beckn ONIX is a platform that helps you quickly launch and configure beckn-enabled networks."
|
||||
@@ -277,6 +277,6 @@ else
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Process complete. Thank you for using Beckn Onix!"
|
||||
echo "Process complete. Thank you for using Beckn-ONIX!"
|
||||
|
||||
|
||||
|
||||
@@ -1,18 +1,20 @@
|
||||
# Release Notes
|
||||
|
||||
## ONIX Version 0.1.0 (2024-02-16)
|
||||
## Beckn-ONIX Version 0.1.0 (2024-02-16)
|
||||
|
||||
### Objective
|
||||
ONIX - Open Network In A Box, is a utility designed to effortlessly set up all BECKN components on a machine using a one-click installer. This tool serves as a valuable resource for developers and network participants eager to explore BECKN protocols or join open networks supported by the BECKN protocol. By simplifying the installation process, ONIX streamlines the onboarding experience.
|
||||
|
||||
The current version installs all components automatically without requiring user input, facilitating a seamless setup process. However, we are committed to further enhancing ONIX's functionality. In the upcoming release, we will introduce the capability to selectively install specific components and accommodate user-provided configurations.
|
||||
Beckn-ONIX - Open Network In A Box, is a utility designed to effortlessly set up all Beckn components on a machine using a one-click installer. This tool serves as a valuable resource for developers and network participants eager to explore Beckn protocols or join open networks supported by the Beckn protocol. By simplifying the installation process, Beckn-ONIX streamlines the onboarding experience.
|
||||
|
||||
The current version installs all components automatically without requiring user input, facilitating a seamless setup process. However, we are committed to further enhancing Beckn-ONIX's functionality. In the upcoming release, we will introduce the capability to selectively install specific components and accommodate user-provided configurations.
|
||||
|
||||
For a comprehensive summary of the features, refer [here](https://github.com/beckn/beckn-utilities/milestone/2?closed=1)
|
||||
|
||||
Experience the convenience and efficiency of ONIX as you embark on your journey with BECKN protocols and open networks.
|
||||
Experience the convenience and efficiency of Beckn-ONIX as you embark on your journey with Beckn protocols and open networks.
|
||||
|
||||
### New Features
|
||||
- Implemented installation support for the following BECKN components:
|
||||
|
||||
- Implemented installation support for the following Beckn components:
|
||||
- Protocol Server BAP
|
||||
- Protocol Server BPP
|
||||
- Webhook BPP
|
||||
@@ -20,26 +22,31 @@ Experience the convenience and efficiency of ONIX as you embark on your journey
|
||||
- Registry
|
||||
- Gateway
|
||||
- Infrastructure required for the above services
|
||||
|
||||
|
||||
This release is specifically tailored for deployment on Linux machines, encompassing all aforementioned components with default configurations.
|
||||
|
||||
### Enhancements
|
||||
|
||||
- None
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- None
|
||||
|
||||
### Known Issues
|
||||
|
||||
- None
|
||||
|
||||
### Limitations
|
||||
|
||||
- The current installer is tested only for Linux (Ubuntu), it might support other flavors also.
|
||||
- The current version installs all the components with the default configurations.
|
||||
|
||||
|
||||
### Upcoming Version
|
||||
|
||||
- Installation of individual components with user-provided configuration.
|
||||
- Support for Windows and Mac OS will be added.
|
||||
|
||||
### Release Date
|
||||
|
||||
- 2024-02-16
|
||||
|
||||
@@ -25,7 +25,7 @@ start_support_services(){
|
||||
}
|
||||
# Main script starts here
|
||||
text="
|
||||
Welcome to ONIX!
|
||||
Welcome to Beckn-ONIX!
|
||||
The following components will be installed
|
||||
|
||||
1. MongoDB, RabbitMQ and Redis
|
||||
|
||||
@@ -187,7 +187,7 @@ The following components will be installed
|
||||
|
||||
# Main script starts here
|
||||
bash scripts/banner.sh
|
||||
echo "Welcome to ONIX"
|
||||
echo "Welcome to Beckn-ONIX"
|
||||
echo "$text"
|
||||
|
||||
read -p "${GREEN}Do you want to install all the components on the local system? (Y/n): ${NC}" install_all
|
||||
@@ -306,11 +306,11 @@ else
|
||||
;;
|
||||
|
||||
7)
|
||||
echo "Exiting ONIX"
|
||||
echo "Exiting Beckn-ONIX"
|
||||
exit 0
|
||||
;;
|
||||
*)
|
||||
echo "Invalid choice. Exiting ONIX."
|
||||
echo "Invalid choice. Exiting Beckn-ONIX."
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
|
||||
Reference in New Issue
Block a user