Use standard nomenclature for Beckn-ONIX
This commit is contained in:
Venkatesh Babu
@@ -2,7 +2,7 @@
|
||||
|
||||
The [demo walkthrough](../docs/demo_walkthrough.md) and the accompanying video shows a story where we have the following steps
|
||||
|
||||
1. We install a core Beckn network using Beckn ONIX
|
||||
1. We install a core Beckn network using Beckn-ONIX
|
||||
2. We try to conduct a retail transaction, but it fails due to layer 2 config not being present
|
||||
3. We install the layer 2 config for retail from and successfully complete a retail transaction
|
||||
4. We try to perform a query to find charging station nearby (energy transaction), but it fails due to the layer 2 for energy being absent
|
||||
@@ -15,7 +15,7 @@ In this document we list a few other demo stories where we can show a similar fl
|
||||
|
||||
Alice wants to book a wellness center appointment and then book a cab to reach the clinic.
|
||||
|
||||
1. We install a core Beckn network using Beckn ONIX
|
||||
1. We install a core Beckn network using Beckn-ONIX
|
||||
2. Alice tries to conduct a healthcare booking, but it fails due to layer 2 config not being present
|
||||
3. We install the layer 2 config for healthcare `https://raw.githubusercontent.com/beckn/beckn-onix/main/layer2/samples/dhp_1.1.0.yaml` and successfully complete a healthcare appointment booking
|
||||
4. She tries to book a cab to reach the clinic, but it fails due to the layer 2 for mobility not being present
|
||||
@@ -26,7 +26,7 @@ Alice wants to book a wellness center appointment and then book a cab to reach t
|
||||
|
||||
Bob wants to book a cab back home. He wants to buy groceries so he can pick it up on the way
|
||||
|
||||
1. We install a core Beckn network using Beckn ONIX
|
||||
1. We install a core Beckn network using Beckn-ONIX
|
||||
2. Bob tries to book a cab, but it fails due to layer 2 config not being present
|
||||
3. We install the layer 2 config for mobility `https://raw.githubusercontent.com/beckn/beckn-onix/main/layer2/samples/mobility_1.1.0.yaml` and successfully complete the booking
|
||||
4. He now wants to buy groceries from a shop on the way, but it fails due to the layer 2 for retail not being present
|
||||
@@ -37,7 +37,7 @@ Bob wants to book a cab back home. He wants to buy groceries so he can pick it u
|
||||
|
||||
Cindy wants to schedule a wellness clinic visit, find charging stations near the clinic to get her bike charged while she is attending her appointment
|
||||
|
||||
1. We install a core Beckn network using Beckn ONIX
|
||||
1. We install a core Beckn network using Beckn-ONIX
|
||||
2. Cindy tries to book a wellness clinic appointment. It fails due to healthcare layer 2 being missing
|
||||
3. We install the layer 2 config for healthcare `https://raw.githubusercontent.com/beckn/beckn-onix/main/layer2/samples/dhp_1.1.0.yaml` and Cindy can successfully book the appointment
|
||||
4. Now she wants to find charging stations near the clinic, but it fails as energy layer 2 config is absent.
|
||||
|
||||
@@ -19,7 +19,7 @@ Some of the outputs listed below might be different when you run the script for
|
||||
|
||||
Note: Due to a [known issue](https://github.com/beckn/beckn-onix/issues/11), on certain machines, when the script is run for the first time, it errors out complaining about permission error in accessing docker daemon. Till this issue is fixed, the work around is to exit the terminal and restart the installation in a new terminal.
|
||||
|
||||
Please refer to the [Beckn Onix User Guide](./user_guide.md) for detailed explanation of the below steps.
|
||||
Please refer to the [Beckn-ONIX User Guide](./user_guide.md) for detailed explanation of the below steps.
|
||||
|
||||
## Sample deployment diagram
|
||||
|
||||
@@ -119,7 +119,7 @@ Registry installation successful
|
||||
[Installation Logs]
|
||||
Your Registry setup is complete.
|
||||
You can access your Registry at https://onix-registry.becknprotocol.io
|
||||
Process complete. Thank you for using Beckn Onix!
|
||||
Process complete. Thank you for using Beckn-ONIX!
|
||||
```
|
||||
|
||||
## Install a gateway for the network
|
||||
@@ -231,7 +231,7 @@ Gateway installation successful
|
||||
[Installation Logs]
|
||||
Your Gateway setup is complete.
|
||||
You can access your Gateway at https://onix-gateway.becknprotocol.io
|
||||
Process complete. Thank you for using Beckn Onix!
|
||||
Process complete. Thank you for using Beckn-ONIX!
|
||||
```
|
||||
|
||||
## Install a Beckn Adaptor for the BAP
|
||||
@@ -324,7 +324,7 @@ Protocol server BAP installation successful
|
||||
[Installation Logs]
|
||||
Your BAP setup is complete.
|
||||
You can access your BAP at https://onix-bap.becknprotocol.io
|
||||
Process complete. Thank you for using Beckn Onix!
|
||||
Process complete. Thank you for using Beckn-ONIX!
|
||||
|
||||
```
|
||||
|
||||
@@ -420,7 +420,7 @@ Protocol server BPP installation successful
|
||||
[Installation Logs]
|
||||
Your BPP setup is complete.
|
||||
You can access your BPP at https://onix-bpp.becknprotocol.io
|
||||
Process complete. Thank you for using Beckn Onix!
|
||||
Process complete. Thank you for using Beckn-ONIX!
|
||||
```
|
||||
|
||||
## Change the status of the BAP and BPP on registry to Subscribed
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
# Beckn ONIX - User Guide
|
||||
# Beckn-ONIX - User Guide
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Introduction](#introduction)
|
||||
- [Running Beckn ONIX on the cloud](#running-beckn-onix-on-the-cloud)
|
||||
- [Running Beckn-ONIX on the cloud](#running-beckn-onix-on-the-cloud)
|
||||
- [Sample deployment diagram](#sample-deployment-diagram)
|
||||
- [Overall Prerequisites](#overall-pre-requisites)
|
||||
- [Setting up a new network - Registry](#setting-up-a-new-network---registry)
|
||||
@@ -12,7 +12,7 @@
|
||||
- [Setting up a BPP Beckn Adapter](#setting-up-a-bpp-beckn-adapter)
|
||||
- [Downloading Layer 2 Configuration for a domain](#downloading-layer-2-configuration-for-a-domain)
|
||||
- [Testing transactions on the network](#testing-transactions-on-the-new-network)
|
||||
- [Running Beckn ONIX locally](#running-beckn-onix-locally)
|
||||
- [Running Beckn-ONIX locally](#running-beckn-onix-locally)
|
||||
- [Appendix A - subdomain/domain name configuration](#appendix-a---registering-or-adding-domain-or-subdomains)
|
||||
- [Appendix B - Nginx reverse proxy configuration](#appendix-b---nginx-reverse-proxy-configuration)
|
||||
|
||||
@@ -24,12 +24,12 @@ This user guide provides all information necessary to setup a Beckn network and
|
||||
|
||||
There are two primary setups covered in this document.
|
||||
|
||||
- A typical production setup with the various Beckn components on different nodes - This is explained in the Running Beckn ONIX on the cloud section.
|
||||
- A developer all in one setup - This is explained in the Running Beckn ONIX locally section.
|
||||
- A typical production setup with the various Beckn components on different nodes - This is explained in the Running Beckn-ONIX on the cloud section.
|
||||
- A developer all in one setup - This is explained in the Running Beckn-ONIX locally section.
|
||||
|
||||
## Running Beckn ONIX on the Cloud
|
||||
## Running Beckn-ONIX on the Cloud
|
||||
|
||||
Using Beckn ONIX, we can install a Beckn network on the cloud. This will be similar to a simple production instance of Beckn network. In the sections below, we use Amazon EC2 as an example for VPS provider. The guide can be useful for other cloud environments with simple changes on methods of accessing them etc. In this part of the guide, we explain installation of the four components of Registry, Gateway, BAP and BPP Beckn Adapter on different instances of virtual servers. You can however use the same process with minimal changes to install multiple nodes on the same virtual server (e.g. Registry and Gateway on a single virtual server)
|
||||
Using Beckn-ONIX, we can install a Beckn network on the cloud. This will be similar to a simple production instance of Beckn network. In the sections below, we use Amazon EC2 as an example for VPS provider. The guide can be useful for other cloud environments with simple changes on methods of accessing them etc. In this part of the guide, we explain installation of the four components of Registry, Gateway, BAP and BPP Beckn Adapter on different instances of virtual servers. You can however use the same process with minimal changes to install multiple nodes on the same virtual server (e.g. Registry and Gateway on a single virtual server)
|
||||
|
||||
### Sample deployment diagram
|
||||
|
||||
@@ -59,7 +59,7 @@ In the Beckn ecosystem, a new network starts with the setting up of the Registry
|
||||
|
||||
**Installation Steps**
|
||||
|
||||
- Clone the Beckn ONIX repository `git clone https://github.com/beckn/beckn-onix.git`
|
||||
- Clone the Beckn-ONIX repository `git clone https://github.com/beckn/beckn-onix.git`
|
||||
- Change into the installation folder `cd beckn-onix/install`
|
||||
- Run the installation script `./beckn-onix.sh`
|
||||
- Specify you want to start a new network and install the registry
|
||||
@@ -81,7 +81,7 @@ In the Beckn ecosystem, the role of the Gateway is limited to the discovery phas
|
||||
|
||||
**Installation Steps**
|
||||
|
||||
- Clone the Beckn ONIX repository (git clone https://github.com/beckn/beckn-onix.git)
|
||||
- Clone the Beckn-ONIX repository (git clone https://github.com/beckn/beckn-onix.git)
|
||||
- Change into the installation folder `cd beckn-onix/install`
|
||||
- Run the installation script `./beckn-onix.sh`
|
||||
- Specify you want to join an existing network and install the gateway
|
||||
@@ -106,7 +106,7 @@ The BAP (Beckn Application Platform) is the bridge between buyer side applicatio
|
||||
|
||||
**Installation Steps**
|
||||
|
||||
- Clone the Beckn ONIX repository (git clone https://github.com/beckn/beckn-onix.git)
|
||||
- Clone the Beckn-ONIX repository (git clone https://github.com/beckn/beckn-onix.git)
|
||||
- Change into the installation folder `cd beckn-onix/install`
|
||||
- Run the installation script `./beckn-onix.sh`
|
||||
- Specify you want to join an existing network and install the BAP.
|
||||
@@ -132,7 +132,7 @@ The BPP (Beckn Provider Platform) is the bridge between the seller side applicat
|
||||
|
||||
**Installation Steps**
|
||||
|
||||
- Clone the Beckn ONIX repository (git clone https://github.com/beckn/beckn-onix.git)
|
||||
- Clone the Beckn-ONIX repository (git clone https://github.com/beckn/beckn-onix.git)
|
||||
- Change into the installation folder `cd beckn-onix/install`
|
||||
- Run the installation script `./beckn-onix.sh`
|
||||
- Specify you want to join an existing network and install the BPP.
|
||||
@@ -145,7 +145,7 @@ The BPP (Beckn Provider Platform) is the bridge between the seller side applicat
|
||||
|
||||
### Changing subscription status of BAP and BPP at the registry
|
||||
|
||||
While the Beckn ONIX installs network participant beckn adapter as well as registers them with the Registry, they need to be manually put to the 'Subscribed' status. Its only then that they can transact. In real networks, the network facilitator might require additional documentation or validation before transitioning the BAP/BPP to the Subscribed state. When we are setting up the entire network ourselves, we do this task ourselves.
|
||||
While the Beckn-ONIX installs network participant beckn adapter as well as registers them with the Registry, they need to be manually put to the 'Subscribed' status. Its only then that they can transact. In real networks, the network facilitator might require additional documentation or validation before transitioning the BAP/BPP to the Subscribed state. When we are setting up the entire network ourselves, we do this task ourselves.
|
||||
|
||||
**Steps**
|
||||
|
||||
@@ -156,7 +156,7 @@ While the Beckn ONIX installs network participant beckn adapter as well as regis
|
||||
|
||||
### Downloading Layer 2 Configuration for a domain
|
||||
|
||||
With Beckn network setup by ONIX, we have a core network with all required network participants. However we cannot still do any transactions on this network. In order to do transactions, we need the Layer 2 Config file for the domain in which we want to transact. Layer 2 configuration files contain
|
||||
With Beckn network setup by Beckn-ONIX, we have a core network with all required network participants. However we cannot still do any transactions on this network. In order to do transactions, we need the Layer 2 Config file for the domain in which we want to transact. Layer 2 configuration files contain
|
||||
|
||||
- rules and policies agreed upon by entities operating in the domain through working group and other consultations
|
||||
- rules and policies required by the network facilitator
|
||||
@@ -176,7 +176,7 @@ Currently the layer-2 config are per domain, though this might change with futur
|
||||
- We can use postman collection for the specific domain to test end to end communication on the domain. Some sample postman collections for testing are [present here](https://github.com/beckn/beckn-sandbox/tree/main/artefacts)
|
||||
- When running postman collection from the buyer side, the base url to which the requests are sent should be the client side endpoint of the BAP Beckn Adapter instance. (e.g https://onix-bap-client.becknprotocol.io)
|
||||
|
||||
## Running Beckn ONIX locally
|
||||
## Running Beckn-ONIX locally
|
||||
|
||||
- In order for people new to Beckn who want to try out Beckn on their own machine, a simple one click installer has been written. Currently it can be installed by running the `start_beckn.sh` script present in the installfolder. In the next release, this will be integrated with the main script and the `start_beckn.sh` script deprecated. An all in one installation has preconfigured values for variables and so pretty much does not ask for any input.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user