iac
/
docker-elk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rename App Search to Enterprise Search 

Starting with 7.7, Elastic App Search and Elastic Workplace Search are
now available as a single download known as Elastic Enterprise Search.
This commit is contained in:
Antoine Cotten 2020-06-10 14:16:47 +02:00
parent ffc52a9c89
commit 155c33cc91
No known key found for this signature in database
GPG Key ID: 94637E68D4A79DD0
7 changed files with 114 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
.travis.yml
View File

@ -22,7 +22,7 @@ before_script:
- sed -i -e 's/\(elasticsearch.username:\) elastic/\1 kibana/g' -e 's/\(elasticsearch.password:\) changeme/\1 testpasswd/g' kibana/config/kibana.yml - sed -i -e 's/\(elasticsearch.username:\) elastic/\1 kibana/g' -e 's/\(elasticsearch.password:\) changeme/\1 testpasswd/g' kibana/config/kibana.yml
- sed -i -e 's/\(xpack.monitoring.elasticsearch.username:\) elastic/\1 logstash_system/g' -e 's/\(xpack.monitoring.elasticsearch.password:\) changeme/\1 testpasswd/g' logstash/config/logstash.yml - sed -i -e 's/\(xpack.monitoring.elasticsearch.username:\) elastic/\1 logstash_system/g' -e 's/\(xpack.monitoring.elasticsearch.password:\) changeme/\1 testpasswd/g' logstash/config/logstash.yml
- sed -i 's/\(password =>\) "changeme"/\1 "testpasswd"/g' logstash/pipeline/logstash.conf - sed -i 's/\(password =>\) "changeme"/\1 "testpasswd"/g' logstash/pipeline/logstash.conf
- sed -i 's/\(elasticsearch.password:\) changeme/\1 testpasswd/g' extensions/app-search/config/app-search.yml - sed -i -e 's/\(elasticsearch.password:\) changeme/\1 testpasswd/g' -e 's/\(secret_management.encryption_keys:\)/\1 [test-encrypt]/g' extensions/enterprise-search/config/enterprise-search.yml
- sed -i 's/\(password:\) changeme/\1 testpasswd/g' extensions/apm-server/config/apm-server.yml - sed -i 's/\(password:\) changeme/\1 testpasswd/g' extensions/apm-server/config/apm-server.yml
script: script:
@ -39,12 +39,13 @@ script:
- docker-compose stop logstash kibana - docker-compose stop logstash kibana
# Extensions # Extensions
# App Search # Enterprise Search
- docker-compose -f docker-compose.yml -f extensions/app-search/app-search-compose.yml up -d app-search - docker-compose -f docker-compose.yml -f extensions/enterprise-search/enterprise-search-compose.yml up -d enterprise-search
- .travis/run-tests-app-search.sh - sleep 30
- docker-compose -f docker-compose.yml -f extensions/app-search/app-search-compose.yml ps - .travis/run-tests-enterprise-search.sh
- docker-compose -f docker-compose.yml -f extensions/app-search/app-search-compose.yml logs app-search - docker-compose -f docker-compose.yml -f extensions/enterprise-search/enterprise-search-compose.yml ps
- docker-compose -f docker-compose.yml -f extensions/app-search/app-search-compose.yml stop app-search - docker-compose -f docker-compose.yml -f extensions/enterprise-search/enterprise-search-compose.yml logs enterprise-search
- docker-compose -f docker-compose.yml -f extensions/enterprise-search/enterprise-search-compose.yml stop enterprise-search
# APM Server # APM Server
- docker-compose -f docker-compose.yml -f extensions/apm-server/apm-server-compose.yml up -d apm-server - docker-compose -f docker-compose.yml -f extensions/apm-server/apm-server-compose.yml up -d apm-server
- .travis/run-tests-apm-server.sh - .travis/run-tests-apm-server.sh
@ -56,7 +57,7 @@ script:
- >- - >-
docker-compose docker-compose
-f docker-compose.yml -f docker-compose.yml
-f extensions/app-search/app-search-compose.yml -f extensions/enterprise-search/enterprise-search-compose.yml
-f extensions/apm-server/apm-server-compose.yml -f extensions/apm-server/apm-server-compose.yml
down -v down -v

3
.travis/lib/testing.sh
View File

