@backstage/plugin-kubernetes-react

Home > @backstage/plugin-kubernetes-react

Web library for the kubernetes-react plugin.

Classes

Class	Description
AksClusterLinksFormatter
AksKubernetesAuthProvider
EksClusterLinksFormatter
GkeClusterLinksFormatter
GoogleKubernetesAuthProvider
KubernetesAuthProviders
KubernetesBackendClient
KubernetesClusterLinkFormatter
KubernetesProxyClient	A client for common requests through the proxy endpoint of the kubernetes backend plugin.
OidcKubernetesAuthProvider
OpenshiftClusterLinksFormatter
RancherClusterLinksFormatter
ServerSideKubernetesAuthProvider	No-op KubernetesAuthProvider, authorization will be handled in the kubernetes-backend plugin
StandardClusterLinksFormatter

Functions

Function	Description
Cluster({ clusterObjects, podsWithErrors })	Component for rendering Kubernetes resources in a cluster
CronJobsAccordions({})
CustomResources({})
ErrorList({ podAndErrors })	Shows a list of errors found on a Pod
ErrorPanel({ entityName, errorMessage, clustersWithErrors, })
ErrorReporting({ detectedErrors, clusters, })
Events({ involvedObjectName, namespace, clusterName, warningEventsOnly, })	Retrieves and shows Kubernetes events for the given object
EventsContent({ events, warningEventsOnly, })	Shows given Kubernetes events
getDefaultFormatters(deps)
HorizontalPodAutoscalerDrawer(props)
IngressesAccordions({})
JobsAccordions({ jobs })
KubernetesDrawer({ open, label, drawerContentsHeader, kubernetesObject, children, })	Button/Drawer component for Kubernetes Objects
KubernetesStructuredMetadataTableDrawer({ object, renderObject, kind, buttonVariant, expanded, children, })
LinkErrorPanel({ cluster, errorMessage, })
ManifestYaml({ object })	Renders a Kubernetes object as a YAML code snippet
PendingPodContent({ pod })	Shows details about pod's conditions as it starts
PodDrawer({ podAndErrors, open })	A Drawer for Kubernetes Pods
PodExecTerminal(props)	Executes a /bin/sh process in the given pod's container and opens a terminal connected to it
PodExecTerminalDialog(props)	Opens a terminal connected to the given pod's container in a dialog
PodLogsDialog({ containerScope })	Shows the logs for the given pod in a Dialog
PodsTable({ pods, extraColumns })
ResourceUtilization({ compressed, title, usage, total, totalFormatted, })	Context for Pod Metrics
ServicesAccordions({})
useCustomResources(entity, customResourceMatchers, intervalMs)	Retrieves the provided custom resources related to the provided entity, refreshes at an interval.
useEvents({ involvedObjectName, namespace, clusterName, })	Retrieves the events for the given object
useKubernetesObjects(entity, intervalMs)
useMatchingErrors(matcher)	Find errors which match the resource
usePodLogs({ containerScope, previous })	Retrieves the logs for the given pod
usePodMetrics(clusterName, matcher)	Find metrics matching the provided pod

Interfaces

Interface	Description
ClusterLinksFormatter
ClusterLinksFormatterOptions
ContainerCardProps	Props for ContainerCard
ContainerScope	Contains the details needed to make a log request to Kubernetes
CustomResourcesProps
ErrorListProps	Props for ErrorList
EventsContentProps	Props for Events
EventsOptions	Arguments for useEvents
EventsProps	Props for Events
FixDialogProps	Props for FixDialog
KubernetesApi
KubernetesAuthProvider
KubernetesAuthProvidersApi
KubernetesClusterLinkFormatterApi
KubernetesDrawerable
KubernetesDrawerProps	Props of KubernetesDrawer
KubernetesObject	The type of object that can be represented by the Drawer
KubernetesObjects
KubernetesProxyApi
KubernetesStructuredMetadataTableDrawerProps
ManifestYamlProps	Props of ManifestYaml
PendingPodContentProps	Props for PendingPodContent
PodAndErrors	Wraps a pod with the associated detected errors and cluster
PodDrawerProps	Props for PodDrawer
PodExecTerminalProps	Props drilled down to the PodExecTerminal component
PodLogsDialogProps	Props for PodLogsDialog
PodLogsOptions	Arguments for usePodLogs
PodLogsProps	Props for PodLogs
PodScope	Contains the details needed to make a log request to Kubernetes, except the container name
ResourceUtilizationProps	Context for Pod Metrics

Variables

Variable	Description
ClusterContext
ContainerCard	Shows details about a container within a pod
DEFAULT_FORMATTER_NAME
DetectedErrorsContext	Context for detected errors
FixDialog	A dialog for fixing detected Kubernetes errors
GroupedResponsesContext
kubernetesApiRef
kubernetesAuthProvidersApiRef
kubernetesClusterLinkFormatterApiRef
kubernetesProxyApiRef
PodLogs	Shows the logs for the given pod
PodMetricsContext	Context for Pod Metrics
PodNamesWithErrorsContext
PodNamesWithMetricsContext
READY_COLUMNS
RESOURCE_COLUMNS

Type Aliases

Type Alias	Description
ClusterProps	Props for Cluster
CronJobsAccordionsProps
ErrorMatcher
ErrorPanelProps
ErrorReportingProps
FormatClusterLinkOptions
IngressesAccordionsProps
JobsAccordionsProps
LinkErrorPanelProps
PodColumns
PodMetricsMatcher
PodsTablesProps
ServicesAccordionsProps