timonel 3.1.1 → 3.1.2

package/dist/lib/resources/cloud/aws/karpenterResources.d.ts

@@ -1,109 +1,202 @@
+/**
+ * @fileoverview Karpenter resources for AWS EKS node management
+ * @since 2.8.0+
+ */
 import type { ApiObject } from 'cdk8s';
 import { BaseResourceProvider } from '../../baseResourceProvider.js';
+/**
+ * Karpenter version compatibility utilities
+ * @since 2.8.0+
+ */
 export declare class KarpenterVersionUtils {
+    /**
+     * Checks if the current Karpenter version supports v1 API
+     * @returns true if v1 API is supported, false otherwise
+     */
     static isKarpenterV1Compatible(): boolean;
+    /**
+     * Gets the appropriate API version for NodePool resources
+     * @returns API version string
+     */
     static getNodePoolApiVersion(): string;
+    /**
+     * Gets the appropriate API version for NodeClaim resources
+     * @returns API version string
+     */
     static getNodeClaimApiVersion(): string;
 }
+/**
+ * Karpenter Disruption Budget specification
+ * @since 2.8.0+
+ */
 export interface KarpenterDisruptionBudget {
+    /** Number or percentage of nodes that can be disrupted */
     nodes: string;
+    /** Cron schedule for when budget applies (optional) */
     schedule?: string;
+    /** Duration the budget is active (optional) */
     duration?: string;
 }
+/**
+ * Validates a KarpenterDisruptionBudget configuration
+ * @param budget - The budget to validate
+ * @returns true if valid, false otherwise
+ * @since 2.8.0+
+ */
 export declare function isValidDisruptionBudget(budget: KarpenterDisruptionBudget): boolean;
+/**
+ * Validates Kubernetes duration format
+ * @param duration - Duration string to validate
+ * @returns true if valid, false otherwise
+ * @since 2.7.1
+ */
 export declare function isValidKubernetesDuration(duration: string): boolean;
+/**
+ * Default termination grace period for Karpenter nodes
+ * @since 2.7.1
+ */
 export declare const DEFAULT_TERMINATION_GRACE_PERIOD = "30s";
+/**
+ * Karpenter Disruption specification
+ * @since 2.7.1
+ */
 export interface KarpenterDisruption {
+    /** Consolidation policy */
     consolidationPolicy?: 'WhenEmpty' | 'WhenEmptyOrUnderutilized';
+    /** Time to wait before consolidating */
     consolidateAfter?: string;
+    /** Node expiration time */
     expireAfter?: string;
+    /** Disruption budgets for rate limiting */
     budgets?: KarpenterDisruptionBudget[];
 }
+/**
+ * Karpenter NodePool specification
+ * @since 2.8.0+
+ */
 export interface KarpenterNodePoolSpec {
+    /** Resource name */
     name: string;
+    /** Template for nodes */
     template: {
         metadata?: {
             labels?: Record<string, string>;
             annotations?: Record<string, string>;
         };
         spec: {
+            /** Node class reference */
             nodeClassRef: {
                 apiVersion: string;
                 kind: string;
                 name: string;
             };
+            /** Node requirements */
             requirements?: Array<{
                 key: string;
                 operator: 'In' | 'NotIn' | 'Exists' | 'DoesNotExist' | 'Gt' | 'Lt';
                 values?: string[];
             }>;
+            /** Taints to apply to nodes */
             taints?: Array<{
                 key: string;
                 value?: string;
                 effect: 'NoSchedule' | 'PreferNoSchedule' | 'NoExecute';
             }>;
+            /** Startup taints */
             startupTaints?: Array<{
                 key: string;
                 value?: string;
                 effect: 'NoSchedule' | 'PreferNoSchedule' | 'NoExecute';
             }>;
+            /** Termination grace period */
             terminationGracePeriod?: string;
         };
     };
+    /** Disruption settings */
     disruption?: KarpenterDisruption;
+    /** Resource limits */
     limits?: Record<string, string>;
+    /** Resource weight for scheduling priority */
     weight?: number;
+    /** Resource labels */
     labels?: Record<string, string>;
+    /** Resource annotations */
     annotations?: Record<string, string>;
 }
+/**
+ * Karpenter NodeClaim specification
+ * @since 2.8.0+
+ */
 export interface KarpenterNodeClaimSpec {
+    /** Resource name */
     name: string;
+    /** Node class reference */
     nodeClassRef: {
         apiVersion: string;
         kind: string;
         name: string;
     };
+    /** Node requirements */
     requirements?: Array<{
         key: string;
         operator: 'In' | 'NotIn' | 'Exists' | 'DoesNotExist' | 'Gt' | 'Lt';
         values?: string[];
     }>;
+    /** Taints to apply to node */
     taints?: Array<{
         key: string;
         value?: string;
         effect: 'NoSchedule' | 'PreferNoSchedule' | 'NoExecute';
     }>;
+    /** Startup taints */
     startupTaints?: Array<{
         key: string;
         value?: string;
         effect: 'NoSchedule' | 'PreferNoSchedule' | 'NoExecute';
     }>;
+    /** Resource labels */
     labels?: Record<string, string>;
+    /** Resource annotations */
     annotations?: Record<string, string>;
 }
+/**
+ * Karpenter EC2NodeClass specification
+ * @since 2.7.0
+ */
 export interface KarpenterEC2NodeClassSpec {
+    /** Resource name */
     name: string;
+    /** AMI family */
     amiFamily?: 'AL2' | 'AL2023' | 'Bottlerocket' | 'Ubuntu' | 'Windows2019' | 'Windows2022' | 'Custom';
+    /** AMI selector */
     amiSelectorTerms?: Array<{
         tags?: Record<string, string>;
         id?: string;
         name?: string;
         owner?: string;
     }>;
+    /** Instance store policy */
     instanceStorePolicy?: 'RAID0' | 'NVME';
+    /** Instance profile */
     instanceProfile?: string;
+    /** Security group selector */
     securityGroupSelectorTerms?: Array<{
         tags?: Record<string, string>;
         id?: string;
         name?: string;
     }>;
+    /** Subnet selector */
     subnetSelectorTerms?: Array<{
         tags?: Record<string, string>;
         id?: string;
     }>;
+    /** User data */
     userData?: string;
+    /** Role */
     role?: string;
+    /** Tags to apply to instances */
     tags?: Record<string, string>;
+    /** Block device mappings */
     blockDeviceMappings?: Array<{
         deviceName: string;
         ebs?: {
@@ -116,19 +209,51 @@ export interface KarpenterEC2NodeClassSpec {
             deleteOnTermination?: boolean;
         };
     }>;
+    /** Metadata options */
     metadataOptions?: {
         httpEndpoint?: 'enabled' | 'disabled';
         httpProtocolIPv6?: 'enabled' | 'disabled';
         httpPutResponseHopLimit?: number;
         httpTokens?: 'required' | 'optional';
     };
+    /** Resource labels */
     labels?: Record<string, string>;
+    /** Resource annotations */
     annotations?: Record<string, string>;
 }
+/**
+ * Karpenter resources provider for AWS EKS node management
+ * @extends BaseResourceProvider
+ * @since 2.7.0
+ */
 export declare class KarpenterResources extends BaseResourceProvider {
+    /**
+     * Creates a Karpenter NodePool resource
+     * @param spec - NodePool specification
+     * @returns Created NodePool ApiObject
+     * @since 2.8.0+
+     */
     addKarpenterNodePool(spec: KarpenterNodePoolSpec): ApiObject;
+    /**
+     * Creates a Karpenter NodeClaim resource
+     * @param spec - NodeClaim specification
+     * @returns Created NodeClaim ApiObject
+     * @since 2.7.0
+     */
     addKarpenterNodeClaim(spec: KarpenterNodeClaimSpec): ApiObject;
+    /**
+     * Creates a Karpenter EC2NodeClass resource
+     * @param spec - EC2NodeClass specification
+     * @returns Created EC2NodeClass ApiObject
+     * @since 2.7.0
+     */
     addKarpenterEC2NodeClass(spec: KarpenterEC2NodeClassSpec): ApiObject;
+    /**
+     * Creates a Karpenter NodePool with optimized disruption settings for cost efficiency
+     * @param spec - NodePool specification with disruption optimization
+     * @returns Created NodePool ApiObject
+     * @since 2.8.0+
+     */
     addKarpenterNodePoolWithDisruption(spec: {
         name: string;
         nodeClassRef: {
@@ -150,6 +275,12 @@ export declare class KarpenterResources extends BaseResourceProvider {
         labels?: Record<string, string>;
         annotations?: Record<string, string>;
     }): ApiObject;
+    /**
+     * Creates a Karpenter NodePool with scheduling constraints and priorities
+     * @param spec - NodePool specification with scheduling optimization
+     * @returns Created NodePool ApiObject
+     * @since 2.8.0+
+     */
     addKarpenterNodePoolWithScheduling(spec: {
         name: string;
         nodeClassRef: {

package/dist/lib/resources/cloud/aws/karpenterResources.js

@@ -1,24 +1,60 @@
+/**
+ * @fileoverview Karpenter resources for AWS EKS node management
+ * @since 2.8.0+
+ */
 import { BaseResourceProvider } from '../../baseResourceProvider.js';
+/**
+ * Karpenter version compatibility utilities
+ * @since 2.8.0+
+ */
 export class KarpenterVersionUtils {
+    /**
+     * Checks if the current Karpenter version supports v1 API
+     * @returns true if v1 API is supported, false otherwise
+     */
     static isKarpenterV1Compatible() {
+        // For now, we assume v1 compatibility since we're targeting Karpenter v1.6+
+        // In the future, this could check actual cluster version
         return true;
     }
+    /**
+     * Gets the appropriate API version for NodePool resources
+     * @returns API version string
+     */
     static getNodePoolApiVersion() {
         return this.isKarpenterV1Compatible() ? 'karpenter.sh/v1' : 'karpenter.sh/v1beta1';
     }
+    /**
+     * Gets the appropriate API version for NodeClaim resources
+     * @returns API version string
+     */
     static getNodeClaimApiVersion() {
         return this.isKarpenterV1Compatible() ? 'karpenter.sh/v1' : 'karpenter.sh/v1beta1';
     }
 }
+/**
+ * Validates a KarpenterDisruptionBudget configuration
+ * @param budget - The budget to validate
+ * @returns true if valid, false otherwise
+ * @since 2.8.0+
+ */
 export function isValidDisruptionBudget(budget) {
     const nodePattern = /^(\d+%|\d+)$/;
     return nodePattern.test(budget.nodes);
 }
+/**
+ * Validates Kubernetes duration format
+ * @param duration - Duration string to validate
+ * @returns true if valid, false otherwise
+ * @since 2.7.1
+ */
 export function isValidKubernetesDuration(duration) {
     try {
+        // Validate input is a string
         if (typeof duration !== 'string') {
             return false;
         }
+        // eslint-disable-next-line security/detect-unsafe-regex
         const durationPattern = /^(\d+h)?(\d+m)?(\d+s)?$/;
         return durationPattern.test(duration) && duration.length > 0;
     }
@@ -26,8 +62,23 @@ export function isValidKubernetesDuration(duration) {
         return false;
     }
 }
+/**
+ * Default termination grace period for Karpenter nodes
+ * @since 2.7.1
+ */
 export const DEFAULT_TERMINATION_GRACE_PERIOD = '30s';
+/**
+ * Karpenter resources provider for AWS EKS node management
+ * @extends BaseResourceProvider
+ * @since 2.7.0
+ */
 export class KarpenterResources extends BaseResourceProvider {
+    /**
+     * Creates a Karpenter NodePool resource
+     * @param spec - NodePool specification
+     * @returns Created NodePool ApiObject
+     * @since 2.8.0+
+     */
     addKarpenterNodePool(spec) {
         const nodePoolSpec = {
             template: spec.template,
@@ -43,6 +94,12 @@ export class KarpenterResources extends BaseResourceProvider {
         }
         return this.createApiObject(spec.name, KarpenterVersionUtils.getNodePoolApiVersion(), 'NodePool', nodePoolSpec, spec.labels, spec.annotations);
     }
+    /**
+     * Creates a Karpenter NodeClaim resource
+     * @param spec - NodeClaim specification
+     * @returns Created NodeClaim ApiObject
+     * @since 2.7.0
+     */
     addKarpenterNodeClaim(spec) {
         const nodeClaimSpec = {
             nodeClassRef: spec.nodeClassRef,
@@ -58,6 +115,12 @@ export class KarpenterResources extends BaseResourceProvider {
         }
         return this.createApiObject(spec.name, KarpenterVersionUtils.getNodeClaimApiVersion(), 'NodeClaim', nodeClaimSpec, spec.labels, spec.annotations);
     }
+    /**
+     * Creates a Karpenter EC2NodeClass resource
+     * @param spec - EC2NodeClass specification
+     * @returns Created EC2NodeClass ApiObject
+     * @since 2.7.0
+     */
     addKarpenterEC2NodeClass(spec) {
         const nodeClassSpec = {};
         if (spec.amiFamily) {
@@ -95,6 +158,12 @@ export class KarpenterResources extends BaseResourceProvider {
         }
         return this.createApiObject(spec.name, 'karpenter.k8s.aws/v1beta1', 'EC2NodeClass', nodeClassSpec, spec.labels, spec.annotations);
     }
+    /**
+     * Creates a Karpenter NodePool with optimized disruption settings for cost efficiency
+     * @param spec - NodePool specification with disruption optimization
+     * @returns Created NodePool ApiObject
+     * @since 2.8.0+
+     */
     addKarpenterNodePoolWithDisruption(spec) {
         const disruption = {};
         if (spec.consolidationPolicy) {
@@ -129,12 +198,14 @@ export class KarpenterResources extends BaseResourceProvider {
             nodePoolConfig['weight'] = spec.weight;
         }
         if (spec.labels) {
+            // Validate labels is an object
             if (typeof spec.labels !== 'object' || Array.isArray(spec.labels)) {
                 throw new Error('Labels must be a valid object');
             }
             nodePoolConfig['labels'] = spec.labels;
         }
         if (spec.annotations) {
+            // Validate annotations is an object
             if (typeof spec.annotations !== 'object' || Array.isArray(spec.annotations)) {
                 throw new Error('Annotations must be a valid object');
             }
@@ -142,6 +213,12 @@ export class KarpenterResources extends BaseResourceProvider {
         }
         return this.addKarpenterNodePool(nodePoolConfig);
     }
+    /**
+     * Creates a Karpenter NodePool with scheduling constraints and priorities
+     * @param spec - NodePool specification with scheduling optimization
+     * @returns Created NodePool ApiObject
+     * @since 2.8.0+
+     */
     addKarpenterNodePoolWithScheduling(spec) {
         const templateSpec = {
             nodeClassRef: spec.nodeClassRef,