53e09dbe-7149-4eef-b52c-e1d16135149a

Committed 24 Feb 2026 10:58AM UTC coverage: 71.243% (+0.07%) from 71.17%

Build # 53e09dbe-7149-4eef-b52c-e1d16135149a

Build Type

push

prow

Committed by

web-flow

Commit Message

Merge pull request #16662 from mhenriks/containerpath-volumes

VEP 165: Containerpath Volumes

Coverage Stats

411 of 454 new or added lines in 14 files covered. (90.53%)

9 existing lines in 3 files now uncovered.

74412 of 104448 relevant lines covered (71.24%)

587.5 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

66.39

/pkg/virt-api/api.go

/*
 * This file is part of the KubeVirt project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Copyright The KubeVirt Authors.
 *
 */

package virt_api

import (
        "context"
        "crypto/tls"
        "encoding/json"
        "fmt"
        "net/http"
        "os"
        "os/signal"
        "sync"
        "syscall"
        "time"

        builderv3 "k8s.io/kube-openapi/pkg/builder3"
        "k8s.io/kube-openapi/pkg/common/restfuladapter"
        "k8s.io/kube-openapi/pkg/validation/spec"

        kvtls "kubevirt.io/kubevirt/pkg/util/tls"

        restful "github.com/emicklei/go-restful/v3"
        "github.com/prometheus/client_golang/prometheus/promhttp"
        flag "github.com/spf13/pflag"
        metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
        "k8s.io/apimachinery/pkg/runtime/schema"
        "k8s.io/apimachinery/pkg/util/validation/field"
        "k8s.io/client-go/tools/cache"
        certificate2 "k8s.io/client-go/util/certificate"
        "k8s.io/client-go/util/flowcontrol"
        aggregatorclient "k8s.io/kube-aggregator/pkg/client/clientset_generated/clientset"

        "kubevirt.io/kubevirt/pkg/util/ratelimiter"

        backupv1 "kubevirt.io/api/backup/v1alpha1"
        v1 "kubevirt.io/api/core/v1"
        "kubevirt.io/client-go/kubecli"
        "kubevirt.io/client-go/log"
        clientutil "kubevirt.io/client-go/util"
        virtversion "kubevirt.io/client-go/version"

        v12 "kubevirt.io/client-go/api"

        "kubevirt.io/kubevirt/pkg/certificates/bootstrap"
        "kubevirt.io/kubevirt/pkg/controller"
        "kubevirt.io/kubevirt/pkg/healthz"
        clientmetrics "kubevirt.io/kubevirt/pkg/monitoring/metrics/common/client"
        metrics "kubevirt.io/kubevirt/pkg/monitoring/metrics/virt-api"
        "kubevirt.io/kubevirt/pkg/monitoring/profiler"
        netadmitter "kubevirt.io/kubevirt/pkg/network/admitter"
        mime "kubevirt.io/kubevirt/pkg/rest"
        "kubevirt.io/kubevirt/pkg/rest/filter"
        "kubevirt.io/kubevirt/pkg/service"
        "kubevirt.io/kubevirt/pkg/util"
        "kubevirt.io/kubevirt/pkg/util/openapi"
        "kubevirt.io/kubevirt/pkg/virt-api/definitions"
        "kubevirt.io/kubevirt/pkg/virt-api/rest"
        "kubevirt.io/kubevirt/pkg/virt-api/webhooks"
        mutating_webhook "kubevirt.io/kubevirt/pkg/virt-api/webhooks/mutating-webhook"
        validating_webhook "kubevirt.io/kubevirt/pkg/virt-api/webhooks/validating-webhook"
        virtconfig "kubevirt.io/kubevirt/pkg/virt-config"
        "kubevirt.io/kubevirt/pkg/virt-operator/resource/generate/components"
        virtoperatorutils "kubevirt.io/kubevirt/pkg/virt-operator/util"
)

const (
        // Default port that virt-api listens on.
        defaultPort = 443

        // Default address that virt-api listens on.
        defaultHost = "0.0.0.0"

        DefaultConsoleServerPort = 8186

        defaultCAConfigMapName     = "kubevirt-ca"
        defaultTlsCertFilePath     = "/etc/virt-api/certificates/tls.crt"
        defaultTlsKeyFilePath      = "/etc/virt-api/certificates/tls.key"
        defaultHandlerCertFilePath = "/etc/virt-handler/clientcertificates/tls.crt"
        defaultHandlerKeyFilePath  = "/etc/virt-handler/clientcertificates/tls.key"

        httpStatusNotFoundMessage     = "Not Found"
        httpStatusBadRequestMessage   = "Bad Request"
        httpStatusInternalServerError = "Internal Server Error"
)

type VirtApi interface {
        Compose()
        Run()
        AddFlags()
        ConfigureOpenAPIService()
        Execute()
}

type virtAPIApp struct {
        service.ServiceListen
        SwaggerUI        string
        SubresourcesOnly bool
        virtCli          kubecli.KubevirtClient
        aggregatorClient *aggregatorclient.Clientset
        authorizor       rest.VirtApiAuthorizor
        certsDirectory   string
        clusterConfig    *virtconfig.ClusterConfig

        namespace               string
        host                    string
        tlsConfig               *tls.Config
        consoleServerPort       int
        certmanager             certificate2.Manager
        handlerTLSConfiguration *tls.Config
        handlerCertManager      certificate2.Manager

        caConfigMapName              string
        tlsCertFilePath              string
        tlsKeyFilePath               string
        handlerCertFilePath          string
        handlerKeyFilePath           string
        externallyManaged            bool
        reloadableRateLimiter        *ratelimiter.ReloadableRateLimiter
        reloadableWebhookRateLimiter *ratelimiter.ReloadableRateLimiter

        // indicates if controllers were started with or without CDI/DataSource support
        hasCDIDataSource bool
        // the channel used to trigger re-initialization.
        reInitChan chan string

        kubeVirtServiceAccounts map[string]struct{}
}

var (
        _                service.Service = &virtAPIApp{}
        apiHealthVersion                 = new(healthz.KubeApiHealthzVersion)
)

func NewVirtApi() VirtApi {

        app := &virtAPIApp{}
        app.BindAddress = defaultHost
        app.Port = defaultPort

        return app
}

func (app *virtAPIApp) Execute() {
        if err := metrics.SetupMetrics(); err != nil {
                panic(err)
        }

        app.reloadableRateLimiter = ratelimiter.NewReloadableRateLimiter(flowcontrol.NewTokenBucketRateLimiter(virtconfig.DefaultVirtAPIQPS, virtconfig.DefaultVirtAPIBurst))
        app.reloadableWebhookRateLimiter = ratelimiter.NewReloadableRateLimiter(flowcontrol.NewTokenBucketRateLimiter(virtconfig.DefaultVirtWebhookClientQPS, virtconfig.DefaultVirtWebhookClientBurst))

        clientmetrics.RegisterRestConfigHooks()
        clientConfig, err := kubecli.GetKubevirtClientConfig()
        if err != nil {
                panic(err)
        }
        clientConfig.RateLimiter = app.reloadableRateLimiter
        app.virtCli, err = kubecli.GetKubevirtClientFromRESTConfig(clientConfig)
        if err != nil {
                panic(err)
        }

        authorizor, err := rest.NewAuthorizor(app.reloadableWebhookRateLimiter)
        if err != nil {
                panic(err)
        }

        app.aggregatorClient = aggregatorclient.NewForConfigOrDie(clientConfig)

        app.authorizor = authorizor

        app.certsDirectory, err = os.MkdirTemp("", "certsdir")
        if err != nil {
                panic(err)
        }
        app.namespace, err = clientutil.GetNamespace()
        if err != nil {
                panic(err)
        }

        app.kubeVirtServiceAccounts = webhooks.KubeVirtServiceAccounts(app.namespace)

        app.ConfigureOpenAPIService()
        app.reInitChan = make(chan string, 10)

        app.Run()
}

func subresourceAPIGroup() metav1.APIGroup {
        apiGroup := metav1.APIGroup{
                Name: "subresource.kubevirt.io",
                PreferredVersion: metav1.GroupVersionForDiscovery{
                        GroupVersion: v1.SubresourceGroupVersions[0].Group + "/" + v1.SubresourceGroupVersions[0].Version,
                        Version:      v1.SubresourceGroupVersions[0].Version,
                },
        }

        for _, version := range v1.SubresourceGroupVersions {
                apiGroup.Versions = append(apiGroup.Versions, metav1.GroupVersionForDiscovery{
                        GroupVersion: version.Group + "/" + version.Version,
                        Version:      version.Version,
                })
        }
        apiGroup.ServerAddressByClientCIDRs = append(apiGroup.ServerAddressByClientCIDRs, metav1.ServerAddressByClientCIDR{
                ClientCIDR:    "0.0.0.0/0",
                ServerAddress: "",
        })
        apiGroup.Kind = "APIGroup"
        return apiGroup
}

func (app *virtAPIApp) composeSubresources() {

        var subwss []*restful.WebService

        for _, version := range v1.SubresourceGroupVersions {
                subresourcesvmGVR := schema.GroupVersionResource{Group: version.Group, Version: version.Version, Resource: "virtualmachines"}
                subresourcesvmiGVR := schema.GroupVersionResource{Group: version.Group, Version: version.Version, Resource: "virtualmachineinstances"}
                expandvmspecGVR := schema.GroupVersionResource{Group: version.Group, Version: version.Version, Resource: "expand-vm-spec"}

                subws := new(restful.WebService)
                subws.Doc(fmt.Sprintf("KubeVirt \"%s\" Subresource API.", version.Version))
                subws.Path(definitions.GroupVersionBasePath(version))

                subresourceApp := rest.NewSubresourceAPIApp(app.virtCli, app.consoleServerPort, app.handlerTLSConfiguration, app.clusterConfig)

                restartRouteBuilder := subws.PUT(definitions.NamespacedResourcePath(subresourcesvmGVR)+definitions.SubResourcePath("restart")).
                        To(subresourceApp.RestartVMRequestHandler).
                        Consumes(mime.MIME_ANY).
                        Reads(v1.RestartOptions{}).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"Restart").
                        Doc("Restart a VirtualMachine object.").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusNotFound, httpStatusNotFoundMessage, "").
                        Returns(http.StatusBadRequest, httpStatusBadRequestMessage, "")
                restartRouteBuilder.ParameterNamed("body").Required(false)
                subws.Route(restartRouteBuilder)

                subws.Route(subws.PUT(definitions.NamespacedResourcePath(subresourcesvmGVR)+definitions.SubResourcePath("migrate")).
                        To(subresourceApp.MigrateVMRequestHandler).
                        Consumes(mime.MIME_ANY).
                        Reads(v1.MigrateOptions{}).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"Migrate").
                        Doc("Migrate a running VirtualMachine to another node.").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusNotFound, httpStatusNotFoundMessage, "").
                        Returns(http.StatusBadRequest, httpStatusBadRequestMessage, ""))

                subws.Route(subws.PUT(definitions.NamespacedResourcePath(subresourcesvmGVR)+definitions.SubResourcePath("start")).
                        To(subresourceApp.StartVMRequestHandler).
                        Consumes(mime.MIME_ANY).
                        Reads(v1.StartOptions{}).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"Start").
                        Doc("Start a VirtualMachine object.").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusNotFound, httpStatusNotFoundMessage, "").
                        Returns(http.StatusBadRequest, httpStatusBadRequestMessage, ""))

                stopRouteBuilder := subws.PUT(definitions.NamespacedResourcePath(subresourcesvmGVR)+definitions.SubResourcePath("stop")).
                        To(subresourceApp.StopVMRequestHandler).
                        Consumes(mime.MIME_ANY).
                        Reads(v1.StopOptions{}).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"Stop").
                        Doc("Stop a VirtualMachine object.").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusNotFound, httpStatusNotFoundMessage, "").
                        Returns(http.StatusBadRequest, httpStatusBadRequestMessage, "")
                stopRouteBuilder.ParameterNamed("body").Required(false)
                subws.Route(stopRouteBuilder)

                subws.Route(subws.GET(definitions.NamespacedResourcePath(subresourcesvmGVR)+definitions.SubResourcePath("expand-spec")).
                        To(subresourceApp.ExpandSpecVMRequestHandler).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"vm-ExpandSpec").
                        Produces(restful.MIME_JSON).
                        Doc("Get VirtualMachine object with expanded instancetype and preference.").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusNotFound, httpStatusNotFoundMessage, "").
                        Returns(http.StatusInternalServerError, httpStatusInternalServerError, ""))

                subws.Route(subws.PUT(definitions.NamespacedResourcePath(subresourcesvmiGVR)+definitions.SubResourcePath("freeze")).
                        To(subresourceApp.FreezeVMIRequestHandler).
                        Consumes(mime.MIME_ANY).
                        Reads(v1.FreezeUnfreezeTimeout{}).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"Freeze").
                        Doc("Freeze a VirtualMachineInstance object.").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusInternalServerError, httpStatusInternalServerError, ""))

                subws.Route(subws.PUT(definitions.NamespacedResourcePath(subresourcesvmiGVR)+definitions.SubResourcePath("unfreeze")).
                        To(subresourceApp.UnfreezeVMIRequestHandler).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"Unfreeze").
                        Doc("Unfreeze a VirtualMachineInstance object.").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusInternalServerError, httpStatusInternalServerError, ""))

                subws.Route(subws.PUT(definitions.NamespacedResourcePath(subresourcesvmiGVR)+definitions.SubResourcePath("reset")).
                        To(subresourceApp.ResetVMIRequestHandler).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"Reset").
                        Doc("Reset a VirtualMachineInstance object.").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusInternalServerError, httpStatusInternalServerError, ""))

                subws.Route(subws.PUT(definitions.NamespacedResourcePath(subresourcesvmiGVR)+definitions.SubResourcePath("softreboot")).
                        To(subresourceApp.SoftRebootVMIRequestHandler).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"SoftReboot").
                        Doc("Soft reboot a VirtualMachineInstance object.").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusInternalServerError, httpStatusInternalServerError, ""))

                subws.Route(subws.PUT(definitions.NamespacedResourcePath(subresourcesvmiGVR)+definitions.SubResourcePath("pause")).
                        To(subresourceApp.PauseVMIRequestHandler).
                        Consumes(mime.MIME_ANY).
                        Reads(v1.PauseOptions{}).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"Pause").
                        Doc("Pause a VirtualMachineInstance object.").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusNotFound, httpStatusNotFoundMessage, "").
                        Returns(http.StatusBadRequest, httpStatusBadRequestMessage, ""))

                subws.Route(subws.PUT(definitions.NamespacedResourcePath(subresourcesvmiGVR)+definitions.SubResourcePath("unpause")).
                        To(subresourceApp.UnpauseVMIRequestHandler). // handles VMIs as well
                        Consumes(mime.MIME_ANY).
                        Reads(v1.UnpauseOptions{}).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"Unpause").
                        Doc("Unpause a VirtualMachineInstance object.").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusNotFound, httpStatusNotFoundMessage, "").
                        Returns(http.StatusBadRequest, httpStatusBadRequestMessage, ""))

                subws.Route(subws.GET(definitions.NamespacedResourcePath(subresourcesvmiGVR) + definitions.SubResourcePath("console")).
                        To(subresourceApp.ConsoleRequestHandler).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version + "Console").
                        Doc("Open a websocket connection to a serial console on the specified VirtualMachineInstance."))

                subws.Route(subws.GET(definitions.NamespacedResourcePath(subresourcesvmiGVR) + definitions.SubResourcePath("vnc")).
                        To(subresourceApp.VNCRequestHandler).
                        Param(definitions.NamespaceParam(subws)).
                        Param(definitions.NameParam(subws)).
                        Param(definitions.PreserveSessionParam(subws)).
                        Operation(version.Version + "VNC").
                        Doc("Open a websocket connection to connect to VNC on the specified VirtualMachineInstance."))
                subws.Route(subws.GET(definitions.NamespacedResourcePath(subresourcesvmiGVR) + definitions.SubResourcePath("vnc/screenshot")).
                        To(subresourceApp.ScreenshotRequestHandler).
                        Param(definitions.NamespaceParam(subws)).
                        Param(definitions.NameParam(subws)).
                        Param(definitions.MoveCursorParam(subws)).
                        Operation(version.Version + "VNCScreenshot").
                        Doc("Get a PNG VNC screenshot of the specified VirtualMachineInstance."))
                subws.Route(subws.GET(definitions.NamespacedResourcePath(subresourcesvmiGVR) + definitions.SubResourcePath("usbredir")).
                        To(subresourceApp.USBRedirRequestHandler).
                        Param(definitions.NamespaceParam(subws)).
                        Param(definitions.NameParam(subws)).
                        Operation(version.Version + "usbredir").
                        Doc("Open a websocket connection to connect to USB device on the specified VirtualMachineInstance."))

                // VMI endpoint
                subws.Route(subws.GET(definitions.NamespacedResourcePath(subresourcesvmiGVR) + definitions.SubResourcePath("portforward") + definitions.PortPath).
                        To(subresourceApp.PortForwardRequestHandler(subresourceApp.FetchVirtualMachineInstance)).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Param(definitions.PortForwardPortParameter(subws)).
                        Operation(version.Version + "vmi-PortForward").
                        Doc("Open a websocket connection forwarding traffic to the specified VirtualMachineInstance and port."))
                subws.Route(subws.GET(definitions.NamespacedResourcePath(subresourcesvmiGVR) + definitions.SubResourcePath("portforward") + definitions.PortPath + definitions.ProtocolPath).
                        To(subresourceApp.PortForwardRequestHandler(subresourceApp.FetchVirtualMachineInstance)).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Param(definitions.PortForwardPortParameter(subws)).
                        Param(definitions.PortForwardProtocolParameter(subws)).
                        Operation(version.Version + "vmi-PortForwardWithProtocol").
                        Doc("Open a websocket connection forwarding traffic of the specified protocol (either tcp or udp) to the specified VirtualMachineInstance and port."))
                subws.Route(subws.GET(definitions.NamespacedResourcePath(subresourcesvmiGVR) + definitions.SubResourcePath("vsock")).
                        To(subresourceApp.VSOCKRequestHandler).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).Param(definitions.VSOCKPortParameter(subws)).Param(definitions.VSOCKTLSParameter(subws)).
                        Operation(version.Version + "VSOCK").
                        Doc("Open a websocket connection forwarding traffic to the specified VirtualMachineInstance and port via VSOCK."))

                // VM endpoint
                subws.Route(subws.GET(definitions.NamespacedResourcePath(subresourcesvmGVR) + definitions.SubResourcePath("portforward") + definitions.PortPath).
                        To(subresourceApp.PortForwardRequestHandler(subresourceApp.FetchVirtualMachineInstanceForVM)).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Param(definitions.PortForwardPortParameter(subws)).
                        Operation(version.Version + "vm-PortForward").
                        Doc("Open a websocket connection forwarding traffic to the running VMI for the specified VirtualMachine and port."))
                subws.Route(subws.GET(definitions.NamespacedResourcePath(subresourcesvmGVR) + definitions.SubResourcePath("portforward") + definitions.PortPath + definitions.ProtocolPath).
                        To(subresourceApp.PortForwardRequestHandler(subresourceApp.FetchVirtualMachineInstanceForVM)).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Param(definitions.PortForwardPortParameter(subws)).
                        Param(definitions.PortForwardProtocolParameter(subws)).
                        Operation(version.Version + "vm-PortForwardWithProtocol").
                        Doc("Open a websocket connection forwarding traffic of the specified protocol (either tcp or udp) to the specified VirtualMachine and port."))

                subws.Route(subws.PUT(definitions.NamespacedResourceBasePath(expandvmspecGVR)).
                        To(subresourceApp.ExpandSpecRequestHandler).
                        Param(definitions.NamespaceParam(subws)).
                        Operation(version.Version+"ExpandSpec").
                        Consumes(restful.MIME_JSON).
                        Produces(restful.MIME_JSON).
                        Doc("Expands instancetype and preference into the passed VirtualMachine object.").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusBadRequest, httpStatusBadRequestMessage, "").
                        Returns(http.StatusInternalServerError, httpStatusInternalServerError, ""))

                subws.Route(subws.GET(definitions.SubResourcePath("version")).Produces(restful.MIME_JSON).
                        To(func(request *restful.Request, response *restful.Response) {
                                response.WriteAsJson(virtversion.Get())
                        }).Operation(version.Version + "Version"))

                subws.Route(subws.GET(definitions.SubResourcePath("start-cluster-profiler")).Produces(restful.MIME_JSON).
                        To(subresourceApp.StartClusterProfilerHandler).
                        Operation(version.Version + "start-cluster-profiler"))

                subws.Route(subws.GET(definitions.SubResourcePath("stop-cluster-profiler")).Produces(restful.MIME_JSON).
                        To(subresourceApp.StopClusterProfilerHandler).
                        Operation(version.Version + "stop-cluster-profiler"))

                subws.Route(subws.GET(definitions.SubResourcePath("dump-cluster-profiler")).Produces(restful.MIME_JSON).
                        To(subresourceApp.DumpClusterProfilerHandler).
                        Operation(version.Version + "dump-cluster-profiler"))

                subws.Route(subws.GET(definitions.SubResourcePath("guestfs")).Produces(restful.MIME_JSON).
                        To(app.GetGsInfo()).
                        Operation(version.Version+"Guestfs").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusBadRequest, httpStatusBadRequestMessage, ""))
                subws.Route(subws.GET(definitions.SubResourcePath("healthz")).
                        To(healthz.KubeConnectionHealthzFuncFactory(app.clusterConfig, apiHealthVersion)).
                        Consumes(restful.MIME_JSON).
                        Produces(restful.MIME_JSON).
                        Operation(version.Version+"CheckHealth").
                        Doc("Health endpoint").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusInternalServerError, "Unhealthy", ""))
                subws.Route(subws.GET(definitions.NamespacedResourcePath(subresourcesvmiGVR)+definitions.SubResourcePath("guestosinfo")).
                        To(subresourceApp.GuestOSInfo).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Consumes(restful.MIME_JSON).
                        Produces(restful.MIME_JSON).
                        Operation(version.Version+"Guestosinfo").
                        Doc("Get guest agent os information").
                        Writes(v1.VirtualMachineInstanceGuestAgentInfo{}).
                        Returns(http.StatusOK, "OK", v1.VirtualMachineInstanceGuestAgentInfo{}))

                subws.Route(subws.GET(definitions.NamespacedResourcePath(subresourcesvmiGVR)+definitions.SubResourcePath("userlist")).
                        To(subresourceApp.UserList).
                        Consumes(restful.MIME_JSON).
                        Produces(restful.MIME_JSON).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"Userlist").
                        Doc("Get list of active users via guest agent").
                        Writes(v1.VirtualMachineInstanceGuestOSUserList{}).
                        Returns(http.StatusOK, "OK", v1.VirtualMachineInstanceGuestOSUserList{}))

                subws.Route(subws.GET(definitions.NamespacedResourcePath(subresourcesvmiGVR)+definitions.SubResourcePath("filesystemlist")).
                        To(subresourceApp.FilesystemList).
                        Consumes(restful.MIME_JSON).
                        Produces(restful.MIME_JSON).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"Filesystemlist").
                        Doc("Get list of active filesystems on guest machine via guest agent").
                        Writes(v1.VirtualMachineInstanceFileSystemList{}).
                        Returns(http.StatusOK, "OK", v1.VirtualMachineInstanceFileSystemList{}))

                subws.Route(subws.GET(definitions.NamespacedResourcePath(subresourcesvmiGVR)+definitions.SubResourcePath("objectgraph")).
                        To(subresourceApp.VMIObjectGraph).
                        Consumes(restful.MIME_JSON).
                        Reads(v1.ObjectGraphOptions{}).
                        Produces(restful.MIME_JSON).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"vmi-objectgraph").
                        Doc("Get graph of objects related to a Virtual Machine Instance").
                        Writes(v1.ObjectGraphNode{}).
                        Returns(http.StatusOK, "OK", v1.ObjectGraphNode{}))

                subws.Route(subws.GET(definitions.NamespacedResourcePath(subresourcesvmGVR)+definitions.SubResourcePath("objectgraph")).
                        To(subresourceApp.VMObjectGraph).
                        Consumes(restful.MIME_JSON).
                        Reads(v1.ObjectGraphOptions{}).
                        Produces(restful.MIME_JSON).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"vm-objectgraph").
                        Doc("Get graph of objects related to a Virtual Machine").
                        Writes(v1.ObjectGraphNode{}).
                        Returns(http.StatusOK, "OK", v1.ObjectGraphNode{}))

                subws.Route(subws.PUT(definitions.NamespacedResourcePath(subresourcesvmiGVR)+definitions.SubResourcePath("addvolume")).
                        To(subresourceApp.VMIAddVolumeRequestHandler).
                        Consumes(mime.MIME_ANY).
                        Reads(v1.AddVolumeOptions{}).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"vmi-addvolume").
                        Doc("Add a volume and disk to a running Virtual Machine Instance").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusBadRequest, httpStatusBadRequestMessage, ""))

                subws.Route(subws.PUT(definitions.NamespacedResourcePath(subresourcesvmiGVR)+definitions.SubResourcePath("removevolume")).
                        To(subresourceApp.VMIRemoveVolumeRequestHandler).
                        Consumes(mime.MIME_ANY).
                        Reads(v1.RemoveVolumeOptions{}).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"vmi-removevolume").
                        Doc("Removes a volume and disk from a running Virtual Machine Instance").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusBadRequest, httpStatusBadRequestMessage, ""))

                subws.Route(subws.PUT(definitions.NamespacedResourcePath(subresourcesvmGVR)+definitions.SubResourcePath("addvolume")).
                        To(subresourceApp.VMAddVolumeRequestHandler).
                        Consumes(mime.MIME_ANY).
                        Reads(v1.AddVolumeOptions{}).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"vm-addvolume").
                        Doc("Add a volume and disk to a running Virtual Machine.").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusBadRequest, httpStatusBadRequestMessage, ""))

                subws.Route(subws.PUT(definitions.NamespacedResourcePath(subresourcesvmGVR)+definitions.SubResourcePath("removevolume")).
                        To(subresourceApp.VMRemoveVolumeRequestHandler).
                        Consumes(mime.MIME_ANY).
                        Reads(v1.RemoveVolumeOptions{}).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"vm-removevolume").
                        Doc("Removes a volume and disk from a running Virtual Machine.").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusBadRequest, httpStatusBadRequestMessage, ""))

                subws.Route(subws.PUT(definitions.NamespacedResourcePath(subresourcesvmGVR)+definitions.SubResourcePath("memorydump")).
                        To(subresourceApp.MemoryDumpVMRequestHandler).
                        Consumes(mime.MIME_ANY).
                        Reads(v1.VirtualMachineMemoryDumpRequest{}).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"MemoryDump").
                        Doc("Dumps a VirtualMachineInstance memory.").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusInternalServerError, httpStatusInternalServerError, ""))

                subws.Route(subws.PUT(definitions.NamespacedResourcePath(subresourcesvmGVR)+definitions.SubResourcePath("removememorydump")).
                        To(subresourceApp.RemoveMemoryDumpVMRequestHandler).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"RemoveMemoryDump").
                        Doc("Remove memory dump association.").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusInternalServerError, httpStatusInternalServerError, ""))

                // AMD SEV endpoints
                subws.Route(subws.GET(definitions.NamespacedResourcePath(subresourcesvmiGVR)+definitions.SubResourcePath("sev/fetchcertchain")).
                        To(subresourceApp.SEVFetchCertChainRequestHandler).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Consumes(restful.MIME_JSON).
                        Produces(restful.MIME_JSON).
                        Operation(version.Version+"SEVFetchCertChain").
                        Doc("Fetch SEV certificate chain from the node where Virtual Machine is scheduled").
                        Writes(v1.SEVPlatformInfo{}).
                        Returns(http.StatusOK, "OK", v1.SEVPlatformInfo{}))

                subws.Route(subws.GET(definitions.NamespacedResourcePath(subresourcesvmiGVR)+definitions.SubResourcePath("sev/querylaunchmeasurement")).
                        To(subresourceApp.SEVQueryLaunchMeasurementHandler).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Consumes(restful.MIME_JSON).
                        Produces(restful.MIME_JSON).
                        Operation(version.Version+"SEVQueryLaunchMeasurement").
                        Doc("Query SEV launch measurement from a Virtual Machine").
                        Writes(v1.SEVMeasurementInfo{}).
                        Returns(http.StatusOK, "OK", v1.SEVMeasurementInfo{}))

                subws.Route(subws.PUT(definitions.NamespacedResourcePath(subresourcesvmiGVR)+definitions.SubResourcePath("sev/setupsession")).
                        To(subresourceApp.SEVSetupSessionHandler).
                        Consumes(mime.MIME_ANY).
                        Reads(v1.SEVSessionOptions{}).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"SEVSetupSession").
                        Doc("Setup SEV session parameters for a Virtual Machine").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusBadRequest, httpStatusBadRequestMessage, ""))

                subws.Route(subws.PUT(definitions.NamespacedResourcePath(subresourcesvmiGVR)+definitions.SubResourcePath("sev/injectlaunchsecret")).
                        To(subresourceApp.SEVInjectLaunchSecretHandler).
                        Consumes(mime.MIME_ANY).
                        Reads(v1.SEVSecretOptions{}).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"SEVInjectLaunchSecret").
                        Doc("Inject SEV launch secret into a Virtual Machine").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusBadRequest, httpStatusBadRequestMessage, ""))

                subws.Route(subws.PUT(definitions.NamespacedResourcePath(subresourcesvmGVR)+definitions.SubResourcePath("evacuate/cancel")).
                        To(subresourceApp.EvacuateCancelHandler(subresourceApp.FetchVirtualMachineInstanceForVM)).
                        Consumes(mime.MIME_ANY).
                        Reads(v1.EvacuateCancelOptions{}).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"vm-evacuatecancel").
                        Doc("Cancel evacuation Virtual Machine").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusNotFound, httpStatusNotFoundMessage, "").
                        Returns(http.StatusBadRequest, httpStatusBadRequestMessage, "").
                        Returns(http.StatusInternalServerError, httpStatusInternalServerError, ""))

                subws.Route(subws.PUT(definitions.NamespacedResourcePath(subresourcesvmiGVR)+definitions.SubResourcePath("evacuate/cancel")).
                        To(subresourceApp.EvacuateCancelHandler(subresourceApp.FetchVirtualMachineInstance)).
                        Consumes(mime.MIME_ANY).
                        Reads(v1.EvacuateCancelOptions{}).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"vmi-evacuatecancel").
                        Doc("Cancel evacuation Virtual Machine Instance").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusNotFound, httpStatusNotFoundMessage, "").
                        Returns(http.StatusBadRequest, httpStatusBadRequestMessage, "").
                        Returns(http.StatusInternalServerError, httpStatusInternalServerError, ""))

                subws.Route(subws.PUT(definitions.NamespacedResourcePath(subresourcesvmiGVR)+definitions.SubResourcePath("backup")).
                        To(subresourceApp.BackupVMIRequestHandler).
                        Consumes(mime.MIME_ANY).
                        Reads(backupv1.BackupOptions{}).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"Backup").
                        Doc("Initiate a VirtualMachineInstance backup.").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusNotFound, httpStatusNotFoundMessage, "").
                        Returns(http.StatusBadRequest, httpStatusBadRequestMessage, ""))

                subws.Route(subws.PUT(definitions.NamespacedResourcePath(subresourcesvmiGVR)+definitions.SubResourcePath("redefine-checkpoint")).
                        To(subresourceApp.RedefineCheckpointVMIRequestHandler).
                        Consumes(mime.MIME_ANY).
                        Reads(backupv1.BackupCheckpoint{}).
                        Param(definitions.NamespaceParam(subws)).Param(definitions.NameParam(subws)).
                        Operation(version.Version+"RedefineCheckpoint").
                        Doc("Redefine a checkpoint for a VirtualMachineInstance.").
                        Returns(http.StatusOK, "OK", "").
                        Returns(http.StatusNotFound, httpStatusNotFoundMessage, "").
                        Returns(http.StatusBadRequest, httpStatusBadRequestMessage, ""))

                // Return empty api resource list.
                // K8s expects to be able to retrieve a resource list for each aggregated
                // app in order to discover what resources it provides. Without returning
                // an empty list here, there's a bug in the k8s resource discovery that
                // breaks kubectl's ability to reference short names for resources.
                subws.Route(subws.GET("/").
                        Produces(restful.MIME_JSON).Writes(metav1.APIResourceList{}).
                        To(func(request *restful.Request, response *restful.Response) {
                                list := &metav1.APIResourceList{}

                                list.Kind = "APIResourceList"
                                list.GroupVersion = version.Group + "/" + version.Version
                                list.APIVersion = "v1"
                                list.APIResources = []metav1.APIResource{
                                        {
                                                Name:       "expand-vm-spec",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/vnc",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/vnc/screenshot",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/console",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/portforward",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/backup",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/redefine-checkpoint",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/pause",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/unpause",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/freeze",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/unfreeze",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/reset",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/softreboot",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachines/start",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachines/stop",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachines/restart",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachines/migrate",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachines/expand-spec",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachines/objectgraph",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachines/evacuate/cancel",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/guestosinfo",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/userlist",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/filesystemlist",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/addvolume",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/removevolume",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/objectgraph",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/sev/fetchcertchain",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/sev/querylaunchmeasurement",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/sev/setupsession",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/sev/injectlaunchsecret",
                                                Namespaced: true,
                                        },
                                        {
                                                Name:       "virtualmachineinstances/evacuate/cancel",
                                                Namespaced: true,
                                        },
                                }

                                response.WriteAsJson(list)
                        }).
                        Operation(version.Version+"getAPISubResources").
                        Doc("Get a KubeVirt API resources").
                        Returns(http.StatusOK, "OK", metav1.APIResourceList{}).
                        Returns(http.StatusNotFound, httpStatusNotFoundMessage, ""))

                restful.Add(subws)

                subwss = append(subwss, subws)
        }
        ws := new(restful.WebService)

        // K8s needs the ability to query the root paths
        ws.Route(ws.GET("/").
                Produces(restful.MIME_JSON).Writes(metav1.RootPaths{}).
                To(func(request *restful.Request, response *restful.Response) {
                        paths := []string{
                                "/apis",
                                "/openapi/v2",
                        }
                        for _, version := range v1.SubresourceGroupVersions {
                                paths = append(paths, definitions.GroupBasePath(version))
                                paths = append(paths, definitions.GroupVersionBasePath(version))
                        }
                        response.WriteAsJson(&metav1.RootPaths{
                                Paths: paths,
                        })
                }).
                Operation("getRootPaths").
                Doc("Get KubeVirt API root paths").
                Returns(http.StatusOK, "OK", metav1.RootPaths{}).
                Returns(http.StatusNotFound, httpStatusNotFoundMessage, ""))
        ws.Route(ws.GET("/healthz").To(healthz.KubeConnectionHealthzFuncFactory(app.clusterConfig, apiHealthVersion)).Doc("Health endpoint"))

        componentProfiler := profiler.NewProfileManager(app.clusterConfig)

        ws.Route(ws.GET("/start-profiler").To(componentProfiler.HandleStartProfiler).Doc("start profiler endpoint"))
        ws.Route(ws.GET("/stop-profiler").To(componentProfiler.HandleStopProfiler).Doc("stop profiler endpoint"))
        ws.Route(ws.GET("/dump-profiler").To(componentProfiler.HandleDumpProfiler).Doc("dump profiler results endpoint"))

        // K8s needs the ability to query info about a specific API group
        ws.Route(ws.GET(definitions.GroupBasePath(v1.SubresourceGroupVersions[0])).
                Produces(restful.MIME_JSON).Writes(metav1.APIGroup{}).
                To(func(request *restful.Request, response *restful.Response) {
                        response.WriteAsJson(subresourceAPIGroup())
                }).
                Operation(v1.SubresourceGroupVersions[0].Version+"GetSubAPIGroup").
                Doc("Get a KubeVirt API Group").
                Returns(http.StatusOK, "OK", metav1.APIGroup{}).
                Returns(http.StatusNotFound, httpStatusNotFoundMessage, ""))

        // K8s needs the ability to query the list of API groups this endpoint supports
        ws.Route(ws.GET("apis").
                Produces(restful.MIME_JSON).Writes(metav1.APIGroupList{}).
                To(func(request *restful.Request, response *restful.Response) {
                        list := &metav1.APIGroupList{}
                        list.Kind = "APIGroupList"
                        list.Groups = append(list.Groups, subresourceAPIGroup())
                        response.WriteAsJson(list)
                }).
                Operation("getAPIGroupList").
                Doc("Get a KubeVirt API GroupList").
                Returns(http.StatusOK, "OK", metav1.APIGroupList{}).
                Returns(http.StatusNotFound, httpStatusNotFoundMessage, ""))

        once := sync.Once{}
        var openapispec *spec.Swagger
        ws.Route(ws.GET("openapi/v2").
                Consumes(restful.MIME_JSON).
                Produces(restful.MIME_JSON).
                To(func(request *restful.Request, response *restful.Response) {
                        once.Do(func() {
                                openapispec = openapi.LoadOpenAPISpec([]*restful.WebService{ws, subwss[0]})
                                openapispec.Info.Version = virtversion.Get().String()
                        })
                        response.WriteAsJson(openapispec)
                }))

        restful.Add(ws)
}

func (app *virtAPIApp) Compose() {

        app.composeSubresources()

        restful.Filter(filter.RequestLoggingFilter())
        restful.Filter(restful.OPTIONSFilter())
        restful.Filter(func(req *restful.Request, resp *restful.Response, chain *restful.FilterChain) {
                allowed, reason, err := app.authorizor.Authorize(req)
                if err != nil {

                        log.Log.Reason(err).Error("internal error during auth request")
                        resp.WriteHeader(http.StatusInternalServerError)
                        return
                } else if allowed {
                        // request is permitted, so proceed with filter chain.
                        chain.ProcessFilter(req, resp)
                        return
                }
                resp.WriteErrorString(http.StatusUnauthorized, reason)
        })
}

func (app *virtAPIApp) ConfigureOpenAPIService() {
        config := openapi.CreateV3Config()
        config.GetDefinitions = v12.GetOpenAPIDefinitions
        spec, err := builderv3.BuildOpenAPISpecFromRoutes(restfuladapter.AdaptWebServices(restful.RegisteredWebServices()), config)
        if err != nil {
                panic(err)
        }

        ws := new(restful.WebService)
        ws.Path("/swaggerapi")
        ws.Produces(restful.MIME_JSON)
        f := func(req *restful.Request, resp *restful.Response) {
                resp.WriteAsJson(spec)
        }
        ws.Route(ws.GET("/").To(f))

        restful.DefaultContainer.Add(ws)
        http.Handle("/swagger-ui/", http.StripPrefix("/swagger-ui/", http.FileServer(http.Dir(app.SwaggerUI))))
}

