Skip to content

Commit

Permalink
Fixed Typos
Browse files Browse the repository at this point in the history
  • Loading branch information
vvoluom committed Apr 9, 2020
1 parent 46a97bc commit a5e5fad
Show file tree
Hide file tree
Showing 6 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/DESIGN_AND_FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ The diagram below gives an idea of the various components at play when the API S
<img src="SERVER.png" alt="design"/>

The API Server works as follows:
- The API Server loads the configuration containing the internal socket information for each node from the `config/user_config_nodes.ini` together with Prometheus endpoint URLs that are used to query blockchain data.
- The API Server loads the API server configuration from the `config/user_config_main.ini` file together with the Node Exporter endpoint which will be used to query machine data running the nodes.
- The API Server loads the configuration containing the internal socket information for each node from the `config/user_config_nodes.ini` file together with Prometheus Endpoints that are used to query blockchain data.
- The API Server loads the API server configuration from the `config/user_config_main.ini` file together with the Node Exporter endpoint which will be used to query machine data.
- The API Server has an option to also retrieve the data of Sentries connected to the node through the External URl and tls certificate data of the Sentry. This data is set up in the `config/user_config_sentry` file.
- By communicating through this port, the API Server receives the endpoints specified in the `Complete List of Endpoints` section below, and requests information from the nodes it is connected to accordingly.
- Once a request is received for an endpoint the server will read the query which should contain the name of the node that will be queried, it then attempts to establish a connection to the node and request data from it. This data is then foramtted into JSON and returned.
Expand Down
2 changes: 1 addition & 1 deletion docs/INSTALL_AND_RUN.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ sudo chown -R <USER>:<USER> <CONFIG_DIR>
No further steps are required.

#### Running the Docker Image
Now that the Docker image is on your machine, and you have written configurations for it, you can run it as follows, where `<CONFIG_DIR>` is the **full path** to the folder containing the previously created config files. The `<INTERNAL_SOCK_DIR>` is the location on your machine where internal socket file can be found for the Oasis Node e.g : `serverdir/node/` while `<PATH_IN_CONFIG>` is the specified location in the API setup where it will look for the internal socket e.g : `serverdir/node/`.
Now that the Docker image is on your machine, and you have written configurations for it, you can run it as follows, where `<CONFIG_DIR>` is the **full path** to the folder containing the previously created config files. The `<INTERNAL_SOCK_DIR>` is the **full path** on your machine where the internal socket file can be found for the Oasis Node e.g : `serverdir/node/` while `<PATH_IN_CONFIG>` is the specified location in the API setup where it will look for the internal socket e.g : `serverdir/node/`.
```bash
docker run -p 8080:8080 \
-v <CONFIG_DIR>:/app/config/ \
Expand Down
Binary file added docs/resources/Oasis_API_Server_Logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/resources/Oasis_API_Server_Logo.xcf
Binary file not shown.
2 changes: 1 addition & 1 deletion setup/setup_user_config_main.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ def setup_api_server(cp: ConfigParser) -> None:
# Get node's local host url
metrics_url = input('Node Exporter\'s localhost url'
' is needed which was exposed during the Node Exporter setup'
' (typically 127.0.0.1:9100/metrics):\n')
' (typically http://127.0.0.1:9100/metrics):\n')


cp['api_server']['port'] = port
Expand Down
2 changes: 1 addition & 1 deletion setup/setup_user_config_nodes.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ def get_node(nodes_so_far: List[NodeConfig]) -> Optional[NodeConfig]:

# Get Prometheus's URL of the Node
p_url = input('Prometheus Node\'s localhost url '
'(typically 127.0.0.1:3000):\n')
'(typically http://127.0.0.1:3000):\n')

# Return node
return NodeConfig(node_name, is_path, p_url)
Expand Down

0 comments on commit a5e5fad

Please sign in to comment.