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.

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

Outdated documentation about Elasticsearch and Homebrew #7226

Open
chosak opened this issue Sep 8, 2022 · 0 comments
Open

Outdated documentation about Elasticsearch and Homebrew #7226

chosak opened this issue Sep 8, 2022 · 0 comments

Comments

@chosak
Copy link
Member

chosak commented Sep 8, 2022

The virtual environment documentation instructs users to install Elasticsearch using Homebrew:

If Elasticsearch is installed via Homebrew, you can see instructions for running manually or as a background service using:

brew info elasticsearch

This is outdated, and running this command currently outputs:

% brew info elasticsearch   
==> elasticsearch: stable 7.10.2 (bottled)
Distributed search & analytics engine
https://www.elastic.co/products/elasticsearch
Disabled because it is switching to an incompatible license. Check out `opensearch` instead!

Running brew install elasticsearch results in an error:

% brew install elasticsearch
Error: elasticsearch has been disabled because it is switching to an incompatible license. Check out `opensearch` instead!

Prior to the switch to OpenSearch in #7192, it was possible to run cf.gov locally using brew install elasticsearch-full (which is currently 7.17.x); however, this no longer works, and connections to a local ES installed this way return errors like

opensearchpy.exceptions.ConnectionTimeout: ConnectionTimeout caused by - ReadTimeoutError(HTTPConnectionPool(host='localhost', port=9200): Read timed out. (read timeout=10))

If local development now requires OpenSearch instead of Elasticsearch, this documentation should be updated, as well as this documentation.

(Related question: the docker-compose setup still seems to use Elasticsearch 7.16.x (example) - will this still work properly with the OpenSearch libraries?)

Notes

For reference, the configuration that worked locally before #7192:

elastic/tap/elasticsearch-full: stable 7.17.4
{
  "name" : "MP-C02DD4J2ML85",
  "cluster_name" : "elasticsearch_chosaka",
  "cluster_uuid" : "HPLcLMR-QRSr8fHZZBKGRg",
  "version" : {
    "number" : "7.17.3",
    "build_flavor" : "default",
    "build_type" : "tar",
    "build_hash" : "5ad023604c8d7416c9eb6c0eadb62b14e766caff",
    "build_date" : "2022-04-19T08:11:19.070913226Z",
    "build_snapshot" : false,
    "lucene_version" : "8.11.1",
    "minimum_wire_compatibility_version" : "6.8.0",
    "minimum_index_compatibility_version" : "6.0.0-beta1"
  },
  "tagline" : "You Know, for Search"
}

After #7192, using brew install opensearch instead, this now works properly locally:

{
  "name" : "MP-C02DD4J2ML85",
  "cluster_name" : "opensearch_homebrew",
  "cluster_uuid" : "S_zaIl8zTkeKOlTkDnKKag",
  "version" : {
    "distribution" : "opensearch",
    "number" : "2.2.1",
    "build_type" : "tar",
    "build_hash" : "unknown",
    "build_date" : "2022-08-23T18:18:37Z",
    "build_snapshot" : false,
    "lucene_version" : "9.3.0",
    "minimum_wire_compatibility_version" : "7.10.0",
    "minimum_index_compatibility_version" : "7.0.0"
  },
  "tagline" : "The OpenSearch Project: https://opensearch.org/"
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant