@alauda-fe/workload-util-shared 0.0.1

package/lib/typings/backend-api.d.ts

@@ -0,0 +1,220 @@
+import { K8sResourceAction, KubernetesResource, DaemonSet, Deployment, StatefulSet, WorkloadStatusEnum } from '@alauda-fe/common';
+import { OamAppOriginalStatusEnum } from './status';
+export type Workload = Deployment | StatefulSet | DaemonSet;
+export declare enum WorkloadKind {
+    Deployment = "Deployment",
+    StatefulSet = "StatefulSet",
+    DaemonSet = "DaemonSet"
+}
+export interface K8sResourceWithActions<T extends KubernetesResource = KubernetesResource> {
+    kubernetes: T;
+    resource_actions?: string[];
+}
+/**
+ * application address
+ * refers to: http://confluence.alaudatech.com/pages/viewpage.action?pageId=44663323#id-%E6%96%B0%E5%BA%94%E7%94%A8API-1.1.6GET/acp/v1/kubernetes/%3Ccluster_name%3E/namespaces/%3Cnamespace%3E/applications/%3Cname%3E/address
+ */
+export interface ApplicationAddress {
+    workloads?: {
+        [key: string]: {
+            [key: string]: WorkloadAddress[];
+        };
+    };
+}
+export interface WorkloadAddress {
+    name?: string;
+    protocol?: string;
+    host?: string;
+    frontend?: number;
+    port?: number;
+    url?: string;
+}
+export interface AlbRules extends KubernetesResource {
+    spec: AlbRulesSpec;
+}
+export interface AlbRulesSpec {
+    address: string;
+    rules: AlbRule[];
+}
+export interface AlbRule {
+    name: string;
+    namespace: string;
+    url?: string;
+    port: number;
+    protocol: string;
+}
+/**
+ * API resource types
+ * refers to: http://confluence.alaudatech.com/pages/viewpage.action?pageId=44663323#id-%E6%96%B0%E5%BA%94%E7%94%A8API-1.2.0GET/acp/v1/resources/{cluster}/resourcetypes
+ */
+export interface APIResource {
+    kind: string;
+    name: string;
+    singularName?: string;
+    shortNames?: string[];
+    namespaced: boolean;
+    verbs: K8sResourceAction[];
+    groupVersion?: string;
+}
+export interface APIResourceList {
+    kind: 'APIResourceList';
+    apiVersion?: string;
+    groupVersion: string;
+    resources: APIResource[];
+}
+export interface Workloads {
+    Deployment?: Deployment[];
+    DaemonSet?: DaemonSet[];
+    StatefulSet?: StatefulSet[];
+}
+/**
+ * Container Log
+ * refers to: http://confluence.alaudatech.com/pages/viewpage.action?pageId=44663323#id-%E6%96%B0%E5%BA%94%E7%94%A8API-1.2.1GET/acp/v1/kubernetes/{cluster}/namespace/{namespace}/pods/{podName}/{containerName}/log
+ */
+export interface ContainerLogParams {
+    previous?: string;
+    logFilePosition?: string;
+    referenceTimestamp?: string;
+    referenceLineNum?: string;
+    offsetFrom?: string;
+    offsetTo?: string;
+}
+export interface LogInfo {
+    podName: string;
+    containerName: string;
+    initContainerName: string;
+    fromDate: string;
+    toDate: string;
+    truncated: boolean;
+}
+export interface LogLine {
+    timestamp: string;
+    content: string;
+}
+export interface LogSelection {
+    logFilePosition: string;
+    referencePoint: LogLineReference;
+    offsetFrom: number;
+    offsetTo: number;
+}
+export interface LogLineReference {
+    timestamp: string;
+    lineNum: number;
+}
+export interface ContainerLog {
+    info: LogInfo;
+    logs: LogLine[];
+    selection: LogSelection;
+}
+export interface Certificate {
+    name: string;
+    namespace: string;
+    notBefore: string;
+    notAfter: string;
+    dnsNames: string[];
+    valid: boolean;
+    reasonCode?: 1 | 2 | 3;
+}
+/**
+ * 应用拓扑api 文档：https://confluence.alauda.cn/pages/viewpage.action?pageId=115527477
+ */
+export interface TopologyEdge {
+    type: string;
+    from?: string;
+    to?: string;
+}
+export interface TopologyResponse {
+    nodes: {
+        [key: string]: KubernetesResource;
+    };
+    edges: TopologyEdge[];
+}
+export interface AppTopologyApplication {
+    kind: string;
+    name: string;
+    uuid: string;
+    state: string;
+    edges?: TopologyEdge[];
+}
+export interface AppBaseTopology {
+    workloads?: Record<string, Record<string, AppTopologyWorkloadNode>>;
+    services?: Record<string, AppTopologyNode>;
+    configmaps?: Record<string, AppTopologyNode>;
+    secrets?: Record<string, AppTopologyNode>;
+    pvcs?: Record<string, AppTopologyNode>;
+    albs?: Record<string, AppTopologyNode>;
+    ingresses?: Record<string, AppTopologyNode>;
+    startstopscalertraits?: Record<string, AppTopologyNode>;
+    statistics?: {
+        wcounts: number;
+        wlimit: number;
+    };
+}
+export interface AppTopology extends AppBaseTopology {
+    application?: AppTopologyApplication;
+    others?: Record<string, AppTopologyNode>;
+}
+export interface ArgocdApplicationSetTopology {
+    applicationSet: AppTopologyNode;
+    applications: Record<string, AppTopologyNode>;
+}
+export interface ArgocdApplicationTopology {
+    application: AppTopologyNode;
+    applications: Record<string, AppTopologyNode>;
+    oamapps: Record<string, AppTopologyNode>;
+}
+export interface AppTopologyNode {
+    uid: string;
+    name: string;
+    namespace?: string;
+    cluster?: string;
+    apiVersion?: string;
+    kind: string;
+    displayName?: string;
+    edges?: TopologyEdge[];
+    component?: string;
+    originalResource?: KubernetesResource;
+    state?: string;
+    syncStatus?: string;
+    restricted?: boolean;
+}
+export interface AppTopologyPodNode extends AppTopologyNode {
+    current: number;
+    desired: number;
+    state: WorkloadStatusEnum;
+    podIP: string;
+}
+export interface AppTopologyWorkloadNode extends AppTopologyNode {
+    current: number;
+    desired: number;
+    state: WorkloadStatusEnum;
+    pods: AppTopologyPodNode[];
+}
+export interface AppTopologyComponentNode extends AppTopologyNode {
+    current: number;
+    desired: number;
+    state: WorkloadStatusEnum;
+    pods: AppTopologyPodNode[];
+}
+export interface AppTopologyExtraResourceNode extends AppTopologyNode {
+    namespace: string;
+    apiVersion: string;
+}
+export interface OamAppTopology extends AppTopology {
+    components?: OamAppTopologyComponentNode[];
+    startstopscalertraits?: Record<string, AppTopologyNode>;
+}
+export interface OamAppTopologyComponentNode extends AppTopologyNode {
+    state: OamAppOriginalStatusEnum;
+    type: string;
+}
+export interface OamAppTopologyTraitNode extends AppTopologyNode {
+    state: WorkloadStatusEnum;
+    component: string;
+}
+export type Pagination<T, O = {
+    [key: string]: unknown;
+}> = {
+    total: number;
+    items: T[];
+} & O;

