APK Management server and Adapter implementation

[dushaniw]

Functionality of APK Agent Client

APK Agent is the responsible party for managing the data-plane cluster by managing its components as well as keeping the control plane sync-up with data-plane.

Mainly it has the following functionality

• Talks to the K8s API server and manages (Create, Update, Delete) resources in the K8s cluster(DP) -> Create APIs (in UI driven approach), Applying policies (from UI)
• Update rate limit service with rate limit policies -> Will be an xDS communication
• Update enforcer with subscription details, etc. -> Will be an xDS communication
• Should have a K8s operator to listen on the resources created on the DP cluster.
• Communicate with CP - xDS

Functionality of APK Management Server

Management server is the responsible party for keeping the CP & DP sync by communicating with APK clients in each data-planes (or in the same control-plane when we run in a single cluster).

• Send API create/delete/update, Subscription, Policy events to the APK client - xDS
• Service registering.
• Update control plane with the resources created on dataplane(using cli) such as APIs, Policies, etc..

APK Management Server to APK Agent Client Communication

API Agent Client should be associated with a k8s operator, which is watching for resource updates and sending the updates to the control plane’s Management Server and the Gateway.

Since we have only one control plane available, we decided to make this communication as a gRPC client to server streaming communication.

[npamudika]

Design and User Flows Document - https://docs.google.com/document/d/1F15zHzHi8ercomq5J3yR8P6TjkVWhhUQ1lnOF4_JCcU/edit?usp=sharing

Events and Data Document - https://docs.google.com/document/d/1opdltBxJIkz3Tn_CsxXbHI7RrhmsXaSgZAq27oayr_s/edit?usp=sharing

DP and CP K8s CRDs for APK - https://docs.google.com/document/d/1CL5ug6neMn-caLbjzLOJms8TNuMSw9evSaEHjQRFudQ/edit?usp=sharing

APK Management Server and Agent Client Implementation - https://docs.google.com/document/d/16-dsKnp_PgnAHdxoaTUTsP51yZ_unRTmf6dScGw9UgM/edit?usp=sharing

[npamudika]

Sub Tasks

Initial Designs and Definitions

• [APK Management server and Adapter] Identify User Flows #22
• [APK Management server and Adapter] Finalize Data Related to User Flows and Data Structures #23
• [APK Management server and Adapter] Design CRDs #24

Management server XDS communication

• [APK Management server and Adapter] Management Server to Agent XDS Communication #25
• [APK Management server and Adapter] Check the Possibility to Store the Last Status Locally #26

Adapter to Management Server gRPC unary communication

Main issue:

• [APK Management server and Adapter] Design and Implement the Agent to Management Server gRPC Unary Call #27

Sub tasks:

• [APK Management server and Adapter] Handle Retries Between Agent to Management Server #28
• [APK Management Server to Agent Client Communication] Implement agent to management server GRPC unary call  #83
• [APK Management Server to Agent Client Communication] Populate gRPC and retry policy configuration value from config file #92
• [APK Management Server to Agent Client Communication] Implement GRPC server in management server #119
• [APK Management Server to Agent Client Communication] Integrate gRPC client with Agent's intermediate representation #123

Data partitioning for Choreo

• [APK Management server and Adapter] Partitioning-like Logic for CRDs #29

Agent Implementation - CP

• APK agent implementation - CP #19
• [APK Management server and Adapter] CRD Change Detection #30
• [APK Management server and Adapter] Extract Data for Enforcer XDS #32

Agent Implementation - DP

• [APK Management server and Adapter] Extract Data for the Management Server #31
• APK agent implementation - DP #21
• [APK Agent Implementation] APK Agent gateway operator basic functionality with API and HttpRoute CRDs #98

Management Server to DB Transactions

• [APK Management Server and Adapter] initiate and configure the Database connection #84
• [APK Management server and Adapter] Management Server to DB Data Transfer #33
• [APK Management server and Adapter] Database queries for DP data  #171

Additional Sub Tasks

• [APK Agent Implementation] Moving code from cc adaptor to apk agent #96
• [APK Management server and Adapter] Add adapter common utils for discovery and configs #132
• [APK] Generate default certificates for network communication #146

[AmaliMatharaarachchi]

Updated Task list

GRPC Unary call for sending API updates to Management Server

• Server implementation in the management server #200

[AmaliMatharaarachchi]

closing as this issue is no longer required.