mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-07-01 06:02:10 +02:00
Revised Keeper page, Publisher page & various others
This commit is contained in:
Troy McConaghy
parent
15420c225b
commit
a84b7b7b3a
|
|
@ -41,7 +41,7 @@ An example marketplace front-end for consumers to explore, download, and publish
|
|||
|
||||
Client libraries used by applications (such as Pleuston or Jupyter notebooks) to interact with Ocean components, including Keepers, Aquarius nodes, Brizo nodes, etc.
|
||||
|
||||
|
||||
|
||||
|
||||
<repo name="squid-js"></repo>
|
||||
<repo name="squid-py"></repo>
|
||||
|
|
|
|||
BIN
content/concepts/images/Squid_role_diagram_small.jpg
Normal file
BIN
content/concepts/images/Squid_role_diagram_small.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 69 KiB |
|
|
@ -1,19 +0,0 @@
|
|||
---
|
||||
title: Set Up a Full Node
|
||||
description: Run every Ocean component in one machine, all at once.
|
||||
---
|
||||
|
||||
A "full node" is a machine that runs all the [Ocean components](/concepts/components/), set up so they all work together.
|
||||
|
||||
As a quick start, you can run a stand-alone full node by doing the following (which requires Git, Docker and Docker Compose):
|
||||
|
||||
```bash
|
||||
git clone https://github.com/oceanprotocol/docker-images.git
|
||||
cd docker-images/
|
||||
|
||||
./start_ocean.sh --latest
|
||||
```
|
||||
|
||||
For more details, see the [docker-images repository](https://github.com/oceanprotocol/docker-images).
|
||||
|
||||
<repo name="docker-images"></repo>
|
||||
|
|
@ -1,4 +1,13 @@
|
|||
---
|
||||
title: Set Up a Keeper
|
||||
description: Coming soon
|
||||
title: Run a Keeper
|
||||
description: How to Run a Keeper node in the Ocean network.
|
||||
---
|
||||
|
||||
The Ocean Protocol v0.9 (Trilobite) Testnet is an Ethereum [Proof-of-Authority (PoA) network](https://wiki.parity.io/Proof-of-Authority-Chains) where all the nodes (Keeper nodes) are running [Parity Ethereum](https://www.parity.io/ethereum/).
|
||||
There are two kinds of Keeper nodes in the Trilobite Testnet: authority nodes (voting nodes) and user nodes (non-voting nodes).
|
||||
|
||||
Authority nodes have a say in determining which transactions are valid. _In the Trilobite Testnet_, the authority nodes are run by BigchainDB GmbH and its partners.
|
||||
|
||||
Anyone can run a user node. It will stay in sync with the other nodes in the Trilobite Testnet, it just won't have a say on whether transactions are valid.
|
||||
Marketplaces and publishers should run user nodes.
|
||||
See the pages for [marketplaces](/setup/marketplace/) and [publishers](/setup/publisher/).
|
||||
|
|
|
|||
|
|
@ -5,22 +5,21 @@ description: Build and run a data marketplace in the Ocean network.
|
|||
|
||||
If you want to set up and run a marketplace in the Ocean network, then at a technical level, you must:
|
||||
|
||||
- Build your marketplace application
|
||||
- Build your marketplace application (app)
|
||||
- Run:
|
||||
- Your marketplace application
|
||||
- Your marketplace app
|
||||
- Aquarius
|
||||
- A database for Aquarius
|
||||
- Parity Ethereum
|
||||
- A database for Aquarius ("OceanDB")
|
||||
- A local Keeper node
|
||||
- Maybe Brizo, unless you are working with others (publishers) running Brizo
|
||||
- Maybe more?
|
||||
|
||||
We expand on all of that below.
|
||||
We expand on all of those things below.
|
||||
|
||||
## Building A Marketplace Application
|
||||
## Building Your Marketplace App
|
||||
|
||||
An Ocean marketplace application (app) is one of the primary ways that end users use the Ocean network. For example, a data scientist could use a marketplace app to see what data sets and data services a marketplace has on offer. They can use the marketplace app to buy access to data sets or services.
|
||||
An Ocean marketplace app is one of the primary ways that end users use the Ocean network. For example, a data scientist could use a marketplace app to see what data sets and data services a marketplace has on offer. They can use the marketplace app to buy access to data sets or services.
|
||||
|
||||
To build an Ocean marketplace application, you will probably want to use one of the Squid software libraries because they simplify working with the Ocean network.
|
||||
To build an Ocean marketplace app, you will probably want to use one of the Squid software libraries because they simplify working with the Ocean network.
|
||||
Currently there are Squid libraries for JavaScript, Python and Java.
|
||||
As an analogy, squid-py is to Ocean like boto3 is to AWS.
|
||||
|
||||
|
|
@ -53,7 +52,7 @@ Note: There's also a squid-java library but it's currently not as full-featured
|
|||
|
||||
## Aquarius
|
||||
|
||||
Aquarius is an application used by Marketplaces to store, update, read and delete metadata about assets. The Squid libraries all know how to talk to Aquarius, so you don't need to think about it or its API too much. You just need to make sure you have Aquarius running on a server somewhere.
|
||||
Aquarius is a software agent used by Marketplaces to store, update, read and delete metadata about assets. The Squid libraries all know how to talk to Aquarius, so you don't need to think about it too much. You just need to make sure you have Aquarius running on a server somewhere.
|
||||
|
||||
TODO: Add instructions here.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,10 @@
|
|||
---
|
||||
title: Publish Data or Services
|
||||
description: Coming soon
|
||||
description: How to operate as a publisher in the Ocean network.
|
||||
---
|
||||
|
||||
Suppose a data scientist purchased a license to use a particular data set. Then they must go through a publisher to get the actual data set. It might be stored on Azure. The publisher would hold the Azure access keys, and would do the checks necessary to ensure that the data scientist has access before letting them get the data set.
|
||||
|
||||
Publishers should run Brizo and a Keeper node.
|
||||
|
||||
Initially, there won't be many Ocean marketplaces or publishers, so most marketplaces will also act as publishers, and most publishers will also act as marketplaces. Therefore, for now, see [the docs for marketplaces](/setup/marketplace/).
|
||||
|
|
|
|||
23
content/setup/quickstart.md
Normal file
23
content/setup/quickstart.md
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
title: Quickstart
|
||||
description: Do a quick test drive.
|
||||
---
|
||||
|
||||
You can run and try every [Ocean software component](/concepts/components/) in your local machine, all at once, using Docker Compose:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/oceanprotocol/docker-images.git
|
||||
cd docker-images/
|
||||
|
||||
./start_ocean.sh --latest
|
||||
```
|
||||
|
||||
One everything is up and running, you can interact with the components. For example, to interact with Pleuston, go to:
|
||||
|
||||
[http://localhost:3000/](http://localhost:3000/)
|
||||
|
||||
Note that everything is running on your local machine, including a local Ethereum node, and it's not connected to any external Ethereum network.
|
||||
|
||||
For the details of what components are running, see the [Ocean Protocol docker-images repository](https://github.com/oceanprotocol/docker-images).
|
||||
|
||||
<repo name="docker-images"></repo>
|
||||
|
|
@ -1,19 +1,19 @@
|
|||
- group: Full Nodes
|
||||
- group: Quickstart
|
||||
items:
|
||||
- title: Set Up a Full Node
|
||||
link: /setup/full-node/
|
||||
- title: Run & Try Everything
|
||||
link: /setup/quickstart/
|
||||
|
||||
- group: Marketplaces
|
||||
items:
|
||||
- title: Set Up a Marketplace
|
||||
link: /setup/marketplace/
|
||||
|
||||
- group: Keepers
|
||||
items:
|
||||
- title: Set Up a Keeper
|
||||
link: /setup/keeper/
|
||||
|
||||
- group: Publishers
|
||||
items:
|
||||
- title: Publish Data or Services
|
||||
link: /setup/publisher/
|
||||
|
||||
- group: Keepers
|
||||
items:
|
||||
- title: Run a Keeper
|
||||
link: /setup/keeper/
|
||||
Loading…
Reference in New Issue
Block a user