func deserializeStrings(in string) ([]string, error) {
        if len(in) == 0 {
                return nil, nil
        }
        var ret []string
        if err := json.Unmarshal([]byte(in), &ret); err != nil {
                return nil, err
        }
        return ret, nil
}

func (app *virtAPIApp) readRequestHeader() error {
        authConfigMap, err := app.virtCli.CoreV1().ConfigMaps(metav1.NamespaceSystem).Get(context.Background(), util.ExtensionAPIServerAuthenticationConfigMap, metav1.GetOptions{})
        if err != nil {
                return err
        }

        // The request-header CA is mandatory. It can be retrieved from the configmap as we do here, or it must be provided
        // via flag on start of this apiserver. Since we don't do the latter, the former is mandatory for us
        // see https://github.com/kubernetes-incubator/apiserver-builder-alpha/blob/master/docs/concepts/auth.md#requestheader-authentication
        _, ok := authConfigMap.Data[util.RequestHeaderClientCAFileKey]
        if !ok {
                return fmt.Errorf("requestheader-client-ca-file not found in extension-apiserver-authentication ConfigMap")
        }

        // This config map also contains information about what
        // headers our authorizor should inspect
        headers, ok := authConfigMap.Data["requestheader-username-headers"]
        if ok {
                headerList, err := deserializeStrings(headers)
                if err != nil {
                        return err
                }
                app.authorizor.AddUserHeaders(headerList)
        }

        headers, ok = authConfigMap.Data["requestheader-group-headers"]
        if ok {
                headerList, err := deserializeStrings(headers)
                if err != nil {
                        return err
                }
                app.authorizor.AddGroupHeaders(headerList)
        }

        headers, ok = authConfigMap.Data["requestheader-extra-headers-prefix"]
        if ok {
                headerList, err := deserializeStrings(headers)
                if err != nil {
                        return err
                }
                app.authorizor.AddExtraPrefixHeaders(headerList)
        }
        return nil
}

