DaprSample

Distributed resilient microservices sample API with dotnet 6 and dapr. This document is designed to set up a dev environment on a Windows system [Recommended].

Pre-requisite

• Engineering laptop or desktop computer with 16-64GB RAM and Windows 10 or later.
• System administrator rights on laptop or desktop computer.

Install Chocolatey

Chocolatey

• For existing choco, upgrade it

      choco upgrade Chocolatey -y

• For new installation with windows command prompt [CMD]

    #Execute on CMD in admin mode
  
    @"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -NoProfile -InputFormat None -ExecutionPolicy Bypass -Command "[System.Net.ServicePointManager]::SecurityProtocol = 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))" && SET "PATH=%PATH%;%ALLUSERSPROFILE%\chocolatey\bin"
  

• For new installation with PowerShell

    #Execute on PowerShell in admin mode
  
    Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))
  

Install Dotnet 6 SDK

Dotnet 6 SDK

• For manual installation, download and install it.

• For existing dotnet sdk, upgrade it

  choco upgrade dotnet-6.0-sdk -y

• With Chocolatey

  choco install dotnet-6.0-sdk -y

Install Git

Git

• For manual installation, download and install it.

• For new installation with Chocolatey, Reference.

  choco install git -y

Install WSL

WSL

• Install WSL2 on Windows 10

    #Execute on PowerShell in admin mode
    wsl --install

• Restart your computer to finish the WSL installation on Windows 10 or later.

• Set up your Linux username and password, Reference.

• Confirm platform

    #Execute on PowerShell in admin mode
      wsl --list --verbose
      or
      wsl -l -v

• Enable Windows Subsystem for Linux 2, Ignore if already set

    #Execute on PowerShell in admin mode
    wsl --set-default-version 2
    or
    wsl --set-version Ubuntu 2

• Reference to install WSL2 on windows 10 or later.

Install Docker Desktop

Docker Desktop

• For manual installation, download and install it.

• With Chocolatey, Docker Desktop and Docker Engine,

  #Execute on PowerShell in admin mode
  choco install docker-desktop -y

• After installation,restart your system and run the Docker desktop.

• Enable Kubernetes(Setting->Kubernetes->Enable Kubernetes).

  Note: After installation, keep docker desktop in running state.

Install Kubernetes cli (kubectl)

kubectl

• For existing kubectl, upgrade it

  #Execute on PowerShell in admin mode
   choco upgrade Kubernetes-cli -y 
  
  #Verify installation
   kubectl version --client

• For new installation.

  #Execute on PowerShell in admin mode
   choco install kubernetes-cli -y
  
  #Verify installation
   kubectl version --client

• Reference document for installation.

Install Helm cli (helm)

helm

• For new installation.

  #Execute on PowerShell in admin mode
   choco install kubernetes-helm -y
  
  #Verify installation
   helm version

• For existing helm, upgrade it

  #Execute on PowerShell in admin mode
  choco upgrade Kubernetes-helm -y
  
  #Verify installation
   helm version

• Reference document for installation.

Install MsSqlServer

