Skip to content

Commit 80fdd5a

Browse files
committed
feat: update es version
1 parent 0a8002b commit 80fdd5a

2 files changed

Lines changed: 14 additions & 14 deletions

File tree

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Arc
22

3-
Arc is a simple, modular API Gateway that sits between a client and an [ElasticSearch](https://elastic.co) cluster. It acts as a reverse proxy, routing requests from clients to services. Arc is extended through plugins, which provide extra functionality and services beyond the ElasticSearch's RESTful API. It can perform various cross-cutting tasks such as basic authentication, logging, rate-limiting, source/referers whitelisting, analytics etc. These functionalities can clearly be extended by adding a plugin encapsulating a desired functionality. It also provides some useful abstractions that helps in managing and controlling the access
3+
Arc is a simple, modular API Gateway that sits between a client and an [ElasticSearch](https://elastic.co) cluster. It acts as a reverse proxy, routing requests from clients to services. Arc is extended through plugins, which provide extra functionality and services beyond the ElasticSearch's RESTful API. It can perform various cross-cutting tasks such as basic authentication, logging, rate-limiting, source/referers whitelisting, analytics etc. These functionalities can clearly be extended by adding a plugin encapsulating a desired functionality. It also provides some useful abstractions that helps in managing and controlling the access
44
to ElasticSearch's RESTful API.
55

66
## Table of contents
@@ -14,10 +14,10 @@ to ElasticSearch's RESTful API.
1414

1515
## Overview
1616

17-
When Arc is deployed, every client request being made to the Elasticsearch
18-
will hit Arc first and then be proxied to the Elasticsearch cluster. In between requests and responses, Arc
19-
may execute the installed plugins, essentially extending the Elasticsearch API feature set. Arc effectively
20-
becomes an entry point for every API request made to Elasticsearch. Arc can be used and deployed against any
17+
When Arc is deployed, every client request being made to the Elasticsearch
18+
will hit Arc first and then be proxied to the Elasticsearch cluster. In between requests and responses, Arc
19+
may execute the installed plugins, essentially extending the Elasticsearch API feature set. Arc effectively
20+
becomes an entry point for every API request made to Elasticsearch. Arc can be used and deployed against any
2121
Elasticsearch cluster (locally and hosted as provided by [Appbase.io](https://appbase.io)).
2222

2323
```
@@ -60,12 +60,12 @@ In order to run arc, you'll require an Elasticsearch node. There are multiple wa
6060

6161
2. Start a single node Elasticsearch cluster locally
6262

63-
docker run -d --rm --name elasticsearch -p 9200:9200 -p 9300:9300 --net=arc -e "discovery.type=single-node" docker.elastic.co/elasticsearch/elasticsearch-oss:6.8.0
63+
docker run -d --rm --name elasticsearch -p 9200:9200 -p 9300:9300 --net=arc -e "discovery.type=single-node" docker.elastic.co/elasticsearch/elasticsearch-oss:7.2.0
6464

6565
3. Start Arc locally
6666

6767
docker build -t arc . && docker run --rm --name arc -p 8000:8000 --net=arc --env-file=config/docker.env arc
68-
68+
6969
For convenience, the steps described above are combined into a single `docker-compose` file. You can execute the file with command:
7070

7171
docker-compose up
@@ -172,16 +172,16 @@ A `User` grants a `Permission` to a certain `User`, predefining its capabilities
172172

173173
#### Category
174174

175-
Categories can be used to control access to data and APIs in Arc. Along with Elasticsearch APIs, Categories cover the APIs provided by Arc itself to allow fine-grained control over the API consumption. For Elasticsearch, Categories broadly resembles to the API [classification](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html) that Elasticsearch
176-
provides such as **Document APIs**, **Search APIs**, **Indices APIs** and so on. For Arc, Categories resembles to the
175+
Categories can be used to control access to data and APIs in Arc. Along with Elasticsearch APIs, Categories cover the APIs provided by Arc itself to allow fine-grained control over the API consumption. For Elasticsearch, Categories broadly resembles to the API [classification](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html) that Elasticsearch
176+
provides such as **Document APIs**, **Search APIs**, **Indices APIs** and so on. For Arc, Categories resembles to the
177177
additional APIs on top of Elasticsearch APIs, such as analytics and book keeping. Refer to category [docs](https://github.com/appbaseio/arc/blob/ugo/update-readme/31-12-2018/docs/categories.md) for the list of
178178
categories that Arc supports.
179179

180180
#### ACL
181181

182182
ACLs allow a fine grained control over the Elasticsearch APIs in addition to the Categories. Each ACL resembles an
183-
action performed by an Elasticsearch API. For brevity, setting and organising Categories automatically sets the default
184-
ACLs associated with the set Categories. Setting ACLs adds just another level of control to provide access to
183+
action performed by an Elasticsearch API. For brevity, setting and organising Categories automatically sets the default
184+
ACLs associated with the set Categories. Setting ACLs adds just another level of control to provide access to
185185
Elasticsearch APIs within a given Category. Refer to acl [docs](https://github.com/appbaseio/arc/blob/ugo/update-readme/31-12-2018/docs/acls.md) for the list of acls that Arc supports.
186186

187187
#### Op
@@ -194,8 +194,8 @@ of the plugin. Operation is currently classified into three kinds:
194194
- `Write`: operation permits write requests exclusively.
195195
- `Delete`: operation permits delete requests exclusively.
196196

197-
In order to allow a user or permission to make requests that involve modifying the data, a combination of the above
198-
operations would be required. For example: `["read", "write"]` operation would allow a user or permission to perform
197+
In order to allow a user or permission to make requests that involve modifying the data, a combination of the above
198+
operations would be required. For example: `["read", "write"]` operation would allow a user or permission to perform
199199
both read and write requests but would forbid making delete requests.
200200

201201
#### Request Logging

docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
version: '3'
22
services:
33
elasticsearch:
4-
image: docker.elastic.co/elasticsearch/elasticsearch-oss:6.8.0
4+
image: docker.elastic.co/elasticsearch/elasticsearch-oss:7.2.0
55
container_name: elasticsearch
66
networks:
77
- arc

0 commit comments

Comments
 (0)