diff --git a/.gitbook/assets/image (1).png b/.gitbook/assets/image (1).png new file mode 100644 index 00000000..0dafba2b Binary files /dev/null and b/.gitbook/assets/image (1).png differ diff --git a/.gitbook/assets/image (10).png b/.gitbook/assets/image (10).png new file mode 100644 index 00000000..a633d8f8 Binary files /dev/null and b/.gitbook/assets/image (10).png differ diff --git a/.gitbook/assets/image (2).png b/.gitbook/assets/image (2).png new file mode 100644 index 00000000..171eaf81 Binary files /dev/null and b/.gitbook/assets/image (2).png differ diff --git a/.gitbook/assets/image (3).png b/.gitbook/assets/image (3).png new file mode 100644 index 00000000..bd62e17e Binary files /dev/null and b/.gitbook/assets/image (3).png differ diff --git a/.gitbook/assets/image (4).png b/.gitbook/assets/image (4).png new file mode 100644 index 00000000..a633d8f8 Binary files /dev/null and b/.gitbook/assets/image (4).png differ diff --git a/.gitbook/assets/image (5).png b/.gitbook/assets/image (5).png new file mode 100644 index 00000000..8a2b8649 Binary files /dev/null and b/.gitbook/assets/image (5).png differ diff --git a/.gitbook/assets/image (6).png b/.gitbook/assets/image (6).png new file mode 100644 index 00000000..a633d8f8 Binary files /dev/null and b/.gitbook/assets/image (6).png differ diff --git a/.gitbook/assets/image (7).png b/.gitbook/assets/image (7).png new file mode 100644 index 00000000..99eb413e Binary files /dev/null and b/.gitbook/assets/image (7).png differ diff --git a/.gitbook/assets/image (8).png b/.gitbook/assets/image (8).png new file mode 100644 index 00000000..cab24603 Binary files /dev/null and b/.gitbook/assets/image (8).png differ diff --git a/.gitbook/assets/image (9).png b/.gitbook/assets/image (9).png new file mode 100644 index 00000000..9967ad31 Binary files /dev/null and b/.gitbook/assets/image (9).png differ diff --git a/.gitbook/assets/image.png b/.gitbook/assets/image.png new file mode 100644 index 00000000..0059a3bc Binary files /dev/null and b/.gitbook/assets/image.png differ diff --git a/building-with-ocean/deploying-components/deploying-aquarius.md b/building-with-ocean/deploying-components/deploying-aquarius.md index 69973db3..d1c1c9db 100644 --- a/building-with-ocean/deploying-components/deploying-aquarius.md +++ b/building-with-ocean/deploying-components/deploying-aquarius.md @@ -20,7 +20,7 @@ Aquarius consists of two parts:\ ### Create a working directory ``` -mkdir Aqaurius +mkdir Aquarius cd Aquarius ``` @@ -63,7 +63,7 @@ services: - 9200:9200 networks: - ocean_backend - aquarius: + aquarius: image: oceanprotocol/aquarius:${AQUARIUS_VERSION} container_name: aquarius restart: on-failure @@ -197,11 +197,65 @@ networks: ``` docker-compose \ -f docker-compose.yml \ --f docker-events-mainnet.yml \ --f docker-events-polygon.yml \ +-f docker-compose-events-mainnet.yml \ +-f docker-compose-events-polygon.yml \ --env-file .env \ -d \ up ``` After pulling all the asset metadata from the blockchain, Aquarius can be used to query the assets using Elasticsearch query. Aquarius REST API are documented here. + +## **Using hosting services** + +Aquarius can be hosted on any infrastructure providers like AWS, Azure, Heroku, Digitalocean, and many others. The tutorial here explains how to create a server using Digitalocean and running the required commands to host Aquarius. Apart from steps for create a server, the remaining part of the tutorial will be same for all hosting providers. + +#### Creating account and setting billing + +Go to [https://www.digitalocean.com/](https://www.digitalocean.com/) and create an account. Provide the appropriate information for billing and accounting. + +#### Create a droplet + +Click on **`Create`** button and choose **`Droplets`** options from dropdown. + +![](../../.gitbook/assets/image.png) + +#### Configure droplet + +Select Ubuntu OS and choose a plan. The required CPU, Memory depends on the number of requests Aquarius is expected to serve. + +![Configure droplet](<../../.gitbook/assets/image (8).png>) + +Also, select the region where you want Aquarius to be hosted and a root password. + +![](<../../.gitbook/assets/image (4).png>) + +![Click Create Droplet](<../../.gitbook/assets/image (7).png>) + +Finalize the parameters for the server, click on `Create Droplet.` After the server is ready, s`e`lect the Access console option from the dropdown. + +![Click Access Console](<../../.gitbook/assets/image (3).png>) + +![Click Launch Droplet Console](<../../.gitbook/assets/image (9).png>) + +A window will open with a terminal session. Now, the required infrastructure is ready for hosting Aquarius. Let's install docker and docker-compose on the server. Follow the installation guide [here](https://docs.docker.com/engine/install/ubuntu/). + +The below commands shows the commands executed by following the guide. + +```bash +sudo apt-get update +sudo apt-get install ca-certificates curl gnupg lsb-release +sudo mkdir -p /etc/apt/keyrings +curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg +echo \ + "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \ + $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null +sudo apt-get update +sudo apt-get install docker-ce docker-ce-cli containerd.io docker-compose-plugin + +# Now install docker-compose +sudo apt-get update +sudo apt-get install docker-compose-plugin +``` + +Now that, the server is ready with all the required dependencies follow the steps from[ creating a working directory](deploying-aquarius.md#create-a-working-directory) to[ Start Aquarius](deploying-aquarius.md#start-aquarius). diff --git a/core-concepts/did-ddo.md b/core-concepts/did-ddo.md index 3e56fc97..39490414 100644 --- a/core-concepts/did-ddo.md +++ b/core-concepts/did-ddo.md @@ -307,6 +307,8 @@ An asset with a service of `type` `compute` has the following additional attribu | `boolean` | **✓** | If `true`, any passed raw text will be allowed to run. Useful for an algorithm drag & drop use case, but increases risk of data escape through malicious user input. Should be `false` by default in all implementations. | | Type | Required | Description | | `boolean` | **✓** | If `true`, any passed raw text will be allowed to run. Useful for an algorithm drag & drop use case, but increases risk of data escape through malicious user input. Should be `false` by default in all implementations. | +| Type | Required | Description | +| `boolean` | **✓** | If `true`, any passed raw text will be allowed to run. Useful for an algorithm drag & drop use case, but increases risk of data escape through malicious user input. Should be `false` by default in all implementations. | |

