You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Arc
2
2
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
4
4
to ElasticSearch's RESTful API.
5
5
6
6
## Table of contents
@@ -14,10 +14,10 @@ to ElasticSearch's RESTful API.
14
14
15
15
## Overview
16
16
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
21
21
Elasticsearch cluster (locally and hosted as provided by [Appbase.io](https://appbase.io)).
22
22
23
23
```
@@ -60,12 +60,12 @@ In order to run arc, you'll require an Elasticsearch node. There are multiple wa
60
60
61
61
2. Start a single node Elasticsearch cluster locally
For convenience, the steps described above are combined into a single `docker-compose` file. You can execute the file with command:
70
70
71
71
docker-compose up
@@ -172,16 +172,16 @@ A `User` grants a `Permission` to a certain `User`, predefining its capabilities
172
172
173
173
#### Category
174
174
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
177
177
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
178
178
categories that Arc supports.
179
179
180
180
#### ACL
181
181
182
182
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
185
185
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.
186
186
187
187
#### Op
@@ -194,8 +194,8 @@ of the plugin. Operation is currently classified into three kinds:
0 commit comments