@backstage/plugin-kubernetes-common

Home > @backstage/plugin-kubernetes-common

Common functionalities for Kubernetes, to be shared between the kubernetes and kubernetes-backend plugins

Functions

Function	Description
detectErrors(objects)	For each cluster try to find errors in each of the object types provided returning a map of cluster names to errors in that cluster
groupResponses(fetchResponse)

Interfaces

Interface	Description
ClientContainerStatus
ClientCurrentResourceUsage
ClientPodStatus
ClusterAttributes
ClusterObjects
ConfigMapFetchResponse
CronJobsFetchResponse
CustomObjectsByEntityRequest
CustomResourceFetchResponse
CustomResourceMatcher
DaemonSetsFetchResponse
DeploymentFetchResponse
DeploymentResources
DetectedError	Represents an error found on a Kubernetes object
DocsSolution
ErrorMapper
EventsSolution
GroupedResponses
HorizontalPodAutoscalersFetchResponse
IngressesFetchResponse
JobsFetchResponse
KubernetesRequestBody
LimitRangeFetchResponse
LogSolution
ObjectsByEntityResponse
PodFetchResponse
PodStatusFetchResponse
ProposedFixBase
RawFetchError
ReplicaSetsFetchResponse
ResourceQuotaFetchResponse
ResourceRef	A reference to a Kubernetes object
ServiceFetchResponse
StatefulSetsFetchResponse
StatusError
WorkloadsByEntityRequest

Variables

Variable	Description
ANNOTATION_KUBERNETES_API_SERVER_CA	Annotation for specifying the Certificate Authority of an API server for a Kubernetes cluster
ANNOTATION_KUBERNETES_API_SERVER	Annotation for specifying the API server of a Kubernetes cluster
ANNOTATION_KUBERNETES_AUTH_PROVIDER	Annotation for specifying the auth provider for a Kubernetes cluster
ANNOTATION_KUBERNETES_AWS_ASSUME_ROLE	Annotation for specifying the assume role use to authenticate with AWS.
ANNOTATION_KUBERNETES_AWS_CLUSTER_ID	Annotation for specifying the AWS ID of a cluster when signing STS tokens
ANNOTATION_KUBERNETES_AWS_EXTERNAL_ID	Annotation for specifying an external id when communicating with AWS
ANNOTATION_KUBERNETES_DASHBOARD_APP	Annotation for specifying the dashboard app for a Kubernetes cluster.
ANNOTATION_KUBERNETES_DASHBOARD_PARAMETERS	Annotation for specifying the dashboard app parameters for a Kubernetes cluster.
ANNOTATION_KUBERNETES_DASHBOARD_URL	Annotation for specifying the dashboard url for a Kubernetes cluster.
ANNOTATION_KUBERNETES_OIDC_TOKEN_PROVIDER	Annotation for specifying the oidc provider used to get id tokens for a Kubernetes cluster
ANNOTATION_KUBERNETES_SKIP_METRICS_LOOKUP	Annotation for specifying boolean value for skip metric lookup.
ANNOTATION_KUBERNETES_SKIP_TLS_VERIFY	Annotation for specifying boolean value for skip tls verify.
kubernetesPermissions	List of all Kubernetes permissions.
kubernetesProxyPermission	This permission is used to check access to the proxy endpoint

Type Aliases

Type Alias	Description
AuthProviderType
DetectedErrorsByCluster	A list of errors keyed by Cluster name
ErrorSeverity	Severity of the error, where 10 is critical and 0 is very low.
FetchResponse
KubernetesErrorTypes
KubernetesFetchError
KubernetesRequestAuth
ProposedFix