allowNetworkAccess

TypeRequiredDescription
boolean✓If true, the algorithm job will have network access.
| | | | Type | Required | Description | | `boolean` | **✓** | If `true`, the algorithm job will have network access. | @@ -314,6 +316,8 @@ An asset with a service of `type` `compute` has the following additional attribu | `boolean` | **✓** | If `true`, the algorithm job will have network access. | | Type | Required | Description | | `boolean` | **✓** | If `true`, the algorithm job will have network access. | +| Type | Required | Description | +| `boolean` | **✓** | If `true`, the algorithm job will have network access. | |

publisherTrustedAlgorithmPublishers

TypeRequiredDescription
Array of string✓If not defined, then any published algorithm is allowed. If empty array, then no algorithm is allowed. If not empty any algo published by the defined publishers is allowed.
| | | | Type | Required | Description | | Array of `string` | **✓** | If not defined, then any published algorithm is allowed. If empty array, then no algorithm is allowed. If not empty any algo published by the defined publishers is allowed. | @@ -321,6 +325,8 @@ An asset with a service of `type` `compute` has the following additional attribu | Array of `string` | **✓** | If not defined, then any published algorithm is allowed. If empty array, then no algorithm is allowed. If not empty any algo published by the defined publishers is allowed. | | Type | Required | Description | | Array of `string` | **✓** | If not defined, then any published algorithm is allowed. If empty array, then no algorithm is allowed. If not empty any algo published by the defined publishers is allowed. | +| Type | Required | Description | +| Array of `string` | **✓** | If not defined, then any published algorithm is allowed. If empty array, then no algorithm is allowed. If not empty any algo published by the defined publishers is allowed. | |

publisherTrustedAlgorithms

TypeRequiredDescription
Array of publisherTrustedAlgorithms✓If not defined, then any published algorithm is allowed. If empty array, then no algorithm is allowed. Otherwise only the algorithms defined in the array are allowed. (see below).
| | | | Type | Required | Description | | Array of `publisherTrustedAlgorithms` | **✓** | If not defined, then any published algorithm is allowed. If empty array, then no algorithm is allowed. Otherwise only the algorithms defined in the array are allowed. (see below). | @@ -328,6 +334,8 @@ An asset with a service of `type` `compute` has the following additional attribu | Array of `publisherTrustedAlgorithms` | **✓** | If not defined, then any published algorithm is allowed. If empty array, then no algorithm is allowed. Otherwise only the algorithms defined in the array are allowed. (see below). | | Type | Required | Description | | Array of `publisherTrustedAlgorithms` | **✓** | If not defined, then any published algorithm is allowed. If empty array, then no algorithm is allowed. Otherwise only the algorithms defined in the array are allowed. (see below). | +| Type | Required | Description | +| Array of `publisherTrustedAlgorithms` | **✓** | If not defined, then any published algorithm is allowed. If empty array, then no algorithm is allowed. Otherwise only the algorithms defined in the array are allowed. (see below). | The `publisherTrustedAlgorithms` is an array of objects with the following structure: