https://github.com/strapdata/gravitee-repository-elassandra
Elassandra gravitee repository for management, ratelimit and analytics
https://github.com/strapdata/gravitee-repository-elassandra
Last synced: 5 months ago
JSON representation
Elassandra gravitee repository for management, ratelimit and analytics
- Host: GitHub
- URL: https://github.com/strapdata/gravitee-repository-elassandra
- Owner: strapdata
- License: agpl-3.0
- Created: 2019-07-05T22:24:24.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-16T04:52:57.000Z (over 3 years ago)
- Last Synced: 2023-03-03T19:03:24.767Z (over 3 years ago)
- Language: Java
- Size: 584 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.AGPL
Awesome Lists containing this project
README
# Gravitee Elassandra Repository [](https://travis-ci.org/strapdata/gravitee-repository-elassandra)
[Elassandra](https://www.elassandra.io/) repository (Management, Rate Limit and Analytics), with the following benefits:
* Distributed gravitee configuration on many datacenters through the Cassandra replication (in active/active mode).
* Elasticsearch reporting for gravitee analytics.
* Scalability by adding Elassandra nodes (without re-indexing) and datacenters (for geo localisation concerns or workload separation)
* Reduce the global complexity and TCO by using the same NoSQL database for both gravitee configuration, reporting and APIs data storage.
This repository uses Datastax Java driver for communication with Cassandra and Elasticsearch query over CQL.
## Requirement
The minimum requirement is :
* Maven3
* Jdk8
In order to use **Gravitee** snapshot, You need to declare the following repository in you Maven settings :
https://oss.sonatype.org/content/repositories/snapshots
## Building
This Elassandra repository use [Elassandra-Unit](https://github.com/strapdata/elassandra-unit) to run gravitee unit tests.
```
$ git clone https://github.com/strapdata/gravitee-repository-elassandra.git
$ cd gravitee-repository-elassandra
$ mvn clean package
```
To build the gravitee docker images including this gravitee-repository-elassandra.zip,
```bash
build.sh
```
Strapdata docker images are also available on the Docker Hub:
* [strapdata/graviteeio-management-api](https://hub.docker.com/r/strapdata/graviteeio-management-api)
* [strapdata/graviteeio-gateway](https://hub.docker.com/r/strapdata/graviteeio-gateway)
## Installing
* Unzip the gravitee-repository-elassandra-[version].zip in the gravitee home directory.
* Copy the *gravitee-repository-elassandra-[version].zip* in the **Gravitee** */plugins* directory.
## Configuration
Configuration settings, prefixed by *scope*.**elassandra**, where *scope* is **management** or **ratelimit**:
| Parameter | Description | default |
| ----------------------- | --------------- | -------------: |
| localDc | Sets the name of the datacenter that will be considered "local" | |
| contactPoint | Allows to connect to Cassandra cluster nodes. It is not necessary to add all contact points because Cassandra driver will use auto-discovery mechanism. | localhost |
| endpoint | Defines the Elasticsearch endpoint used to create Elasticsearch indices. | http://localhost:9200 |
| port | Defines the CQL native transport port | 9042 |
| keyspaceName | Name of the keyspace. Note that the final will be prefixed with the corresponding scope. |gravitee |
| username | Permit to connect to Cassandra and Elasticsearch if using access with credentials. | cassandra |
| password | Permit to connect to Cassandra and Elasticsearch if using access with credentials. | cassandra |
| index.prefix | Index name prefix (to setup elasticsearch template for indices starting with this prefix) | |
| connectTimeoutMillis | Defines how long the driver waits to establish a new connection to a Cassandra node before giving up | 5000 |
| readTimeoutMillis | Controls how long the driver waits for a response from a given Cassandra node before considering it unresponsive | 12000 |
| reconnectDelay | Reconnection retry delay in milliseconds | 5000 |
| consistencyLevel | Sets the level of consistency for read & write access, e.g. ONE, QUORUM, ALL (see Datastax documentation for comprehensive list) | LOCAL_QUORUM | ssl.provider | Java SSL/TLS provider | JDK |
| ssl.truststore.path | Truststore file name (JKS or P12) | |
| ssl.truststore.password | Truststore password | |
| ssl.keystore.path | Keystore file name (JKS or P12) for TLS client authentication | |
| ssl.keystore.password | Keystore password | |
For analytics, settings are the same as Elasticsearch, see the
[gravitee documentation](https://docs.gravitee.io/apim_installguide_management_api_configuration.html#analytics) (Elassandra is seen as a vanilla Elasticsearch).
Configuration sample:
```yaml
management:
type: elassandra
elassandra:
clusterName: elassandra
port: 39042
contactPoint: elassandra.default.svc.cluster.local
endpoint: https://elassandra-elasticsearch.default.svc.cluster.local:9200
username: cassandra
password: cassandra
ssl:
truststore:
path: /ca-pub/truststore.p12
password: changeit
ratelimit:
type: elassandra
elassandra:
clusterName: elassandra
port: 39042
contactPoint: elassandra.default.svc.cluster.local
endpoint: https://elassandra-elasticsearch.default.svc.cluster.local:9200
username: cassandra
password: cassandra
ssl:
truststore:
path: /ca-pub/truststore.p12
password: changeit
analytics:
type: elasticsearch
elasticsearch:
endpoints:
- https://elassandra-elasticsearch.default.svc.cluster.local:9200
security:
username: cassandra
password: cassandra
ssl:
truststore:
path: /ca-pub/truststore.p12
password: changeit
index: analytics
cluster: elassandra
...
```
## Support
* Commercial support is available through [Strapdata](http://www.strapdata.com/).
* Community support available via [elassandra google groups](https://groups.google.com/forum/#!forum/elassandra).
* Post feature requests and bugs on [gravitee-repository-elassandra](https://github.com/strapdata/gravitee-repository-elassandra).
## License
This software is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE.
## Acknowledgments
* Elasticsearch and Kibana are trademarks of Elasticsearch BV, registered in the U.S. and in other countries.
* Apache Cassandra, Apache Lucene, Apache, Lucene and Cassandra are trademarks of the Apache Software Foundation.
* Gravitee is a trademark of Graviteesource.
* Elassandra is a trademark of Strapdata SAS.