Show lens-metrics on cluster settings (#2714)

* show lens-metrics on cluster settings Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * remove ClusterFeature Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * remove ClusterFeature Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * tweak resource applier/stack Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * update metrics stack components Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * fix Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * fix drawer menu styles Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * cleanup Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * cleanup Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * clarify ui Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * built-in -> bundled Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * splitterError -> splitError Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * support multi-doc yamls Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * dedicated action button Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * fix headers Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * cleanup Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * async file operations Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * cleanup Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * fix bugs Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>
2025-05-20 05:10:56 +00:00 · 2021-05-18 16:12:45 +03:00
1 parent d9c6e5c52f
commit 683e5926e0
@@ -1,156 +0,0 @@
-/**
- * Copyright (c) 2021 OpenLens Authors
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of
- * this software and associated documentation files (the "Software"), to deal in
- * the Software without restriction, including without limitation the rights to
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
- * the Software, and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
-
-import fs from "fs";
-import path from "path";
-import hb from "handlebars";
-import { observable } from "mobx";
-import { ResourceApplier } from "../main/resource-applier";
-import { KubernetesCluster } from "./core-api/catalog";
-import logger from "../main/logger";
-import { app } from "electron";
-import { requestMain } from "../common/ipc";
-import { clusterKubectlApplyAllHandler } from "../common/cluster-ipc";
-import { ClusterStore } from "../common/cluster-store";
-
-export interface ClusterFeatureStatus {
-  /** feature's current version, as set by the implementation */
-  currentVersion: string;
-  /** feature's latest version, as set by the implementation */
-  latestVersion: string;
-  /** whether the feature is installed or not, as set by the implementation */
-  installed: boolean;
-  /** whether the feature can be upgraded or not, as set by the implementation */
-  canUpgrade: boolean;
-}
-
-export abstract class ClusterFeature {
-
-  /**
-   * this field sets the template parameters that are to be applied to any templated kubernetes resources that are to be installed for the feature.
-   * See the renderTemplates() method for more details
-   */
-  templateContext: any;
-
-  /**
-   * this field holds the current feature status, is accessed directly by Lens
-   */
-  @observable status: ClusterFeatureStatus = {
-    currentVersion: null,
-    installed: false,
-    latestVersion: null,
-    canUpgrade: false
-  };
-
-  /**
-   * to be implemented in the derived class, this method is typically called by Lens when a user has indicated that this feature is to be installed. The implementation
-   * of this method should install kubernetes resources using the applyResources() method, or by directly accessing the kubernetes api (K8sApi)
-   *
-   * @param cluster the cluster that the feature is to be installed on
-   */
-  abstract install(cluster: KubernetesCluster): Promise<void>;
-
-  /**
-   * to be implemented in the derived class, this method is typically called by Lens when a user has indicated that this feature is to be upgraded. The implementation
-   * of this method should upgrade the kubernetes resources already installed, if relevant to the feature
-   *
-   * @param cluster the cluster that the feature is to be upgraded on
-   */
-  abstract upgrade(cluster: KubernetesCluster): Promise<void>;
-
-  /**
-   * to be implemented in the derived class, this method is typically called by Lens when a user has indicated that this feature is to be uninstalled. The implementation
-   * of this method should uninstall kubernetes resources using the kubernetes api (K8sApi)
-   *
-   * @param cluster the cluster that the feature is to be uninstalled from
-   */
-  abstract uninstall(cluster: KubernetesCluster): Promise<void>;
-
-  /**
-   * to be implemented in the derived class, this method is called periodically by Lens to determine details about the feature's current status. The implementation
-   * of this method should provide the current status information. The currentVersion and latestVersion fields may be displayed by Lens in describing the feature.
-   * The installed field should be set to true if the feature has been installed, otherwise false. Also, Lens relies on the canUpgrade field to determine if the feature
-   * can be upgraded so the implementation should set the canUpgrade field according to specific rules for the feature, if relevant.
-   *
-   * @param cluster the cluster that the feature may be installed on
-   *
-   * @return a promise, resolved with the updated ClusterFeatureStatus
-   */
-  abstract updateStatus(cluster: KubernetesCluster): Promise<ClusterFeatureStatus>;
-
-  /**
-   * this is a helper method that conveniently applies kubernetes resources to the cluster.
-   *
-   * @param cluster the cluster that the resources are to be applied to
-   * @param resourceSpec as a string type this is a folder path that is searched for files specifying kubernetes resources. The files are read and if any of the resource
-   * files are templated, the template parameters are filled using the templateContext field (See renderTemplate() method). Finally the resources are applied to the
-   * cluster. As a string[] type resourceSpec is treated as an array of fully formed (not templated) kubernetes resources that are applied to the cluster
-   */
-  protected async applyResources(cluster: KubernetesCluster, resourceSpec: string | string[]) {
-    let resources: string[];
-
-    const clusterModel = ClusterStore.getInstance().getById(cluster.metadata.uid);
-
-    if (!clusterModel) {
-      throw new Error(`cluster not found`);
-    }
-
-    if ( typeof resourceSpec === "string" ) {
-      resources = this.renderTemplates(resourceSpec);
-    } else {
-      resources = resourceSpec;
-    }
-
-    if (app) {
-      await new ResourceApplier(clusterModel).kubectlApplyAll(resources);
-    } else {
-      await requestMain(clusterKubectlApplyAllHandler, cluster.metadata.uid, resources);
-    }
-  }
-
-  /**
-   * this is a helper method that conveniently reads kubernetes resource files into a string array. It also fills templated resource files with the template parameter values
-   * specified by the templateContext field. Templated files must end with the extension '.hb' and the template syntax must be compatible with handlebars.js
-   *
-   * @param folderPath this is a folder path that is searched for files defining kubernetes resources.
-   *
-   * @return an array of strings, each string being the contents of a resource file found in the folder path. This can be passed directly to applyResources()
-   */
-  protected renderTemplates(folderPath: string): string[] {
-    const resources: string[] = [];
-
-    logger.info(`[FEATURE]: render templates from ${folderPath}`);
-    fs.readdirSync(folderPath).forEach(filename => {
-      const file = path.join(folderPath, filename);
-      const raw = fs.readFileSync(file);
-
-      if (filename.endsWith(".hb")) {
-        const template = hb.compile(raw.toString());
-
-        resources.push(template(this.templateContext));
-      } else {
-        resources.push(raw.toString());
-      }
-    });
-
-    return resources;
-  }
-}
@@ -1,23 +0,0 @@
-/**
- * Copyright (c) 2021 OpenLens Authors
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of
- * this software and associated documentation files (the "Software"), to deal in
- * the Software without restriction, including without limitation the rights to
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
- * the Software, and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
-
-export { ClusterFeature as Feature } from "../cluster-feature";
-export type { ClusterFeatureStatus as FeatureStatus } from "../cluster-feature";
@@ -28,7 +28,6 @@ import * as App from "./app";
 import * as EventBus from "./event-bus";
 import * as Store from "./stores";
 import * as Util from "./utils";
-import * as ClusterFeature from "./cluster-feature";
 import * as Interface from "../interfaces";
 import * as Catalog from "./catalog";
 import * as Types from "./types";
@@ -37,7 +36,6 @@ export {
  App,
  EventBus,
  Catalog,
-  ClusterFeature,
  Interface,
  Store,
  Types,
@@ -32,13 +32,14 @@ export interface EntitySettingComponents {
 }

 export interface EntitySettingRegistration {
-  title: string;
-  kind: string;
  apiVersions: string[];
-  source?: string;
+  kind: string;
+  title: string;
  components: EntitySettingComponents;
+  source?: string;
  id?: string;
  priority?: number;
+  group?: string;
 }

 export interface RegisteredEntitySetting extends EntitySettingRegistration {
@@ -30,6 +30,7 @@ export * from "../../renderer/components/checkbox";
 export * from "../../renderer/components/radio";
 export * from "../../renderer/components/select";
 export * from "../../renderer/components/slider";
+export * from "../../renderer/components/switch";
 export * from "../../renderer/components/input/input";

 // command-overlay
@@ -20,6 +20,7 @@
 */

 export { isAllowedResource } from "../../common/rbac";
+export { ResourceStack } from "../../common/k8s/resource-stack";
 export { apiManager } from "../../renderer/api/api-manager";
 export { KubeObjectStore } from "../../renderer/kube-object.store";
 export { KubeApi, forCluster, IKubeApiCluster } from "../../renderer/api/kube-api";