Add new API to get cached versions of components on the VHD

apiserver/getcachedvhdimages.go

@@ -0,0 +1,41 @@
+package apiserver
+
+import (
+	"encoding/json"
+	"fmt"
+	"log"
+	"net/http"
+
+	"github.com/Azure/agentbaker/pkg/agent"
+)
+
+const (
+	// RoutePathGetCachedVersionsOnVHD the route path to get cached vhd images.
+	RoutePathGetCachedVersionsOnVHD string = "/getcachedversionsonvhd"
+)
+
+// GetCachedVersionsOnVHD endpoint for getting the current versions of components cached on the vhd.
+func (api *APIServer) GetCachedVersionsOnVHD(w http.ResponseWriter, r *http.Request) {
+	agentBaker, err := agent.NewAgentBaker()
+	if err != nil {
+		log.Println(err.Error())
+		http.Error(w, err.Error(), http.StatusBadRequest)
+		return
+	}
+
+	cachedOnVHD, err := agentBaker.GetCachedVersionsOnVHD()
+	if err != nil {
+		log.Println(err.Error())
+		http.Error(w, err.Error(), http.StatusBadRequest)
+		return
+	}
+
+	jsonResponse, err := json.Marshal(cachedOnVHD)
+	if err != nil {
+		log.Println(err.Error())
+		http.Error(w, err.Error(), http.StatusBadRequest)
+		return
+	}
+	w.WriteHeader(http.StatusOK)
+	fmt.Fprint(w, string(jsonResponse))
+}

apiserver/getdistrosigimageconfig.go

@@ -6,7 +6,7 @@ import (
 	"log"
 	"net/http"
 
-	agent "github.com/Azure/agentbaker/pkg/agent"
+	"github.com/Azure/agentbaker/pkg/agent"
 	"github.com/Azure/agentbaker/pkg/agent/datamodel"
 )
 

apiserver/getlatestsigimageconfig.go

@@ -6,7 +6,7 @@ import (
 	"log"
 	"net/http"
 
-	agent "github.com/Azure/agentbaker/pkg/agent"
+	"github.com/Azure/agentbaker/pkg/agent"
 	"github.com/Azure/agentbaker/pkg/agent/datamodel"
 )
 

apiserver/getnodebootstrapdata.go

@@ -8,7 +8,7 @@ import (
 	"net/http"
 	"time"
 
-	agent "github.com/Azure/agentbaker/pkg/agent"
+	"github.com/Azure/agentbaker/pkg/agent"
 	"github.com/Azure/agentbaker/pkg/agent/datamodel"
 )
 

apiserver/routers.go

@@ -40,6 +40,12 @@ func (api *APIServer) NewRouter() *mux.Router {
 		Name("GetDistroSigImageConfig").
 		HandlerFunc(api.GetDistroSigImageConfig)
 
+	router.
+		Methods("GET").
+		Path(RoutePathGetCachedVersionsOnVHD).
+		Name("GetCachedVersionsOnVHD").
+		HandlerFunc(api.GetCachedVersionsOnVHD)
+
 	router.Methods("GET").Path("/healthz").Name("healthz").HandlerFunc(healthz)
 
 	// global timeout and panic handlers.

pkg/agent/bakerapi.go

@@ -16,6 +16,7 @@ type AgentBaker interface {
 	GetNodeBootstrapping(ctx context.Context, config *datamodel.NodeBootstrappingConfiguration) (*datamodel.NodeBootstrapping, error)
 	GetLatestSigImageConfig(sigConfig datamodel.SIGConfig, distro datamodel.Distro, envInfo *datamodel.EnvironmentInfo) (*datamodel.SigImageConfig, error)
 	GetDistroSigImageConfig(sigConfig datamodel.SIGConfig, envInfo *datamodel.EnvironmentInfo) (map[datamodel.Distro]datamodel.SigImageConfig, error)
+	GetCachedVersionsOnVHD() (datamodel.CachedOnVHD, error)
 }
 
 type agentBakerImpl struct {
@@ -174,3 +175,17 @@ func findSIGImageConfig(sigConfig datamodel.SIGAzureEnvironmentSpecConfig, distr
 
 	return nil
 }
+
+func (agentBaker *agentBakerImpl) GetCachedVersionsOnVHD() (datamodel.CachedOnVHD, error) {
+	cached := datamodel.CachedOnVHD{
+		CachedFromManifest:                 datamodel.CachedFromManifest,
+		CachedFromComponentContainerImages: datamodel.CachedFromComponentContainerImages,
+		CachedFromComponentDownloadedFiles: datamodel.CachedFromComponentDownloadedFiles,
+	}
+
+	if datamodel.CachedFromManifest == (&datamodel.Manifest{}) || datamodel.CachedFromComponentContainerImages == nil || datamodel.CachedFromComponentDownloadedFiles == nil {
+		return cached, fmt.Errorf("cached versions are not available")
+	}
+
+	return cached, nil
+}

pkg/agent/bakerapi_test.go

@@ -523,4 +523,37 @@ var _ = Describe("AgentBaker API implementation tests", func() {
 			}
 		})
 	})
