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

Commit f5fdf74

Browse files
author
Chris Wiechmann
authored
Update README.md
1 parent 64a1290 commit f5fdf74

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ This shows a sample dashboard created in Kibana based on the indexed documents:
3737
- [Prerequisites](#prerequisites)
3838
- [Getting started](#getting-started)
3939
- [Basic setup](#basic-setup)
40+
- [Preparations](#preparations)
41+
- [Elasticsearch](#elasticsearch)
42+
- [Kibana](#kibana)
43+
- [Logstash / API-Builder / Memcached](#logstash--api-builder--memcached)
44+
- [Filebeat](#filebeat)
4045
- [Configure Axway API-Management](#configure-axway-api-management)
4146
- [Production Setup](#production-setup)
4247
- [Infrastructure sizing](#infrastructure-sizing)
@@ -108,17 +113,18 @@ cd axway-apim-elk-v1.0.0
108113
mv env-sample .env
109114
```
110115

111-
From this point on it is assumed that all commands are executed within the unpacked release folder. As it is important that the `.env' can be found by Docker-Compose.
112-
If, as recommended, you run the solution on different machines, it is also assumed that you download and unpack the release package on each machine. And then provide the `.env` file.
113-
Furthermore, it is recommended to store the .env as central configuration file in a version management system.
116+
- From this point on it is assumed that all commands are executed within the unpacked release folder.
117+
- As it is important that the `.env` can be found by Docker-Compose.
118+
- If, as recommended, you run the solution on different machines, it is also assumed that you download and unpack the release package on each machine. And then provide the `.env` file.
119+
- Furthermore, it is recommended to store the .env as central configuration file in a version management system.
114120

115121
Even if otherwise possible, it is recommended to deploy the individual components in the following order. For each component you can then check if it is functional.
116122

117-
#### Elasticsearch
123+
### Elasticsearch
118124

119-
Open the `.env` file and configure the ELASTICSEARCH_HOSTS. At this point please configure only one Elasticsearch node. You can start with a single node and add more nodes later. More about this topic [Multi-Node Deployment](#setup-elasticsearch-multi-node) later in the documenation.
120-
This URL is used by all Elasticsearch clients (Logstash, API-Builder, Filebeat) of the solution to establish communication.
121-
If you use an external Elasticsearch cluster, please specify which node(s) that are given to you.
125+
Open the `.env` file and configure the ELASTICSEARCH_HOSTS. At this point please configure only one Elasticsearch node. You can start with a single node and add more nodes later. More about this topic [Multi-Node Deployment](#setup-elasticsearch-multi-node) later in the documenation.
126+
This URL is used by all Elasticsearch clients (Logstash, API-Builder, Filebeat) of the solution to establish communication.
127+
If you use an external Elasticsearch cluster, please specify the node(s) that are given to you.
122128
Please keep in mind that the hostnames must be resolvable within the docker containers. You can also assign the cluster name here if the default: `axway-apim-elasticsearch` is not appropriate. Example:
123129
```
124130
ELASTICSEARCH_HOSTS=https://my-elasticsearch-host.com:9200
@@ -151,7 +157,7 @@ GET https://my-elasticsearch-host.com:9200
151157
```
152158
At this point you can already add the cluster UUID to the `.env` (`ELASTICSEARCH_CLUSTER_UUID`) file. With that, the Single-Node Elasticsearch Cluster is up & running.
153159

154-
#### Kibana
160+
### Kibana
155161

156162
For Kibana all parameters are already stored in the .env file. Start Kibana with the following command:
157163
```
@@ -167,7 +173,7 @@ At this point you can already import the sample dashboard: `kibana/Axway-APIM-Da
167173

168174
:exclamation: You are welcome to create additional visualizations and dashboards, but do not adapt the existing ones, as they will be overwritten with the next update.
169175

170-
#### Logstash / API-Builder / Memcached
176+
### Logstash / API-Builder / Memcached
171177

172178
It is recommended to deploy these components on one machine, so they are in a common Docker-Compose file and share the same network. Furthermore, a low latency between these components is beneficial. This allows you to use the default values for Memcached and API Builder. Therefore you only need to specify where the Admin-Node-Manager or the API manager can be found for this step. If necessary you have to specify an API-Manager admin user.
173179
```

0 commit comments

Comments
 (0)