func (app *virtAPIApp) prepareCertManager() {
        app.certmanager = bootstrap.NewFileCertificateManager(app.tlsCertFilePath, app.tlsKeyFilePath)
        app.handlerCertManager = bootstrap.NewFileCertificateManager(app.handlerCertFilePath, app.handlerKeyFilePath)
}

func (app *virtAPIApp) registerValidatingWebhooks(informers *webhooks.Informers) {
        http.HandleFunc(components.VMICreateValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServeVMICreate(w, r, app.clusterConfig, app.kubeVirtServiceAccounts,
                        func(field *field.Path, vmiSpec *v1.VirtualMachineInstanceSpec, clusterCfg *virtconfig.ClusterConfig) []metav1.StatusCause {
                                return netadmitter.Validate(field, vmiSpec, clusterCfg)
                        },
                )
        })
        http.HandleFunc(components.VMIUpdateValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServeVMIUpdate(w, r, app.clusterConfig, app.kubeVirtServiceAccounts)
        })
        http.HandleFunc(components.VMValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServeVMs(w, r, app.clusterConfig, app.virtCli, informers, app.kubeVirtServiceAccounts)
        })
        http.HandleFunc(components.VMIRSValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServeVMIRS(w, r, app.clusterConfig)
        })
        http.HandleFunc(components.VMPoolValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServeVMPool(w, r, app.clusterConfig, app.kubeVirtServiceAccounts)
        })
        http.HandleFunc(components.VMIPresetValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServeVMIPreset(w, r)
        })
        http.HandleFunc(components.MigrationCreateValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServeMigrationCreate(w, r, app.clusterConfig, app.virtCli, app.kubeVirtServiceAccounts)
        })
        http.HandleFunc(components.MigrationUpdateValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServeMigrationUpdate(w, r)
        })
        http.HandleFunc(components.VMSnapshotValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServeVMSnapshots(w, r, app.clusterConfig, app.virtCli)
        })
        http.HandleFunc(components.VMRestoreValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServeVMRestores(w, r, app.clusterConfig, app.virtCli, informers)
        })
        http.HandleFunc(components.VMBackupValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServeVMBackups(w, r, app.clusterConfig, app.virtCli, informers)
        })
        http.HandleFunc(components.VMBackupTrackerValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServeVMBackupTrackers(w, r, app.clusterConfig)
        })
        http.HandleFunc(components.VMExportValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServeVMExports(w, r, app.clusterConfig)
        })
        http.HandleFunc(components.VMInstancetypeValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServeVmInstancetypes(w, r)
        })
        http.HandleFunc(components.VMClusterInstancetypeValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServeVmClusterInstancetypes(w, r)
        })
        http.HandleFunc(components.VMPreferenceValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServeVmPreferences(w, r)
        })
        http.HandleFunc(components.VMClusterPreferenceValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServeVmClusterPreferences(w, r)
        })
        http.HandleFunc(components.StatusValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServeStatusValidation(w, r, app.clusterConfig, app.virtCli, informers, app.kubeVirtServiceAccounts)
        })
        http.HandleFunc(components.PodEvictionValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServePodEvictionInterceptor(w, r, app.clusterConfig, app.virtCli)
        })
        http.HandleFunc(components.MigrationPolicyCreateValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServeMigrationPolicies(w, r)
        })
        http.HandleFunc(components.VMCloneCreateValidatePath, func(w http.ResponseWriter, r *http.Request) {
                validating_webhook.ServeVirtualMachineClones(w, r, app.clusterConfig, app.virtCli)
        })
}

func (app *virtAPIApp) registerMutatingWebhook(informers *webhooks.Informers) {

        http.HandleFunc(components.VMMutatePath, func(w http.ResponseWriter, r *http.Request) {
                mutating_webhook.ServeVMs(w, r, app.clusterConfig, app.virtCli)
        })
        http.HandleFunc(components.VMIMutatePath, func(w http.ResponseWriter, r *http.Request) {
                mutating_webhook.ServeVMIs(w, r, app.clusterConfig, informers, app.kubeVirtServiceAccounts)
        })
        http.HandleFunc(components.MigrationMutatePath, func(w http.ResponseWriter, r *http.Request) {
                mutating_webhook.ServeMigrationCreate(w, r)
        })
        http.HandleFunc(components.VMCloneCreateMutatePath, func(w http.ResponseWriter, r *http.Request) {
                mutating_webhook.ServeClones(w, r)
        })
        http.HandleFunc(components.VirtLauncherPodMutatePath, func(w http.ResponseWriter, r *http.Request) {
                mutating_webhook.ServeVirtLauncherPods(w, r, app.clusterConfig, app.virtCli)
        })
}

func (app *virtAPIApp) setupTLS(k8sCAManager kvtls.KubernetesCAManager, kubevirtCAManager kvtls.ClientCAManager) {

        // A VerifyClientCertIfGiven request means we're not guaranteed
        // a client has been authenticated unless they provide a peer
        // cert.
        //
        // Make sure to verify in subresource endpoint that peer cert
        // was provided before processing request. If the peer cert is
        // given on the connection, then we can be guaranteed that it
        // was signed by the client CA in our pool.
        //
        // There is another ClientAuth type called 'RequireAndVerifyClientCert'
        // We can't use this type here because during the aggregated api status
        // check it attempts to hit '/' on our api endpoint to verify an http
        // response is given. That status request won't send a peer cert regardless
        // if the TLS handshake requests it. As a result, the TLS handshake fails
        // and our aggregated endpoint never becomes available.
        app.tlsConfig = kvtls.SetupTLSWithCertManager(k8sCAManager, app.certmanager, tls.VerifyClientCertIfGiven, app.clusterConfig)
        app.handlerTLSConfiguration = kvtls.SetupTLSForVirtHandlerClients(kubevirtCAManager, app.handlerCertManager, app.externallyManaged)
}

func (app *virtAPIApp) startTLS(informerFactory controller.KubeInformerFactory) error {

        errors := make(chan error)
        c := make(chan os.Signal, 1)

        signal.Notify(c, os.Interrupt,
                syscall.SIGHUP,
                syscall.SIGINT,
                syscall.SIGTERM,
                syscall.SIGQUIT,
        )

        authConfigMapInformer := informerFactory.ApiAuthConfigMap()
        kubevirtCAConfigInformer := informerFactory.KubeVirtCAConfigMap()

        k8sCAManager := kvtls.NewKubernetesClientCAManager(authConfigMapInformer.GetStore())
        kubevirtCAInformer := kvtls.NewCAManager(kubevirtCAConfigInformer.GetStore(), app.namespace, app.caConfigMapName)
        app.setupTLS(k8sCAManager, kubevirtCAInformer)

        app.Compose()

        http.Handle("/metrics", promhttp.Handler())
        server := &http.Server{
                Addr:      fmt.Sprintf("%s:%d", app.BindAddress, app.Port),
                TLSConfig: app.tlsConfig,
                // Disable HTTP/2
                // See CVE-2023-44487
                TLSNextProto: map[string]func(*http.Server, *tls.Conn, http.Handler){},
        }

        // start TLS server
        go func() {
                errors <- server.ListenAndServeTLS("", "")
        }()

        // start graceful shutdown handler
        go func() {
                select {
                case s := <-c:
                        log.Log.Infof("Received signal %s, initiating graceful shutdown", s.String())
                case msg := <-app.reInitChan:
                        log.Log.Infof("Received signal to reInitialize virt-api [%s], initiating graceful shutdown", msg)
                }

                // pause briefly to ensure the load balancer has had a chance to
                // remove this endpoint from rotation due to pod.DeletionTimestamp != nil
                // By pausing, we reduce the chance that the load balancer will attempt to
                // route new requests to the service after we've started the shutdown
                // procedure
                time.Sleep(5 * time.Second)

                // by default, server.Shutdown() waits indefinitely for all existing
                // connections to close. We need to give this a timeout to ensure the
                // shutdown will eventually complete.
                ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
                defer func() {
                        cancel()
                }()

                // Shutdown means new connections are not permitted and it waits for existing
                // connections to terminate (up to the context timeout)
                server.Shutdown(ctx)
                // Shutdown forces any existing connections that persist after the shutdown
                // times out to be forced closed.
                server.Close()
        }()

        // wait for server to exit
        err := <-errors

        if err != nil && err != http.ErrServerClosed {
                // ErrServerClosed is an expected error during normal shutdown
                return err
        }
        return nil
}

