Skip to main content

Local Setup

This section will guide you in installing and deploying the Integration Service API on a Kubernetes cluster.

This installation was tested on Kubernetes 1.21.

Requirements​

Please make sure to have the following installed before moving forward:

Clone Integration Services Repository​

Please follow these steps to clone the Integration Services:

  1. Clone the project:

    git clone https://github.com/iotaledger/integration-services.git

  2. Change directory to your freshly cloned project:

    cd integration-services

Start Minikube​

Setup and start the empty cluster by running the following command:

minikube start

Set Up Kong​

  1. Install helm by running the following command:
brew install helm
  1. Add helm repo by running the following command:
helm repo add kong https://charts.konghq.com
  1. Install kong using helm by running the following command:
helm install kong kong/kong
  1. Expose the kong service (Do NOT close this terminal):
sudo minikube tunnel
  1. Open a new terminal and export the PROXY_IP variable by running the following command:
export PROXY_IP=$(kubectl get -o jsonpath="{.status.loadBalancer.ingress[0].ip}" service kong-kong-proxy)

You can check that you have exported the variable correctly by running the following command:

echo $PROXY_IP

It should output the IP you have exported. In most of the cases this will be http://127.0.0.1.

Create the Kong Cluster​

  1. Apply the Kubernetes cluster to kong by running the following command:
kubectl apply -f kubernetes/optional -f kubernetes/ -f kubernetes/kong-gw
  1. You can check if the services are up and running with the following command:
kubectl get services

Expected output:

NAME              TYPE           CLUSTER-IP       EXTERNAL-IP   PORT(S)                      AGE
audit-trail-gw    ClusterIP      10.105.148.167   <none>        3000/TCP                     17h
kong-kong-proxy   LoadBalancer   10.97.208.78     127.0.0.1     80:30959/TCP,443:32326/TCP   17h
kubernetes        ClusterIP      10.96.0.1        <none>        443/TCP                      21h
mongodb-service   ClusterIP      10.106.253.44    <none>        27017/TCP                    17h
ssi-bridge        ClusterIP      10.110.29.161    <none>        3000/TCP                     17h

You can check if the pods are running with the following command. It will take a few minutes before all pods are running.

kubectl get pods

Expected output:


NAME                                  READY   STATUS      RESTARTS        AGE
audit-trail-gw-557959d777-52p94       1/1     Running     0               9m8s
audit-trail-gw-557959d777-cmqvg       1/1     Running     0               9m8s
generate-key--1-zbz7x                 0/1     Completed   0               9m8s
kong-75757c49b6-pptwm                 2/2     Running     0               26m
kong-75757c49b6-zgqkg                 2/2     Running     0               26m
kong-postgresql-0                     1/1     Running     0               26m
mongodb-deployment-5f89c7c88f-nr5xv   1/1     Running     0               9m9s
ssi-bridge-f849f7fc7-fhg6g            1/1     Running     2 (7m42s ago)   9m8s
ssi-bridge-f849f7fc7-t4msg            1/1     Running     2 (7m42s ago)   9m8s
  1. Check if the services are up and running:

In few minutes, depending on how many resources you allocated, the Integration Service API will be ready to handle requests. Once the generate-key pod is completed and the audit-trail and ssi-bridge pods are running, you can check if they are available with following two commands:

curl -i $PROXY_IP/ssi-bridge/info
curl -i $PROXY_IP/audit-trail-gw/info

You finished the setup of the Integration Services using Kubernetes!

  • You set up a single MongoDB instance with an ephemeral storage (i.e. no persistent bound volume) with root as username and rootpasswordas password for administration purpose and username and password as credentials for the database integration-service.
  • You run a Kubernetes Job that will create a root identity in the database if there is not one yet.
  • You created replicated backend service for Integration Service API (2 replicas as default value).

You can find information on how to configure Integration Service with a production-ready database in the configuration section.

FAQ​

How can I stop the cluster?

Just run the following command to stop the cluster.

kubectl delete -f kubernetes/optional -f kubernetes/ -f kubernetes/kong-gw

How can I delete my whole Kubernetes cluster?

  1. First, shut down the cluster by running:
kubectl delete -f kubernetes/optional -f kubernetes/ -f kubernetes/kong-gw

  1. Close all open terminal windows.

  2. Delete the kong load balancer by running the following command:

helm delete kong
  1. Delete the minikube container containing the cluster
minikube delete