package/lib/typings/batch-action.type.d.ts

@@ -0,0 +1,35 @@
+import { KubernetesResource } from '@alauda-fe/common';
+export interface BatchActionResource<Phase extends string = string, ResultState extends string = string> extends KubernetesResource {
+    spec: {
+        actions: Array<{
+            name: string;
+            verb: 'put' | 'patch' | 'delete' | 'post';
+            target: {
+                names: string[];
+                resource: {
+                    group: string;
+                    version: string;
+                    resource: string;
+                    subresource?: string;
+                };
+            };
+            body?: string;
+        }>;
+    };
+    status?: {
+        phase: Phase;
+        completionTime?: string;
+        startTime?: string;
+        expiredTime?: string;
+        cancelledTime?: string;
+        actionResults?: Array<{
+            name: string;
+            results: {
+                [name: string]: {
+                    state: ResultState;
+                    reason?: string;
+                };
+            };
+        }>;
+    };
+}

package/lib/typings/form.d.ts

@@ -0,0 +1,10 @@
+export interface ResourceLimit {
+    cpu: {
+        value: number;
+        unit: 'core' | 'm';
+    };
+    memory: {
+        value: number;
+        unit: 'Gi' | 'Mi';
+    };
+}

package/lib/typings/helpers.d.ts

