docs/modules/getting-started/pages/local-tutorial.adoc

= Solr on Kubernetes on local Mac
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

This tutorial shows how to setup Solr under Kubernetes on your local mac. The plan is as follows:

. xref:getting-started:local-tutorial.adoc#setup-kubernetes-and-dependencies[Setup Kubernetes and Dependencies]
.. xref:getting-started:local-tutorial.adoc#setup-docker-for-mac-with-k8s[Setup Docker for Mac with K8S]
.. xref:getting-started:local-tutorial.adoc#install-an-ingress-controller[Install an Ingress Controller to reach the cluster on localhost]
. xref:getting-started:local-tutorial.adoc#install-the-solr-operator[Install Solr Operator]
. xref:getting-started:local-tutorial.adoc#start-an-example-solr-cloud-cluster[Start your Solr cluster]
. xref:getting-started:local-tutorial.adoc#create-a-collection-and-index-some-documents[Create a collection and index some documents]
. xref:getting-started:local-tutorial.adoc#scale-from-3-to-5-nodes[Scale from 3 to 5 nodes]
.. xref:getting-started:local-tutorial.adoc#horizontal-pod-autoscaler-hpa[Using the Horizontal Pod Autoscaler]
. xref:getting-started:local-tutorial.adoc#upgrade-to-newer-version[Upgrade to newer Solr version]
. xref:getting-started:local-tutorial.adoc#install-kubernetes-dashboard-optional[Install Kubernetes Dashboard (optional)]
. xref:getting-started:local-tutorial.adoc#delete-the-solrcloud-cluster-named-example[Delete the solrCloud cluster named 'example']

== Setup Kubernetes and Dependencies

=== Setup Docker for Mac with K8s

[source,bash]
----
# Install Homebrew, if you don't have it already
/bin/bash -c "$(curl -fsSL \
	https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

# Install Docker Desktop for Mac (use edge version to get latest k8s)
brew install --cask docker

# Enable Kubernetes in Docker Settings, or run the command below:
sed -i -e 's/"kubernetesEnabled": false/"kubernetesEnabled": true/g' \
    ~/Library/Group\ Containers/group.com.docker/settings.json

# Start Docker for mac from Finder, or run the command below
open /Applications/Docker.app

# Install Helm, which we'll use to install the operator, and 'watch'
brew install helm watch
----

=== Install an Ingress Controller

Kubernetes services are by default only accessible from within the k8s cluster. To make them adressable from our laptop, we'll add an ingress controller

[source,bash]
----
# Install the nginx ingress controller
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/cloud/deploy.yaml

# Inspect that the ingress controller is running by visiting the Kubernetes dashboard
# and selecting namespace `ingress-nginx`, or running this command:
kubectl get all --namespace ingress-nginx

# Edit your /etc/hosts file (`sudo vi /etc/hosts`) and replace the 127.0.0.1 line with:
127.0.0.1	localhost default-example-solrcloud.ing.local.domain ing.local.domain default-example-solrcloud-0.ing.local.domain default-example-solrcloud-1.ing.local.domain default-example-solrcloud-2.ing.local.domain dinghy-ping.localhost
----

Once we have installed Solr to our k8s, this will allow us to address the nodes locally.

== Install the Solr Operator

You can follow along here, or follow the instructions in the https://artifacthub.io/packages/helm/apache-solr/solr-operator[Official Helm release].

Now that we have the prerequisites setup, let us install Solr Operator which will let us easily manage a large Solr cluster:

Now add the Solr Operator Helm repository. (You should only need to do this once)

[source,bash]
----
$ helm repo add apache-solr https://solr.apache.org/charts
$ helm repo update
----

Next, install the Solr Operator chart. Note this is using Helm v3, in order to use Helm v2 please consult the https://hub.helm.sh/charts/solr-operator/solr-operator[Helm Chart documentation].
This will install the https://github.com/pravega/zookeeper-operator[Zookeeper Operator] by default.

[source,bash,subs="verbatim,attributes"]
----
# Install the Solr & Zookeeper CRDs
$ kubectl create -f https://solr.apache.org/operator/downloads/crds/v{operator-version}/all-with-dependencies.yaml
# Install the Solr operator and Zookeeper Operator
$ helm install solr-operator apache-solr/solr-operator --version {operator-version}
----

_Note that the Helm chart version does not contain a `v` prefix, which the downloads version does. The Helm chart version is the only part of the Solr Operator release that does not use the `v` prefix._

After installing, you can check to see what lives in the cluster to make sure that the Solr and ZooKeeper operators have started correctly.

[source,bash]
----
$ kubectl get all

NAME                                                   READY   STATUS             RESTARTS   AGE
pod/solr-operator-8449d4d96f-cmf8p                     1/1     Running            0          47h
pod/solr-operator-zookeeper-operator-674676769c-gd4jr  1/1     Running            0          49d

NAME                                              READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/solr-operator                     1/1     1            1           49d
deployment.apps/solr-operator-zookeeper-operator  1/1     1            1           49d

