Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes spelling of Elasticsearch. #752

Merged
merged 1 commit into from
Nov 12, 2024
Merged

Fixes spelling of Elasticsearch. #752

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/elasticsearch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ElasticSearch
# Elasticsearch

ElasticSearch is an integral component of Altis, enabling enhanced search and relevancy as well as powering the analytics data query
Elasticsearch is an integral component of Altis, enabling enhanced search and relevancy as well as powering the analytics data query
layer.

## Available Versions
Expand Down Expand Up @@ -78,9 +78,9 @@ types.

![Kibana Discover panel](./assets/kibana-discover.png)

## Accessing ElasticSearch Directly
## Accessing Elasticsearch Directly

The ElasticSearch host name is not directly exposed however you can find the dynamic port and IP to connect to by
The Elasticsearch host name is not directly exposed however you can find the dynamic port and IP to connect to by
running `composer server status | grep elasticsearch`.

You should see output similar to this:
Expand All @@ -89,17 +89,17 @@ You should see output similar to this:
project_elasticsearch_1 /elastic-entrypoint.sh ela ... Up (healthy) 0.0.0.0:32871->9200/tcp, 9300/tcp
```

Copy the mapped IP and port (`0.0.0.0:32871` in the example above) and use it to query ElasticSearch directly:
Copy the mapped IP and port (`0.0.0.0:32871` in the example above) and use it to query Elasticsearch directly:

```shell
curl -XGET http://0.0.0.0:32871
```

## ElasticSearch Memory Limit
## Elasticsearch Memory Limit

ElasticSearch requires more memory on certain operating systems such as Ubuntu or when using Continuous Integration services. If
ElasticSearch does not have enough memory it can cause other services to stop working. The Local Server supports an environment
variable which can change the default memory limit for ElasticSearch called `ES_MEM_LIMIT`.
Elasticsearch requires more memory on certain operating systems such as Ubuntu or when using Continuous Integration services. If
Elasticsearch does not have enough memory it can cause other services to stop working. The Local Server supports an environment
variable which can change the default memory limit for Elasticsearch called `ES_MEM_LIMIT`.

You can set the `ES_MEM_LIMIT` variable in 2 ways:

Expand Down
10 changes: 5 additions & 5 deletions docs/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,18 @@ In the docker GUI go to the "Preferences" pane, then the "Advanced" tab and move

![Docker Advanced Settings](./assets/docker-gui-advanced.png)

## ElasticSearch service fails to start
## Elasticsearch service fails to start

ElasticSearch requires more memory on certain operating systems such as Ubuntu or when using Continuous Integration services. If
ElasticSearch does not have enough memory it can cause other services to stop working. The Local Server supports an environment
variable which can change the default memory limit for ElasticSearch called `ES_MEM_LIMIT`.
Elasticsearch requires more memory on certain operating systems such as Ubuntu or when using Continuous Integration services. If
Elasticsearch does not have enough memory it can cause other services to stop working. The Local Server supports an environment
variable which can change the default memory limit for Elasticsearch called `ES_MEM_LIMIT`.

You can set the `ES_MEM_LIMIT` variable in 2 ways:

- Set it globally e.g. `export ES_MEM_LIMIT=2g`
- Set it for the local server process only: `ES_MEM_LIMIT=2g composer server start`

Another problem can be related to the Docker Virtual Machine settings. In Linux environments the ElasticSearch container is in
Another problem can be related to the Docker Virtual Machine settings. In Linux environments the Elasticsearch container is in
production mode and requires the setting `vm.max_map_count` to be increased. To do this edit the file `/etc/sysctl.conf` and add the
following line:

Expand Down