@@ -0,0 +1,45 @@
+import { Secret, ResourceListParams, Environments as _Environments, TranslateKey, Workspace } from '@alauda-fe/common';
+import { ResourceQuotaItem } from './k8s';
+export interface WorkspaceDetailParams extends Workspace {
+    name?: string;
+}
+export interface WorkspaceListParams extends Workspace, ResourceListParams {
+}
+export interface AdminBaseParams {
+    cluster?: string;
+    namespace?: string;
+}
+export interface AdminDetailParams extends AdminBaseParams {
+    name?: string;
+}
+export interface AdminListParams extends AdminBaseParams, ResourceListParams {
+}
+export type Environments = _Environments;
+/**
+ * Console related status.
+ *
+ * All feature related status should be mapped into one of the categories
+ */
+export declare enum UnifiedStatus {
+    SUCCESS = "SUCCESS",
+    ERROR = "ERROR",
+    PENDING = "PENDING",
+    IN_PROGRESS = "IN_PROGRESS",
+    INACTIVE = "INACTIVE"
+}
+export interface SecretsGroup {
+    global: Secret[];
+    namespace: Secret[];
+}
+export interface ExecInfo {
+    user: string;
+    command: string;
+}
+export interface ResourceQuotaDefinition {
+    key: keyof ResourceQuotaItem;
+    fallbackKey?: keyof ResourceQuotaItem;
+    name: TranslateKey;
+    unit: string;
+    description?: TranslateKey;
+    normalizer?: (value: string) => string;
+}

package/lib/typings/index.d.ts

@@ -0,0 +1,9 @@
+export * from './account';
+export * from './backend-api';
+export * from './batch-action.type';
+export * from './form';
+export * from './helpers';
+export * from './k8s';
+export * from './k8s-form-model';
+export * from './k8s-resource-definitions';
+export * from './status';

package/lib/typings/k8s-form-model.d.ts

