Merge pull request #79 from peterzhongyi/om2

Migrate Guess the Sketch demo from using OM1 to OM2

Author: gongmax

examples/guess-the-sketch/README.md

@@ -31,7 +31,22 @@ presented with three predefined prompts and asked to select one of them._
    cd ${CUR_DIR:?}/examples/guess-the-sketch
    skaffold run --build-concurrency=0 --cache-artifacts=false
    ```
-1. Install the frontend, match maker, and open match into your cluster:
+1. Deploy Open Match 2 on Cloud Run by following [the documention](https://github.com/googleforgames/open-match2/blob/main/docs/DEVELOPMENT.md).
+   - NOTE: before running `gcloud run services replace service.yaml` to deploy Open Match 2, make sure to:
+      - Replace the IP address of the `OM_REDIS_WRITE_HOST` and `OM_REDIS_READ_HOST` in the [`service.yaml`](https://github.com/googleforgames/open-match2/blob/main/deploy/service.yaml) file to be the IP address of the Redis instance you created.
+      - Replace the `run.googleapis.com/network-interfaces` field to use the network and subnetwork configured by terraform. In this case, it's `vpc-genai-quickstart` and `sn-usc1`.
+      - Replace the `cloud.googleapis.com/location` field to be the location of your `sn-usc1` subnetwork (us-central1 if you followed the top level [README](https://github.com/googleforgames/GenAI-quickstart/blob/main/README.md)).
+1. Configure Open Match 2's permissions to your cluster.
+   - Create a Google Service Account in your project and give it the `Cloud Run Invoker` role.
+   - Replace the value of `iam.gke.io/gcp-service-account` of `frontend_k8s.yaml` and `director_k8s.yaml` to be the Google Service Account you created.
+   - Bind the Kubernetes Service Account in `frontend_k8s.yaml` and `director_k8s.yaml` to the Google Service Account(in the form of `SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com`) with 
+   ```
+   gcloud iam service-accounts add-iam-policy-binding   --role roles/iam.workloadIdentityUser   --member "serviceAccount:PROJECT_ID.svc.id.goog[genai/frontend-sa]"   YOUR_GOOGLE_SERVICE_ACCOUNT
+
+   gcloud iam service-accounts add-iam-policy-binding   --role roles/iam.workloadIdentityUser   --member "serviceAccount:PROJECT_ID.svc.id.goog[genai/fleet-allocator]"   YOUR_GOOGLE_SERVICE_ACCOUNT
+   ```
+   - Replace the value of `OM_CORE_ADDRESS` environment variable in `frontend_k8s.yaml` and `director_k8s.yaml` to be the url of the OM2 that's deployed on Cloud Run.
+1. Install the frontend and match maker into your cluster:
    - (optional) If you want to enable the consent screen, update `examples/guess-the-sketch/matchmaker/frontend/k8s.yaml` to set `showConsentPage` to `true` before running the `skaffold` command.
    ```
    cd ${CUR_DIR:?}/examples/guess-the-sketch/matchmaker

examples/guess-the-sketch/fleet.yaml

@@ -31,7 +31,7 @@ spec:
         spec:
           containers:
             - name: guess-the-sketch-app
-              image: guess-the-sketch-app
+              image: guess-the-sketch
               resources:
                 requests:
                   memory: 256Mi

…he-sketch/matchmaker/director/Dockerfile …he-sketch/matchmaker/Director.Dockerfileexamples/guess-the-sketch/matchmaker/director/Dockerfile renamed to examples/guess-the-sketch/matchmaker/Director.Dockerfile examples/guess-the-sketch/matchmaker/director/Dockerfile renamed to examples/guess-the-sketch/matchmaker/Director.Dockerfile

@@ -22,7 +22,9 @@ COPY go.mod go.sum ./
 RUN go mod download
 
 # Copy source code into the image
