hendrik/lens
1
0
Fork 0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
Code Issues Projects Releases Wiki Activity

[BREAKING]: refine and document cluster feature api (#1507)

Browse Source 
* refine and document cluster feature api

Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com>

* lint fix

Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com>
This commit is contained in:
Jim Ehrismann 2020-11-25 09:40:25 -05:00 committed by GitHub
parent ab24325e69
commit 73724b5a54
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 71 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
extensions/metrics-cluster-feature/src/metrics-feature.ts
View File

@ -28,7 +28,7 @@ export class MetricsFeature extends ClusterFeature.Feature {
name = "metrics";
latestVersion = "v2.17.2-lens1";
config: MetricsConfiguration = {
templateContext: MetricsConfiguration = {
persistence: {
enabled: false,
storageClass: null,
@ -53,12 +53,12 @@ export class MetricsFeature extends ClusterFeature.Feature {
// Check if there are storageclasses
const storageClassApi = K8sApi.forCluster(cluster, K8sApi.StorageClass);
const scs = await storageClassApi.list();
this.config.persistence.enabled = scs.some(sc => (
this.templateContext.persistence.enabled = scs.some(sc => (
sc.metadata?.annotations?.['storageclass.kubernetes.io/is-default-class'] === 'true' ||
sc.metadata?.annotations?.['storageclass.beta.kubernetes.io/is-default-class'] === 'true'
));
super.applyResources(cluster, super.renderTemplates(path.join(__dirname, "../resources/")));
super.applyResources(cluster, path.join(__dirname, "../resources/"));
}
async upgrade(cluster: Store.Cluster): Promise<void> {

74
src/extensions/cluster-feature.ts
View File

@ -10,17 +10,27 @@ import { requestMain } from "../common/ipc";
import { clusterKubectlApplyAllHandler } from "../common/cluster-ipc";
export interface ClusterFeatureStatus {
/** feature's current version, as set by the implementation */
currentVersion: string;
installed: boolean;
/** 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 {
name: string;
latestVersion: string;
config: any;
/**
* 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,
@ -28,15 +38,59 @@ export abstract class ClusterFeature {
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 async install(cluster: Cluster): 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 ugraded. 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 async upgrade(cluster: Cluster): 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 install kubernetes resources using the kubernetes api (K8sApi)
*
* @param cluster the cluster that the feature is to be uninstalled from
*/
abstract async uninstall(cluster: Cluster): 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 async updateStatus(cluster: Cluster): Promise<ClusterFeatureStatus>;
protected async applyResources(cluster: Cluster, resources: string[]) {
/**
* 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: Cluster, resourceSpec: string | string[]) {
let resources: string[];
if ( typeof resourceSpec === "string" ) {
resources = this.renderTemplates(resourceSpec);
} else {
resources = resourceSpec;
}
if (app) {
await new ResourceApplier(cluster).kubectlApplyAll(resources);
} else {
@ -44,6 +98,14 @@ export abstract class ClusterFeature {
}
}
/**
* 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}`);
@ -52,7 +114,7 @@ export abstract class ClusterFeature {
const raw = fs.readFileSync(file);
if (filename.endsWith('.hb')) {
const template = hb.compile(raw.toString());
resources.push(template(this.config));
resources.push(template(this.templateContext));
} else {
resources.push(raw.toString());
}