@@ -0,0 +1,128 @@
+import { KubernetesResource, LabelSelector, ObjectMeta, StringMap, Container, DaemonSetSpec, DaemonSetUpdateStrategy, DeploymentSpec, DeploymentStrategy, JobSpec, Probe, Service, StatefulSetSpec, StatefulSetUpdateStrategy, IngressRule, LocalObjectReference, PodAffinityTerm, PodSpecAffinity, WeightedPodAffinityTerm, IngressBackend } from '@alauda-fe/common';
+import { ClusterNetworkType } from '@alauda-fe/network';
+import { Workload, WorkloadKind, Workloads } from './backend-api';
+export declare const LOG_PATH_KEY = "__FILE_LOG_PATH__";
+export declare const EXCLUDE_LOG_PATH_KEY = "__EXCLUDE_LOG_PATH__";
+export interface ContainerProbes {
+    livenessProbe?: Probe;
+    readinessProbe?: Probe;
+}
+export interface WorkloadOption {
+    kind: WorkloadKind;
+    name: string;
+}
+export interface ApplicationFormModel<T extends KubernetesResource = KubernetesResource> extends KubernetesResource {
+    spec?: {
+        selector?: LabelSelector;
+        componentTemplates: T[];
+    };
+}
+export interface PodControllerFormModel extends KubernetesResource {
+    suffixName?: string;
+    spec?: DeploymentSpec | StatefulSetSpec | DaemonSetSpec;
+}
+export interface PodTemplateSpecFormModel {
+    network?: PodNetworkFormModel;
+    metadata: ObjectMeta;
+    spec: PodSpecFormModel;
+}
+export interface PodSpecFormModel {
+    initContainers?: ContainerFormModel[];
+    containers?: ContainerFormModel[];
+    hostNetwork?: boolean;
+    nodeSelector?: StringMap;
+    affinity?: PodSpecAffinity;
+    imagePullSecrets?: LocalObjectReference[];
+    terminationGracePeriodSeconds?: number;
+    runtimeClassName?: string;
+}
+export interface PodNetworkFormModel {
+    fixIp?: string[];
+    networkType?: ClusterNetworkType;
+    subnet?: string;
+    ingressRate?: number | string;
+    egressRate?: number | string;
+}
+export interface ContainerFormModel extends Container {
+    probes?: {
+        livenessProbe?: Probe;
+        readinessProbe?: Probe;
+    };
+    logPaths?: string[];
+    excludeLogPaths?: string[];
+}
+export interface PodAffinityFormModel {
+    type: string;
+    weight: number;
+    topologyKey: string;
+    labelSelector: LabelSelector;
+}
+export type AffinityTerm = WeightedPodAffinityTerm | PodAffinityTerm;
+export declare const PodAffinityType: {
+    readonly required: "requiredDuringSchedulingIgnoredDuringExecution";
+    readonly preferred: "preferredDuringSchedulingIgnoredDuringExecution";
+};
+export interface ResourceRequirementsFormModel {
+    limits?: {
+        cpu?: {
+            value: string;
+            unit: string;
+        };
+        memory?: {
+            value: string;
+            unit: string;
+        };
+    };
+    requests?: {
+        cpu?: {
+            value: string;
+            unit: string;
+        };
+        memory?: {
+            value: string;
+            unit: string;
+        };
+    };
+    customResource?: {
+        limits: {
+            [key: string]: string;
+        };
+        requests: {
+            [key: string]: string;
+        };
+    };
+}
+export type StrategyFormModel = DeploymentStrategy | DaemonSetUpdateStrategy | StatefulSetUpdateStrategy;
+export interface ServiceFormModel {
+    service: Service;
+    workload?: Workload;
+    targetComponents?: 'workload' | 'virtualization' | 'label-selectors';
+    workloadType?: keyof Workloads;
+    workloadName?: string;
+    virtualizationType?: 'VirtualMachine' | 'VirtualMachinePool';
+    virtualizationName?: string;
+    _selector?: StringMap;
+    annotations?: StringMap;
+}
+export declare enum PodNetworkTypeEnum {
+    host = "Host",
+    cluster = "Cluster"
+}
+export interface IngressRuleFormModel extends IngressRule {
+    protocol?: string;
+    secretName?: string;
+    domain?: string;
+    subDomain?: string;
+}
+export interface IngressSpecFormModel {
+    ingressClassName?: string;
+    backend?: IngressBackend;
+    rules?: IngressRuleFormModel[];
+}
+export interface IngressFormModel extends KubernetesResource {
+    spec?: IngressSpecFormModel;
+}
+export interface JobSpecFormModel extends JobSpec {
+    jobType?: string;
+    startingDeadlineSeconds?: number | '';
+}

package/lib/typings/k8s-resource-definitions/acp-resource-definition.d.ts

