Skip to content
This repository was archived by the owner on Dec 14, 2022. It is now read-only.

Commit d580e53

Browse files
author
Chris Wiechmann
committed
Documentation improved
1 parent 56ce6a1 commit d580e53

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
1010
- Now it is possible to perform a Full-Text search (search for a part of value) on the Subject-Column in Traffic-Monitor [#70](https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/issues/70)
1111

1212
### Changed
13-
- ILM policies optimized to reduce the required disk space [#73](https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/issues/73)
13+
- ILM policies optimized to reduce the required disk space / Traffic-Details & -Summary retention period now 30 days [#73](https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/issues/73)
1414

1515
### Fixed
1616
- Indices are rolled over too often when an Index-Template is changed [#72](https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/issues/72)

DEVELOPMENT.MD

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,22 @@
22

33
### Bump version
44
- docker-compose.yml
5-
`image: cwiechmann/apibuilder4elastic:v2.0.0`
5+
- `image: cwiechmann/apibuilder4elastic:v2.0.0`
66
- apibuilder4elastic/package.json
7-
`"version": "v2.0.0",`
7+
- `"version": "v2.0.0",`
88
- UPDATE.md
9-
`"version": "v2.0.0",`
9+
- `"version": "v2.0.0",`
10+
- Adjust/Verify version table
1011

1112
### CHANGELOG.md
12-
- Add recent changes
13+
- Add/Verify recent changes
1314

1415
### Create the release
1516
- Create a new release on Github with the tag name: v2.0.2
1617

1718
## Create the shipped certificates
1819

19-
To generate the sample keys and certificates we a using the Elasticsearch cert-util:
20+
To generate the sample keys and certificates we are using the Elasticsearch cert-util:
2021
https://www.elastic.co/guide/en/elasticsearch/reference/current/certutil.html
2122

2223
Within a running Elasticsearch instance docker container:

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -780,7 +780,7 @@ Please note:
780780
#### Retention period
781781

782782
The second important aspect for sizing is the retention period, which defines how long data should be available. Accordingly, disk space must be made available.
783-
In particular the Traffic-Summary and Traffic-Details indicies become huge and therefore play a particularly important role here. The solution is delivered with default values which you can read [here](#lifecycle-management). Based on the these default values which result in ap. 30 days the following disk space is required.
783+
In particular the Traffic-Summary and Traffic-Details indicies become huge and therefore play a particularly important role here. The solution is delivered with default values which you can read [here](#lifecycle-management). Based on the these default values which result in ap. __30 days__ the following disk space is required.
784784

785785
| Volume per day | Total Disk-Space | Comment |
786786
| :--- | :--- | :--- |

0 commit comments

Comments
 (0)