@ -12,9 +12,6 @@ function poll_ready {
if [ "$#" -ge 3 ]; then if [ "$#" -ge 3 ]; then
args+=( '-u' "$3" ) args+=( '-u' "$3" )
fi fi
if [ "$#" -ge 4 ]; then
args+=( '-o' '/dev/null' )
fi
local label local label
if [ "$MODE" == "swarm" ]; then if [ "$MODE" == "swarm" ]; then

6
.travis/run-tests-app-search.sh → .travis/run-tests-enterprise-search.sh
View File

@ -12,11 +12,11 @@ declare MODE=""
log 'Waiting for readiness of Elasticsearch' log 'Waiting for readiness of Elasticsearch'
poll_ready elasticsearch 'http://localhost:9200/' 'elastic:testpasswd' poll_ready elasticsearch 'http://localhost:9200/' 'elastic:testpasswd'
log 'Waiting for readiness of App Search' log 'Waiting for readiness of Enterprise Search'
poll_ready app-search 'http://localhost:3002/login' ':' quiet poll_ready enterprise-search 'http://localhost:3002/api/ent/v1/internal/health' 'elastic:testpasswd'
log 'Retrieving private key from Elasticsearch' log 'Retrieving private key from Elasticsearch'
response="$(curl 'http://localhost:9200/.app-search-actastic-loco_moco_api_tokens/_search?q=name:private-key' -s -u elastic:testpasswd)" response="$(curl 'http://localhost:9200/.ent-search-actastic-app_search_api_tokens/_search?q=name:private-key' -s -u elastic:testpasswd)"
hits="$(jq -rn --argjson data "${response}" '$data.hits.hits')" hits="$(jq -rn --argjson data "${response}" '$data.hits.hits')"
echo "$hits" echo "$hits"
count="$(jq -rn --argjson data "${response}" '$data.hits.total.value')" count="$(jq -rn --argjson data "${response}" '$data.hits.total.value')"

104
extensions/enterprise-search/README.md
View File

@ -1,83 +1,119 @@
# App Search extension # Enterprise Search extension
Elastic App Search provides access to a set of robust APIs and people friendly dashboard controls to deliver amazing Elastic Enterprise Search is a suite of products for search applications backed by the Elastic Stack.
search experiences, all backed by the Elastic Stack.
## Requirements ## Requirements
* 2 GB of free RAM, on top of the resources required by the other stack components and extensions * 2 GB of free RAM, on top of the resources required by the other stack components and extensions.
App Search exposes the TCP port `3002` for its Web UI and API. Enterprise Search exposes the TCP port `3002` for its Web UI and API.
## Usage ## Usage
To include App Search in the stack, run Docker Compose from the root of the repository with an additional command ### Generate an encryption key
line argument referencing the `app-search-compose.yml` file:
Enterprise Search requires one or more [encryption keys][enterprisesearch-encryption] to be configured before the
initial startup. Failing to do so prevents the server from starting.
Encryption keys can contain any series of characters. Elastic recommends using 256-bit keys for optimal security.
Those encryption keys must be added manually to the [`config/enterprise-search.yml`][config-enterprisesearch] file. By
default, the list of encryption keys is empty and must be populated using one of the following formats:
```yaml
secret_management.encryption_keys:
- my_first_encryption_key
- my_second_encryption_key
- ...
```
```yaml
secret_management.encryption_keys: [my_first_encryption_key, my_second_encryption_key, ...]
```
> :information_source: To generate a strong encryption key, for example using the AES-256 cipher, you can use the
> OpenSSL utility or any other online/offline tool of your choice:
>
> ```console
> $ openssl enc -aes-256 -P
>
> enter aes-256-cbc encryption password: <a strong password>
> Verifying - enter aes-256-cbc encryption password: <repeat your strong password>
> ...
>
> key=<generated AES key>
> ```
### Start the server
To include Enterprise Search in the stack, run Docker Compose from the root of the repository with an additional command
line argument referencing the `enterprise-search-compose.yml` file:
```console ```console
$ docker-compose -f docker-compose.yml -f extensions/app-search/app-search-compose.yml up $ docker-compose -f docker-compose.yml -f extensions/enterprise-search/enterprise-search-compose.yml up
``` ```
Allow a few minutes for the stack to start, then open your web browser at the address http://localhost:3002 to see the Allow a few minutes for the stack to start, then open your web browser at the address http://localhost:3002 to see the
App Search home page. Enterprise Search home page.
App Search is configured on first boot with the following default credentials: Enterprise Search is configured on first boot with the following default credentials:
* user: *app_search* * user: *enterprise_search*
* password: *changeme* * password: *changeme*
## Security ## Security
The App Search password is defined inside the Compose file via the `APP_SEARCH_DEFAULT_PASSWORD` environment variable. The Enterprise Search password is defined inside the Compose file via the `ENT_SEARCH_DEFAULT_PASSWORD` environment
We highly recommend choosing a more secure password than the default one for security reasons. variable. We highly recommend choosing a more secure password than the default one for security reasons.
To do so, change the value `APP_SEARCH_DEFAULT_PASSWORD` environment variable inside the Compose file **before the first To do so, change the value `ENT_SEARCH_DEFAULT_PASSWORD` environment variable inside the Compose file **before the first
boot**: boot**:
```yaml ```yaml
app-search: enterprise-search:
environment: environment:
APP_SEARCH_DEFAULT_PASSWORD: {{some strong password}} ENT_SEARCH_DEFAULT_PASSWORD: {{some strong password}}
``` ```
> :warning: The default App Search password can only be set during the initial boot. Once the password is persisted in > :warning: The default Enterprise Search password can only be set during the initial boot. Once the password is
> Elasticsearch, it can only be changed via the Elasticsearch API. > persisted in Elasticsearch, it can only be changed via the Elasticsearch API.
For more information, please refer to [Security and User Management][appsearch-security]. For more information, please refer to [User Management and Security][enterprisesearch-security].
## Configuring App Search ## Configuring Enterprise Search
The App Search configuration is stored in [`config/app-search.yml`][config-appsearch]. You can modify this file using The Enterprise Search configuration is stored in [`config/enterprise-search.yml`][config-enterprisesearch]. You can
the [Default App Search configuration][appsearch-config] as a reference. modify this file using the [Default Enterprise Search configuration][enterprisesearch-config] as a reference.
You can also specify the options you want to override by setting environment variables inside the Compose file: You can also specify the options you want to override by setting environment variables inside the Compose file:
```yaml ```yaml
app-search: enterprise-search:
environment: environment:
app_search.auth.source: standard ent_search.auth.source: standard
worker.threads: '6' worker.threads: '6'
``` ```
Any change to the App Search configuration requires a restart of the App Search container: Any change to the Enterprise Search configuration requires a restart of the Enterprise Search container:
```console ```console
$ docker-compose -f docker-compose.yml -f extensions/app-search/app-search-compose.yml restart app-search $ docker-compose -f docker-compose.yml -f extensions/enterprise-search/enterprise-search-compose.yml restart enterprise-search
``` ```
Please refer to the following documentation page for more details about how to configure App Search inside a Docker Please refer to the following documentation page for more details about how to configure Enterprise Search inside a
container: [Run App Search as a Docker container][appsearch-docker]. Docker container: [Running Enterprise Search Using Docker][enterprisesearch-docker].
## See also ## See also
[App Search Self-Managed documentation][appsearch-selfmanaged] [Enterprise Search documentation][enterprisesearch-docs]
[config-appsearch]: ./config/app-search.yml [config-enterprisesearch]: ./config/enterprise-search.yml
[appsearch-security]: https://swiftype.com/documentation/app-search/self-managed/security [enterprisesearch-encryption]: https://www.elastic.co/guide/en/enterprise-search/current/encryption-keys.html
[appsearch-config]: https://swiftype.com/documentation/app-search/self-managed/configuration [enterprisesearch-security]: https://www.elastic.co/guide/en/workplace-search/current/workplace-search-security.html
[appsearch-docker]: https://swiftype.com/documentation/app-search/self-managed/installation#docker [enterprisesearch-config]: https://www.elastic.co/guide/en/enterprise-search/current/configuration.html
[appsearch-selfmanaged]: https://swiftype.com/documentation/app-search/self-managed/overview [enterprisesearch-docker]: https://www.elastic.co/guide/en/enterprise-search/current/docker.html
[enterprisesearch-docs]: https://www.elastic.co/guide/en/enterprise-search/current/index.html

18
extensions/enterprise-search/config/app-search.yml
View File

@ -1,18 +0,0 @@
---
## App Search core configuration
## https://swiftype.com/documentation/app-search/self-managed/configuration
#
# IP address App Search listens on
app_search.listen_host: 0.0.0.0
# URL at which users reach App Search
app_search.external_url: http://localhost:3002
# Elasticsearch URL and credentials
elasticsearch.host: http://elasticsearch:9200
elasticsearch.username: elastic
elasticsearch.password: changeme
# Allow App Search to modify Elasticsearch settings. Used to enable auto-creation of Elasticsearch indexes.
allow_es_settings_modification: true

27
extensions/enterprise-search/config/enterprise-search.yml Normal file
View File

@ -0,0 +1,27 @@
---
## Enterprise Search core configuration
## https://www.elastic.co/guide/en/enterprise-search/current/configuration.html
#
## --------------------- REQUIRED ---------------------
# Encryption keys to protect application secrets.
secret_management.encryption_keys:
# add encryption keys below
#- add encryption keys here
## ----------------------------------------------------
# IP address Enterprise Search listens on
ent_search.listen_host: 0.0.0.0
# URL at which users reach Enterprise Search
ent_search.external_url: http://localhost:3002
# Elasticsearch URL and credentials
elasticsearch.host: http://elasticsearch:9200
elasticsearch.username: elastic
elasticsearch.password: changeme
# Allow Enterprise Search to modify Elasticsearch settings. Used to enable auto-creation of Elasticsearch indexes.
allow_es_settings_modification: true

10
extensions/enterprise-search/enterprise-search-compose.yml
View File

@ -1,19 +1,19 @@
version: '3.2' version: '3.2'
services: services:
app-search: enterprise-search:
build: build:
context: extensions/app-search/ context: extensions/enterprise-search/
args: args:
ELK_VERSION: $ELK_VERSION ELK_VERSION: $ELK_VERSION
volumes: volumes:
- type: bind - type: bind
source: ./extensions/app-search/config/app-search.yml source: ./extensions/enterprise-search/config/enterprise-search.yml
target: /usr/share/app-search/config/app-search.yml target: /usr/share/enterprise-search/config/enterprise-search.yml
read_only: true read_only: true
environment: environment:
JAVA_OPTS: -Xmx2g -Xms2g JAVA_OPTS: -Xmx2g -Xms2g
APP_SEARCH_DEFAULT_PASSWORD: changeme ENT_SEARCH_DEFAULT_PASSWORD: changeme
ports: ports:
- '3002:3002' - '3002:3002'
networks: networks: