timonel 2.3.0 → 2.5.0

package/dist/lib/resources/core/coreResources.d.ts

@@ -0,0 +1,766 @@
+import { ApiObject } from 'cdk8s';
+import { BaseResourceProvider } from '../baseResourceProvider.js';
+/**
+ * Core Kubernetes resources provider
+ * Handles fundamental Kubernetes resources like Deployments, Services, ConfigMaps, etc.
+ *
+ * @since 2.4.0
+ */
+export declare class CoreResources extends BaseResourceProvider {
+    private static readonly APPS_API_VERSION;
+    private static readonly CORE_API_VERSION;
+    private static readonly RBAC_API_VERSION;
+    private static readonly LABEL_NAME;
+    private static readonly HELPER_NAME;
+    /**
+     * Creates a Deployment resource
+     * @param spec - Deployment specification
+     * @returns Created Deployment ApiObject
+     *
+     * @example
+     * ```typescript
+     * coreResources.addDeployment({
+     *   name: 'web-app',
+     *   image: 'nginx:1.21',
+     *   replicas: 3,
+     *   containerPort: 80
+     * });
+     * ```
+     *
+     * @since 2.4.0
+     */
+    addDeployment(spec: DeploymentSpec): ApiObject;
+    /**
+     * Creates a Service resource
+     * @param spec - Service specification
+     * @returns Created Service ApiObject
+     *
+     * @example
+     * ```typescript
+     * coreResources.addService({
+     *   name: 'web-service',
+     *   port: 80,
+     *   targetPort: 8080,
+     *   type: 'ClusterIP'
+     * });
+     * ```
+     *
+     * @since 2.4.0
+     */
+    addService(spec: ServiceSpec): ApiObject;
+    /**
+     * Creates a ConfigMap resource
+     * @param spec - ConfigMap specification
+     * @returns Created ConfigMap ApiObject
+     *
+     * @example
+     * ```typescript
+     * coreResources.addConfigMap({
+     *   name: 'app-config',
+     *   data: {
+     *     'config.yaml': 'key: value',
+     *     'app.properties': 'debug=true'
+     *   }
+     * });
+     * ```
+     *
+     * @since 2.4.0
+     */
+    addConfigMap(spec: ConfigMapSpec): ApiObject;
+    /**
+     * Creates a Secret resource
+     * @param spec - Secret specification
+     * @returns Created Secret ApiObject
+     *
+     * @example
+     * ```typescript
+     * coreResources.addSecret({
+     *   name: 'app-secrets',
+     *   type: 'Opaque',
+     *   data: {
+     *     username: 'YWRtaW4=',
+     *     password: 'MWYyZDFlMmU2N2Rm'
+     *   }
+     * });
+     * ```
+     *
+     * @since 2.4.0
+     */
+    addSecret(spec: SecretSpec): ApiObject;
+    /**
+     * Creates a ServiceAccount resource
+     * @param spec - ServiceAccount specification
+     * @returns Created ServiceAccount ApiObject
+     *
+     * @example
+     * ```typescript
+     * coreResources.addServiceAccount({
+     *   name: 'app-service-account',
+     *   automountServiceAccountToken: false
+     * });
+     * ```
+     *
+     * @since 2.4.0
+     */
+    addServiceAccount(spec: ServiceAccountSpec): ApiObject;
+    /**
+     * Creates a DaemonSet resource
+     * @param spec - DaemonSet specification
+     * @returns Created DaemonSet ApiObject
+     *
+     * @example
+     * ```typescript
+     * coreResources.addDaemonSet({
+     *   name: 'log-collector',
+     *   image: 'fluentd:v1.14',
+     *   containerPort: 24224,
+     *   hostNetwork: true
+     * });
+     * ```
+     *
+     * @since 2.4.0
+     */
+    addDaemonSet(spec: DaemonSetSpec): ApiObject;
+    /**
+     * Builds DaemonSet specification object
+     * @private
+     */
+    private buildDaemonSetSpec;
+    /**
+     * Builds container specification for DaemonSet
+     * @private
+     */
+    private buildDaemonSetContainers;
+    /**
+     * Builds pod specification for DaemonSet
+     * @private
+     */
+    private buildDaemonSetPodSpec;
+    /**
+     * Creates a StatefulSet resource
+     * @param spec - StatefulSet specification
+     * @returns Created StatefulSet ApiObject
+     *
+     * @example
+     * ```typescript
+     * coreResources.addStatefulSet({
+     *   name: 'database',
+     *   image: 'postgres:13',
+     *   replicas: 3,
+     *   containerPort: 5432,
+     *   serviceName: 'database-headless'
+     * });
+     * ```
+     *
+     * @since 2.4.0
+     */
+    addStatefulSet(spec: StatefulSetSpec): ApiObject;
+    /**
+     * Builds StatefulSet specification object
+     * @private
+     */
+    private buildStatefulSetSpec;
+    /**
+     * Builds container specification for StatefulSet
+     * @private
+     */
+    private buildStatefulSetContainers;
+    /**
+     * Builds pod specification for StatefulSet
+     * @private
+     */
+    private buildStatefulSetPodSpec;
+    /**
+     * Creates a Role resource for RBAC
+     * @param spec - Role specification
+     * @returns Created Role ApiObject
+     *
+     * @example
+     * ```typescript
+     * coreResources.addRole({
+     *   name: 'pod-reader',
+     *   rules: [
+     *     {
+     *       apiGroups: [''],
+     *       resources: ['pods'],
+     *       verbs: ['get', 'list', 'watch']
+     *     }
+     *   ]
+     * });
+     * ```
+     *
+     * @since 2.4.0
+     */
+    addRole(spec: RoleSpec): ApiObject;
+    /**
+     * Creates a ClusterRole resource for cluster-wide RBAC
+     * @param spec - ClusterRole specification
+     * @returns Created ClusterRole ApiObject
+     *
+     * @example
+     * ```typescript
+     * coreResources.addClusterRole({
+     *   name: 'cluster-admin',
+     *   rules: [
+     *     {
+     *       apiGroups: ['*'],
+     *       resources: ['*'],
+     *       verbs: ['*']
+     *     }
+     *   ]
+     * });
+     * ```
+     *
+     * @since 2.4.0
+     */
+    addClusterRole(spec: ClusterRoleSpec): ApiObject;
+    /**
+     * Creates a RoleBinding resource for RBAC
+     * @param spec - RoleBinding specification
+     * @returns Created RoleBinding ApiObject
+     *
+     * @example
+     * ```typescript
+     * coreResources.addRoleBinding({
+     *   name: 'pod-reader-binding',
+     *   roleRef: {
+     *     kind: 'Role',
+     *     name: 'pod-reader',
+     *     apiGroup: 'rbac.authorization.k8s.io'
+     *   },
+     *   subjects: [
+     *     {
+     *       kind: 'ServiceAccount',
+     *       name: 'my-service-account',
+     *       namespace: 'default'
+     *     }
+     *   ]
+     * });
+     * ```
+     *
+     * @since 2.4.0
+     */
+    addRoleBinding(spec: RoleBindingSpec): ApiObject;
+    /**
+     * Creates a ClusterRoleBinding resource for cluster-wide RBAC
+     * @param spec - ClusterRoleBinding specification
+     * @returns Created ClusterRoleBinding ApiObject
+     *
+     * @example
+     * ```typescript
+     * coreResources.addClusterRoleBinding({
+     *   name: 'cluster-admin-binding',
+     *   roleRef: {
+     *     kind: 'ClusterRole',
+     *     name: 'cluster-admin',
+     *     apiGroup: 'rbac.authorization.k8s.io'
+     *   },
+     *   subjects: [
+     *     {
+     *       kind: 'ServiceAccount',
+     *       name: 'admin-user',
+     *       namespace: 'kube-system'
+     *     }
+     *   ]
+     * });
+     * ```
+     *
+     * @since 2.4.0
+     */
+    addClusterRoleBinding(spec: ClusterRoleBindingSpec): ApiObject;
+    /**
+     * Creates a Job resource for batch workloads
+     * @param spec - Job specification
+     * @returns Created Job ApiObject
+     *
+     * @example
+     * ```typescript
+     * coreResources.addJob({
+     *   name: 'data-processor',
+     *   image: 'busybox:1.35',
+     *   command: ['sh', '-c', 'echo "Processing data..." && sleep 30'],
+     *   completions: 1,
+     *   parallelism: 1
+     * });
+     * ```
+     *
+     * @since 2.4.0
+     */
+    addJob(spec: JobSpec): ApiObject;
+    /**
+     * Builds Job specification object
+     * @private
+     */
+    private buildJobSpec;
+    /**
+     * Builds container specification for Job
+     * @private
+     */
+    private buildJobContainers;
+    /**
+     * Builds pod specification for Job
+     * @private
+     */
+    private buildJobPodSpec;
+    /**
+     * Creates a ReplicaSet resource
+     * @param spec - ReplicaSet specification
+     * @returns Created ReplicaSet ApiObject
+     *
+     * @example
+     * ```typescript
+     * coreResources.addReplicaSet({
+     *   name: 'web-replica',
+     *   image: 'nginx:1.21',
+     *   replicas: 3,
+     *   containerPort: 80
+     * });
+     * ```
+     *
+     * @since 2.4.0
+     */
+    addReplicaSet(spec: ReplicaSetSpec): ApiObject;
+    /**
+     * Creates a Pod resource
+     * @param spec - Pod specification
+     * @returns Created Pod ApiObject
+     *
+     * @example
+     * ```typescript
+     * coreResources.addPod({
+     *   name: 'web-pod',
+     *   image: 'nginx:1.21',
+     *   containerPort: 80
+     * });
+     * ```
+     *
+     * @since 2.4.0
+     */
+    addPod(spec: PodSpec): ApiObject;
+    /**
+     * Creates a CronJob resource
+     * @param spec - CronJob specification
+     * @returns Created CronJob ApiObject
+     *
+     * @example
+     * ```typescript
+     * coreResources.addCronJob({
+     *   name: 'backup-job',
+     *   schedule: '0 2 * * *',
+     *   image: 'backup:latest',
+     *   command: ['sh', '-c', 'backup-script.sh']
+     * });
+     * ```
+     *
+     * @since 2.4.0
+     */
+    addCronJob(spec: CronJobSpec): ApiObject;
+    /**
+     * Builds CronJob specification object
+     * @private
+     */
+    private buildCronJobSpec;
+    /**
+     * Builds generic container specification
+     * @private
+     */
+    private buildGenericContainers;
+    /**
+     * Builds pod specification for CronJob
+     * @private
+     */
+    private buildCronJobPodSpec;
+}
+export interface DeploymentSpec {
+    name: string;
+    image: string;
+    replicas?: number;
+    containerPort?: number;
+    env?: Array<{
+        name: string;
+        value?: string;
+        valueFrom?: unknown;
+    }>;
+    resources?: {
+        requests?: {
+            cpu?: string;
+            memory?: string;
+        };
+        limits?: {
+            cpu?: string;
+            memory?: string;
+        };
+    };
+    volumeMounts?: Array<{
+        name: string;
+        mountPath: string;
+        readOnly?: boolean;
+    }>;
+    volumes?: Array<unknown>;
+    serviceAccountName?: string;
+    securityContext?: unknown;
+    nodeSelector?: Record<string, string>;
+    tolerations?: Array<unknown>;
+    affinity?: unknown;
+    matchLabels?: Record<string, string>;
+    labels?: Record<string, string>;
+    annotations?: Record<string, string>;
+}
+export interface DaemonSetSpec {
+    name: string;
+    image: string;
+    containerPort?: number;
+    env?: Array<{
+        name: string;
+        value?: string;
+        valueFrom?: unknown;
+    }>;
+    resources?: {
+        requests?: {
+            cpu?: string;
+            memory?: string;
+        };
+        limits?: {
+            cpu?: string;
+            memory?: string;
+        };
+    };
+    volumeMounts?: Array<{
+        name: string;
+        mountPath: string;
+        readOnly?: boolean;
+    }>;
+    volumes?: Array<unknown>;
+    serviceAccountName?: string;
+    securityContext?: unknown;
+    nodeSelector?: Record<string, string>;
+    tolerations?: Array<unknown>;
+    affinity?: unknown;
+    matchLabels?: Record<string, string>;
+    labels?: Record<string, string>;
+    annotations?: Record<string, string>;
+    hostNetwork?: boolean;
+    hostPID?: boolean;
+    dnsPolicy?: string;
+    priorityClassName?: string;
+    updateStrategy?: {
+        type?: 'RollingUpdate' | 'OnDelete';
+        rollingUpdate?: {
+            maxUnavailable?: number | string;
+        };
+    };
+}
+export interface StatefulSetSpec {
+    name: string;
+    image: string;
+    replicas?: number | string;
+    serviceName: string;
+    containerPort?: number;
+    env?: Array<{
+        name: string;
+        value?: string;
+        valueFrom?: unknown;
+    }>;
+    resources?: {
+        requests?: {
+            cpu?: string;
+            memory?: string;
+        };
+        limits?: {
+            cpu?: string;
+            memory?: string;
+        };
+    };
+    volumeMounts?: Array<{
+        name: string;
+        mountPath: string;
+        readOnly?: boolean;
+    }>;
+    volumes?: Array<unknown>;
+    volumeClaimTemplates?: Array<unknown>;
+    serviceAccountName?: string;
+    securityContext?: unknown;
+    nodeSelector?: Record<string, string>;
+    tolerations?: Array<unknown>;
+    affinity?: unknown;
+    matchLabels?: Record<string, string>;
+    labels?: Record<string, string>;
+    annotations?: Record<string, string>;
+    initContainers?: Array<unknown>;
+    livenessProbe?: unknown;
+    readinessProbe?: unknown;
+    terminationGracePeriodSeconds?: number;
+    updateStrategy?: {
+        type?: 'RollingUpdate' | 'OnDelete';
+        rollingUpdate?: {
+            partition?: number;
+            maxUnavailable?: number | string;
+        };
+    };
+    podManagementPolicy?: 'OrderedReady' | 'Parallel';
+    revisionHistoryLimit?: number;
+}
+export interface RoleSpec {
+    name: string;
+    namespace?: string;
+    rules: Array<{
+        apiGroups?: string[];
+        resources?: string[];
+        resourceNames?: string[];
+        verbs: string[];
+        nonResourceURLs?: string[];
+    }>;
+    labels?: Record<string, string>;
+    annotations?: Record<string, string>;
+}
+export interface ClusterRoleSpec {
+    name: string;
+    rules: Array<{
+        apiGroups?: string[];
+        resources?: string[];
+        resourceNames?: string[];
+        verbs: string[];
+        nonResourceURLs?: string[];
+    }>;
+    labels?: Record<string, string>;
+    annotations?: Record<string, string>;
+}
+export interface RoleBindingSpec {
+    name: string;
+    namespace?: string;
+    roleRef: {
+        kind: 'Role' | 'ClusterRole';
+        name: string;
+        apiGroup: string;
+    };
+    subjects: Array<{
+        kind: 'User' | 'Group' | 'ServiceAccount';
+        name: string;
+        namespace?: string;
+        apiGroup?: string;
+    }>;
+    labels?: Record<string, string>;
+    annotations?: Record<string, string>;
+}
+export interface ClusterRoleBindingSpec {
+    name: string;
+    roleRef: {
+        kind: 'Role' | 'ClusterRole';
+        name: string;
+        apiGroup: string;
+    };
+    subjects: Array<{
+        kind: 'User' | 'Group' | 'ServiceAccount';
+        name: string;
+        namespace?: string;
+        apiGroup?: string;
+    }>;
+    labels?: Record<string, string>;
+    annotations?: Record<string, string>;
+}
+export interface JobSpec {
+    name: string;
+    image: string;
+    command?: string[];
+    args?: string[];
+    completions?: number;
+    parallelism?: number;
+    backoffLimit?: number;
+    activeDeadlineSeconds?: number;
+    ttlSecondsAfterFinished?: number;
+    completionMode?: 'NonIndexed' | 'Indexed';
+    suspend?: boolean;
+    restartPolicy?: 'Never' | 'OnFailure';
+    env?: Array<{
+        name: string;
+        value?: string;
+        valueFrom?: unknown;
+    }>;
+    resources?: {
+        requests?: {
+            cpu?: string;
+            memory?: string;
+        };
+        limits?: {
+            cpu?: string;
+            memory?: string;
+        };
+    };
+    volumeMounts?: Array<{
+        name: string;
+        mountPath: string;
+        readOnly?: boolean;
+    }>;
+    volumes?: Array<unknown>;
+    serviceAccountName?: string;
+    securityContext?: unknown;
+    nodeSelector?: Record<string, string>;
+    tolerations?: Array<unknown>;
+    affinity?: unknown;
+    matchLabels?: Record<string, string>;
+    labels?: Record<string, string>;
+    annotations?: Record<string, string>;
+    initContainers?: Array<unknown>;
+}
+export interface ServiceSpec {
+    name: string;
+    port: number;
+    targetPort?: number;
+    ports?: Array<{
+        port: number;
+        targetPort?: number;
+        protocol?: string;
+        name?: string;
+    }>;
+    type?: 'ClusterIP' | 'NodePort' | 'LoadBalancer' | 'ExternalName';
+    selector?: Record<string, string>;
+    clusterIP?: string;
+    externalIPs?: string[];
+    loadBalancerIP?: string;
+    sessionAffinity?: string;
+    protocol?: string;
+    labels?: Record<string, string>;
+    annotations?: Record<string, string>;
+}
+export interface ConfigMapSpec {
+    name: string;
+    data?: Record<string, string>;
+    binaryData?: Record<string, string>;
+    labels?: Record<string, string>;
+    annotations?: Record<string, string>;
+}
+export interface SecretSpec {
+    name: string;
+    type?: string;
+    data?: Record<string, string>;
+    stringData?: Record<string, string>;
+    labels?: Record<string, string>;
+    annotations?: Record<string, string>;
+}
+export interface ServiceAccountSpec {
+    name: string;
+    automountServiceAccountToken?: boolean;
+    imagePullSecrets?: Array<{
+        name: string;
+    }>;
+    secrets?: Array<{
+        name: string;
+    }>;
+    labels?: Record<string, string>;
+    annotations?: Record<string, string>;
+}
+export interface ReplicaSetSpec {
+    name: string;
+    image: string;
+    replicas?: number;
+    containerPort?: number;
+    env?: Array<{
+        name: string;
+        value?: string;
+        valueFrom?: unknown;
+    }>;
+    resources?: {
+        requests?: {
+            cpu?: string;
+            memory?: string;
+        };
+        limits?: {
+            cpu?: string;
+            memory?: string;
+        };
+    };
+    volumeMounts?: Array<{
+        name: string;
+        mountPath: string;
+        readOnly?: boolean;
+    }>;
+    volumes?: Array<unknown>;
+    serviceAccountName?: string;
+    securityContext?: unknown;
+    nodeSelector?: Record<string, string>;
+    tolerations?: Array<unknown>;
+    affinity?: unknown;
+    matchLabels?: Record<string, string>;
+    labels?: Record<string, string>;
+    annotations?: Record<string, string>;
+}
+export interface PodSpec {
+    name: string;
+    image: string;
+    containerPort?: number;
+    restartPolicy?: 'Always' | 'OnFailure' | 'Never';
+    env?: Array<{
+        name: string;
+        value?: string;
+        valueFrom?: unknown;
+    }>;
+    resources?: {
+        requests?: {
+            cpu?: string;
+            memory?: string;
+        };
+        limits?: {
+            cpu?: string;
+            memory?: string;
+        };
+    };
+    volumeMounts?: Array<{
+        name: string;
+        mountPath: string;
+        readOnly?: boolean;
+    }>;
+    volumes?: Array<unknown>;
+    serviceAccountName?: string;
+    securityContext?: unknown;
+    nodeSelector?: Record<string, string>;
+    tolerations?: Array<unknown>;
+    affinity?: unknown;
+    initContainers?: Array<unknown>;
+    labels?: Record<string, string>;
+    annotations?: Record<string, string>;
+}
+export interface CronJobSpec {
+    name: string;
+    schedule: string;
+    image: string;
+    command?: string[];
+    args?: string[];
+    restartPolicy?: 'OnFailure' | 'Never';
+    concurrencyPolicy?: 'Allow' | 'Forbid' | 'Replace';
+    suspend?: boolean;
+    successfulJobsHistoryLimit?: number;
+    failedJobsHistoryLimit?: number;
+    startingDeadlineSeconds?: number;
+    backoffLimit?: number;
+    activeDeadlineSeconds?: number;
+    env?: Array<{
+        name: string;
+        value?: string;
+        valueFrom?: unknown;
+    }>;
+    resources?: {
+        requests?: {
+            cpu?: string;
+            memory?: string;
+        };
+        limits?: {
+            cpu?: string;
+            memory?: string;
+        };
+    };
+    volumeMounts?: Array<{
+        name: string;
+        mountPath: string;
+        readOnly?: boolean;
+    }>;
+    volumes?: Array<unknown>;
+    serviceAccountName?: string;
+    securityContext?: unknown;
+    nodeSelector?: Record<string, string>;
+    tolerations?: Array<unknown>;
+    affinity?: unknown;
+    matchLabels?: Record<string, string>;
+    labels?: Record<string, string>;
+    annotations?: Record<string, string>;
+}
+//# sourceMappingURL=coreResources.d.ts.map