NAME                                                         DESIRED   CURRENT   READY   AGE
replicaset.apps/solr-operator-8449d4d96f                     1         1         1       2d1h
replicaset.apps/solr-operator-zookeeper-operator-674676769c  1         1         1       49d
----

After inspecting the status of you Kube cluster, you should see a deployment for the Solr Operator as well as the Zookeeper Operator.

== Start an example Solr Cloud cluster

To start a Solr Cloud cluster, we will create a yaml that will tell the Solr Operator what version of Solr Cloud to run, and how many nodes, with how much memory etc.

[source,bash,subs="verbatim,attributes"]
----
# Create a 3-node cluster v9.10.0 with 300m Heap each:
helm install example-solr apache-solr/solr --version {operator-version} \
  --set image.tag=9.10.0 \
  --set solrOptions.javaMemory="-Xms300m -Xmx300m" \
  --set addressability.external.method=Ingress \
  --set addressability.external.domainName="ing.local.domain" \
  --set addressability.external.useExternalAddress="true" \
  --set ingressOptions.ingressClassName="nginx"

# The solr-operator has created a new resource type 'solrclouds' which we can query
# Check the status live as the deploy happens
kubectl get solrclouds -w

# Open a web browser to see a solr node:
# Note that this is the service level, so will round-robin between the nodes
open "http://default-example-solrcloud.ing.local.domain/solr/#/~cloud?view=nodes"
----

== Create a collection and index some documents

Create a collection via the https://solr.apache.org/guide/8_8/collection-management.html#create[Collections API].

[source,bash]
----
# 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"
----

Now index some documents into the empty collection.

[source,bash]
----
curl -XPOST -H "Content-Type: application/json" \
    -d '[{id: 1}, {id: 2}, {id: 3}, {id: 4}, {id: 5}, {id: 6}, {id: 7}, {id: 8}]' \
    "http://default-example-solrcloud.ing.local.domain/solr/mycoll/update/"
----

== Scale from 3 to 5 nodes

So we wish to add more capacity. Scaling the cluster is a breeze.

[source,bash]
----
# Issue the scale command
kubectl scale --replicas=5 solrcloud/example
----

After issuing the scale command, start hitting the "Refresh" button in the Admin UI.
You will see how the new Solr nodes are added.
You can also watch the status via the `kubectl get solrclouds` command:

[source,bash]
----
kubectl get solrclouds -w

# Hit Control-C when done
----

=== Horizontal Pod Autoscaler (HPA)

The SolrCloud CRD is setup so that it is able to run with the HPA.
Merely use the following when creating an HPA object:

[source,yaml]
----
apiVersion: autoscaling/v2
kind: HorizontalPodAutoscaler
metadata:
  name: example-solr
spec:
  maxReplicas: 6
  minReplicas: 3
  scaleTargetRef:
    apiVersion: solr.apache.org/v1beta1
    kind: SolrCloud
    name: example
  metrics:
    ....
----

Make sure that you are not overwriting the `SolrCloud.Spec.replicas` field when doing `kubectl apply`,
otherwise you will be undoing the autoscaler's work.
By default, the helm chart does not set the `replicas` field, so it is safe to use with the HPA.

== Upgrade to newer version

So we wish to upgrade to a newer Solr version:

[source,bash,subs="verbatim,attributes"]
----
# Take note of the current version
curl -s http://default-example-solrcloud.ing.local.domain/solr/admin/info/system | grep solr-i

# Update the solrCloud configuration with the new version, keeping all previous settings and the number of nodes set by the autoscaler.
helm upgrade example-solr apache-solr/solr --version {operator-version} \
  --reuse-values \
  --set image.tag=9.10.0

# Click the 'Show all details" button in Admin UI and start hitting the "Refresh" button
# See how the operator upgrades one pod at a time. Solr version is in the 'node' column
# You can also watch the status with the 'kubectl get solrclouds' command
kubectl get solrclouds -w

# Hit Control-C when done
----

== Install Kubernetes Dashboard (optional)

Kubernetes Dashboard is a web interface that gives a better overview of your k8s cluster than only running command-line commands. This step is optional, you don't need it if you're comfortable with the cli.

[source,bash]
----
# Install the Dashboard
kubectl apply -f https://raw.githubusercontent.com/kubernetes/dashboard/v2.0.4/aio/deploy/recommended.yaml

# You need to authenticate with the dashboard. Get a token:
kubectl -n kubernetes-dashboard describe secret \
    $(kubectl -n kubernetes-dashboard get secret | grep default-token | awk '{print $1}') \
    | grep "token:" | awk '{print $2}'

# Start a kube-proxy in the background (it will listein on localhost:8001)
kubectl proxy &

# Open a browser to the dashboard (note, this is one long URL)
open "http://localhost:8001/api/v1/namespaces/kubernetes-dashboard/services/https:kubernetes-dashboard:/proxy/#/overview?namespace=default"

# Select 'Token' in the UI and paste the token from last step (starting with 'ey...')
----

== Delete the solrCloud cluster named 'example'

[source,bash]
----
kubectl delete solrcloud example
----