topology

Documentation

Index

• func GetTopology(clusterMgr *cluster.ClusterManager, insightMgr *insight.InsightManager, ...) http.HandlerFunc

Functions

func GetTopology

func GetTopology(clusterMgr *cluster.ClusterManager, insightMgr *insight.InsightManager, c *server.CompletedConfig) http.HandlerFunc

GetTopology returns an HTTP handler function that returns a topology map for a Kubernetes resource. It utilizes an InsightManager to execute the logic.

@Summary GetTopology returns a topology map for a Kubernetes resource by name, namespace, cluster, apiVersion and kind. @Description This endpoint returns a topology map for a Kubernetes resource by name, namespace, cluster, apiVersion and kind. @Tags insight @Produce json @Param cluster query string false "The specified cluster name, such as 'example-cluster'" @Param apiVersion query string false "The specified apiVersion, such as 'apps/v1'. Should be percent-encoded" @Param kind query string false "The specified kind, such as 'Deployment'" @Param namespace query string false "The specified namespace, such as 'default'" @Param name query string false "The specified resource name, such as 'foo'" @Param forceNew query bool false "Force re-generating the topology, default is 'false'" @Success 200 {object} map[string]map[string]insight.ResourceTopology "map from string to resource.ResourceTopology" @Failure 400 {string} string "Bad Request" @Failure 401 {string} string "Unauthorized" @Failure 404 {string} string "Not Found" @Failure 405 {string} string "Method Not Allowed" @Failure 429 {string} string "Too Many Requests" @Failure 500 {string} string "Internal Server Error" @Router /rest-api/v1/insight/topology [get]