@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 |
|---|---|
| getDefaultFormatters(deps) |
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 |
|---|---|
| Cluster | Component for rendering Kubernetes resources in a cluster |
| ClusterContext | |
| ContainerCard | Shows details about a container within a pod |
| CronJobsAccordions | |
| CustomResources | |
| DEFAULT_FORMATTER_NAME | |
| DetectedErrorsContext | Context for detected errors |
| ErrorList | Shows a list of errors found on a Pod |
| ErrorPanel | |
| ErrorReporting | |
| Events | Retrieves and shows Kubernetes events for the given object |
| EventsContent | Shows given Kubernetes events |
| FixDialog | A dialog for fixing detected Kubernetes errors |
| GroupedResponsesContext | |
| HorizontalPodAutoscalerDrawer | |
| IngressesAccordions | |
| JobsAccordions | |
| kubernetesApiRef | |
| kubernetesAuthProvidersApiRef | |
| kubernetesClusterLinkFormatterApiRef | |
| KubernetesDrawer | Button/Drawer component for Kubernetes Objects |
| kubernetesProxyApiRef | |
| KubernetesStructuredMetadataTableDrawer | |
| LinkErrorPanel | |
| ManifestYaml | Renders a Kubernetes object as a YAML code snippet |
| PendingPodContent | Shows details about pod's conditions as it starts |
| PodDrawer | A Drawer for Kubernetes Pods |
| PodExecTerminal | Executes a /bin/sh process in the given pod's container and opens a terminal connected to it |
| PodExecTerminalDialog | Opens a terminal connected to the given pod's container in a dialog |
| PodLogs | Shows the logs for the given pod |
| PodLogsDialog | Shows the logs for the given pod in a Dialog |
| PodMetricsContext | Context for Pod Metrics |
| PodNamesWithErrorsContext | |
| PodNamesWithMetricsContext | |
| PodsTable | |
| READY_COLUMNS | |
| RESOURCE_COLUMNS | |
| ResourceUtilization | Context for Pod Metrics |
| ServicesAccordions | |
| useCustomResources | Retrieves the provided custom resources related to the provided entity, refreshes at an interval. |
| useEvents | Retrieves the events for the given object |
| useKubernetesObjects | |
| useMatchingErrors | Find errors which match the resource |
| usePodLogs | Retrieves the logs for the given pod |
| usePodMetrics | Find metrics matching the provided pod |