lagom-on-k8s

Running on Kubernetes

This project uses Lightbend Orchestration for Kubernetes to simplify deployment of Restaurant to Kubernetes. Follow the steps below to install Restaurant in your own local Kubernetes environment.

Setup

You'll need to ensure that the following software is installed:

• Docker
• VirtualBox
• kubectl
• Minikube v0.28.2 or later (Verify with minikube version)

Build & Deploy

1. Environment Preparation

Start minikube

You can start the Minikube by following command:

(minikube delete || true) &>/dev/null && minikube start --memory 4096 && eval $(minikube docker-env)

Note: It will also setup Docker engine context to point to Minikube

2a. Development Workflow

Note that this is an alternative to the Operations workflow documented below.

sbt-reactive-app defines a task, deploy minikube, that can be used to deploy all aggregated subprojects to your running Minikube. It also installs the Reactive Sandbox if your project needs it, e.g. for Lagom applications that use Cassandra or Kafka.

Build and Deploy Project

sbt> deploy minikube

Once completed, Chirper and its dependencies should be installed in your cluster. Continue with step 3, Verify Deployment.

2b. Operations Workflow

Note that this is an alternative to the Development workflow documented above.

Install Reactive Sandbox

The reactive-sandbox includes development-grade (i.e. it will lose your data) installations of Cassandra, Elasticsearch, Kafka, and ZooKeeper. It's packaged as a Helm chart for easy installation into your Kubernetes cluster.

Note that if you have an external Cassanda cluster, you can skip this step. You'll need to change the cassandra_svc variable (defined below) if this is the case.

helm init
helm repo add lightbend-helm-charts https://repo.lightbend.com/helm-charts
helm update

Verify that Helm is available (this takes a minute or two):

kubectl --namespace kube-system get -w deploy/tiller-deploy

The -w flag will watch for changes. Use CTRL-c to exit.

NAME            DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
tiller-deploy   1         1         1            1           3m

Install the sandbox. Since Chirper only uses Cassandra, we're disabling the other services but you can leave them enabled by omitting the set flag if you wish.

helm install lightbend-helm-charts/reactive-sandbox \
    --name reactive-sandbox \
    --set elasticsearch.enabled=false,kafka.enabled=false,zookeeper.enabled=false

Verify that it is available (this takes a minute or two):

kubectl get -w deploy/reactive-sandbox

NAME               DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
reactive-sandbox   1         1         1            1           1m

Build Project

sbt clean docker:publishLocal

View Images

docker images

Deploy Projects

Finally, you're ready to deploy the services. Be sure to adjust the secret variables and cassanda service address as necessary.

# Be sure to change these secret values

chirp_secret="changeme"
friend_secret="changeme"
activity_stream_secret="changeme"
front_end_secret="changeme"

# Default address for reactive-sandbox, change if using external Cassandra

cassandra_svc="_cql._tcp.reactive-sandbox-cassandra.default.svc.cluster.local"

# Configure the services to allow requests to the minikube IP (Play's Allowed Hosts Filter)

allowed_host="$(minikube ip)"

# deploy chirp-impl

rp generate-kubernetes-resources "chirp-impl:1.0.0-SNAPSHOT" \
  --generate-pod-controllers --generate-services \
  --env JAVA_OPTS="-Dplay.http.secret.key=$chirp_secret -Dplay.filters.hosts.allowed.0=$allowed_host" \
  --external-service "cas_native=$cassandra_svc" \
  --pod-controller-replicas 2 | kubectl apply -f -

# deploy friend-impl

rp generate-kubernetes-resources "friend-impl:1.0.0-SNAPSHOT" \
  --generate-pod-controllers --generate-services \
  --env JAVA_OPTS="-Dplay.http.secret.key=$friend_secret -Dplay.filters.hosts.allowed.0=$allowed_host" \
  --external-service "cas_native=$cassandra_svc" \
  --pod-controller-replicas 2 | kubectl apply -f -

# deploy activity-stream-impl

