add Redis cache and some clean up
- update and cleanup in README.md - update getIdentity to throw response exception with 401 in JwtService - update http files to use identity from env - add cacheable to getIdentityFromDevice in DeviceRegistryService - add RedisCacheConfiguration - add CacheProperty - set up cache property - set up data redis cache
This commit is contained in:
90
README.md
90
README.md
@@ -5,26 +5,31 @@ Classes and endpoints, to shape and to steer, Devices and sensors, their purpose
|
||||
## Properties for deployment
|
||||
|
||||
| name | required | info |
|
||||
|----------------------------------------------|----------|----------------------------------------------|
|
||||
| spring.profiles.active | * | Spring Boot environment |
|
||||
| server.port | * | HTTP port |
|
||||
| server.ssl.enabled | * | HTTP Enable SSL |
|
||||
| server.ssl.key-store | * | HTTP Keystore |
|
||||
| server.ssl.key-store-type | * | HTTP Cert Type |
|
||||
| server.ssl.key-store-password | ** | HTTP Cert Pass |
|
||||
| jwt.public-key | * | JWT public key |
|
||||
| device-registry.url | * | Device Register URL |
|
||||
| device-data.url | * | Device Data URL |
|
||||
| device-configuration.url | * | Device Configuration URL |
|
||||
|----------------------------------------------|:--------:|----------------------------------------------|
|
||||
| spring.profiles.active | ✓ | Spring Boot environment |
|
||||
| server.port | ✓ | HTTP port |
|
||||
| server.ssl.enabled | ✓ | HTTP Enable SSL |
|
||||
| server.ssl.key-store | ✓ | HTTP Keystore |
|
||||
| server.ssl.key-store-type | ✓ | HTTP Cert Type |
|
||||
| server.ssl.key-store-password | ✗ | HTTP Cert Pass |
|
||||
| spring.cache.type | | Cache type (redis) |
|
||||
| spring.data.redis.host | ✓ | Redis host |
|
||||
| spring.data.redis.port | | Redis port |
|
||||
| spring.data.redis.database | ✓ | Redis database |
|
||||
| cache.time-to-live | | Cache time to live (minutes) |
|
||||
| jwt.public-key | ✓ | JWT public key |
|
||||
| device-registry.url | ✓ | Device Register URL |
|
||||
| device-data.url | ✓ | Device Data URL |
|
||||
| device-configuration.url | ✓ | Device Configuration URL |
|
||||
| management.influx.metrics.export.api-version | | InfluxDB API version |
|
||||
| management.influx.metrics.export.enabled | | Enable/Disable exporting metrics to InfluxDB |
|
||||
| management.influx.metrics.export.bucket | * | InfluxDB bucket name |
|
||||
| management.influx.metrics.export.org | * | InfluxDB organization |
|
||||
| management.influx.metrics.export.token | ** | InfluxDB token |
|
||||
| management.influx.metrics.export.uri | * | InfluxDB URL |
|
||||
| management.metrics.tags.application | * | Application instance tag for metrics |
|
||||
| management.influx.metrics.export.bucket | ✓ | InfluxDB bucket name |
|
||||
| management.influx.metrics.export.org | ✓ | InfluxDB organization |
|
||||
| management.influx.metrics.export.token | ✗ | InfluxDB token |
|
||||
| management.influx.metrics.export.uri | ✓ | InfluxDB URL |
|
||||
| management.metrics.tags.application | ✓ | Application instance tag for metrics |
|
||||
|
||||
Required: * can be stored as text, and ** need to be stored as secret.
|
||||
*Required: ✓ can be stored as text, and ✗ need to be stored as secret.*
|
||||
|
||||
## Releasing Service
|
||||
|
||||
@@ -34,43 +39,32 @@ Run `release.sh` script from `master` branch.
|
||||
|
||||
### Developer Keystore
|
||||
|
||||
1. Open `hosts` file:
|
||||
* On Unix-like systems (Linux, macOS), this directory is typically `/etc/hosts`.
|
||||
* On Windows, this directory is typically `%SystemRoot%\System32\drivers\etc\hosts`.
|
||||
|
||||
2. Add the following lines to the `hosts` file:
|
||||
```text
|
||||
127.0.0.1 deviceapi # Hlæja Device API
|
||||
```
|
||||
|
||||
3. Generate Keystores
|
||||
```shell
|
||||
keytool -genkeypair -alias device-api -keyalg RSA -keysize 2048 -validity 3650 -dname "CN=deviceapi" -keypass password -keystore ./cert/keystore.p12 -storetype PKCS12 -storepass password
|
||||
```
|
||||
|
||||
4. Export the public certificate
|
||||
```shell
|
||||
keytool -export -alias device-api -keystore ./cert/keystore.p12 -storepass password -file ./cert/device-api.cer -rfc
|
||||
```
|
||||
We use a keystore to enable HTTPS for our API. To set up your developer environment for local development, please refer to [generate keystore](https://github.com/swordsteel/hlaeja-development/blob/master/doc/keystore.md) documentation. When generating and exporting the certificate for local development, please store it in the `./cert/keystore.p12` folder at the project root.
|
||||
|
||||
### Public RSA Key
|
||||
|
||||
To validate devices, copy file named `public_key.pem` from `./cert` generated for local development in **Hlæja Device Register** in to `./cert`.
|
||||
This service uses the public key from **[Hlæja Device Register](https://github.com/swordsteel/hlaeja-device-registry)** to identify devices. To set up device identification for local development, copy the `public_key.pem` file from the `./cert` directory in **Hlæja Device Register** into the `./cert` directory of this project.
|
||||
|
||||
### Global gradle properties
|
||||
*Note: For more information on generating RSA keys, please refer to our [generate RSA key](https://github.com/swordsteel/hlaeja-development/blob/master/doc/rsa_key.md) documentation.*
|
||||
|
||||
To authenticate with Gradle to access repositories that require authentication, you can set your user and token in the `gradle.properties` file.
|
||||
### Global Settings
|
||||
|
||||
Here's how you can do it:
|
||||
This services rely on a set of global settings to configure development environments. These settings, managed through Gradle properties or environment variables.
|
||||
|
||||
1. Open or create the `gradle.properties` file in your Gradle user home directory:
|
||||
*Note: For more information on global properties, please refer to our [global settings](https://github.com/swordsteel/hlaeja-development/blob/master/doc/global_settings.md) documentation.*
|
||||
|
||||
- On Unix-like systems (Linux, macOS), this directory is typically `~/.gradle/`.
|
||||
- On Windows, this directory is typically `C:\Users\<YourUsername>\.gradle\`.
|
||||
#### Gradle Properties
|
||||
|
||||
2. Add the following lines to the `gradle.properties` file:
|
||||
```properties
|
||||
repository.user=your_user
|
||||
repository.token=your_token_value
|
||||
```
|
||||
or use environment variables `REPOSITORY_USER` and `REPOSITORY_TOKEN`
|
||||
```properties
|
||||
repository.user=your_user
|
||||
repository.token=your_token_value
|
||||
influxdb.token=your_token_value
|
||||
```
|
||||
|
||||
#### Environment Variables
|
||||
|
||||
```properties
|
||||
REPOSITORY_USER=your_user
|
||||
REPOSITORY_TOKEN=your_token_value
|
||||
INFLUXDB_TOKEN=your_token_value
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user