You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@solr.apache.org by ho...@apache.org on 2021/05/24 16:23:09 UTC

[solr] branch main updated: SOLR-15241: Add Docker & Kubernetes info to the README (#141)

This is an automated email from the ASF dual-hosted git repository.

houston pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/solr.git


The following commit(s) were added to refs/heads/main by this push:
     new f7a3f7e  SOLR-15241: Add Docker & Kubernetes info to the README (#141)
f7a3f7e is described below

commit f7a3f7e8d2652dc9cc62942a9eea693d3f39a94b
Author: Houston Putman <ho...@apache.org>
AuthorDate: Mon May 24 12:23:02 2021 -0400

    SOLR-15241: Add Docker & Kubernetes info to the README (#141)
---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/README.md b/README.md
index 1118a35..4ba4982 100644
--- a/README.md
+++ b/README.md
@@ -90,6 +90,37 @@ Common options are described in some detail in solr/README.txt.  For an
 exhaustive treatment of options, run `bin/solr start -h` from the `solr/`
 directory.
 
+### Running Solr in Docker
+
+You can run Solr in Docker via the [official image](https://hub.docker.com/_/solr).
+
+To run Solr in a container and expose the Solr port, run:
+
+`docker run -p 8983:8983 solr`
+
+In order to start Solr in cloud mode, run the following.
+
+`docker run -p 8983:8983 solr solr-fg -c`
+
+For documentation on using the official docker builds, please refer to the [DockerHub page](https://hub.docker.com/_/solr).  
+Up to date documentation for running locally built images of this branch can be found in the [local reference guide](solr/solr-ref-guide/src/running-solr-in-docker.adoc).
+
+There is also a gradle task for building custom Solr images from your local checkout.
+These local images are built identically to the official image except for retrieving the Solr artifacts locally instead of from the official release.
+This can be useful for testing out local changes as well as creating custom images for yourself or your organization.
+The task will output the image name to use at the end of the build.
+
+`./gradlew docker`
+
+For more info on building an image, run:
+
+`./gradlew helpDocker`
+
+### Running Solr on Kubernetes
+
+Solr has official support for running on Kubernetes, in the official Docker image.
+Please refer to the [Solr Operator](https://solr.apache.org/operator) home for details, tutorials and instructions.
+
 ### Gradle build and IDE support
 
 - *IntelliJ* - IntelliJ idea can import the project out of the box.