Customizing SDK Components

Overview

This guide documents how to run customized components in your own Scroll SDK deployment. We’ll see how to modify a service, build a custom Docker image, and deploy your changes to an existing Scroll SDK deployment.

Prerequisites

1. Clone the scroll-sdk repo to your local machine
2. Install dependencies:
   • Docker
   • kubectl
   • minikube
   • Helm
3. Verify installations by running:
   • docker -v
   • kubectl version
   • minikube status
   • helm version

Modifying a Service

1. Clone the repository of the service you want to modify
2. Make your desired code modifications
3. Test your changes locally

Available Services

Building a Custom Docker Image

1. Locate the Dockerfile for your service

2. Build the image:

   docker build -f <dockerfile> -t <service-name>:<version> .

3. Choose one of two options for making the image available:

   Option 1: Publish to Docker Hub

   docker login
   docker push <your_docker_user_name>/<service_name>:<version>

   Option 2: Load Directly to Minikube

   minikube image load <service_name>:<version>

Updating the Service Configuration

1. Locate the values.yaml file for your service in devnet/scroll-sdk/charts/<service-name>/values.yaml

2. Update the image field based on your chosen deployment method:

   For published Docker Hub images:

   image:
     repository: <your_docker_user_name>/<service_name>
     pullPolicy: Always
     tag: <version>

   For local Minikube images:

   image:
     repository: <service_name>
     tag: <version>

3. Apply your changes:

   make install

4. Verify the deployment:

   kubectl get pods