-COPY *.go ./
+COPY director/*.go ./
+COPY omclient/ ./omclient
+COPY logging/ ./logging
 
 # Build
 RUN CGO_ENABLED=0 GOOS=linux go build -o /app/director

…he-sketch/matchmaker/frontend/Dockerfile …he-sketch/matchmaker/Frontend.Dockerfileexamples/guess-the-sketch/matchmaker/frontend/Dockerfile renamed to examples/guess-the-sketch/matchmaker/Frontend.Dockerfile examples/guess-the-sketch/matchmaker/frontend/Dockerfile renamed to examples/guess-the-sketch/matchmaker/Frontend.Dockerfile

@@ -22,8 +22,10 @@ COPY go.mod go.sum ./
 RUN go mod download
 
 # Copy source code into the image
-COPY *.go ./
-COPY static/ /app/static/
+COPY frontend/*.go ./
+COPY frontend/static/ /app/static/
+COPY omclient/ ./omclient
+COPY logging/ ./logging
 
 # Build
 RUN CGO_ENABLED=0 GOOS=linux go build -o /app/frontend

…ess-the-sketch/matchmaker/mmf/Dockerfile …ess-the-sketch/matchmaker/Mmf.Dockerfileexamples/guess-the-sketch/matchmaker/mmf/Dockerfile renamed to examples/guess-the-sketch/matchmaker/Mmf.Dockerfile examples/guess-the-sketch/matchmaker/mmf/Dockerfile renamed to examples/guess-the-sketch/matchmaker/Mmf.Dockerfile

@@ -23,7 +23,9 @@ RUN go mod download
 
 # Copy source code into the image
 RUN mkdir /app
-COPY *.go ./
+COPY mmf/*.go ./
+COPY omclient/ ./omclient
+COPY logging/ ./logging
 
 # Build
 RUN CGO_ENABLED=0 GOOS=linux go build -o /app/mmf

examples/guess-the-sketch/matchmaker/director/director.go

@@ -17,61 +17,42 @@ package main
 import (
 	"context"
 	"fmt"
-	"io"
 	"log"
 	"time"
 
-	"google.golang.org/grpc"
 	"google.golang.org/protobuf/types/known/anypb"
-	"open-match.dev/open-match/pkg/pb"
 
 	allocationv1 "agones.dev/agones/pkg/apis/allocation/v1"
 	"agones.dev/agones/pkg/client/clientset/versioned"
-	"google.golang.org/grpc/credentials/insecure"
+	pb2 "github.com/googleforgames/open-match2/v2/pkg/pb"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/rest"
 
-	_ "k8s.io/client-go/plugin/pkg/client/auth/gcp"
-)
+	"matchmaker/omclient"
 
-const (
-	omApiHost  = "open-match-backend.open-match.svc.cluster.local:50505"
-	mmfApiHost = "guess-the-sketch-mmf.genai.svc.cluster.local"
-	mmfApiPort = 50502
+	_ "k8s.io/client-go/plugin/pkg/client/auth/gcp"
 )
 
 type Client struct {
-	BackendServiceClient       pb.BackendServiceClient
-	CloserBackendServiceClient func() error
-	AgonesClientset            versioned.Interface
+	AgonesClientset versioned.Interface
+	OmClient        *omclient.RestfulOMGrpcClient
 }
 
 func main() {
 	log.Println("Starting Director")
 
 	for range time.Tick(time.Second) {
-
-		omBackendClient, omCloser := createOMBackendClient()
-
 		var r Client
 		r.AgonesClientset = createAgonesClient()
-		r.BackendServiceClient = omBackendClient
-		r.CloserBackendServiceClient = omCloser
+		r.OmClient = omclient.CreateOMClient()
 
 		if err := r.run(); err != nil {
 			log.Println("Error running director:", err.Error())
 		}
 	}
 }
 
-func createOMBackendClient() (pb.BackendServiceClient, func() error) {
-	conn, err := grpc.Dial(omApiHost, grpc.WithTransportCredentials(insecure.NewCredentials()))
-	if err != nil {
-		panic(err)
-	}
-	return pb.NewBackendServiceClient(conn), conn.Close
-}
-
 func createAgonesClient() *versioned.Clientset {
 	config, err := rest.InClusterConfig()
 	if err != nil {
@@ -85,21 +66,41 @@ func createAgonesClient() *versioned.Clientset {
 }
 
 // Customize the backend.FetchMatches request, the default one will return all tickets in the statestore
-func createOMFetchMatchesRequest() *pb.FetchMatchesRequest {
-	return &pb.FetchMatchesRequest{
+func createOMFetchMatchesRequest() *pb2.MmfRequest {
+	config, err := rest.InClusterConfig()
+	if err != nil {
+		fmt.Printf("failed to get K8s config: %v\n", err)
+		return &pb2.MmfRequest{}
+	}
+
+	client, err := kubernetes.NewForConfig(config)
+	if err != nil {
+		fmt.Printf("failed to create K8s client: %v\n", err)
+		return &pb2.MmfRequest{}
+	}
+
+	service, err := client.CoreV1().Services("genai").Get(context.Background(), "guess-the-sketch-mmf", metav1.GetOptions{})
+	if err != nil {
+		fmt.Printf("Failed to get service: %v\n", err)
+		return &pb2.MmfRequest{}
+	}
+	if len(service.Status.LoadBalancer.Ingress) <= 0 {
+		fmt.Println("No external IP found (LoadBalancer might be still provisioning)")
+		return &pb2.MmfRequest{}
+	}
+	ingress := service.Status.LoadBalancer.Ingress[0]
+	return &pb2.MmfRequest{
 		// om-function:50502 -> the internal hostname & port number of the MMF service in our Kubernetes cluster
-		Config: &pb.FunctionConfig{
-			Host: mmfApiHost,
-			Port: mmfApiPort,
-			Type: pb.FunctionConfig_GRPC,
-		},
-		Profile: &pb.MatchProfile{
-			Name: "1v1",
-			Pools: []*pb.Pool{
-				{
-					Name: "everyone",
-				},
+		Mmfs: []*pb2.MatchmakingFunctionSpec{
+			{
+				Host: "http://" + ingress.IP,
+				Port: 50502,
+				Type: pb2.MatchmakingFunctionSpec_GRPC,
 			},
+		},
+		Profile: &pb2.Profile{
+			Name:       "1v1",
+			Pools:      map[string]*pb2.Pool{"all": {Name: "everyone"}},
 			Extensions: map[string]*anypb.Any{},
 		},
 	}
@@ -109,52 +110,43 @@ func createAgonesGameServerAllocation() *allocationv1.GameServerAllocation {
 	return &allocationv1.GameServerAllocation{}
 }
 
-func createOMAssignTicketRequest(match *pb.Match, gsa *allocationv1.GameServerAllocation) *pb.AssignTicketsRequest {
-	tids := []string{}
-	for _, t := range match.GetTickets() {
-		tids = append(tids, t.GetId())
+func createOMAssignTicketRequest(match *pb2.Match, gsa *allocationv1.GameServerAllocation) *pb2.CreateAssignmentsRequest {
+	tids := []*pb2.Ticket{}
+	for _, r := range match.Rosters {
+		tids = append(tids, r.Tickets...)
 	}
 
-	return &pb.AssignTicketsRequest{
-		Assignments: []*pb.AssignmentGroup{
-			{
-				TicketIds: tids,
-				Assignment: &pb.Assignment{
-					Connection: fmt.Sprintf("%s:%d", gsa.Status.Address, gsa.Status.Ports[0].Port),
-				},
+	return &pb2.CreateAssignmentsRequest{
+		AssignmentRoster: &pb2.Roster{
+			Name: "My_Assignment_Roster_Name",
+			Assignment: &pb2.Assignment{
+				Connection: fmt.Sprintf("%s:%d", gsa.Status.Address, gsa.Status.Ports[0].Port),
 			},
+			Tickets: tids,
 		},
 	}
 }
 
 func (r Client) run() error {
-	bc := r.BackendServiceClient
-	closer := r.CloserBackendServiceClient
-	defer func() {
-		err := closer()
-		if err != nil {
-			log.Println(err)
-		}
-	}()
+	invocationResultChan := make(chan *pb2.StreamedMmfResponse)
 
-	agonesClient := r.AgonesClientset
+	fmt.Println("Director: start InvokeMatchmakingFunctions in another thread")
 
-	stream, err := bc.FetchMatches(context.Background(), createOMFetchMatchesRequest())
-	if err != nil {
-		return fmt.Errorf("fail to get response stream from backend.FetchMatches call: %w", err)
-	}
+	go r.OmClient.InvokeMatchmakingFunctions(context.Background(), createOMFetchMatchesRequest(), invocationResultChan)
+
+	agonesClient := r.AgonesClientset
 
 	totalMatches := 0
 	// Read the FetchMatches response. Each loop fetches an available game match that satisfies the match profiles.
-	for {
-		resp, err := stream.Recv()
-		if err == io.EOF {
-			break
-		}
-		if err != nil {
-			return fmt.Errorf("error streaming response from backend.FetchMatches call: %w", err)
-		}
+	fmt.Println("Director: waiting for invocationResultChan to have a resp")
+	for resp := range invocationResultChan {
+
+		fmt.Println("got something from the invocationResultChan: ", resp)
+
 		ctx := context.Background()
+
+		fmt.Println("Allocating a game server")
+
 		gsa, err := agonesClient.AllocationV1().GameServerAllocations("default").Create(ctx, createAgonesGameServerAllocation(), metav1.CreateOptions{})
 		if err != nil {
 			return fmt.Errorf("error requesting allocation: %w", err)
@@ -167,7 +159,9 @@ func (r Client) run() error {
 			continue
 		}
 
-		if _, err = bc.AssignTickets(context.Background(), createOMAssignTicketRequest(resp.GetMatch(), gsa)); err != nil {
+		fmt.Println("The game server is allocated, assigning tickets")
+
+		if _, err = r.OmClient.CreateAssignments(createOMAssignTicketRequest(resp.GetMatch(), gsa)); err != nil {
 			// Corner case where we allocated a game server for players who left the queue after some waiting time.
 			// Note that we may still leak some game servers when tickets got assigned but players left the queue before game frontend announced the assignments.
 			if err = agonesClient.AgonesV1().GameServers("default").Delete(ctx, gsa.Status.GameServerName, metav1.DeleteOptions{}); err != nil {