rp generate-kubernetes-resources "activity-stream-impl:1.0.0-SNAPSHOT" \
  --generate-pod-controllers --generate-services \
  --env JAVA_OPTS="-Dplay.http.secret.key=$activity_stream_secret -Dplay.filters.hosts.allowed.0=$allowed_host" \
  --pod-controller-replicas 2 | kubectl apply -f -

# deploy front-end

rp generate-kubernetes-resources "front-end:1.0.0-SNAPSHOT" \
  --generate-pod-controllers --generate-services \
  --env JAVA_OPTS="-Dplay.http.secret.key=$front_end_secret -Dplay.filters.hosts.allowed.0=$allowed_host" | kubectl apply -f -

# deploy ingress
rp generate-kubernetes-resources \
  --generate-ingress --ingress-name chirper \
  "chirp-impl:1.0.0-SNAPSHOT" \
  "friend-impl:1.0.0-SNAPSHOT" \
  "activity-stream-impl:1.0.0-SNAPSHOT" \
  "front-end:1.0.0-SNAPSHOT" | kubectl apply -f -

3. Verify Deployment

Now that you've deployed your services (using either the Developer or Operations workflows), you can use kubectl to inspect the resources, and your favorite web browser to use the application.

See the resources created for you

kubectl get all

NAME                            DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
deploy/activityservice-v1-5-0   1         1         1            1           2h
deploy/chirpservice-v1-5-0      3         3         3            3           2h
deploy/friendservice-v1-5-0     3         3         3            3           2h
deploy/front-end-v1-5-0         1         1         1            1           2h

NAME                                   DESIRED   CURRENT   READY     AGE
rs/activityservice-v1-5-0-659877cd49   1         1         1         2h
rs/chirpservice-v1-5-0-6548865dc5      3         3         3         2h
rs/friendservice-v1-5-0-66f688897b     3         3         3         2h
rs/front-end-v1-5-0-87c5b6b79          1         1         1         2h

NAME                            DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
deploy/activityservice-v1-5-0   1         1         1            1           2h
deploy/chirpservice-v1-5-0      3         3         3            3           2h
deploy/friendservice-v1-5-0     3         3         3            3           2h
deploy/front-end-v1-5-0         1         1         1            1           2h

NAME                                   DESIRED   CURRENT   READY     AGE
rs/activityservice-v1-5-0-659877cd49   1         1         1         2h
rs/chirpservice-v1-5-0-6548865dc5      3         3         3         2h
rs/friendservice-v1-5-0-66f688897b     3         3         3         2h
rs/front-end-v1-5-0-87c5b6b79          1         1         1         2h

NAME                                         READY     STATUS    RESTARTS   AGE
po/activityservice-v1-5-0-659877cd49-59z4z   1/1       Running   0          2h
po/chirpservice-v1-5-0-6548865dc5-2fjn6      1/1       Running   0          2h
po/chirpservice-v1-5-0-6548865dc5-kgbbb      1/1       Running   0          2h
po/chirpservice-v1-5-0-6548865dc5-zcc6l      1/1       Running   0          2h
po/friendservice-v1-5-0-66f688897b-d22ph     1/1       Running   0          2h
po/friendservice-v1-5-0-66f688897b-fvndd     1/1       Running   0          2h
po/friendservice-v1-5-0-66f688897b-j9tzj     1/1       Running   0          2h
po/front-end-v1-5-0-87c5b6b79-mvnh8          1/1       Running   0          2h

NAME                  TYPE        CLUSTER-IP   EXTERNAL-IP   PORT(S)                         AGE
svc/activityservice   ClusterIP   None         <none>        10000/TCP,10001/TCP,10002/TCP   2h
svc/chirpservice      ClusterIP   None         <none>        10000/TCP,10001/TCP,10002/TCP   2h
svc/friendservice     ClusterIP   None         <none>        10000/TCP,10001/TCP,10002/TCP   2h
svc/front-end         ClusterIP   None         <none>        10000/TCP                       2h

Open the URL this command prints in the browser

echo "http://$(minikube ip)"