add newly generated api reports

Signed-off-by: secustor <sebastian@poxhofer.at>
This commit is contained in:
secustor
2024-07-21 09:17:36 +02:00
parent 30c2be9bcd
commit 65da28ad53
251 changed files with 4846 additions and 580 deletions
+604
View File
@@ -0,0 +1,604 @@
## API Report File for "@backstage/plugin-kubernetes-common"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { BasicPermission } from '@backstage/plugin-permission-common';
import { Entity } from '@backstage/catalog-model';
import { FetchResponse as FetchResponse_2 } from '@backstage/plugin-kubernetes-common';
import type { JsonObject } from '@backstage/types';
import type { JsonValue } from '@backstage/types';
import { ObjectsByEntityResponse as ObjectsByEntityResponse_2 } from '@backstage/plugin-kubernetes-common';
import { PodStatus } from '@kubernetes/client-node';
import { V1ConfigMap } from '@kubernetes/client-node';
import { V1CronJob } from '@kubernetes/client-node';
import { V1DaemonSet } from '@kubernetes/client-node';
import { V1Deployment } from '@kubernetes/client-node';
import { V1Ingress } from '@kubernetes/client-node';
import { V1Job } from '@kubernetes/client-node';
import { V1LimitRange } from '@kubernetes/client-node';
import { V1Pod } from '@kubernetes/client-node';
import { V1ReplicaSet } from '@kubernetes/client-node';
import { V1ResourceQuota } from '@kubernetes/client-node';
import { V1Service } from '@kubernetes/client-node';
import { V1StatefulSet } from '@kubernetes/client-node';
import { V2HorizontalPodAutoscaler } from '@kubernetes/client-node';
// @public
export const ANNOTATION_KUBERNETES_API_SERVER = 'kubernetes.io/api-server';
// @public
export const ANNOTATION_KUBERNETES_API_SERVER_CA =
'kubernetes.io/api-server-certificate-authority';
// @public
export const ANNOTATION_KUBERNETES_AUTH_PROVIDER =
'kubernetes.io/auth-provider';
// @public
export const ANNOTATION_KUBERNETES_AWS_ASSUME_ROLE =
'kubernetes.io/aws-assume-role';
// @public
export const ANNOTATION_KUBERNETES_AWS_CLUSTER_ID =
'kubernetes.io/x-k8s-aws-id';
// @public
export const ANNOTATION_KUBERNETES_AWS_EXTERNAL_ID =
'kubernetes.io/aws-external-id';
// @public
export const ANNOTATION_KUBERNETES_DASHBOARD_APP =
'kubernetes.io/dashboard-app';
// @public
export const ANNOTATION_KUBERNETES_DASHBOARD_PARAMETERS =
'kubernetes.io/dashboard-parameters';
// @public
export const ANNOTATION_KUBERNETES_DASHBOARD_URL =
'kubernetes.io/dashboard-url';
// @public
export const ANNOTATION_KUBERNETES_OIDC_TOKEN_PROVIDER =
'kubernetes.io/oidc-token-provider';
// @public
export const ANNOTATION_KUBERNETES_SKIP_METRICS_LOOKUP =
'kubernetes.io/skip-metrics-lookup';
// @public
export const ANNOTATION_KUBERNETES_SKIP_TLS_VERIFY =
'kubernetes.io/skip-tls-verify';
// @public (undocumented)
export type AuthProviderType = 'google' | 'serviceAccount' | 'aws' | 'azure';
// @public (undocumented)
export interface ClientContainerStatus {
// (undocumented)
container: string;
// (undocumented)
cpuUsage: ClientCurrentResourceUsage;
// (undocumented)
memoryUsage: ClientCurrentResourceUsage;
}
// @public (undocumented)
export interface ClientCurrentResourceUsage {
// (undocumented)
currentUsage: number | string;
// (undocumented)
limitTotal: number | string;
// (undocumented)
requestTotal: number | string;
}
// @public (undocumented)
export interface ClientPodStatus {
// (undocumented)
containers: ClientContainerStatus[];
// (undocumented)
cpu: ClientCurrentResourceUsage;
// (undocumented)
memory: ClientCurrentResourceUsage;
// (undocumented)
pod: V1Pod;
}
// @public (undocumented)
export interface ClusterAttributes {
dashboardApp?: string;
dashboardParameters?: JsonObject;
dashboardUrl?: string;
name: string;
title?: string;
}
// @public (undocumented)
export interface ClusterObjects {
// (undocumented)
cluster: ClusterAttributes;
// (undocumented)
errors: KubernetesFetchError[];
// (undocumented)
podMetrics: ClientPodStatus[];
// (undocumented)
resources: FetchResponse[];
}
// @public (undocumented)
export interface ConfigMapFetchResponse {
// (undocumented)
resources: Array<V1ConfigMap>;
// (undocumented)
type: 'configmaps';
}
// @public (undocumented)
export interface CronJobsFetchResponse {
// (undocumented)
resources: Array<V1CronJob>;
// (undocumented)
type: 'cronjobs';
}
// @public (undocumented)
export interface CustomObjectsByEntityRequest {
// (undocumented)
auth: KubernetesRequestAuth;
// (undocumented)
customResources: CustomResourceMatcher[];
// (undocumented)
entity: Entity;
}
// @public (undocumented)
export interface CustomResourceFetchResponse {
// (undocumented)
resources: Array<any>;
// (undocumented)
type: 'customresources';
}
// @public (undocumented)
export interface CustomResourceMatcher {
// (undocumented)
apiVersion: string;
// (undocumented)
group: string;
// (undocumented)
plural: string;
}
// @public (undocumented)
export interface DaemonSetsFetchResponse {
// (undocumented)
resources: Array<V1DaemonSet>;
// (undocumented)
type: 'daemonsets';
}
// @public (undocumented)
export interface DeploymentFetchResponse {
// (undocumented)
resources: Array<V1Deployment>;
// (undocumented)
type: 'deployments';
}
// @public (undocumented)
export interface DeploymentResources {
// (undocumented)
deployments: V1Deployment[];
// (undocumented)
horizontalPodAutoscalers: V2HorizontalPodAutoscaler[];
// (undocumented)
pods: V1Pod[];
// (undocumented)
replicaSets: V1ReplicaSet[];
}
// @public
export interface DetectedError {
// (undocumented)
message: string;
// (undocumented)
occurrenceCount: number;
// (undocumented)
proposedFix?: ProposedFix;
// (undocumented)
severity: ErrorSeverity;
// (undocumented)
sourceRef: ResourceRef;
// (undocumented)
type: string;
}
// @public
export type DetectedErrorsByCluster = Map<string, DetectedError[]>;
// @public
export const detectErrors: (
objects: ObjectsByEntityResponse_2,
) => DetectedErrorsByCluster;
// @public (undocumented)
export interface DocsSolution extends ProposedFixBase {
// (undocumented)
docsLink: string;
// (undocumented)
type: 'docs';
}
// @public (undocumented)
export interface ErrorMapper<T> {
// (undocumented)
detectErrors: (resource: T) => DetectedError[];
}
// @public
export type ErrorSeverity = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
// @public (undocumented)
export interface EventsSolution extends ProposedFixBase {
// (undocumented)
podName: string;
// (undocumented)
type: 'events';
}
// @public (undocumented)
export type FetchResponse =
| PodFetchResponse
| ServiceFetchResponse
| ConfigMapFetchResponse
| DeploymentFetchResponse
| LimitRangeFetchResponse
| ResourceQuotaFetchResponse
| ReplicaSetsFetchResponse
| HorizontalPodAutoscalersFetchResponse
| JobsFetchResponse
| CronJobsFetchResponse
| IngressesFetchResponse
| CustomResourceFetchResponse
| StatefulSetsFetchResponse
| DaemonSetsFetchResponse
| PodStatusFetchResponse;
// @public (undocumented)
export interface GroupedResponses extends DeploymentResources {
// (undocumented)
configMaps: V1ConfigMap[];
// (undocumented)
cronJobs: V1CronJob[];
// (undocumented)
customResources: any[];
// (undocumented)
daemonSets: V1DaemonSet[];
// (undocumented)
ingresses: V1Ingress[];
// (undocumented)
jobs: V1Job[];
// (undocumented)
services: V1Service[];
// (undocumented)
statefulsets: V1StatefulSet[];
}
// @public (undocumented)
export const groupResponses: (
fetchResponse: FetchResponse_2[],
) => GroupedResponses;
// @public (undocumented)
export interface HorizontalPodAutoscalersFetchResponse {
// (undocumented)
resources: Array<V2HorizontalPodAutoscaler>;
// (undocumented)
type: 'horizontalpodautoscalers';
}
// @public (undocumented)
export interface IngressesFetchResponse {
// (undocumented)
resources: Array<V1Ingress>;
// (undocumented)
type: 'ingresses';
}
// @public (undocumented)
export interface JobsFetchResponse {
// (undocumented)
resources: Array<V1Job>;
// (undocumented)
type: 'jobs';
}
// @public (undocumented)
export type KubernetesErrorTypes =
| 'BAD_REQUEST'
| 'UNAUTHORIZED_ERROR'
| 'NOT_FOUND'
| 'SYSTEM_ERROR'
| 'UNKNOWN_ERROR';
// @public (undocumented)
export type KubernetesFetchError = StatusError | RawFetchError;
// @public
export const kubernetesPermissions: BasicPermission[];
// @public
export const kubernetesProxyPermission: BasicPermission;
// @public (undocumented)
export type KubernetesRequestAuth = {
[providerKey: string]: JsonValue | undefined;
};
// @public (undocumented)
export interface KubernetesRequestBody {
// (undocumented)
auth?: KubernetesRequestAuth;
// (undocumented)
entity: Entity;
}
// @public (undocumented)
export interface LimitRangeFetchResponse {
// (undocumented)
resources: Array<V1LimitRange>;
// (undocumented)
type: 'limitranges';
}
// @public (undocumented)
export interface LogSolution extends ProposedFixBase {
// (undocumented)
container: string;
// (undocumented)
type: 'logs';
}
// @public (undocumented)
export interface ObjectsByEntityResponse {
// (undocumented)
items: ClusterObjects[];
}
// @public (undocumented)
export interface PodFetchResponse {
// (undocumented)
resources: Array<V1Pod>;
// (undocumented)
type: 'pods';
}
// @public (undocumented)
export interface PodStatusFetchResponse {
// (undocumented)
resources: Array<PodStatus>;
// (undocumented)
type: 'podstatus';
}
// @public (undocumented)
export type ProposedFix = LogSolution | DocsSolution | EventsSolution;
// @public (undocumented)
export interface ProposedFixBase {
// (undocumented)
actions: string[];
// (undocumented)
errorType: string;
// (undocumented)
rootCauseExplanation: string;
}
// @public (undocumented)
export interface RawFetchError {
// (undocumented)
errorType: 'FETCH_ERROR';
// (undocumented)
message: string;
}
// @public (undocumented)
export interface ReplicaSetsFetchResponse {
// (undocumented)
resources: Array<V1ReplicaSet>;
// (undocumented)
type: 'replicasets';
}
// @public (undocumented)
export interface ResourceQuotaFetchResponse {
// (undocumented)
resources: Array<V1ResourceQuota>;
// (undocumented)
type: 'resourcequotas';
}
// @public
export interface ResourceRef {
// (undocumented)
apiGroup: string;
// (undocumented)
kind: string;
// (undocumented)
name: string;
// (undocumented)
namespace: string;
}
// @public (undocumented)
export interface ServiceFetchResponse {
// (undocumented)
resources: Array<V1Service>;
// (undocumented)
type: 'services';
}
// @public (undocumented)
export interface StatefulSetsFetchResponse {
// (undocumented)
resources: Array<V1StatefulSet>;
// (undocumented)
type: 'statefulsets';
}
// @public (undocumented)
export interface StatusError {
// (undocumented)
errorType: KubernetesErrorTypes;
// (undocumented)
resourcePath?: string;
// (undocumented)
statusCode?: number;
}
// @public (undocumented)
export interface WorkloadsByEntityRequest {
// (undocumented)
auth: KubernetesRequestAuth;
// (undocumented)
entity: Entity;
}
// Warnings were encountered during analysis:
//
// src/error-detection/types.d.ts:19:5 - (ae-undocumented) Missing documentation for "name".
// src/error-detection/types.d.ts:20:5 - (ae-undocumented) Missing documentation for "namespace".
// src/error-detection/types.d.ts:21:5 - (ae-undocumented) Missing documentation for "kind".
// src/error-detection/types.d.ts:22:5 - (ae-undocumented) Missing documentation for "apiGroup".
// src/error-detection/types.d.ts:30:5 - (ae-undocumented) Missing documentation for "type".
// src/error-detection/types.d.ts:31:5 - (ae-undocumented) Missing documentation for "severity".
// src/error-detection/types.d.ts:32:5 - (ae-undocumented) Missing documentation for "message".
// src/error-detection/types.d.ts:33:5 - (ae-undocumented) Missing documentation for "proposedFix".
// src/error-detection/types.d.ts:34:5 - (ae-undocumented) Missing documentation for "sourceRef".
// src/error-detection/types.d.ts:35:5 - (ae-undocumented) Missing documentation for "occurrenceCount".
// src/error-detection/types.d.ts:38:1 - (ae-undocumented) Missing documentation for "ProposedFix".
// src/error-detection/types.d.ts:40:1 - (ae-undocumented) Missing documentation for "ProposedFixBase".
// src/error-detection/types.d.ts:41:5 - (ae-undocumented) Missing documentation for "errorType".
// src/error-detection/types.d.ts:42:5 - (ae-undocumented) Missing documentation for "rootCauseExplanation".
// src/error-detection/types.d.ts:43:5 - (ae-undocumented) Missing documentation for "actions".
// src/error-detection/types.d.ts:46:1 - (ae-undocumented) Missing documentation for "LogSolution".
// src/error-detection/types.d.ts:47:5 - (ae-undocumented) Missing documentation for "type".
// src/error-detection/types.d.ts:48:5 - (ae-undocumented) Missing documentation for "container".
// src/error-detection/types.d.ts:51:1 - (ae-undocumented) Missing documentation for "DocsSolution".
// src/error-detection/types.d.ts:52:5 - (ae-undocumented) Missing documentation for "type".
// src/error-detection/types.d.ts:53:5 - (ae-undocumented) Missing documentation for "docsLink".
// src/error-detection/types.d.ts:56:1 - (ae-undocumented) Missing documentation for "EventsSolution".
// src/error-detection/types.d.ts:57:5 - (ae-undocumented) Missing documentation for "type".
// src/error-detection/types.d.ts:58:5 - (ae-undocumented) Missing documentation for "podName".
// src/error-detection/types.d.ts:61:1 - (ae-undocumented) Missing documentation for "ErrorMapper".
// src/error-detection/types.d.ts:62:5 - (ae-undocumented) Missing documentation for "detectErrors".
// src/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "KubernetesRequestAuth".
// src/types.d.ts:9:1 - (ae-undocumented) Missing documentation for "CustomResourceMatcher".
// src/types.d.ts:10:5 - (ae-undocumented) Missing documentation for "group".
// src/types.d.ts:11:5 - (ae-undocumented) Missing documentation for "apiVersion".
// src/types.d.ts:12:5 - (ae-undocumented) Missing documentation for "plural".
// src/types.d.ts:15:1 - (ae-undocumented) Missing documentation for "WorkloadsByEntityRequest".
// src/types.d.ts:16:5 - (ae-undocumented) Missing documentation for "auth".
// src/types.d.ts:17:5 - (ae-undocumented) Missing documentation for "entity".
// src/types.d.ts:20:1 - (ae-undocumented) Missing documentation for "CustomObjectsByEntityRequest".
// src/types.d.ts:21:5 - (ae-undocumented) Missing documentation for "auth".
// src/types.d.ts:22:5 - (ae-undocumented) Missing documentation for "customResources".
// src/types.d.ts:23:5 - (ae-undocumented) Missing documentation for "entity".
// src/types.d.ts:26:1 - (ae-undocumented) Missing documentation for "KubernetesRequestBody".
// src/types.d.ts:27:5 - (ae-undocumented) Missing documentation for "auth".
// src/types.d.ts:28:5 - (ae-undocumented) Missing documentation for "entity".
// src/types.d.ts:31:1 - (ae-undocumented) Missing documentation for "ClusterAttributes".
// src/types.d.ts:73:1 - (ae-undocumented) Missing documentation for "ClusterObjects".
// src/types.d.ts:74:5 - (ae-undocumented) Missing documentation for "cluster".
// src/types.d.ts:75:5 - (ae-undocumented) Missing documentation for "resources".
// src/types.d.ts:76:5 - (ae-undocumented) Missing documentation for "podMetrics".
// src/types.d.ts:77:5 - (ae-undocumented) Missing documentation for "errors".
// src/types.d.ts:80:1 - (ae-undocumented) Missing documentation for "ObjectsByEntityResponse".
// src/types.d.ts:81:5 - (ae-undocumented) Missing documentation for "items".
// src/types.d.ts:84:1 - (ae-undocumented) Missing documentation for "AuthProviderType".
// src/types.d.ts:86:1 - (ae-undocumented) Missing documentation for "FetchResponse".
// src/types.d.ts:88:1 - (ae-undocumented) Missing documentation for "PodFetchResponse".
// src/types.d.ts:89:5 - (ae-undocumented) Missing documentation for "type".
// src/types.d.ts:90:5 - (ae-undocumented) Missing documentation for "resources".
// src/types.d.ts:93:1 - (ae-undocumented) Missing documentation for "ServiceFetchResponse".
// src/types.d.ts:94:5 - (ae-undocumented) Missing documentation for "type".
// src/types.d.ts:95:5 - (ae-undocumented) Missing documentation for "resources".
// src/types.d.ts:98:1 - (ae-undocumented) Missing documentation for "ConfigMapFetchResponse".
// src/types.d.ts:99:5 - (ae-undocumented) Missing documentation for "type".
// src/types.d.ts:100:5 - (ae-undocumented) Missing documentation for "resources".
// src/types.d.ts:103:1 - (ae-undocumented) Missing documentation for "DeploymentFetchResponse".
// src/types.d.ts:104:5 - (ae-undocumented) Missing documentation for "type".
// src/types.d.ts:105:5 - (ae-undocumented) Missing documentation for "resources".
// src/types.d.ts:108:1 - (ae-undocumented) Missing documentation for "ReplicaSetsFetchResponse".
// src/types.d.ts:109:5 - (ae-undocumented) Missing documentation for "type".
// src/types.d.ts:110:5 - (ae-undocumented) Missing documentation for "resources".
// src/types.d.ts:113:1 - (ae-undocumented) Missing documentation for "LimitRangeFetchResponse".
// src/types.d.ts:114:5 - (ae-undocumented) Missing documentation for "type".
// src/types.d.ts:115:5 - (ae-undocumented) Missing documentation for "resources".
// src/types.d.ts:118:1 - (ae-undocumented) Missing documentation for "ResourceQuotaFetchResponse".
// src/types.d.ts:119:5 - (ae-undocumented) Missing documentation for "type".
// src/types.d.ts:120:5 - (ae-undocumented) Missing documentation for "resources".
// src/types.d.ts:123:1 - (ae-undocumented) Missing documentation for "HorizontalPodAutoscalersFetchResponse".
// src/types.d.ts:124:5 - (ae-undocumented) Missing documentation for "type".
// src/types.d.ts:125:5 - (ae-undocumented) Missing documentation for "resources".
// src/types.d.ts:128:1 - (ae-undocumented) Missing documentation for "JobsFetchResponse".
// src/types.d.ts:129:5 - (ae-undocumented) Missing documentation for "type".
// src/types.d.ts:130:5 - (ae-undocumented) Missing documentation for "resources".
// src/types.d.ts:133:1 - (ae-undocumented) Missing documentation for "CronJobsFetchResponse".
// src/types.d.ts:134:5 - (ae-undocumented) Missing documentation for "type".
// src/types.d.ts:135:5 - (ae-undocumented) Missing documentation for "resources".
// src/types.d.ts:138:1 - (ae-undocumented) Missing documentation for "IngressesFetchResponse".
// src/types.d.ts:139:5 - (ae-undocumented) Missing documentation for "type".
// src/types.d.ts:140:5 - (ae-undocumented) Missing documentation for "resources".
// src/types.d.ts:143:1 - (ae-undocumented) Missing documentation for "CustomResourceFetchResponse".
// src/types.d.ts:144:5 - (ae-undocumented) Missing documentation for "type".
// src/types.d.ts:145:5 - (ae-undocumented) Missing documentation for "resources".
// src/types.d.ts:148:1 - (ae-undocumented) Missing documentation for "StatefulSetsFetchResponse".
// src/types.d.ts:149:5 - (ae-undocumented) Missing documentation for "type".
// src/types.d.ts:150:5 - (ae-undocumented) Missing documentation for "resources".
// src/types.d.ts:153:1 - (ae-undocumented) Missing documentation for "DaemonSetsFetchResponse".
// src/types.d.ts:154:5 - (ae-undocumented) Missing documentation for "type".
// src/types.d.ts:155:5 - (ae-undocumented) Missing documentation for "resources".
// src/types.d.ts:158:1 - (ae-undocumented) Missing documentation for "PodStatusFetchResponse".
// src/types.d.ts:159:5 - (ae-undocumented) Missing documentation for "type".
// src/types.d.ts:160:5 - (ae-undocumented) Missing documentation for "resources".
// src/types.d.ts:163:1 - (ae-undocumented) Missing documentation for "KubernetesFetchError".
// src/types.d.ts:165:1 - (ae-undocumented) Missing documentation for "StatusError".
// src/types.d.ts:166:5 - (ae-undocumented) Missing documentation for "errorType".
// src/types.d.ts:167:5 - (ae-undocumented) Missing documentation for "statusCode".
// src/types.d.ts:168:5 - (ae-undocumented) Missing documentation for "resourcePath".
// src/types.d.ts:171:1 - (ae-undocumented) Missing documentation for "RawFetchError".
// src/types.d.ts:172:5 - (ae-undocumented) Missing documentation for "errorType".
// src/types.d.ts:173:5 - (ae-undocumented) Missing documentation for "message".
// src/types.d.ts:176:1 - (ae-undocumented) Missing documentation for "KubernetesErrorTypes".
// src/types.d.ts:178:1 - (ae-undocumented) Missing documentation for "ClientCurrentResourceUsage".
// src/types.d.ts:179:5 - (ae-undocumented) Missing documentation for "currentUsage".
// src/types.d.ts:180:5 - (ae-undocumented) Missing documentation for "requestTotal".
// src/types.d.ts:181:5 - (ae-undocumented) Missing documentation for "limitTotal".
// src/types.d.ts:184:1 - (ae-undocumented) Missing documentation for "ClientContainerStatus".
// src/types.d.ts:185:5 - (ae-undocumented) Missing documentation for "container".
// src/types.d.ts:186:5 - (ae-undocumented) Missing documentation for "cpuUsage".
// src/types.d.ts:187:5 - (ae-undocumented) Missing documentation for "memoryUsage".
// src/types.d.ts:190:1 - (ae-undocumented) Missing documentation for "ClientPodStatus".
// src/types.d.ts:191:5 - (ae-undocumented) Missing documentation for "pod".
// src/types.d.ts:192:5 - (ae-undocumented) Missing documentation for "cpu".
// src/types.d.ts:193:5 - (ae-undocumented) Missing documentation for "memory".
// src/types.d.ts:194:5 - (ae-undocumented) Missing documentation for "containers".
// src/types.d.ts:197:1 - (ae-undocumented) Missing documentation for "DeploymentResources".
// src/types.d.ts:198:5 - (ae-undocumented) Missing documentation for "pods".
// src/types.d.ts:199:5 - (ae-undocumented) Missing documentation for "replicaSets".
// src/types.d.ts:200:5 - (ae-undocumented) Missing documentation for "deployments".
// src/types.d.ts:201:5 - (ae-undocumented) Missing documentation for "horizontalPodAutoscalers".
// src/types.d.ts:204:1 - (ae-undocumented) Missing documentation for "GroupedResponses".
// src/types.d.ts:205:5 - (ae-undocumented) Missing documentation for "services".
// src/types.d.ts:206:5 - (ae-undocumented) Missing documentation for "configMaps".
// src/types.d.ts:207:5 - (ae-undocumented) Missing documentation for "ingresses".
// src/types.d.ts:208:5 - (ae-undocumented) Missing documentation for "jobs".
// src/types.d.ts:209:5 - (ae-undocumented) Missing documentation for "cronJobs".
// src/types.d.ts:210:5 - (ae-undocumented) Missing documentation for "customResources".
// src/types.d.ts:211:5 - (ae-undocumented) Missing documentation for "statefulsets".
// src/types.d.ts:212:5 - (ae-undocumented) Missing documentation for "daemonSets".
// src/util/response.d.ts:4:22 - (ae-undocumented) Missing documentation for "groupResponses".
```
-468
View File
@@ -1,468 +0,0 @@
## API Report File for "@backstage/plugin-kubernetes-common"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { BasicPermission } from '@backstage/plugin-permission-common';
import { Entity } from '@backstage/catalog-model';
import { FetchResponse as FetchResponse_2 } from '@backstage/plugin-kubernetes-common';
import type { JsonObject } from '@backstage/types';
import type { JsonValue } from '@backstage/types';
import { ObjectsByEntityResponse as ObjectsByEntityResponse_2 } from '@backstage/plugin-kubernetes-common';
import { PodStatus } from '@kubernetes/client-node';
import { V1ConfigMap } from '@kubernetes/client-node';
import { V1CronJob } from '@kubernetes/client-node';
import { V1DaemonSet } from '@kubernetes/client-node';
import { V1Deployment } from '@kubernetes/client-node';
import { V1Ingress } from '@kubernetes/client-node';
import { V1Job } from '@kubernetes/client-node';
import { V1LimitRange } from '@kubernetes/client-node';
import { V1Pod } from '@kubernetes/client-node';
import { V1ReplicaSet } from '@kubernetes/client-node';
import { V1ResourceQuota } from '@kubernetes/client-node';
import { V1Service } from '@kubernetes/client-node';
import { V1StatefulSet } from '@kubernetes/client-node';
import { V2HorizontalPodAutoscaler } from '@kubernetes/client-node';
// @public
export const ANNOTATION_KUBERNETES_API_SERVER = 'kubernetes.io/api-server';
// @public
export const ANNOTATION_KUBERNETES_API_SERVER_CA =
'kubernetes.io/api-server-certificate-authority';
// @public
export const ANNOTATION_KUBERNETES_AUTH_PROVIDER =
'kubernetes.io/auth-provider';
// @public
export const ANNOTATION_KUBERNETES_AWS_ASSUME_ROLE =
'kubernetes.io/aws-assume-role';
// @public
export const ANNOTATION_KUBERNETES_AWS_CLUSTER_ID =
'kubernetes.io/x-k8s-aws-id';
// @public
export const ANNOTATION_KUBERNETES_AWS_EXTERNAL_ID =
'kubernetes.io/aws-external-id';
// @public
export const ANNOTATION_KUBERNETES_DASHBOARD_APP =
'kubernetes.io/dashboard-app';
// @public
export const ANNOTATION_KUBERNETES_DASHBOARD_PARAMETERS =
'kubernetes.io/dashboard-parameters';
// @public
export const ANNOTATION_KUBERNETES_DASHBOARD_URL =
'kubernetes.io/dashboard-url';
// @public
export const ANNOTATION_KUBERNETES_OIDC_TOKEN_PROVIDER =
'kubernetes.io/oidc-token-provider';
// @public
export const ANNOTATION_KUBERNETES_SKIP_METRICS_LOOKUP =
'kubernetes.io/skip-metrics-lookup';
// @public
export const ANNOTATION_KUBERNETES_SKIP_TLS_VERIFY =
'kubernetes.io/skip-tls-verify';
// @public (undocumented)
export type AuthProviderType = 'google' | 'serviceAccount' | 'aws' | 'azure';
// @public (undocumented)
export interface ClientContainerStatus {
// (undocumented)
container: string;
// (undocumented)
cpuUsage: ClientCurrentResourceUsage;
// (undocumented)
memoryUsage: ClientCurrentResourceUsage;
}
// @public (undocumented)
export interface ClientCurrentResourceUsage {
// (undocumented)
currentUsage: number | string;
// (undocumented)
limitTotal: number | string;
// (undocumented)
requestTotal: number | string;
}
// @public (undocumented)
export interface ClientPodStatus {
// (undocumented)
containers: ClientContainerStatus[];
// (undocumented)
cpu: ClientCurrentResourceUsage;
// (undocumented)
memory: ClientCurrentResourceUsage;
// (undocumented)
pod: V1Pod;
}
// @public (undocumented)
export interface ClusterAttributes {
dashboardApp?: string;
dashboardParameters?: JsonObject;
dashboardUrl?: string;
name: string;
title?: string;
}
// @public (undocumented)
export interface ClusterObjects {
// (undocumented)
cluster: ClusterAttributes;
// (undocumented)
errors: KubernetesFetchError[];
// (undocumented)
podMetrics: ClientPodStatus[];
// (undocumented)
resources: FetchResponse[];
}
// @public (undocumented)
export interface ConfigMapFetchResponse {
// (undocumented)
resources: Array<V1ConfigMap>;
// (undocumented)
type: 'configmaps';
}
// @public (undocumented)
export interface CronJobsFetchResponse {
// (undocumented)
resources: Array<V1CronJob>;
// (undocumented)
type: 'cronjobs';
}
// @public (undocumented)
export interface CustomObjectsByEntityRequest {
// (undocumented)
auth: KubernetesRequestAuth;
// (undocumented)
customResources: CustomResourceMatcher[];
// (undocumented)
entity: Entity;
}
// @public (undocumented)
export interface CustomResourceFetchResponse {
// (undocumented)
resources: Array<any>;
// (undocumented)
type: 'customresources';
}
// @public (undocumented)
export interface CustomResourceMatcher {
// (undocumented)
apiVersion: string;
// (undocumented)
group: string;
// (undocumented)
plural: string;
}
// @public (undocumented)
export interface DaemonSetsFetchResponse {
// (undocumented)
resources: Array<V1DaemonSet>;
// (undocumented)
type: 'daemonsets';
}
// @public (undocumented)
export interface DeploymentFetchResponse {
// (undocumented)
resources: Array<V1Deployment>;
// (undocumented)
type: 'deployments';
}
// @public (undocumented)
export interface DeploymentResources {
// (undocumented)
deployments: V1Deployment[];
// (undocumented)
horizontalPodAutoscalers: V2HorizontalPodAutoscaler[];
// (undocumented)
pods: V1Pod[];
// (undocumented)
replicaSets: V1ReplicaSet[];
}
// @public
export interface DetectedError {
// (undocumented)
message: string;
// (undocumented)
occurrenceCount: number;
// (undocumented)
proposedFix?: ProposedFix;
// (undocumented)
severity: ErrorSeverity;
// (undocumented)
sourceRef: ResourceRef;
// (undocumented)
type: string;
}
// @public
export type DetectedErrorsByCluster = Map<string, DetectedError[]>;
// @public
export const detectErrors: (
objects: ObjectsByEntityResponse_2,
) => DetectedErrorsByCluster;
// @public (undocumented)
export interface DocsSolution extends ProposedFixBase {
// (undocumented)
docsLink: string;
// (undocumented)
type: 'docs';
}
// @public (undocumented)
export interface ErrorMapper<T> {
// (undocumented)
detectErrors: (resource: T) => DetectedError[];
}
// @public
export type ErrorSeverity = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
// @public (undocumented)
export interface EventsSolution extends ProposedFixBase {
// (undocumented)
podName: string;
// (undocumented)
type: 'events';
}
// @public (undocumented)
export type FetchResponse =
| PodFetchResponse
| ServiceFetchResponse
| ConfigMapFetchResponse
| DeploymentFetchResponse
| LimitRangeFetchResponse
| ResourceQuotaFetchResponse
| ReplicaSetsFetchResponse
| HorizontalPodAutoscalersFetchResponse
| JobsFetchResponse
| CronJobsFetchResponse
| IngressesFetchResponse
| CustomResourceFetchResponse
| StatefulSetsFetchResponse
| DaemonSetsFetchResponse
| PodStatusFetchResponse;
// @public (undocumented)
export interface GroupedResponses extends DeploymentResources {
// (undocumented)
configMaps: V1ConfigMap[];
// (undocumented)
cronJobs: V1CronJob[];
// (undocumented)
customResources: any[];
// (undocumented)
daemonSets: V1DaemonSet[];
// (undocumented)
ingresses: V1Ingress[];
// (undocumented)
jobs: V1Job[];
// (undocumented)
services: V1Service[];
// (undocumented)
statefulsets: V1StatefulSet[];
}
// @public (undocumented)
export const groupResponses: (
fetchResponse: FetchResponse_2[],
) => GroupedResponses;
// @public (undocumented)
export interface HorizontalPodAutoscalersFetchResponse {
// (undocumented)
resources: Array<V2HorizontalPodAutoscaler>;
// (undocumented)
type: 'horizontalpodautoscalers';
}
// @public (undocumented)
export interface IngressesFetchResponse {
// (undocumented)
resources: Array<V1Ingress>;
// (undocumented)
type: 'ingresses';
}
// @public (undocumented)
export interface JobsFetchResponse {
// (undocumented)
resources: Array<V1Job>;
// (undocumented)
type: 'jobs';
}
// @public (undocumented)
export type KubernetesErrorTypes =
| 'BAD_REQUEST'
| 'UNAUTHORIZED_ERROR'
| 'NOT_FOUND'
| 'SYSTEM_ERROR'
| 'UNKNOWN_ERROR';
// @public (undocumented)
export type KubernetesFetchError = StatusError | RawFetchError;
// @public
export const kubernetesPermissions: BasicPermission[];
// @public
export const kubernetesProxyPermission: BasicPermission;
// @public (undocumented)
export type KubernetesRequestAuth = {
[providerKey: string]: JsonValue | undefined;
};
// @public (undocumented)
export interface KubernetesRequestBody {
// (undocumented)
auth?: KubernetesRequestAuth;
// (undocumented)
entity: Entity;
}
// @public (undocumented)
export interface LimitRangeFetchResponse {
// (undocumented)
resources: Array<V1LimitRange>;
// (undocumented)
type: 'limitranges';
}
// @public (undocumented)
export interface LogSolution extends ProposedFixBase {
// (undocumented)
container: string;
// (undocumented)
type: 'logs';
}
// @public (undocumented)
export interface ObjectsByEntityResponse {
// (undocumented)
items: ClusterObjects[];
}
// @public (undocumented)
export interface PodFetchResponse {
// (undocumented)
resources: Array<V1Pod>;
// (undocumented)
type: 'pods';
}
// @public (undocumented)
export interface PodStatusFetchResponse {
// (undocumented)
resources: Array<PodStatus>;
// (undocumented)
type: 'podstatus';
}
// @public (undocumented)
export type ProposedFix = LogSolution | DocsSolution | EventsSolution;
// @public (undocumented)
export interface ProposedFixBase {
// (undocumented)
actions: string[];
// (undocumented)
errorType: string;
// (undocumented)
rootCauseExplanation: string;
}
// @public (undocumented)
export interface RawFetchError {
// (undocumented)
errorType: 'FETCH_ERROR';
// (undocumented)
message: string;
}
// @public (undocumented)
export interface ReplicaSetsFetchResponse {
// (undocumented)
resources: Array<V1ReplicaSet>;
// (undocumented)
type: 'replicasets';
}
// @public (undocumented)
export interface ResourceQuotaFetchResponse {
// (undocumented)
resources: Array<V1ResourceQuota>;
// (undocumented)
type: 'resourcequotas';
}
// @public
export interface ResourceRef {
// (undocumented)
apiGroup: string;
// (undocumented)
kind: string;
// (undocumented)
name: string;
// (undocumented)
namespace: string;
}
// @public (undocumented)
export interface ServiceFetchResponse {
// (undocumented)
resources: Array<V1Service>;
// (undocumented)
type: 'services';
}
// @public (undocumented)
export interface StatefulSetsFetchResponse {
// (undocumented)
resources: Array<V1StatefulSet>;
// (undocumented)
type: 'statefulsets';
}
// @public (undocumented)
export interface StatusError {
// (undocumented)
errorType: KubernetesErrorTypes;
// (undocumented)
resourcePath?: string;
// (undocumented)
statusCode?: number;
}
// @public (undocumented)
export interface WorkloadsByEntityRequest {
// (undocumented)
auth: KubernetesRequestAuth;
// (undocumented)
entity: Entity;
}
```