+
+	Context("GetCachedVersionsOnVHD", func() {
+		It("should return cached VHD data", func() {
+			agentBaker, err := NewAgentBaker()
+			Expect(err).NotTo(HaveOccurred())
+
+			cachedOnVHD, err := agentBaker.GetCachedVersionsOnVHD()
+			Expect(err).NotTo(HaveOccurred())
+
+			manifest := datamodel.CacheManifest()
+			component := datamodel.CacheComponents()
+
+			// The indices are hardcoded based on the current components.json.
+			// Add new components to the bottom of components.json, or update the indices.
+			pauseIndx := 2
+			azureCNSIndx := 5
+			cniPluginIndx := 0
+			azureCNIIndx := 1
+
+			Expect(cachedOnVHD.CachedFromManifest.Runc.Installed["default"]).To(Equal(manifest.Runc.Installed["default"]))
+			Expect(cachedOnVHD.CachedFromManifest.Runc.Pinned["1804"]).To(Equal(manifest.Runc.Pinned["1804"]))
+			Expect(cachedOnVHD.CachedFromManifest.Runc.FileName).To(Equal(manifest.Runc.FileName))
+			Expect(cachedOnVHD.CachedFromManifest.Containerd.Pinned["1804"]).To(Equal(manifest.Containerd.Pinned["1804"]))
+			Expect(cachedOnVHD.CachedFromManifest.Containerd.Edge).To(Equal(manifest.Containerd.Edge))
+			Expect(cachedOnVHD.CachedFromManifest.Kubernetes.Versions[0]).To(Equal(manifest.Kubernetes.Versions[0]))
+			Expect(cachedOnVHD.CachedFromComponentContainerImages["pause"].MultiArchVersions[0]).To(Equal(component.ContainerImages[pauseIndx].MultiArchVersions[0]))
+			Expect(cachedOnVHD.CachedFromComponentContainerImages["azure-cns"].PrefetchOptimizations[0].Version).To(
+				Equal(component.ContainerImages[azureCNSIndx].PrefetchOptimizations[0].Version))
+			Expect(cachedOnVHD.CachedFromComponentContainerImages["azure-cns"].PrefetchOptimizations[0].Binaries[0]).To(Equal("usr/local/bin/azure-cns"))
+			Expect(cachedOnVHD.CachedFromComponentDownloadedFiles["cni-plugins"].Versions[0]).To(Equal(component.DownloadFiles[cniPluginIndx].Versions[0]))
+			Expect(cachedOnVHD.CachedFromComponentDownloadedFiles["azure-cni"].Versions[1]).To(Equal(component.DownloadFiles[azureCNIIndx].Versions[1]))
+		})
+	})
 })

pkg/agent/datamodel/helper.go

@@ -7,6 +7,7 @@ import (
 	"bufio"
 	"bytes"
 	"fmt"
+	"net/url"
 	"regexp"
 	"sort"
 	"strings"
@@ -93,3 +94,25 @@ func IndentString(original string, spaces int) string {
 	}
 	return out.String()
 }
