@backstage/plugin-kubernetes-react 0.0.0-nightly-20230927021302

package/dist/index.d.ts

@@ -0,0 +1,770 @@
+import { Entity } from '@backstage/catalog-model';
+import { ObjectsByEntityResponse, CustomResourceMatcher, ClientPodStatus, GroupedResponses, ClusterAttributes, DetectedError, KubernetesRequestBody, WorkloadsByEntityRequest, CustomObjectsByEntityRequest, ClusterObjects, DetectedErrorsByCluster, ClientContainerStatus } from '@backstage/plugin-kubernetes-common';
+import * as React from 'react';
+import React__default from 'react';
+import { IObjectMeta, IIoK8sApimachineryPkgApisMetaV1ObjectMeta } from '@kubernetes-models/apimachinery/apis/meta/v1/ObjectMeta';
+import { TypeMeta } from '@kubernetes-models/base';
+import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
+import { OAuthApi, OpenIdConnectApi, DiscoveryApi, IdentityApi } from '@backstage/core-plugin-api';
+import * as kubernetes_models_v1 from 'kubernetes-models/v1';
+import { Event, Pod, IContainer, IContainerStatus } from 'kubernetes-models/v1';
+import { V1HorizontalPodAutoscaler, V1Job, V1ObjectMeta, V1Pod } from '@kubernetes/client-node';
+import * as react_use_lib_useAsyncFn from 'react-use/lib/useAsyncFn';
+import { Pod as Pod$1 } from 'kubernetes-models/v1/Pod';
+
+/**
+ *
+ * @public
+ */
+interface KubernetesObjects {
+    kubernetesObjects?: ObjectsByEntityResponse;
+    loading: boolean;
+    error?: string;
+}
+/**
+ *
+ * @public
+ */
+declare const useKubernetesObjects: (entity: Entity, intervalMs?: number) => KubernetesObjects;
+
+/**
+ * Retrieves the provided custom resources related to the provided entity, refreshes at an interval.
+ *
+ * @public
+ */
+declare const useCustomResources: (entity: Entity, customResourceMatchers: CustomResourceMatcher[], intervalMs?: number) => KubernetesObjects;
+
+/**
+ * @public
+ */
+declare const PodNamesWithErrorsContext: React__default.Context<Set<string>>;
+
+/**
+ * @public
+ */
+declare const PodNamesWithMetricsContext: React__default.Context<Map<string, ClientPodStatus>>;
+
+/**
+ *
+ *
+ * @public
+ */
+declare const GroupedResponsesContext: React__default.Context<GroupedResponses>;
+
+/**
+ * @public
+ */
+declare const ClusterContext: React__default.Context<ClusterAttributes>;
+
+/**
+ * Context for Pod Metrics
+ *
+ * @public
+ */
+declare const PodMetricsContext: React__default.Context<Map<string, ClientPodStatus[]>>;
+/**
+ * @public
+ */
+type PodMetricsMatcher = {
+    metadata?: IObjectMeta;
+};
+/**
+ * Find metrics matching the provided pod
+ *
+ * @public
+ */
+declare const usePodMetrics: (clusterName: string, matcher: PodMetricsMatcher) => ClientPodStatus | undefined;
+
+/**
+ * Context for detected errors
+ *
+ * @public
+ */
+declare const DetectedErrorsContext: React__default.Context<DetectedError[]>;
+/**
+ *
+ * @public
+ */
+type ErrorMatcher = {
+    metadata?: IIoK8sApimachineryPkgApisMetaV1ObjectMeta;
+} & TypeMeta;
+/**
+ * Find errors which match the resource
+ *
+ * @public
+ */
+declare const useMatchingErrors: (matcher: ErrorMatcher) => DetectedError[];
+
+/** @public */
+declare const kubernetesApiRef: _backstage_core_plugin_api.ApiRef<KubernetesApi>;
+/** @public */
+declare const kubernetesProxyApiRef: _backstage_core_plugin_api.ApiRef<KubernetesProxyApi>;
+/** @public */
+interface KubernetesApi {
+    getObjectsByEntity(requestBody: KubernetesRequestBody): Promise<ObjectsByEntityResponse>;
+    getClusters(): Promise<{
+        name: string;
+        authProvider: string;
+        oidcTokenProvider?: string | undefined;
+    }[]>;
+    getWorkloadsByEntity(request: WorkloadsByEntityRequest): Promise<ObjectsByEntityResponse>;
+    getCustomObjectsByEntity(request: CustomObjectsByEntityRequest): Promise<ObjectsByEntityResponse>;
+    proxy(options: {
+        clusterName: string;
+        path: string;
+        init?: RequestInit;
+    }): Promise<Response>;
+}
+/** @public */
+interface KubernetesProxyApi {
+    getPodLogs(request: {
+        podName: string;
+        namespace: string;
+        clusterName: string;
+        containerName: string;
+        previous?: boolean;
+    }): Promise<{
+        text: string;
+    }>;
+    getEventsByInvolvedObjectName(request: {
+        clusterName: string;
+        involvedObjectName: string;
+        namespace: string;
+    }): Promise<Event[]>;
+}
+
+/** @public */
+interface KubernetesAuthProvider {
+    decorateRequestBodyForAuth(requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
+    getCredentials(): Promise<{
+        token?: string;
+    }>;
+}
+/** @public */
+declare const kubernetesAuthProvidersApiRef: _backstage_core_plugin_api.ApiRef<KubernetesAuthProvidersApi>;
+/** @public */
+interface KubernetesAuthProvidersApi {
+    decorateRequestBodyForAuth(authProvider: string, requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
+    getCredentials(authProvider: string): Promise<{
+        token?: string;
+    }>;
+}
+
+/** @public */
+declare class KubernetesAuthProviders implements KubernetesAuthProvidersApi {
+    private readonly kubernetesAuthProviderMap;
+    constructor(options: {
+        microsoftAuthApi: OAuthApi;
+        googleAuthApi: OAuthApi;
+        oidcProviders?: {
+            [key: string]: OpenIdConnectApi;
+        };
+    });
+    decorateRequestBodyForAuth(authProvider: string, requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
+    getCredentials(authProvider: string): Promise<{
+        token?: string;
+    }>;
+}
+
+/** @public */
+declare class GoogleKubernetesAuthProvider implements KubernetesAuthProvider {
+    authProvider: OAuthApi;
+    constructor(authProvider: OAuthApi);
+    decorateRequestBodyForAuth(requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
+    getCredentials(): Promise<{
+        token: string;
+    }>;
+}
+
+/**
+ * No-op KubernetesAuthProvider, authorization will be handled in the kubernetes-backend plugin
+ *
+ * @public
+ */
+declare class ServerSideKubernetesAuthProvider implements KubernetesAuthProvider {
+    decorateRequestBodyForAuth(requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
+    getCredentials(): Promise<{}>;
+}
+
+/** @public */
+declare class OidcKubernetesAuthProvider implements KubernetesAuthProvider {
+    providerName: string;
+    authProvider: OpenIdConnectApi;
+    constructor(providerName: string, authProvider: OpenIdConnectApi);
+    decorateRequestBodyForAuth(requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
+    getCredentials(): Promise<{
+        token: string;
+    }>;
+}
+
+/** @public */
+declare class AksKubernetesAuthProvider implements KubernetesAuthProvider {
+    private readonly microsoftAuthApi;
+    constructor(microsoftAuthApi: OAuthApi);
+    decorateRequestBodyForAuth(requestBody: KubernetesRequestBody): Promise<KubernetesRequestBody>;
+    getCredentials(): Promise<{
+        token?: string;
+    }>;
+}
+
+/** @public */
+declare class KubernetesBackendClient implements KubernetesApi {
+    private readonly discoveryApi;
+    private readonly identityApi;
+    private readonly kubernetesAuthProvidersApi;
+    constructor(options: {
+        discoveryApi: DiscoveryApi;
+        identityApi: IdentityApi;
+        kubernetesAuthProvidersApi: KubernetesAuthProvidersApi;
+    });
+    private handleResponse;
+    private postRequired;
+    private getCluster;
+    private getCredentials;
+    getObjectsByEntity(requestBody: KubernetesRequestBody): Promise<ObjectsByEntityResponse>;
+    getWorkloadsByEntity(request: WorkloadsByEntityRequest): Promise<ObjectsByEntityResponse>;
+    getCustomObjectsByEntity(request: CustomObjectsByEntityRequest): Promise<ObjectsByEntityResponse>;
+    getClusters(): Promise<{
+        name: string;
+        authProvider: string;
+    }[]>;
+    proxy(options: {
+        clusterName: string;
+        path: string;
+        init?: RequestInit;
+    }): Promise<Response>;
+}
+
+/**
+ * A client for common requests through the proxy endpoint of the kubernetes backend plugin.
+ *
+ * @public
+ */
+declare class KubernetesProxyClient {
+    private readonly kubernetesApi;
+    constructor(options: {
+        kubernetesApi: KubernetesApi;
+    });
+    private handleText;
+    private handleJson;
+    getEventsByInvolvedObjectName({ clusterName, involvedObjectName, namespace, }: {
+        clusterName: string;
+        involvedObjectName: string;
+        namespace: string;
+    }): Promise<Event[]>;
+    getPodLogs({ podName, namespace, clusterName, containerName, previous, }: {
+        podName: string;
+        namespace: string;
+        clusterName: string;
+        containerName: string;
+        previous?: boolean;
+    }): Promise<{
+        text: string;
+    }>;
+}
+
+/**
+ * Props for Cluster
+ *
+ * @public
+ */
+type ClusterProps = {
+    clusterObjects: ClusterObjects;
+    podsWithErrors: Set<string>;
+    children?: React__default.ReactNode;
+};
+/**
+ * Component for rendering Kubernetes resources in a cluster
+ *
+ * @public
+ */
+declare const Cluster: ({ clusterObjects, podsWithErrors }: ClusterProps) => React__default.JSX.Element;
+
+/**
+ *
+ *
+ * @public
+ */
+type CronJobsAccordionsProps = {
+    children?: React__default.ReactNode;
+};
+/**
+ *
+ *
+ * @public
+ */
+declare const CronJobsAccordions: ({}: CronJobsAccordionsProps) => React__default.JSX.Element;
+
+/**
+ *
+ *
+ * @public
+ */
+interface CustomResourcesProps {
+    children?: React__default.ReactNode;
+}
+/**
+ *
+ *
+ * @public
+ */
+declare const CustomResources: ({}: CustomResourcesProps) => React__default.JSX.Element;
+
+/**
+ *
+ *
+ * @public
+ */
+type ErrorPanelProps = {
+    entityName: string;
+    errorMessage?: string;
+    clustersWithErrors?: ClusterObjects[];
+    children?: React__default.ReactNode;
+};
+/**
+ *
+ *
+ * @public
+ */
+declare const ErrorPanel: ({ entityName, errorMessage, clustersWithErrors, }: ErrorPanelProps) => React__default.JSX.Element;
+
+/**
+ *
+ *
+ * @public
+ */
+type ErrorReportingProps = {
+    detectedErrors: DetectedErrorsByCluster;
+};
+/**
+ *
+ *
+ * @public
+ */
+declare const ErrorReporting: ({ detectedErrors }: ErrorReportingProps) => React.JSX.Element;
+
+/** @public */
+declare const HorizontalPodAutoscalerDrawer: (props: {
+    hpa: V1HorizontalPodAutoscaler;
+    expanded?: boolean;
+    children?: React__default.ReactNode;
+}) => React__default.JSX.Element;
+
+/**
+ *
+ *
+ * @public
+ */
+type IngressesAccordionsProps = {};
+/**
+ *
+ *
+ * @public
+ */
+declare const IngressesAccordions: ({}: IngressesAccordionsProps) => React__default.JSX.Element;
+
+/**
+ *
+ *
+ * @public
+ */
+type JobsAccordionsProps = {
+    jobs: V1Job[];
+    children?: React__default.ReactNode;
+};
+/**
+ *
+ *
+ * @public
+ */
+declare const JobsAccordions: ({ jobs }: JobsAccordionsProps) => React__default.JSX.Element;
+
+/**
+ *
+ *
+ * @public
+ */
+type LinkErrorPanelProps = {
+    cluster: ClusterAttributes;
+    errorMessage?: string;
+    children?: React__default.ReactNode;
+};
+/**
+ *
+ *
+ * @public
+ */
+declare const LinkErrorPanel: ({ cluster, errorMessage, }: LinkErrorPanelProps) => React__default.JSX.Element;
+/**
+ *
+ *
+ * @public
+ */
+interface KubernetesDrawerable {
+    metadata?: V1ObjectMeta;
+}
+/**
+ *
+ * @public
+ */
+interface KubernetesStructuredMetadataTableDrawerProps<T extends KubernetesDrawerable> {
+    object: T;
+    renderObject: (obj: T) => object;
+    buttonVariant?: 'h5' | 'subtitle2';
+    kind: string;
+    expanded?: boolean;
+    children?: React__default.ReactNode;
+}
+/**
+ *
+ * @public
+ */
+declare const KubernetesStructuredMetadataTableDrawer: <T extends KubernetesDrawerable>({ object, renderObject, kind, buttonVariant, expanded, children, }: KubernetesStructuredMetadataTableDrawerProps<T>) => React__default.JSX.Element;
+
+/**
+ * The type of object that can be represented by the Drawer
+ *
+ * @public
+ */
+interface KubernetesObject {
+    kind: string;
+    metadata?: IObjectMeta;
+}
+/**
+ * Props of KubernetesDrawer
+ *
+ * @public
+ */
+interface KubernetesDrawerProps {
+    open?: boolean;
+    kubernetesObject: KubernetesObject;
+    label: React__default.ReactNode;
+    drawerContentsHeader?: React__default.ReactNode;
+    children?: React__default.ReactNode;
+}
+/**
+ * Button/Drawer component for Kubernetes Objects
+ *
+ * @public
+ */
+declare const KubernetesDrawer: ({ open, label, drawerContentsHeader, kubernetesObject, children, }: KubernetesDrawerProps) => React__default.JSX.Element;
+
+/**
+ * Props of ManifestYaml
+ *
+ * @public
+ */
+interface ManifestYamlProps {
+    object: object;
+}
+/**
+ * Renders a Kubernetes object as a YAML code snippet
+ *
+ * @public
+ */
+declare const ManifestYaml: ({ object }: ManifestYamlProps) => React__default.JSX.Element;
+
+/**
+ * Wraps a pod with the associated detected errors and cluster name
+ *
+ * @public
+ */
+interface PodAndErrors {
+    clusterName: string;
+    pod: Pod;
+    errors: DetectedError[];
+}
+
+/**
+ * Props for PodDrawer
+ *
+ * @public
+ */
+interface PodDrawerProps {
+    open?: boolean;
+    podAndErrors: PodAndErrors;
+}
+/**
+ * A Drawer for Kubernetes Pods
+ *
+ * @public
+ */
+declare const PodDrawer: ({ podAndErrors, open }: PodDrawerProps) => React__default.JSX.Element;
+
+/**
+ * Contains the details needed to make a log request to Kubernetes, except the container name
+ *
+ * @public
+ */
+interface PodScope {
+    podName: string;
+    podNamespace: string;
+    clusterName: string;
+}
+/**
+ * Contains the details needed to make a log request to Kubernetes
+ *
+ * @public
+ */
+interface ContainerScope extends PodScope {
+    containerName: string;
+}
+
+/**
+ * Props for PodLogs
+ *
+ * @public
+ */
+interface PodLogsProps {
+    containerScope: ContainerScope;
+    previous?: boolean;
+}
+/**
+ * Shows the logs for the given pod
+ *
+ * @public
+ */
+declare const PodLogs: React__default.FC<PodLogsProps>;
+
+/**
+ * Props for PodLogsDialog
+ *
+ * @public
+ */
+interface PodLogsDialogProps {
+    containerScope: ContainerScope;
+}
+/**
+ * Shows the logs for the given pod in a Dialog
+ *
+ * @public
+ */
+declare const PodLogsDialog: ({ containerScope }: PodLogsDialogProps) => React__default.JSX.Element;
+
+/**
+ * Arguments for usePodLogs
+ *
+ * @public
+ */
+interface PodLogsOptions {
+    containerScope: ContainerScope;
+    previous?: boolean;
+}
+/**
+ * Retrieves the logs for the given pod
+ *
+ * @public
+ */
+declare const usePodLogs: ({ containerScope, previous }: PodLogsOptions) => react_use_lib_useAsyncFn.AsyncState<{
+    text: string;
+}>;
+
+/**
+ * Props for ContainerCard
+ *
+ * @public
+ */
+interface ContainerCardProps {
+    podScope: PodScope;
+    containerSpec?: IContainer;
+    containerStatus: IContainerStatus;
+    containerMetrics?: ClientContainerStatus;
+}
+/**
+ * Shows details about a container within a pod
+ *
+ * @public
+ */
+declare const ContainerCard: React__default.FC<ContainerCardProps>;
+
+/**
+ * Props for PendingPodContent
+ *
+ * @public
+ */
+interface PendingPodContentProps {
+    pod: Pod;
+}
+/**
+ * Shows details about pod's conditions as it starts
+ *
+ * @public
+ */
+declare const PendingPodContent: ({ pod }: PendingPodContentProps) => React__default.JSX.Element;
+
+/**
+ * Props for FixDialog
+ *
+ * @public
+ */
+interface FixDialogProps {
+    open?: boolean;
+    clusterName: string;
+    pod: Pod$1;
+    error: DetectedError;
+}
+/**
+ * A dialog for fixing detected Kubernetes errors
+ *
+ * @public
+ */
+declare const FixDialog: React__default.FC<FixDialogProps>;
+
+/**
+ * Props for Events
+ *
+ * @public
+ */
+interface EventsContentProps {
+    warningEventsOnly?: boolean;
+    events: Event[];
+}
+/**
+ * Shows given Kubernetes events
+ *
+ * @public
+ */
+declare const EventsContent: ({ events, warningEventsOnly, }: EventsContentProps) => React__default.JSX.Element;
+/**
+ * Props for Events
+ *
+ * @public
+ */
+interface EventsProps {
+    involvedObjectName: string;
+    namespace: string;
+    clusterName: string;
+    warningEventsOnly?: boolean;
+}
+/**
+ * Retrieves and shows Kubernetes events for the given object
+ *
+ * @public
+ */
+declare const Events: ({ involvedObjectName, namespace, clusterName, warningEventsOnly, }: EventsProps) => React__default.JSX.Element;
+
+/**
+ * Arguments for useEvents
+ *
+ * @public
+ */
+interface EventsOptions {
+    involvedObjectName: string;
+    namespace: string;
+    clusterName: string;
+}
+/**
+ * Retrieves the events for the given object
+ *
+ * @public
+ */
+declare const useEvents: ({ involvedObjectName, namespace, clusterName, }: EventsOptions) => react_use_lib_useAsyncFn.AsyncState<kubernetes_models_v1.Event[]>;
+
+/**
+ * Props for ErrorList
+ *
+ * @public
+ */
+interface ErrorListProps {
+    podAndErrors: PodAndErrors[];
+}
+/**
+ * Shows a list of errors found on a Pod
+ *
+ * @public
+ */
+declare const ErrorList: ({ podAndErrors }: ErrorListProps) => React__default.JSX.Element;
+
+/**
+ *
+ *
+ * @public
+ */
+declare const READY_COLUMNS: PodColumns;
+/**
+ *
+ *
+ * @public
+ */
+declare const RESOURCE_COLUMNS: PodColumns;
+/**
+ *
+ *
+ * @public
+ */
+type PodColumns = 'READY' | 'RESOURCE';
+/**
+ *
+ *
+ * @public
+ */
+type PodsTablesProps = {
+    pods: Pod$1 | V1Pod[];
+    extraColumns?: PodColumns[];
+    children?: React__default.ReactNode;
+};
+/**
+ *
+ *
+ * @public
+ */
+declare const PodsTable: ({ pods, extraColumns }: PodsTablesProps) => React__default.JSX.Element;
+
+/**
+ *
+ *
+ * @public
+ */
+type ServicesAccordionsProps = {};
+/**
+ *
+ *
+ * @public
+ */
+declare const ServicesAccordions: ({}: ServicesAccordionsProps) => React__default.JSX.Element;
+
+/**
+ * Context for Pod Metrics
+ *
+ * @public
+ */
+interface ResourceUtilizationProps {
+    compressed?: boolean;
+    title: string;
+    usage: number | string;
+    total: number | string;
+    totalFormatted: string;
+}
+/**
+ * Context for Pod Metrics
+ *
+ * @public
+ */
+declare const ResourceUtilization: ({ compressed, title, usage, total, totalFormatted, }: ResourceUtilizationProps) => React__default.JSX.Element;
+
+/**
+ * Props drilled down to the PodExecTerminal component
+ *
+ * @public
+ */
+interface PodExecTerminalProps {
+    clusterName: string;
+    containerName: string;
+    podName: string;
+    podNamespace: string;
+}
+/**
+ * Executes a `/bin/sh` process in the given pod's container and opens a terminal connected to it
+ *
+ * @public
+ */
+declare const PodExecTerminal: (props: PodExecTerminalProps) => React__default.JSX.Element;
+
+/**
+ * Opens a terminal connected to the given pod's container in a dialog
+ *
+ * @public
+ */
+declare const PodExecTerminalDialog: (props: PodExecTerminalProps) => React__default.JSX.Element;
+
+export { AksKubernetesAuthProvider, Cluster, ClusterContext, ClusterProps, ContainerCard, ContainerCardProps, ContainerScope, CronJobsAccordions, CronJobsAccordionsProps, CustomResources, CustomResourcesProps, DetectedErrorsContext, ErrorList, ErrorListProps, ErrorMatcher, ErrorPanel, ErrorPanelProps, ErrorReporting, ErrorReportingProps, Events, EventsContent, EventsContentProps, EventsOptions, EventsProps, FixDialog, FixDialogProps, GoogleKubernetesAuthProvider, GroupedResponsesContext, HorizontalPodAutoscalerDrawer, IngressesAccordions, IngressesAccordionsProps, JobsAccordions, JobsAccordionsProps, KubernetesApi, KubernetesAuthProvider, KubernetesAuthProviders, KubernetesAuthProvidersApi, KubernetesBackendClient, KubernetesDrawer, KubernetesDrawerProps, KubernetesDrawerable, KubernetesObject, KubernetesObjects, KubernetesProxyApi, KubernetesProxyClient, KubernetesStructuredMetadataTableDrawer, KubernetesStructuredMetadataTableDrawerProps, LinkErrorPanel, LinkErrorPanelProps, ManifestYaml, ManifestYamlProps, OidcKubernetesAuthProvider, PendingPodContent, PendingPodContentProps, PodAndErrors, PodColumns, PodDrawer, PodDrawerProps, PodExecTerminal, PodExecTerminalDialog, PodExecTerminalProps, PodLogs, PodLogsDialog, PodLogsDialogProps, PodLogsOptions, PodLogsProps, PodMetricsContext, PodMetricsMatcher, PodNamesWithErrorsContext, PodNamesWithMetricsContext, PodScope, PodsTable, PodsTablesProps, READY_COLUMNS, RESOURCE_COLUMNS, ResourceUtilization, ResourceUtilizationProps, ServerSideKubernetesAuthProvider, ServicesAccordions, ServicesAccordionsProps, kubernetesApiRef, kubernetesAuthProvidersApiRef, kubernetesProxyApiRef, useCustomResources, useEvents, useKubernetesObjects, useMatchingErrors, usePodLogs, usePodMetrics };