i14y

Search engine for agencies' published content

Dependencies/Prerequisistes

• Install Elasticsearch 5.6+:

$ brew search elasticsearch
$ brew install [email protected]

To allow ES 5.6 to run in parallel with another version of Elasticsearch in development and test environments, we run I14y on port 9256 instead of the default port 9200. You'll need to specify the port, cluster name, and node name for your 5.6 cluster:

$ vi /usr/local/Cellar/[email protected]/<specific version>/libexec/config/elasticsearch.yml
  
  cluster.name: elasticsearch_56
  node.name: "es56"
  http.port: 9256

• You'll need Java 7+ to run the included stream2es utility that handles copying data from one index version to the next. Run java -version to make sure.

• Your Elasticsearch cluster needs the ICU analysis plugin and the Kuromoji analysis plugin and the Smart Chinese Analysis Plugin installed:

$ /usr/local/opt/[email protected]/libexec/bin/elasticsearch-plugin install analysis-kuromoji
$ /usr/local/opt/[email protected]/libexec/bin/elasticsearch-plugin install analysis-icu
$ /usr/local/opt/[email protected]/libexec/bin/elasticsearch-plugin install analysis-smartcn

Be sure to restart Elasticsearch after you have installed the plugins:

$ brew services restart [email protected]

Verify that Elasticsearch 5.6.x is running on port 9256:

$ curl localhost:9256
{
  "name" : "es56",
  "cluster_name" : "elasticsearch_56",
  "cluster_uuid" : "IhVLFTNYQj6Ac6Xi4Uegmg",
  "version" : {
    "number" : "5.6.9",
    "build_hash" : "877a590",
    "build_date" : "2018-04-12T16:25:14.838Z",
    "build_snapshot" : false,
    "lucene_version" : "6.6.1"
  },
  "tagline" : "You Know, for Search"
}

Development

• Use rvm to install the version of Ruby specified in .ruby-version.
• bundle install.
• Copy config/secrets_example.yml to config/secrets.yml and fill in your own secrets. To generate a random long secret, use rake secret.
• Run bundle exec rake i14y:setup to create the neccessary indexes, index templates, and dynamic field templates.

If you ever want to start from scratch with your indexes/templates, you can clear everything out: bundle exec rake i14y:clear_all

Tests

bundle exec rake

Deployment

• Set your Airbrake api key in config/airbrake.yml in the deployment directory for /i14y/shared/config. This will get copied into the current release directory on deployment.
• Update your config/secrets.yml file in the deployment directory for /i14y/shared/config. This will get copied into the current release directory on deployment.
• Update your config/newrelic.yml file in the deployment directory for /i14y/shared/config. This will get copied into the current release directory on deployment.
• bundle exec cap staging deploy to deploy to a staging environment
• bundle exec cap production deploy to deploy to a production environment