@@ -0,0 +1,242 @@
+export declare const OAM_GROUP = "core.oam.dev";
+export declare const GATEWAY_NETWORKING_GROUP = "gateway.networking.k8s.io";
+export declare const ACPResourceDefinitions: {
+    readonly VERTICAL_POD_AUTOSCALER: {
+        readonly apiGroup: "autoscaling.k8s.io";
+        readonly apiVersion: "v1";
+        readonly type: "VerticalPodAutoscaler";
+    };
+    readonly POD_AUTOSCALER: {
+        readonly apiGroup: "autoscaling.k8s.io";
+        readonly apiVersion: "v1";
+        readonly type: "PodAutoscaler";
+    };
+    readonly ROUTE: {
+        readonly type: "routes";
+        readonly apiGroup: "route.openshift.io";
+    };
+    readonly ADDON: {
+        readonly apiGroup: "platform.tkestack.io";
+        readonly type: "addons";
+    };
+    readonly INSTALLPLAN: {
+        readonly apiGroup: "operators.coreos.com";
+        readonly apiVersion: "v1alpha1";
+        readonly type: "installplans";
+    };
+    readonly CEPH_CLUSTER: {
+        readonly apiGroup: "ceph.rook.io";
+        readonly apiVersion: "v1";
+        readonly type: "cephclusters";
+    };
+    readonly CEPH_FILE_SYSTEM: {
+        readonly apiGroup: "ceph.rook.io";
+        readonly apiVersion: "v1";
+        readonly type: "cephfilesystems";
+    };
+    readonly ARTIFACT: {
+        readonly apiGroup: "meta.katanomi.dev";
+        readonly apiVersion: "v1alpha1";
+        readonly type: "artifacts";
+    };
+    readonly TDSQL_INSTANCE: {
+        readonly type: "instances";
+        readonly apiVersion: "v1alpha1";
+        readonly apiGroup: "tdsql.alauda.io";
+    };
+    readonly TDSQL_INSTANCE_BINDING: {
+        readonly type: "instancebindings";
+        readonly apiVersion: "v1alpha1";
+        readonly apiGroup: "tdsql.alauda.io";
+    };
+    readonly TDSQL_ACCOUNTS: {
+        readonly type: "accounts";
+        readonly apiVersion: "v1alpha1";
+        readonly apiGroup: "tdsql.alauda.io";
+    };
+    readonly TDSQL_INSTANCE_SET: {
+        readonly type: "requests";
+        readonly apiVersion: "v1alpha1";
+        readonly apiGroup: "tdsql.alauda.io";
+    };
+    readonly CEPH_BLOCK_POOL: {
+        readonly apiGroup: "ceph.rook.io";
+        readonly type: "cephblockpools";
+    };
+    readonly CSI_DRIVER: {
+        readonly apiGroup: "storage.k8s.io";
+        readonly type: "csidrivers";
+    };
+    readonly EPHEMERAL_CONTAINERS: {
+        readonly type: "ephemeralcontainers";
+    };
+    readonly APP_CONFIG: {
+        readonly apiGroup: "asm.alauda.io";
+        readonly apiVersion: "v1alpha1";
+        readonly type: "appconfigs";
+    };
+    readonly CEPH_OBJECT_STORE: {
+        readonly apiGroup: "ceph.rook.io";
+        readonly type: "cephobjectstores";
+    };
+    readonly TOPOLVM_CLUSTER: {
+        readonly type: "topolvmclusters";
+        readonly apiGroup: "topolvm.cybozu.com";
+        readonly apiVersion: "v1";
+    };
+    readonly VLAN: {
+        readonly type: "vlans";
+        readonly apiGroup: "kubeovn.io";
+    };
+    readonly PROVIDER_NETWORK: {
+        readonly type: "provider-networks";
+        readonly apiGroup: "kubeovn.io";
+    };
+    readonly PRODUCT_UPGRADE: {
+        readonly type: "productupgrades";
+        readonly apiGroup: "product.alauda.io";
+        readonly apiVersion: "v1alpha1";
+    };
+    readonly INGRESS_CLASS: {
+        readonly apiGroup: "networking.k8s.io";
+        readonly type: "ingressclasses";
+    };
+    readonly INGRESS_V1BEAT1: {
+        readonly apiGroup: "networking.k8s.io";
+        readonly type: "ingresses";
+        readonly apiVersion: "v1beta1";
+    };
+    readonly NAMESPACE_AUDIT: {
+        readonly apiGroup: "aiops.alauda.io";
+        readonly type: "namespaceaudits";
+    };
+    readonly OAM_APP_STATUS: {
+        readonly apiGroup: "oam.alauda.io";
+        readonly apiVersion: "v1alpha1";
+        readonly type: "appstatuses";
+    };
+    readonly OAM_COMPONENT_DEFINITION: {
+        readonly apiGroup: "core.oam.dev";
+        readonly apiVersion: "v1beta1";
+        readonly type: "componentdefinitions";
+    };
+    readonly OAM_TRAIT_DEFINITION: {
+        readonly apiGroup: "core.oam.dev";
+        readonly apiVersion: "v1beta1";
+        readonly type: "traitdefinitions";
+    };
+    readonly OAM_APP_REVISION: {
+        readonly apiGroup: "core.oam.dev";
+        readonly apiVersion: "v1beta1";
+        readonly type: "applicationrevisions";
+    };
+    readonly ALAUDA_BUCKET_REQUEST: {
+        readonly apiGroup: "cosi.alauda.io";
+        readonly apiVersion: "v1alpha1";
+        readonly type: "alaudabucketrequests";
+    };
+    readonly BUCKET_ACCESS_CLASS: {
+        readonly apiGroup: "objectstorage.k8s.io";
+        readonly apiVersion: "v1alpha1";
+        readonly type: "bucketaccessclasses";
+    };
+    readonly BUCKET_ACCESS_REQUEST: {
+        readonly apiGroup: "objectstorage.k8s.io";
+        readonly apiVersion: "v1alpha1";
+        readonly type: "bucketaccessrequests";
+    };
+    readonly GATEWAY_CLASS: {
+        readonly apiGroup: "gateway.networking.k8s.io";
+        readonly apiVersion: "v1beta1";
+        readonly type: "gatewayclasses";
+    };
+    readonly GATEWAY: {
+        readonly apiGroup: "gateway.networking.k8s.io";
+        readonly apiVersion: "v1beta1";
+        readonly type: "gateways";
+    };
+    readonly HTTP_ROUTE: {
+        readonly apiGroup: "gateway.networking.k8s.io";
+        readonly apiVersion: "v1beta1";
+        readonly type: "httproutes";
+    };
+    readonly TCP_ROUTE: {
+        readonly apiGroup: "gateway.networking.k8s.io";
+        readonly apiVersion: "v1alpha2";
+        readonly type: "tcproutes";
+    };
+    readonly UDP_ROUTE: {
+        readonly apiGroup: "gateway.networking.k8s.io";
+        readonly apiVersion: "v1alpha2";
+        readonly type: "udproutes";
+    };
+    readonly ALAUDA_ARTIFACT: {
+        readonly apiGroup: "app.alauda.io";
+        readonly apiVersion: "v1alpha1";
+        readonly type: "artifacts";
+    };
+    readonly ALAUDA_ARTIFACT_VERSION: {
+        readonly apiGroup: "app.alauda.io";
+        readonly apiVersion: "v1alpha1";
+        readonly type: "artifactversions";
+    };
+    readonly ARTIFACT_UPLOAD_PROCESSOR: {
+        readonly apiGroup: "app.alauda.io";
+        readonly apiVersion: "v1";
+        readonly type: "artifactuploadprocessors";
+    };
+    readonly GIT_COMMIT: {
+        readonly apiGroup: "gitops.app.alauda.io";
+        readonly apiVersion: "v1alpha1";
+        readonly type: "applications/commit";
+    };
+    readonly GITOPS_IGNORE_DIFFERENCE: {
+        readonly apiGroup: "gitops.app.alauda.io";
+        readonly apiVersion: "v1alpha1";
+        readonly type: "gitopsignoredifferences";
+    };
+    readonly GATEKEEPER_CONSTRAINTS: {
+        readonly apiGroup: "gatekeeper.alauda.io";
+        readonly apiVersion: "v1alpha1";
+        readonly type: "constraints";
+    };
+    readonly ARTIFACT_APP: {
+        readonly apiGroup: "app.alauda.io";
+        readonly type: "artifacts";
+        readonly apiVersion: "v1alpha1";
+    };
+    readonly ARTIFACT_VERSION: {
+        readonly apiGroup: "app.alauda.io";
+        readonly type: "artifactversions";
+        readonly apiVersion: "v1alpha1";
+    };
+    readonly APP_PACKAGE_MANIFEST: {
+        readonly apiGroup: "app.alauda.io";
+        readonly type: "packagemanifests";
+        readonly apiVersion: "v1alpha1";
+    };
+    readonly MINIO_PEER: {
+        readonly apiGroup: "minio.min.io";
+        readonly apiVersion: "v1alpha1";
+        readonly type: "miniopeers";
+    };
+    readonly GITOPS_APPLICATIONS: {
+        readonly apiGroup: "gitops.app.alauda.io";
+        readonly type: "applications";
+    };
+    readonly GIT_BUILD: {
+        readonly apiGroup: "build.alauda.io";
+        readonly apiVersion: "v1alpha1";
+        readonly type: "builds";
+    };
+    readonly GIT_BUILD_RUN: {
+        readonly apiGroup: "build.alauda.io";
+        readonly apiVersion: "v1alpha1";
+        readonly type: "buildruns";
+    };
+    readonly GIT_BUILDER_IMAGE_CATEGORY: {
+        readonly apiGroup: "build.alauda.io";
+        readonly apiVersion: "v1alpha1";
+        readonly type: "builderimagecategories";
+    };
+};