+
+func processContainerImage(downloadURL string) (string, error) {
+	// example URL "downloadURL": "mcr.microsoft.com/oss/kubernetes/autoscaler/addon-resizer:*",
+	// getting the data between the last / and the last :
+	parts := strings.Split(downloadURL, "/")
+	if len(parts) == 0 || len(parts[len(parts)-1]) == 0 {
+		return "", fmt.Errorf("container image component URL is not in the expected format: %s", downloadURL)
+	}
+	lastPart := parts[len(parts)-1]
+	component := strings.TrimSuffix(lastPart, ":*")
+	return component, nil
+}
+
+func processDownloadFile(downloadURL string) (string, error) {
+	// example URL "downloadURL": "https://acs-mirror.azureedge.net/cni-plugins/v*/binaries",
+	url, err := url.Parse(downloadURL) // /cni-plugins/v*/binaries
+	if err != nil {
+		return "", fmt.Errorf("download file image URL is not in the expected format: %s", downloadURL)
+	}
+	urlSplit := strings.Split(url.Path, "/") // ["", cni-plugins, v*, binaries]
+	return urlSplit[1], nil
+}

pkg/agent/datamodel/sig_config.go

@@ -1,9 +1,13 @@
 package datamodel
 
 import (
+	"bytes"
 	_ "embed"
 	"encoding/json"
 	"fmt"
+	"os"
+	"path"
+	"runtime"
 	"strings"
 )
 
@@ -12,6 +16,136 @@ const (
 	AzurePublicCloudSigSubscription string = "109a5e88-712a-48ae-9078-9ca8b3c81345" // AKS VHD
 )
 
+//nolint:gochecknoglobals
+var (
+	CachedFromComponentContainerImages = make(map[string]ContainerImage)
+	CachedFromComponentDownloadedFiles = make(map[string]DownloadFiles)
+	CachedFromManifest                 = &Manifest{}
+)
+
+//nolint:gochecknoinits
+func init() {
+	manifest := CacheManifest()
+	processManifest(manifest)
+
+	components := CacheComponents()
+	processComponents(components)
+}
+
+func CacheManifest() Manifest {
+	_, filename, _, _ := runtime.Caller(0)
+	manifestFilePath := "../../../parts/linux/cloud-init/artifacts/manifest.json"
+	return getCachedVersionsFromManifestJSON(path.Join(path.Dir(filename), manifestFilePath))
+}
+
+func CacheComponents() Components {
+	_, filename, _, _ := runtime.Caller(0)
+	componentsFilePath := "../../../vhdbuilder/packer/components.json"
+	return getCachedVersionsFromComponentsJSON(path.Join(path.Dir(filename), componentsFilePath))
+}
+
+func processManifest(manifest Manifest) {
+	CachedFromManifest.Kubernetes = manifest.Kubernetes
+	CachedFromManifest.Runc = manifest.Runc
+	CachedFromManifest.Containerd = manifest.Containerd
+	CachedFromManifest.NvidiaContainerRuntime = manifest.NvidiaContainerRuntime
+	CachedFromManifest.NvidiaDrivers = manifest.NvidiaDrivers
+}
+
+func processComponents(components Components) {
+	for _, image := range components.ContainerImages {
+		componentName, err := processContainerImage(image.DownloadURL)
+		if err != nil {
+			panic(err)
+		}
+		CachedFromComponentContainerImages[componentName] = image
+	}
+	for _, file := range components.DownloadFiles {
+		componetName, err := processDownloadFile(file.DownloadURL)
+		if err != nil {
+			panic(err)
+		}
+		CachedFromComponentDownloadedFiles[componetName] = file
+	}
+}
+
+func getCachedVersionsFromManifestJSON(manifestFilePath string) Manifest {
+	data, err := os.ReadFile(manifestFilePath)
+	if err != nil {
+		panic(err)
+	}
+	data = bytes.ReplaceAll(data, []byte("#EOF"), []byte(""))
+	var manifest Manifest
+	if err = json.Unmarshal(data, &manifest); err != nil {
+		panic(err)
+	}
+	return manifest
+}
+
+func getCachedVersionsFromComponentsJSON(componentsFilePath string) Components {
+	data, err := os.ReadFile(componentsFilePath)
+	if err != nil {
+		panic(err)
+	}
+	var components Components
+	if err = json.Unmarshal(data, &components); err != nil {
+		panic(err)
+	}
+	return components
+}
+
+type CachedOnVHD struct {
+	CachedFromManifest                 *Manifest                 `json:"cached_from_manifest"`
+	CachedFromComponentContainerImages map[string]ContainerImage `json:"cached_from_component_container_images"`
+	CachedFromComponentDownloadedFiles map[string]DownloadFiles  `json:"cached_from_component_downloaded_files"`
+}
+
+type Dependency struct {
+	FileName         string            `json:"fileName"`
+	DownloadLocation string            `json:"downloadLocation"`
+	DownloadURL      string            `json:"downloadURL"`
+	Versions         []string          `json:"versions"`
+	Installed        map[string]string `json:"installed"`
+	Pinned           map[string]string `json:"pinned"`
+	Edge             string            `json:"edge"`
+}
+
+type Manifest struct {
+	Containerd             Dependency `json:"containerd"`
+	Runc                   Dependency `json:"runc"`
+	NvidiaContainerRuntime Dependency `json:"nvidia-container-runtime"`
+	NvidiaDrivers          Dependency `json:"nvidia-drivers"`
+	Kubernetes             Dependency `json:"kubernetes"`
+}
+
+type Versions struct {
+	Versions []string `json:"versions"`
+}
+
+type Components struct {
+	ContainerImages []ContainerImage `json:"containerImages"`
+	DownloadFiles   []DownloadFiles  `json:"downloadFiles"`
+}
+
+type ContainerImage struct {
+	DownloadURL           string                 `json:"downloadURL"`
+	MultiArchVersions     []string               `json:"multiArchVersions"`
+	Amd64OnlyVersions     []string               `json:"amd64OnlyVersions"`
+	PrefetchOptimizations []PrefetchOptimization `json:"prefetchOptimizations"`
+}
+
+type PrefetchOptimization struct {
+	Version  string   `json:"version"`
+	Binaries []string `json:"binaries"`
+}
+
+type DownloadFiles struct {
+	FileName         string   `json:"fileName"`
+	DownloadLocation string   `json:"downloadLocation"`
+	DownloadURL      string   `json:"downloadURL"`
+	Versions         []string `json:"versions"`
+}
+
 // SIGAzureEnvironmentSpecConfig is the overall configuration differences in different cloud environments.
 /* TODO(tonyxu) merge this with AzureEnvironmentSpecConfig from aks-engine(pkg/api/azenvtypes.go) once
 it's moved into AKS RP. */
@@ -278,8 +412,6 @@ func (d Distro) IsWindowsDistro() bool {
 }
 
 // SigImageConfigTemplate represents the SIG image configuration template.
-//
-//nolint:musttag // tags can be added if deemed necessary
 type SigImageConfigTemplate struct {
 	ResourceGroup string
 	Gallery       string

pkg/agent/datamodel/types.go

@@ -1638,8 +1638,6 @@ type K8sComponents struct {
 
 // GetLatestSigImageConfigRequest describes the input for a GetLatestSigImageConfig HTTP request.
 // This is mostly a wrapper over existing types so RP doesn't have to manually construct JSON.
-//
-//nolint:musttag // tags can be added if deemed necessary
 type GetLatestSigImageConfigRequest struct {
 	SIGConfig      SIGConfig
 	SubscriptionID string
@@ -1649,8 +1647,6 @@ type GetLatestSigImageConfigRequest struct {
 }
 
 // NodeBootstrappingConfiguration represents configurations for node bootstrapping.
-//
-//nolint:musttag // tags can be added if deemed necessary
 type NodeBootstrappingConfiguration struct {
 	ContainerService              *ContainerService
 	CloudSpecConfig               *AzureEnvironmentSpecConfig
@@ -1713,8 +1709,6 @@ const (
 )
 
 // NodeBootstrapping represents the custom data, CSE, and OS image info needed for node bootstrapping.
-//
-//nolint:musttag // tags can be added if deemed necessary
 type NodeBootstrapping struct {
 	CustomData     string
 	CSE            string