@rulebricks/cli 1.9.0

package/dist/lib/kubernetes.d.ts

@@ -0,0 +1,161 @@
+import { CloudProvider } from "../types/index.js";
+/**
+ * Checks if kubectl is installed
+ */
+export declare function isKubectlInstalled(): Promise<boolean>;
+/**
+ * Gets the kubectl client version
+ */
+export declare function getKubectlVersion(): Promise<string>;
+/**
+ * Checks if the cluster is accessible
+ */
+export declare function isClusterAccessible(): Promise<boolean>;
+/**
+ * Checks if the cluster is accessible and returns error details if not.
+ * Returns null if accessible, or an error message string if not.
+ */
+export declare function checkClusterAccessible(): Promise<string | null>;
+/**
+ * Gets the current kubectl context
+ */
+export declare function getCurrentContext(): Promise<string | null>;
+/**
+ * Gets pod status for the Rulebricks namespace
+ */
+export declare function getPodStatus(namespace?: string): Promise<PodStatus[]>;
+export interface PodStatus {
+    name: string;
+    status: string;
+    ready: boolean;
+    restarts: number;
+}
+/**
+ * Gets service status for the Rulebricks namespace
+ */
+export declare function getServiceStatus(namespace?: string): Promise<ServiceStatus[]>;
+export interface ServiceStatus {
+    name: string;
+    type: string;
+    ports: number[];
+    externalIP: string | null;
+}
+/**
+ * Gets ingress status for the Rulebricks namespace
+ */
+export declare function getIngressStatus(namespace?: string): Promise<IngressStatus[]>;
+export interface IngressStatus {
+    name: string;
+    hosts: string[];
+    tls: boolean;
+    address: string | null;
+}
+/**
+ * Gets certificate status
+ */
+export declare function getCertificateStatus(namespace?: string): Promise<CertificateStatus[]>;
+export interface CertificateStatus {
+    name: string;
+    dnsNames: string[];
+    ready: boolean;
+}
+/**
+ * Streams logs from a pod
+ */
+export declare function streamLogs(podName: string, namespace?: string, options?: {
+    follow?: boolean;
+    tail?: number;
+    container?: string;
+}): Promise<void>;
+/**
+ * Callback type for receiving log lines from multiple pods
+ */
+export type LogLineCallback = (podName: string, line: string, colorIndex: number) => void;
+/**
+ * Streams logs from multiple pods simultaneously.
+ * Each log line is prefixed with the pod name and a unique color.
+ * Returns a cleanup function to stop all log streams.
+ */
+export declare function streamMultiPodLogs(podNames: string[], namespace: string, options?: {
+    follow?: boolean;
+    tail?: number;
+    timestamps?: boolean;
+    onLine?: LogLineCallback;
+}): () => void;
+/**
+ * Gets pods by label selector
+ */
+export declare function getPodsByLabel(labelSelector: string, namespace?: string): Promise<string[]>;
+/**
+ * List of valid component names for log viewing
+ */
+export declare const VALID_LOG_COMPONENTS: string[];
+/**
+ * Gets pods for a specific component in a deployment.
+ * Queries all pods in the namespace and filters by component name patterns.
+ * This approach works for all components including subcharts like Traefik
+ * that may have different instance labels than the parent release.
+ */
+export declare function getComponentPods(component: string, _releaseName: string, namespace: string): Promise<string[]>;
+/**
+ * Deletes a namespace
+ */
+export declare function deleteNamespace(namespace: string, options?: {
+    wait?: boolean;
+}): Promise<void>;
+/**
+ * Deletes all PVCs in a namespace
+ */
+export declare function deletePVCs(namespace: string, options?: {
+    wait?: boolean;
+}): Promise<void>;
+/**
+ * Removes finalizers from KEDA ScaledObjects to prevent namespace deletion from hanging.
+ * KEDA finalizers wait for the KEDA controller to clean up, but if KEDA is being deleted
+ * with the namespace, this causes a deadlock.
+ */
+export declare function removeKedaFinalizers(namespace: string): Promise<void>;
+/**
+ * Checks if a namespace exists
+ */
+export declare function namespaceExists(namespace: string): Promise<boolean>;
+/**
+ * Waits for cluster to be accessible with retries.
+ * EKS IAM authentication can take time to propagate after cluster creation.
+ */
+export declare function waitForClusterAccess(maxRetries?: number, delayMs?: number): Promise<void>;
+/**
+ * Creates default StorageClass for the cloud provider.
+ * Should be called after kubeconfig is configured and cluster is accessible.
+ */
+export declare function createDefaultStorageClass(provider: CloudProvider): Promise<void>;
+/**
+ * Deployed image versions from Kubernetes
+ */
+export interface DeployedVersions {
+    appVersion: string | null;
+    hpsVersion: string | null;
+}
+/**
+ * Gets the actual deployed image versions from Kubernetes deployments.
+ * Queries the app and HPS deployments to get their current image tags.
+ *
+ * @param releaseName - The Helm release name (e.g., "rulebricks")
+ * @param namespace - The Kubernetes namespace
+ * @returns DeployedVersions with app and HPS versions, or null if not found
+ */
+export declare function getDeployedImageVersions(releaseName: string, namespace: string): Promise<DeployedVersions>;
+/**
+ * Kubernetes workload types that support rollout restart
+ */
+export type WorkloadType = "deployment" | "statefulset" | "daemonset";
+/**
+ * Performs a rollout restart on a Kubernetes workload (deployment, statefulset, or daemonset).
+ * This forces pods to be recreated, pulling fresh images if pullPolicy is Always.
+ *
+ * @param workloadType - The type of workload (deployment, statefulset, daemonset)
+ * @param name - The name of the workload to restart
+ * @param namespace - The Kubernetes namespace
+ * @returns true if restart was successful, false if workload doesn't exist or failed
+ */
+export declare function rolloutRestart(workloadType: WorkloadType, name: string, namespace: string): Promise<boolean>;