• Start docker desktop [Ignore if it's already running].

  #Execute on PowerShell in admin mode
  docker pull mcr.microsoft.com/mssql/server:2019-latest
  cd C:\install
  
  #Git clone this:
  git clone https://github.com/microsoft/mssql-docker
  
  #Navigate to linux based chart.
  cd .\mssql-docker\linux\sample-helm-chart\
  
  #Helm install this:
  helm install sqlserver . --set sa_password=Welcome@123 --set pvc.StorageClass=hostpath
  #Installed in k8s default namespace

Install Sql Server Management Studio(SSMS)

• Manually download and install it.

• With Chocolatey.

  #Execute on PowerShell in admin mode
   choco install ssms -y

• Start docker desktop [Ignore if it's already running].

• Start SSMS and try to connect with sql server:

  Server: localhost,1433 User: sa Password: Welcome@123

Install Visual Studio

Visual Studio

• For manual installation, download and install it [Recommended].

• For new installation with Chocolatey, Reference.

  choco install visualstudio2022community
  or
  choco install visualstudio2022community --package-parameters "--allWorkloads --includeRecommended --includeOptional --passive --locale en-US"

Install Windows Terminal

Terminal

• Reference document to set up it.

Install PowerShell 7

PowerShell7

• For manual installation, Download and install it.

• With Chocolatey.

  #Execute on PowerShell in admin mode
   choco install powershell-core -y

Install OpenSsl

OpenSsl

• For manual installation, Download and install it.

• With Chocolatey.

  #Execute on PowerShell in admin mode
   choco install openssl -y

Install Github Desktop

Github Desktop

• For manual installation, download and install it.

• For new installation with Chocolatey, Reference.

  choco install github-desktop -y

• Configure it with your github account.

  Note: Use any Git UI tool as per your choice.

Install Lens for Kubernetes

Lens

• For manual installation, download and install it.

• For new installation with Chocolatey, Reference.

  #Execute on PowerShell in admin mode
  choco install lens -y

Install the Dapr CLI

Dapr

• For new installation.

  #Execute on PowerShell in admin mode
   Set-ExecutionPolicy RemoteSigned -scope CurrentUser;
   powershell -Command "iwr -useb https://raw.githubusercontent.com/dapr/cli/master/install/install.ps1 | iex"
  
  
  #Verify installation (run this in new terminal)
   dapr

• For existing dapr, upgrade it

  #Execute on PowerShell in admin mode
   dapr upgrade

Dapr initialization in self-hosted mode

#Execute on PowerShell in admin mode
dapr init
#Verify Dapr version
dapr --version

Here, dapr self-hosted mode initialization created dapr_redis,dapr_zipkin. You need to delete them for forever as we will deploy these separately later on.

Dapr initialization in local K8s

#Execute on PowerShell in admin mode
dapr init -k
#Verify Dapr version
dapr status -k

Create namespace in local k8s

 kubectl create ns vik

Add helm repos

helm repo add bitnami https://charts.bitnami.com/bitnami 
helm repo add jetstack https://charts.jetstack.io
helm repo add kafka-ui https://provectus.github.io/kafka-ui
helm repo update
helm repo list

Install Kafka

• Zookeeper

  helm install zookeeper bitnami/zookeeper --set replicaCount=1 --set auth.enabled=false --set allowAnonymousLogin=true -n vik
  
  #ZooKeeper can be accessed via port 2181 on the following DNS name from within your cluster:
  # zookeeper.vik.svc.cluster.local
  
  #To connect to your ZooKeeper server from outside the cluster execute the following commands:
  
    kubectl port-forward --namespace vik svc/zookeeper 2181:2181 & zkCli.sh 127.0.0.1:2181
  

• Kafka

  helm install kafka bitnami/kafka --set zookeeper.enabled=false --set replicaCount=1 --set externalZookeeper.servers=zookeeper.vik.svc.cluster.local --set externalAccess.enabled=true --set externalAccess.service.type=LoadBalancer --set externalAccess.autoDiscovery.enabled=true --set rbac.create=true --set autoCreateTopicsEnable=true --set deleteTopicEnable=true -n vik
  #Kafka can be accessed by consumers via port 9092 on the following DNS name from within your cluster:
  
   # kafka.vik.svc.cluster.local
  
  #Each Kafka broker can be accessed by producers via port 9092 on the following DNS name(s) from within your cluster:
  
   # kafka-0.kafka-headless.vik.svc.cluster.local:9092
   #  Kafka Brokers port: 9094

• Create Kafka topic

  kubectl --namespace vik exec -it kafka-0 -- kafka-topics.sh --create --topic mytopic --replication-factor 1 --partitions 1 --bootstrap-server kafka.vik.svc.cluster.local:9092

Install Redis

helm install redis bitnami/redis --set auth.enabled=false -n vik
# create load balancer
kubectl expose service redis-master -n vik --port=6379 --target-port=6379 --name=redis-external --type=LoadBalancer

Install Zipkin

# Pull Zipkin image
docker pull openzipkin/zipkin
# Create Zipkin deployment in k8s
kubectl create deployment zipkin --image openzipkin/zipkin -n vik
# Create Zipkin service
kubectl expose deployment zipkin --type ClusterIP --port 9411 -n vik
# Create Zipkin load balancer
kubectl expose service zipkin -n vik --port=9411 --target-port=9411 --name=zipkin-external --type=LoadBalancer
# http://localhost:9411/zipkin/

Install Kafka UI

# Pull Kafka-UI image
docker pull provectuslabs/kafka-ui
# Create Kafka-UI deployment in k8s
kubectl run kafka-ui --image provectuslabs/kafka-ui --env="KAFKA_CLUSTERS_0_BOOTSTRAPSERVERS=kafka-0.kafka-headless.vik.svc.cluster.local:9093" --port=8080 -n vik
# Create Kafka-UI service
kubectl expose pod kafka-ui --type ClusterIP --port 8080 -n vik
# Create Kafka-UI load balancer
kubectl expose service kafka-ui -n vik --port=8080 --target-port=8080 --name=kafka-ui-external --type=LoadBalancer
# http://localhost:8080

Run dapr sidecar in self-hosted mode

# Navigate to **src** folder path in terminal.

dapr run --app-id="sample-api" --app-port=5000 --dapr-grpc-port=53000 --dapr-http-port=53001

# Now, run SampleAPI project with following launch setting:
"profiles": {
    "SampleAPI": {
      "commandName": "Project",
      "launchBrowser": true,
      "launchUrl": "swagger",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development",
        "DAPR_GRPC_PORT": "53000",
        "DAPR_HTTP_PORT": "53001"
      },
      "applicationUrl": "https://localhost:7117;http://localhost:5117",
      "dotnetRunMessages": true
    }
# Now, call API with swagger endpoint

Install Dapr Component in k8s

# Navigate to **local-cluster** folder path in terminal. 
kubectl apply -f ./dapr-config.yaml -n vik
kubectl apply -f ./kafka-pubsub.yaml -n vik
kubectl apply -f ./state-redis.yaml -n vik
kubectl apply -f ./dapr-secrets.yaml -n vik

Deploy SampleAPI in k8s

• publish SampleAPI image in docker sampleapi:latest (Right click on Dockerfile-> Build Docker Image)

   # Navigate to **local-cluster** folder path in terminal.
   kubectl apply -f ./service-deployment.yaml -n vik
   kubectl port-forward --namespace vik svc/sample-api 51000:80
   # http://localhost:51000/swagger/index.html

Troubleshooting

• Helm charts are not able to pull images due to low internet speed. In this case, pull images explicitly.