@k8slens/extensions 5.5.0-git.b6af0e3eba.0 → 5.5.0-git.e01916c73d.0

package/dist/src/common/k8s-api/__tests__/ingress.api.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+export {};

package/dist/src/common/k8s-api/endpoints/ingress.api.d.ts

@@ -2,7 +2,7 @@
  * Copyright (c) OpenLens Authors. All rights reserved.
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
-import { KubeObject } from "../kube-object";
+import { KubeObject, TypedLocalObjectReference } from "../kube-object";
 import { IMetrics } from "./metrics.api";
 import { KubeApi } from "../kube-api";
 import type { KubeJsonApiData } from "../kube-json-api";
@@ -21,46 +21,50 @@ export interface ILoadBalancerIngress {
     hostname?: string;
     ip?: string;
 }
-interface IExtensionsBackend {
-    serviceName: string;
-    servicePort: number | string;
+export interface ExtensionsBackend {
+    serviceName?: string;
+    servicePort?: number | string;
 }
-interface INetworkingBackend {
-    service: IIngressService;
+export interface NetworkingBackend {
+    service?: IngressService;
 }
-export declare type IIngressBackend = IExtensionsBackend | INetworkingBackend;
-export interface IIngressService {
+export declare type IngressBackend = (ExtensionsBackend | NetworkingBackend) & {
+    resource?: TypedLocalObjectReference;
+};
+export interface IngressService {
     name: string;
-    port: {
-        name?: string;
-        number?: number;
+    port: RequireExactlyOne<{
+        name: string;
+        number: number;
+    }>;
+}
+/**
+ * Format an ingress backend into the name of the service and port
+ * @param backend The ingress target
+ */
+export declare function getBackendServiceNamePort(backend: IngressBackend): string;
+export interface IngressRule {
+    host?: string;
+    http?: {
+        paths: {
+            path?: string;
+            backend: IngressBackend;
+        }[];
     };
 }
-export declare const getBackendServiceNamePort: (backend: IIngressBackend) => {
-    serviceName: string;
-    servicePort: string | number;
-};
 export interface Ingress {
-    spec: {
-        tls: {
+    spec?: {
+        tls?: {
             secretName: string;
         }[];
-        rules?: {
-            host?: string;
-            http: {
-                paths: {
-                    path?: string;
-                    backend: IIngressBackend;
-                }[];
-            };
-        }[];
-        backend?: IExtensionsBackend;
+        rules?: IngressRule[];
+        backend?: ExtensionsBackend;
         /**
          * The default backend which is exactly on of:
          * - service
          * - resource
          */
-        defaultBackend?: RequireExactlyOne<INetworkingBackend & {
+        defaultBackend?: RequireExactlyOne<NetworkingBackend & {
             resource: {
                 apiGroup: string;
                 kind: string;
@@ -74,16 +78,25 @@ export interface Ingress {
         };
     };
 }
+export interface ComputedIngressRoute {
+    displayAsLink: boolean;
+    pathname: string;
+    url: string;
+    service: string;
+}
 export declare class Ingress extends KubeObject {
     static kind: string;
     static namespaced: boolean;
     static apiBase: string;
     constructor(data: KubeJsonApiData);
+    getRules(): IngressRule[];
     getRoutes(): string[];
-    getServiceNamePort(): IExtensionsBackend;
+    getServiceNamePort(): ExtensionsBackend;
     getHosts(): string[];
     getPorts(): string;
     getLoadBalancers(): string[];
 }
+export declare function computeRuleDeclarations(ingress: Ingress, rule: IngressRule): ComputedIngressRoute[];
+export declare function computeRouteDeclarations(ingress: Ingress): ComputedIngressRoute[];
 declare let ingressApi: IngressApi;
 export { ingressApi, };

package/dist/src/common/k8s-api/endpoints/metrics.api.d.ts

@@ -50,7 +50,7 @@ export declare const metricsApi: {
 };
 export declare function normalizeMetrics(metrics: IMetrics, frames?: number): IMetrics;
 export declare function isMetricsEmpty(metrics: Record<string, IMetrics>): boolean;
-export declare function getItemMetrics(metrics: Record<string, IMetrics>, itemName: string): Record<string, IMetrics> | void;
+export declare function getItemMetrics(metrics: Record<string, IMetrics>, itemName: string): Record<string, IMetrics> | undefined;
 export declare function getMetricLastPoints(metrics: Record<string, IMetrics>): Partial<{
     [metric: string]: number;
 }>;

package/dist/src/common/k8s-api/endpoints/persistent-volume-claims.api.d.ts

@@ -15,17 +15,24 @@ export interface IPvcMetrics<T = IMetrics> {
     diskUsage: T;
     diskCapacity: T;
 }
-export interface PersistentVolumeClaim {
-    spec: {
-        accessModes: string[];
-        storageClassName: string;
-        selector: LabelSelector;
-        resources: {
-            requests: {
-                storage: string;
-            };
-        };
+export interface PersistentVolumeClaimSpec {
+    accessModes: string[];
+    selector: LabelSelector;
+    resources: {
+        requests?: Record<string, string>;
+        limits?: Record<string, string>;
+    };
+    volumeName?: string;
+    storageClassName?: string;
+    volumeMode?: string;
+    dataSource?: {
+        apiGroup: string;
+        kind: string;
+        name: string;
     };
+}
+export interface PersistentVolumeClaim {
+    spec: PersistentVolumeClaimSpec;
     status: {
         phase: string;
     };

package/dist/src/common/k8s-api/endpoints/pods.api.d.ts

@@ -6,6 +6,10 @@ import { IAffinity, WorkloadKubeObject } from "../workload-kube-object";
 import { IMetrics } from "./metrics.api";
 import { KubeApi } from "../kube-api";
 import type { KubeJsonApiData } from "../kube-json-api";
+import type { RequireExactlyOne } from "type-fest";
+import type { KubeObjectMetadata, LocalObjectReference } from "../kube-object";
+import type { SecretReference } from "./secret.api";
+import type { PersistentVolumeClaimSpec } from "./persistent-volume-claims.api";
 export declare class PodsApi extends KubeApi<Pod> {
     getLogs: (params: {
         namespace: string;
@@ -82,12 +86,8 @@ export interface IPodContainer extends Partial<Record<PodContainerProbe, IContai
         };
     }[];
     envFrom?: {
-        configMapRef?: {
-            name: string;
-        };
-        secretRef?: {
-            name: string;
-        };
+        configMapRef?: LocalObjectReference;
+        secretRef?: LocalObjectReference;
     }[];
     volumeMounts?: {
         name: string;
@@ -156,29 +156,418 @@ export interface IPodContainerStatus {
     containerID?: string;
     started?: boolean;
 }
+export interface AwsElasticBlockStoreSource {
+    volumeID: string;
+    fsType: string;
+}
+export interface AzureDiskSource {
+    /**
+     * The name of the VHD blob object OR the name of an Azure managed data disk if `kind` is `"Managed"`.
+     */
+    diskName: string;
+    /**
+     * The URI of the vhd blob object OR the `resourceID` of an Azure managed data disk if `kind` is `"Managed"`.
+     */
+    diskURI: string;
+    /**
+     * Kind of disk
+     * @default "Shared"
+     */
+    kind?: "Shared" | "Dedicated" | "Managed";
+    /**
+     * Disk caching mode.
+     * @default "None"
+     */
+    cachingMode?: "None" | "ReadOnly" | "ReadWrite";
+    /**
+     * The filesystem type to mount.
+     * @default "ext4"
+     */
+    fsType?: string;
+    /**
+     * Whether the filesystem is used as readOnly.
+     * @default false
+     */
+    readonly?: boolean;
+}
+export interface AzureFileSource {
+    /**
+     * The name of the secret that contains both Azure storage account name and key.
+     */
+    secretName: string;
+    /**
+     * The share name to be used.
+     */
+    shareName: string;
+    /**
+     * In case the secret is stored in a different namespace.
+     * @default "default"
+     */
+    secretNamespace?: string;
+    /**
+     * Whether the filesystem is used as readOnly.
+     */
+    readOnly: boolean;
+}
+export interface CephfsSource {
+    /**
+     * List of Ceph monitors
+     */
+    monitors: string[];
+    /**
+     * Used as the mounted root, rather than the full Ceph tree.
+     * @default "/"
+     */
+    path?: string;
+    /**
+     * The RADOS user name.
+     * @default "admin"
+     */
+    user?: string;
+    /**
+     * The path to the keyring file.
+     * @default "/etc/ceph/user.secret"
+     */
+    secretFile?: string;
+    /**
+     * Reference to Ceph authentication secrets. If provided, then the secret overrides `secretFile`
+     */
+    secretRef?: SecretReference;
+    /**
+     * Whether the filesystem is used as readOnly.
+     */
+    readOnly: boolean;
+}
+export interface CinderSource {
+    volumeID: string;
+    fsType: string;
+    /**
+     * @default false
+     */
+    readOnly?: boolean;
+    secretRef?: SecretReference;
+}
+export interface ConfigMapSource {
+    name: string;
+    items: {
+        key: string;
+        path: string;
+    }[];
+}
+export interface DownwardApiSource {
+    items: {
+        path: string;
+        fieldRef: {
+            fieldPath: string;
+        };
+    }[];
+}
+export interface EphemeralSource {
+    volumeClaimTemplate: {
+        /**
+         * All the rest of the fields are ignored and rejected during validation
+         */
+        metadata?: Pick<KubeObjectMetadata, "labels" | "annotations">;
+        spec: PersistentVolumeClaimSpec;
+    };
+}
+export interface EmptyDirSource {
+    medium?: string;
+    sizeLimit?: string;
+}
+export interface FiberChannelSource {
+    /**
+     * A list of World Wide Names
+     */
+    targetWWNs: string[];
+    /**
+     * Logical Unit number
+     */
+    lun: number;
+    /**
+     * The type of filesystem
+     * @default "ext4"
+     */
+    fsType?: string;
+    readOnly: boolean;
+}
+export interface FlockerSource {
+    datasetName: string;
+}
+export interface FlexVolumeSource {
+    driver: string;
+    fsType?: string;
+    secretRef?: LocalObjectReference;
+    /**
+     * @default false
+     */
+    readOnly?: boolean;
+    options?: Record<string, string>;
+}
+export interface GcePersistentDiskSource {
+    pdName: string;
+    fsType: string;
+}
+export interface GitRepoSource {
+    repository: string;
+    revision: string;
+}
+export interface GlusterFsSource {
+    /**
+     * The name of the Endpoints object that represents a Gluster cluster configuration.
+     */
+    endpoints: string;
+    /**
+     * The Glusterfs volume name.
+     */
+    path: string;
+    /**
+     * The boolean that sets the mountpoint readOnly or readWrite.
+     */
+    readOnly: boolean;
+}
+export interface HostPathSource {
+    path: string;
+    /**
+     * Determines the sorts of checks that will be done
+     * @default ""
+     */
+    type?: "" | "DirectoryOrCreate" | "Directory" | "FileOrCreate" | "File" | "Socket" | "CharDevice" | "BlockDevice";
+}
+export interface IScsiSource {
+    targetPortal: string;
+    iqn: string;
+    lun: number;
+    fsType: string;
+    readOnly: boolean;
+    chapAuthDiscovery?: boolean;
+    chapAuthSession?: boolean;
+    secretRef?: SecretReference;
+}
+export interface LocalSource {
+    path: string;
+}
+export interface NetworkFsSource {
+    server: string;
+    path: string;
+    readOnly?: boolean;
+}
+export interface PersistentVolumeClaimSource {
+    claimName: string;
+}
+export interface PhotonPersistentDiskSource {
+    pdID: string;
+    /**
+     * @default "ext4"
+     */
+    fsType?: string;
+}
+export interface PortworxVolumeSource {
+    volumeID: string;
+    fsType?: string;
+    readOnly?: boolean;
+}
+export interface ProjectedSource {
+    sources: {
+        secret?: {
+            name: string;
+            items?: {
+                key: string;
+                path: string;
+                mode?: number;
+            }[];
+        };
+        downwardAPI?: {
+            items?: {
+                path: string;
+                fieldRef?: {
+                    fieldPath: string;
+                    apiVersion?: string;
+                };
+                resourceFieldRef?: {
+                    resource: string;
+                    containerName?: string;
+                };
+                mode?: number;
+            }[];
+        };
+        configMap?: {
+            name: string;
+            items?: {
+                key: string;
+                path: string;
+                mode?: number;
+            }[];
+            optional?: boolean;
+        };
+        serviceAccountToken?: {
+            audience?: string;
+            expirationSeconds?: number;
+            path: string;
+        };
+    }[];
+    defaultMode: number;
+}
+export interface QuobyteSource {
+    registry: string;
+    volume: string;
+    /**
+     * @default false
+     */
+    readOnly?: boolean;
+    /**
+     * @default "serivceaccount"
+     */
+    user?: string;
+    group?: string;
+    tenant?: string;
+}
+export interface RadosBlockDeviceSource {
+    monitors: string[];
+    image: string;
+    /**
+     * @default "ext4"
+     */
+    fsType?: string;
+    /**
+     * @default "rbd"
+     */
+    pool?: string;
+    /**
+     * @default "admin"
+     */
+    user?: string;
+    /**
+     * @default "/etc/ceph/keyring"
+     */
+    keyring?: string;
+    secretRef?: SecretReference;
+    /**
+     * @default false
+     */
+    readOnly?: boolean;
+}
+export interface ScaleIoSource {
+    gateway: string;
+    system: string;
+    secretRef?: LocalObjectReference;
+    /**
+     * @default false
+     */
+    sslEnabled?: boolean;
+    protectionDomain?: string;
+    storagePool?: string;
+    /**
+     * @default "ThinProvisioned"
+     */
+    storageMode?: "ThickProvisioned" | "ThinProvisioned";
+    volumeName: string;
+    /**
+     * @default "xfs"
+     */
+    fsType?: string;
+    /**
+     * @default false
+     */
+    readOnly?: boolean;
+}
+export interface SecretSource {
+    secretName: string;
+    items?: {
+        key: string;
+        path: string;
+        mode?: number;
+    }[];
+    defaultMode?: number;
+    optional?: boolean;
+}
+export interface StorageOsSource {
+    volumeName: string;
+    /**
+     * @default Pod.metadata.namespace
+     */
+    volumeNamespace?: string;
+    /**
+     * @default "ext4"
+     */
+    fsType?: string;
+    /**
+     * @default false
+     */
+    readOnly?: boolean;
+    secretRef?: LocalObjectReference;
+}
+export interface VsphereVolumeSource {
+    volumePath: string;
+    /**
+     * @default "ext4"
+     */
+    fsType?: string;
+    storagePolicyName?: string;
+    storagePolicyID?: string;
+}
+export interface ContainerStorageInterfaceSource {
+    driver: string;
+    /**
+     * @default false
+     */
+    readOnly?: boolean;
+    /**
+     * @default "ext4"
+     */
+    fsType?: string;
+    volumeAttributes?: Record<string, string>;
+    controllerPublishSecretRef?: SecretReference;
+    nodeStageSecretRef?: SecretReference;
+    nodePublishSecretRef?: SecretReference;
+    controllerExpandSecretRef?: SecretReference;
+}
+export interface PodVolumeVariants {
+    awsElasticBlockStore: AwsElasticBlockStoreSource;
+    azureDisk: AzureDiskSource;
+    azureFile: AzureFileSource;
+    cephfs: CephfsSource;
+    cinder: CinderSource;
+    configMap: ConfigMapSource;
+    csi: ContainerStorageInterfaceSource;
+    downwardAPI: DownwardApiSource;
+    emptyDir: EmptyDirSource;
+    ephemeral: EphemeralSource;
+    fc: FiberChannelSource;
+    flexVolume: FlexVolumeSource;
+    flocker: FlockerSource;
+    gcePersistentDisk: GcePersistentDiskSource;
+    gitRepo: GitRepoSource;
+    glusterfs: GlusterFsSource;
+    hostPath: HostPathSource;
+    iscsi: IScsiSource;
+    local: LocalSource;
+    nfs: NetworkFsSource;
+    persistentVolumeClaim: PersistentVolumeClaimSource;
+    photonPersistentDisk: PhotonPersistentDiskSource;
+    portworxVolume: PortworxVolumeSource;
+    projected: ProjectedSource;
+    quobyte: QuobyteSource;
+    rbd: RadosBlockDeviceSource;
+    scaleIO: ScaleIoSource;
+    secret: SecretSource;
+    storageos: StorageOsSource;
+    vsphereVolume: VsphereVolumeSource;
+}
+/**
+ * The valid kinds of volume
+ */
+export declare type PodVolumeKind = keyof PodVolumeVariants;
+export declare type PodVolume = RequireExactlyOne<PodVolumeVariants> & {
+    name: string;
+};
 export declare class Pod extends WorkloadKubeObject {
     static kind: string;
     static namespaced: boolean;
     static apiBase: string;
     constructor(data: KubeJsonApiData);
     spec?: {
-        volumes?: {
-            name: string;
-            persistentVolumeClaim: {
-                claimName: string;
-            };
-            emptyDir: {
-                medium?: string;
-                sizeLimit?: string;
-            };
-            configMap: {
-                name: string;
-            };
-            secret: {
-                secretName: string;
-                defaultMode: number;
-            };
-        }[];
+        volumes?: PodVolume[];
         initContainers: IPodContainer[];
         containers: IPodContainer[];
         restartPolicy?: string;
@@ -195,9 +584,7 @@ export declare class Pod extends WorkloadKubeObject {
             [selector: string]: string;
         };
         securityContext?: {};
-        imagePullSecrets?: {
-            name: string;
-        }[];
+        imagePullSecrets?: LocalObjectReference[];
         hostNetwork?: boolean;
         hostPID?: boolean;
         hostIPC?: boolean;
@@ -255,23 +642,7 @@ export declare class Pod extends WorkloadKubeObject {
         lastProbeTime: number;
         lastTransitionTime: string;
     }[];
-    getVolumes(): {
-        name: string;
-        persistentVolumeClaim: {
-            claimName: string;
-        };
-        emptyDir: {
-            medium?: string;
-            sizeLimit?: string;
-        };
-        configMap: {
-            name: string;
-        };
-        secret: {
-            secretName: string;
-            defaultMode: number;
-        };
-    }[];
+    getVolumes(): PodVolume[];
     getSecrets(): string[];
     getNodeSelectors(): string[];
     getTolerations(): {

package/dist/src/common/k8s-api/endpoints/secret.api.d.ts

@@ -19,6 +19,10 @@ export interface ISecretRef {
     key?: string;
     name: string;
 }
+export interface SecretReference {
+    name: string;
+    namespace?: string;
+}
 export interface SecretData extends KubeJsonApiData {
     type: SecretType;
     data?: Record<string, string>;

package/dist/src/common/k8s-api/kube-object.d.ts

@@ -11,6 +11,12 @@ export declare type KubeObjectConstructor<K extends KubeObject> = (new (data: Ku
     namespaced?: boolean;
     apiBase?: string;
 };
+/**
+ * A reference to an object in the same namespace
+ */
+export interface LocalObjectReference {
+    name: string;
+}
 export interface KubeObjectMetadata {
     uid: string;
     name: string;
@@ -83,6 +89,11 @@ export declare type LabelMatchExpression = {
      */
     values: string[];
 });
+export interface TypedLocalObjectReference {
+    apiGroup?: string;
+    kind: string;
+    name: string;
+}
 export interface LabelSelector {
     matchLabels?: Record<string, string | undefined>;
     matchExpressions?: LabelMatchExpression[];