Skip to main content

@backstage/plugin-kubernetes-common

Home > @backstage/plugin-kubernetes-common

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

Interfaces

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

Variables

VariableDescription
ANNOTATION_KUBERNETES_API_SERVER_CAAnnotation for specifying the Certificate Authority of an API server for a Kubernetes cluster
ANNOTATION_KUBERNETES_API_SERVERAnnotation for specifying the API server of a Kubernetes cluster
ANNOTATION_KUBERNETES_AUTH_PROVIDERAnnotation for specifying the auth provider for a Kubernetes cluster
ANNOTATION_KUBERNETES_AWS_ASSUME_ROLEAnnotation for specifying the assume role use to authenticate with AWS.
ANNOTATION_KUBERNETES_AWS_CLUSTER_IDAnnotation for specifying the AWS ID of a cluster when signing STS tokens
ANNOTATION_KUBERNETES_AWS_EXTERNAL_IDAnnotation for specifying an external id when communicating with AWS
ANNOTATION_KUBERNETES_DASHBOARD_APPAnnotation for specifying the dashboard app for a Kubernetes cluster.
ANNOTATION_KUBERNETES_DASHBOARD_PARAMETERSAnnotation for specifying the dashboard app parameters for a Kubernetes cluster.
ANNOTATION_KUBERNETES_DASHBOARD_URLAnnotation for specifying the dashboard url for a Kubernetes cluster.
ANNOTATION_KUBERNETES_OIDC_TOKEN_PROVIDERAnnotation for specifying the oidc provider used to get id tokens for a Kubernetes cluster
ANNOTATION_KUBERNETES_SKIP_METRICS_LOOKUPAnnotation for specifying boolean value for skip metric lookup.
ANNOTATION_KUBERNETES_SKIP_TLS_VERIFYAnnotation for specifying boolean value for skip tls verify.
detectErrorsFor 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
kubernetesPermissionsList of all Kubernetes permissions.
kubernetesProxyPermissionThis permission is used to check access to the proxy endpoint

Type Aliases

Type AliasDescription
AuthProviderType
DetectedErrorsByClusterA list of errors keyed by Cluster name
ErrorSeveritySeverity of the error, where 10 is critical and 0 is very low.
FetchResponse
KubernetesErrorTypes
KubernetesFetchError
KubernetesRequestAuth
ProposedFix