func (app *virtAPIApp) Run() {
        host, err := os.Hostname()
        if err != nil {
                panic(fmt.Errorf("unable to get hostname: %v", err))
        }
        app.host = host

        // get client Cert
        err = app.readRequestHeader()
        if err != nil {
                panic(err)
        }

        // Get/Set selfsigned cert
        app.prepareCertManager()

        // Run informers for webhooks usage
        kubeInformerFactory := controller.NewKubeInformerFactory(app.virtCli.RestClient(), app.virtCli, app.aggregatorClient, app.namespace)

        kubeVirtInformer := kubeInformerFactory.KubeVirt()
        // Wire up health check trigger
        kubeVirtInformer.SetWatchErrorHandler(func(r *cache.Reflector, err error) {
                apiHealthVersion.Clear()
                cache.DefaultWatchErrorHandler(context.TODO(), r, err)
        })

        kubeInformerFactory.ApiAuthConfigMap()
        kubeInformerFactory.KubeVirtCAConfigMap()
        crdInformer := kubeInformerFactory.CRD()
        vmiPresetInformer := kubeInformerFactory.VirtualMachinePreset()
        vmRestoreInformer := kubeInformerFactory.VirtualMachineRestore()
        vmBackupInformer := kubeInformerFactory.VirtualMachineBackup()
        namespaceInformer := kubeInformerFactory.Namespace()

        stopChan := make(chan struct{}, 1)
        defer close(stopChan)
        kubeInformerFactory.Start(stopChan)
        kubeInformerFactory.WaitForCacheSync(stopChan)

        app.clusterConfig, err = virtconfig.NewClusterConfig(crdInformer, kubeVirtInformer, app.namespace)
        if err != nil {
                panic(err)
        }
        app.hasCDIDataSource = app.clusterConfig.HasDataSourceAPI()
        app.clusterConfig.SetConfigModifiedCallback(app.configModificationCallback)
        app.clusterConfig.SetConfigModifiedCallback(app.shouldChangeLogVerbosity)
        app.clusterConfig.SetConfigModifiedCallback(app.shouldChangeRateLimiter)

        var dataSourceInformer cache.SharedIndexInformer
        if app.hasCDIDataSource {
                dataSourceInformer = kubeInformerFactory.DataSource()
                log.Log.Infof("CDI detected, DataSource integration enabled")
        } else {
                // Add a dummy DataSource informer in the event datasource support
                // is disabled. This lets the controller continue to work without
                // requiring a separate branching code path.
                dataSourceInformer = kubeInformerFactory.DummyDataSource()
                log.Log.Infof("CDI not detected, DataSource integration disabled")
        }

        // It is safe to call kubeInformerFactory.Start multiple times.
        // The function is idempotent and will only start the informers that
        // have not been started yet
        kubeInformerFactory.Start(stopChan)
        kubeInformerFactory.WaitForCacheSync(stopChan)

        webhookInformers := &webhooks.Informers{
                VMIPresetInformer:  vmiPresetInformer,
                VMRestoreInformer:  vmRestoreInformer,
                VMBackupInformer:   vmBackupInformer,
                DataSourceInformer: dataSourceInformer,
                NamespaceInformer:  namespaceInformer,
        }

        // Build webhook subresources
        app.registerMutatingWebhook(webhookInformers)
        app.registerValidatingWebhooks(webhookInformers)

        go app.certmanager.Start()
        go app.handlerCertManager.Start()

        // start TLS server
        // tls server will only accept connections when fetching a certificate and internal configuration passed once
        err = app.startTLS(kubeInformerFactory)
        if err != nil {
                panic(err)
        }

}

// Detects if a config has been applied that requires
// re-initializing virt-api.
func (app *virtAPIApp) configModificationCallback() {
        newHasCDI := app.clusterConfig.HasDataSourceAPI()
        if newHasCDI != app.hasCDIDataSource {
                if newHasCDI {
                        log.Log.Infof("Reinitialize virt-api, cdi DataSource api has been introduced")
                } else {
                        log.Log.Infof("Reinitialize virt-api, cdi DataSource api has been removed")
                }
                app.reInitChan <- "reinit due to CDI api change"
        }
}

// Update virt-api log verbosity on relevant config changes
func (app *virtAPIApp) shouldChangeLogVerbosity() {
        verbosity := app.clusterConfig.GetVirtAPIVerbosity(app.host)
        log.Log.SetVerbosityLevel(int(verbosity))
        log.Log.V(2).Infof("set log verbosity to %d", verbosity)
}

// Update virt-handler rate limiter
func (app *virtAPIApp) shouldChangeRateLimiter() {
        config := app.clusterConfig.GetConfig()
        qps := config.APIConfiguration.RestClient.RateLimiter.TokenBucketRateLimiter.QPS
        burst := config.APIConfiguration.RestClient.RateLimiter.TokenBucketRateLimiter.Burst
        app.reloadableRateLimiter.Set(flowcontrol.NewTokenBucketRateLimiter(qps, burst))
        log.Log.V(2).Infof("setting rate limiter for the API to %v QPS and %v Burst", qps, burst)
        qps = config.WebhookConfiguration.RestClient.RateLimiter.TokenBucketRateLimiter.QPS
        burst = config.WebhookConfiguration.RestClient.RateLimiter.TokenBucketRateLimiter.Burst
        app.reloadableWebhookRateLimiter.Set(flowcontrol.NewTokenBucketRateLimiter(qps, burst))
        log.Log.V(2).Infof("setting rate limiter for webhooks to %v QPS and %v Burst", qps, burst)
}

func (app *virtAPIApp) AddFlags() {
        app.InitFlags()

        app.AddCommonFlags()

        flag.StringVar(&app.SwaggerUI, "swagger-ui", "third_party/swagger-ui",
                "swagger-ui location")
        flag.BoolVar(&app.SubresourcesOnly, "subresources-only", false,
                "Only serve subresource endpoints")
        flag.IntVar(&app.consoleServerPort, "console-server-port", DefaultConsoleServerPort,
                "The port virt-handler listens on for console requests")
        flag.StringVar(&app.caConfigMapName, "ca-configmap-name", defaultCAConfigMapName,
                "The name of configmap containing CA certificates to authenticate requests presenting client certificates with matching CommonName")
        flag.StringVar(&app.tlsCertFilePath, "tls-cert-file", defaultTlsCertFilePath,
                "File containing the default x509 Certificate for HTTPS")
        flag.StringVar(&app.tlsKeyFilePath, "tls-key-file", defaultTlsKeyFilePath,
                "File containing the default x509 private key matching --tls-cert-file")
        flag.StringVar(&app.handlerCertFilePath, "handler-cert-file", defaultHandlerCertFilePath,
                "Client certificate used to prove the identity of the virt-api when it must call virt-handler during a request")
        flag.StringVar(&app.handlerKeyFilePath, "handler-key-file", defaultHandlerKeyFilePath,
                "Private key for the client certificate used to prove the identity of the virt-api when it must call virt-handler during a request")
        flag.BoolVar(&app.externallyManaged, "externally-managed", false,
                "Allow intermediate certificates to be used in building up the chain of trust when certificates are externally managed")
}

// GetGsInfo returns the libguestfs-tools image information based on the KubeVirt installation in the namespace.
func (app *virtAPIApp) GetGsInfo() func(_ *restful.Request, response *restful.Response) {
        return func(_ *restful.Request, response *restful.Response) {
                var kvConfig virtoperatorutils.KubeVirtDeploymentConfig
                kv := app.clusterConfig.GetConfigFromKubeVirtCR()
                if kv == nil {
                        error_guestfs(fmt.Errorf("Failed getting KubeVirt config"), response)
                }
                err := json.Unmarshal([]byte(kv.Status.ObservedDeploymentConfig), &kvConfig)
                if err != nil {
                        error_guestfs(err, response)
                        return
                }
                response.WriteAsJson(kubecli.GuestfsInfo{
                        Registry:    kv.Status.ObservedKubeVirtRegistry,
                        Tag:         kv.Status.ObservedKubeVirtVersion,
                        ImagePrefix: kvConfig.GetImagePrefix(),
                        GsImage:     kvConfig.GsImage,
                })
                return
        }
}

func error_guestfs(err error, response *restful.Response) {
        res := map[string]interface{}{}
        res["guestfs"] = map[string]interface{}{"status": "failed", "error": fmt.Sprintf("%v", err)}
        response.WriteHeaderAndJson(http.StatusInternalServerError, res, restful.MIME_JSON)
}

kubevirt / kubevirt / 53e09dbe-7149-4eef-b52c-e1d16135149a

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous