solr-operator icon indicating copy to clipboard operation
solr-operator copied to clipboard

Local tutorial corrections

Open sigram opened this issue 5 years ago • 3 comments

Describe the bug Local tutorial on a fresh Mac doesn't work, it needs additional steps.

Environment (please complete the following information):

  • Operating System and Version: macOS 10.15.7 (Catalina)
  • Hardware: Macbook Pro 2015 / i7 2.6GHz / 32 GB RAM

Additions & corrections to the tutorial

  • before calling brew cask install docker-edge the following was required, otherwise brew couldn't find this cask: brew tap homebrew/cask-versions

  • when you first run the Docker.app you need to check "Enable Kubernetes" in the Kubernetes tab, and "Apply & Restart".

  • "visiting the Kubernetes dashboard" - for a Kubernetes newbie this is totally cryptic, it should probably direct the user to the later section on installing the dashboard.

  • "Create a collection" section should probably add ?commit=true when indexing new docs to make them immediately visible for searching. For Solr newbies it may be confusing that search will still return 0 docs for a while.

  • following the example "scaling up" section, adding more (docker) replicas resulted in some instability - occasionally instead of 5 it would show 4 nodes, and the kubectl proxy would show: http: proxy error: context canceled

sigram avatar Oct 26 '20 14:10 sigram

I noticed that the default setting for docker-edge is to use osxfs, which results in high CPU usage. It would be nice to mention that users can switch to gRPC FUSE by checking the option "Include VM in Time Machine backups" in General > Settings.

Also, due to numerous bugs in com.docker.hyperkit when using the Kubernetes option in Docker.app there's significant CPU overhead, around 200% or more.

sigram avatar Oct 26 '20 17:10 sigram

Thanks for finding these issues! It's easy to miss some of the setup steps when you are writing these instructions after-the-fact.

For posterity, @sigram and I have also been talking about using microk8s in the tutorial, which relates to #111. Some of these changes are applicable regardless, but the first two certainly would change with the shift to microk8s.

HoustonPutman avatar Oct 28 '20 16:10 HoustonPutman

Additional thing I found going through the tutorial that I think fits here in terms of small corrections

  • Missing a /solr in the Execute the Collection API command
# Execute the Collections API command
curl "http://default-example-solrcloud.ing.local.domain/solr/admin/collections?action=CREATE&name=mycoll&numShards=1&replicationFactor=3&maxShardsPerNode=2&collection.configName=_default"

# Check in Admin UI that collection is created
open "http://default-example-solrcloud.ing.local.domain/solr/#/~cloud?view=graph"

nosvalds avatar Jun 04 '21 09:06 nosvalds