Skip to content

Commit e01954b

Browse files
📈 Update dependencies in CONTRIBUTING.md (#5970)
* Update dependency name/version CONTRIBUTING.md We moved off elasticsearch almost four years ago. We rely on opensearch now. * Update Rubygems version in CONTRIBUTING.md
1 parent 7e63f36 commit e01954b

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

‎CONTRIBUTING.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Move to the newly cloned repository directory: `cd rubygems.org`
6060
### Setting up the environment
6161

6262
Rubygems.org is a Ruby on Rails application.
63-
The app depends on Elasticsearch, Memcached, and PostgreSQL.
63+
The app depends on OpenSearch, Memcached, and PostgreSQL.
6464
Google Chrome is used for tests.
6565

6666
Setup the development environment using one of the approaches below.
@@ -79,16 +79,16 @@ Follow the instructions below on how to install Bundler and setup the database.
7979

8080
#### Environment (OS X)
8181

82-
* Install Elasticsearch:
82+
* Install OpenSearch:
8383

84-
* Pull Elasticsearch `7.10.1` : `docker pull docker.elastic.co/elasticsearch/elasticsearch:7.10.1`
85-
* Running Elasticsearch from the command line:
84+
* Pull OpenSearch `2.13.0` : `docker pull opensearchproject/opensearch:2.13.0`
85+
* Running OpenSearch from the command line:
8686

8787
```
88-
docker run -p 9200:9200 -e "http.host=0.0.0.0" -e "transport.host=127.0.0.1" -e "xpack.security.enabled=false" docker.elastic.co/elasticsearch/elasticsearch:7.10.1
88+
docker run -p 9200:9200 -e "discovery.type=single-node" -e "DISABLE_SECURITY_PLUGIN=true" -e "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m" opensearchproject/opensearch:2.13.0
8989
```
9090

91-
* Note that `-e "xpack.security.enabled=false"` disables authentication.
91+
* Note that `-e "DISABLE_SECURITY_PLUGIN=true"` disables authentication.
9292

9393
* Install PostgreSQL (>= 14.x): `brew install postgresql`
9494
* Setup information: `brew info postgresql`
@@ -98,11 +98,11 @@ Follow the instructions below on how to install Bundler and setup the database.
9898

9999
#### Environment (Linux - Debian/Ubuntu)
100100

101-
* Install Elasticsearch (see the docker installation instructions above):
102-
* Pull Elasticsearch `7.10.1` : `docker pull docker.elastic.co/elasticsearch/elasticsearch:7.10.1`
103-
* Running Elasticsearch from the command line:
101+
* Install OpenSearch (see the docker installation instructions above):
102+
* Pull OpenSearch `2.13.0` : `docker pull opensearchproject/opensearch:2.13.0`
103+
* Running OpenSearch from the command line:
104104
```
105-
docker run -p 9200:9200 -e "http.host=0.0.0.0" -e "transport.host=127.0.0.1" docker.elastic.co/elasticsearch/elasticsearch:7.10.1
105+
docker run -p 9200:9200 -e "discovery.type=single-node" -e "DISABLE_SECURITY_PLUGIN=true" -e "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m" opensearchproject/opensearch:2.13.0
106106
```
107107
* Install PostgreSQL: `apt-get install postgresql postgresql-server-dev-all`
108108
* Help to setup database <https://wiki.debian.org/PostgreSql>
@@ -117,27 +117,27 @@ Follow the instructions below on how to install Bundler and setup the database.
117117
* Use Ruby 3.4.x
118118
* See: [Ruby install instructions](https://www.ruby-lang.org/en/downloads/).
119119
* `.ruby-version` is present and can be used.
120-
* Use Rubygems 3.5.x
120+
* Use Rubygems 3.6.x
121121
* Install bundler:
122122
`gem install bundler`
123123
* Install dependencies and setup the database:
124124
`./bin/setup`
125-
* Set up elasticsearch indexes:
125+
* Set up search indexes:
126126
`bundle exec rake searchkick:reindex CLASS=Rubygem`
127127

128128
### Running tests
129129

130130
Make sure that the tests run successfully before making changes.
131131

132132
* Depending on how you setup your environment, run `docker compose up` or
133-
ensure elasticsearch, memcached, and postgres are running.
133+
ensure opensearch, memcached, and postgres are running.
134134
* Run the tests: `bin/rails test:all`
135135
* See also: [Ruby on Rails testing documentation](https://guides.rubyonrails.org/testing.html).
136136

137137
### Running the application
138138

139139
* Depending on how you setup your environment, run `docker compose up` or
140-
ensure elasticsearch, memcached, and postgres are running.
140+
ensure opensearch, memcached, and postgres are running.
141141
* Start the application: `bin/rails s`
142142
* Visit http://localhost:3000 in your browser.
143143

0 commit comments

Comments
 (0)