Skip to content

Commit

Permalink
Refreshed the Index a Project documentation with new flow and screens…
Browse files Browse the repository at this point in the history
…hots (#536)
  • Loading branch information
Danielvul authored Jun 21, 2024
1 parent d72ead3 commit f0bcd44
Show file tree
Hide file tree
Showing 16 changed files with 31 additions and 37 deletions.
Binary file modified docs/.vuepress/public/assets/img/network/indexer_project_add.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
68 changes: 31 additions & 37 deletions docs/subquery_network/node_operators/indexers/index-project.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Indexing a SubQuery SDK Project

Node Operators can run either data indexing projects or RPC endpoints for the network (or both). If you instead want to connect an RPC endpoint, please follow the instructions [here](../rpc_providers/connect-node.md).
Node Operators can run SubQuery SDK Data Indexing projects, RPC projects, and Subgraphs. If you instead want to connect an RPC endpoint please follow the instructions [here](../rpc_providers/connect-node.md). Alternatively, if you want to connect a Subgraph follow the instructions [here](./connect-subgraph.md).

## 1. Select and Add a Project

Expand All @@ -12,49 +12,43 @@ Enter the project deployment ID when adding the new project.

![Add a New Project Using Deploy ID](/assets/img/network/indexer_project_add.png)

After finishing the process of adding your project, move forward with indexing the project.
After confirming the project details, press Next to configure the project

## 2. Index a Project

Select the project card to open the project details page.

For a brand new project, the indexing status will be `NOT INDEXING`. Select the **`Start Indexing`** button to begin indexing the project.
## 2. Configure Project

You will need to provide an indexing endpoint, this endpoint must be a non-pruned archive node. Public nodes may be rate limited, which can affect indexing speed. **When indexing your project we suggest getting a private API key to avoid being rate limited.**

Public RPC Endpoints may be rate limited which can affect indexing speed, when indexing your project we suggest getting a private API key. You can retrieve endpoints for some networks for free from SubQuery Network itself.

Please make sure that you set “Enable POI” to `true`. Then press `Submit` to trigger the request to start the node and query service for this project in the coordinator service.
Select the Indexer Version and Query Version (latest recommended)

Once the services are started, the service information will be displayed. The Node Operator can then check the service log to see the indexing details:

![Node Operator Service Log](/assets/img/network/indexer_service_logs.png)
Then press `Start` to start the node and query service for this project in the coordinator service.

You have successfully started Indexing. Next comes the Announcements section. Let’s dig in further.
Once the services are started, the service information will be displayed such as the Indexer Service and Query Endpoint status, and the Indexing Status. The Node Operator can then check the service log to see the indexing details:

## 3. Announcements
![Node Operator Service Log](/assets/img/network/indexer_service_logs.png)

### 3.1 Announcing a Project to the Network
You have successfully started Indexing. Next we need to get our project online on the SubQuery Network. Let’s dig in further.

Once the project has started indexing, you can announce your project deployment to the network so the network knows that you are in the proccess of indexing the project.
## 3. Go Online

Select the `Announce Indexing` button and send a transaction.
For a brand new project, the project status will be `Offline`.

![Announce a Project to Network](/assets/img/network/indexer_project_announce.png)
Once the project has started indexing, you can Go Online so that the Network knows that you are running the project. When the indexing progress reaches the minimum required block height the network can now start to distribute requests to the Node Operator's project deployment.

After the transaction is processed, the project's status will change to `INDEXING`. Now, you can:
Select the `Go Online` button and send a transaction.

- Publish the project to `READY` on the network via `Announce Ready`.
- `Stop indexing` the project.
- `Restart indexing` the project with a new network endpoint.
![Go Online](/assets/img/network/indexer_project_go_online.png)

![Indexing Status](/assets/img/network/indexer_project_indexing.png)
**Note**: Your controller account will need balance to complete the transaction.

### 3.2 Announcing that Indexing Service is Ready to Use
After the transaction is processed, the project's status will change to `Online`. Now, you can:

Once a Node Operator announces that they have started indexing the project on the network, and when the indexing progress reaches the minimum required block height (or catches up with the latest height), the Node Operator can publish the project to the `ready` status. This indicates that the network can now start to distribute requests to the Node Operator's project deployment.
- `Update` the project with a new network endpoint and configuration.
- `Stop` to stop indexing the project and prepare for removal.
- `Go Offline` to inform the Network that this project isn't available.

![Indexing Service Ready to Use Announcement](/assets/img/network/indexer_project_ready.png)
![Indexing Status](/assets/img/network/indexer_project_online.png)

## 4 Allocate SQT to the Project and Monitor

Expand All @@ -71,30 +65,30 @@ Congratulations! You have successfully indexed your SubQuery Project.

## 5. Other Actions

### 5.1 Stop Indexing the Project
### 5.1 Updating a Project

When you stop indexing the project, the node and query service will be terminated on the coordinator service side. Additionally, the status of the indexing service will need to be changed back to `NOT INDEXING`.
Update the project if you want to change the network endpoint, network dictionary, or image versions. This will restart the project.

After the status changes to `TERMINATED`, remove the project directly.
![Update a Project](/assets/img/network/indexer_project_update.png)

![Stop Indexing the Project](/assets/img/network/indexer_project_stop.png)
### 5.2 Stop Indexing the Project

The proxy services status will change to `TERMINATED` after triggering the stop indexing function.
When you stop indexing the project the node and query service will be terminated on the coordinator service side.

Once the services are terminated, the Node Operator also needs to send a transaction to change the status to `NOT INDEXING` on the network.
![Stop Indexing the Project](/assets/img/network/indexer_project_stop.png)

![Not Indexing the Project Announcement_Transaction](/assets/img/network/indexer_project_stop_indexing.png)
After the status changes to `TERMINATED` you can remove the project.

**Note**: You can start re-indexing the project at any time after stopping the project.

### 5.2 Restarting a Project
### 5.3 Go Offline

Restart the project if you want to change the network endpoint, network dictionary, or image versions.
Go Offline to tell the Network that your project is not available for queries, or has been stopped.

![Restart a Project](/assets/img/network/indexer_project_restart.png)
![Go Offline](/assets/img/network/indexer_project_go_offline.png)

### 5.3 Removing a Project
### 5.4 Removing a Project

You can remove the project from the service if a project is not required anymore.
You can remove the project from the service if a project is not required anymore. Stop the project and Go Offline first.

![Remove a Project](/assets/img/network/indexer_project_remove.png)

0 comments on commit f0bcd44

Please sign in to comment.