1
0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00

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>
This commit is contained in:
Jari Kolehmainen 2021-05-18 16:12:45 +03:00 committed by GitHub
parent d9c6e5c52f
commit 683e5926e0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
35 changed files with 662 additions and 443 deletions

View File

@ -19,58 +19,24 @@
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/ */
import { LensRendererExtension, Interface, Component, Catalog} from "@k8slens/extensions"; import React from "react";
import { MetricsFeature } from "./src/metrics-feature"; import { LensRendererExtension, Catalog } from "@k8slens/extensions";
import { MetricsSettings } from "./src/metrics-settings";
export default class ClusterMetricsFeatureExtension extends LensRendererExtension { export default class ClusterMetricsFeatureExtension extends LensRendererExtension {
onActivate() { entitySettings = [
const category = Catalog.catalogCategories.getForGroupKind<Catalog.KubernetesClusterCategory>("entity.k8slens.dev", "KubernetesCluster"); {
apiVersions: ["entity.k8slens.dev/v1alpha1"],
if (!category) { kind: "KubernetesCluster",
return; title: "Lens Metrics",
} priority: 5,
components: {
category.on("contextMenuOpen", this.clusterContextMenuOpen.bind(this)); View: ({ entity = null }: { entity: Catalog.KubernetesCluster}) => {
} return (
<MetricsSettings cluster={entity} />
async clusterContextMenuOpen(cluster: Catalog.KubernetesCluster, ctx: Interface.CatalogEntityContextMenuContext) { );
if (!cluster.status.active) {
return;
}
const metricsFeature = new MetricsFeature();
await metricsFeature.updateStatus(cluster);
if (metricsFeature.status.installed) {
if (metricsFeature.status.canUpgrade) {
ctx.menuItems.unshift({
icon: "refresh",
title: "Upgrade Lens Metrics stack",
onClick: async () => {
metricsFeature.upgrade(cluster);
}
});
}
ctx.menuItems.unshift({
icon: "toggle_off",
title: "Uninstall Lens Metrics stack",
onClick: async () => {
await metricsFeature.uninstall(cluster);
Component.Notifications.info(`Lens Metrics has been removed from ${cluster.metadata.name}`, { timeout: 10_000 });
}
});
} else {
ctx.menuItems.unshift({
icon: "toggle_on",
title: "Install Lens Metrics stack",
onClick: async () => {
metricsFeature.install(cluster);
Component.Notifications.info(`Lens Metrics is now installed to ${cluster.metadata.name}`, { timeout: 10_000 });
}
});
} }
} }
}
];
} }

View File

@ -2,3 +2,5 @@ apiVersion: v1
kind: Namespace kind: Namespace
metadata: metadata:
name: lens-metrics name: lens-metrics
annotations:
extensionVersion: "{{ version }}"

View File

@ -1,3 +1,4 @@
{{#if prometheus.enabled}}
apiVersion: v1 apiVersion: v1
kind: Service kind: Service
metadata: metadata:
@ -14,3 +15,4 @@ spec:
protocol: TCP protocol: TCP
port: 80 port: 80
targetPort: 9090 targetPort: 9090
{{/if}}

View File

@ -1,3 +1,4 @@
{{#if prometheus.enabled}}
apiVersion: apps/v1 apiVersion: apps/v1
kind: StatefulSet kind: StatefulSet
metadata: metadata:
@ -46,14 +47,14 @@ spec:
serviceAccountName: prometheus serviceAccountName: prometheus
initContainers: initContainers:
- name: chown - name: chown
image: docker.io/alpine:3.9 image: docker.io/alpine:3.12
command: ["chown", "-R", "65534:65534", "/var/lib/prometheus"] command: ["chown", "-R", "65534:65534", "/var/lib/prometheus"]
volumeMounts: volumeMounts:
- name: data - name: data
mountPath: /var/lib/prometheus mountPath: /var/lib/prometheus
containers: containers:
- name: prometheus - name: prometheus
image: quay.io/prometheus/prometheus:v2.19.3 image: quay.io/prometheus/prometheus:v2.26.0
args: args:
- --web.listen-address=0.0.0.0:9090 - --web.listen-address=0.0.0.0:9090
- --config.file=/etc/prometheus/prometheus.yaml - --config.file=/etc/prometheus/prometheus.yaml
@ -114,3 +115,4 @@ spec:
requests: requests:
storage: {{persistence.size}} storage: {{persistence.size}}
{{/if}} {{/if}}
{{/if}}

View File

@ -41,7 +41,7 @@ spec:
hostPID: true hostPID: true
containers: containers:
- name: node-exporter - name: node-exporter
image: quay.io/prometheus/node-exporter:v1.0.1 image: quay.io/prometheus/node-exporter:v1.1.2
args: args:
- --path.procfs=/host/proc - --path.procfs=/host/proc
- --path.sysfs=/host/sys - --path.sysfs=/host/sys

View File

@ -39,7 +39,7 @@ spec:
serviceAccountName: kube-state-metrics serviceAccountName: kube-state-metrics
containers: containers:
- name: kube-state-metrics - name: kube-state-metrics
image: quay.io/coreos/kube-state-metrics:v1.9.7 image: quay.io/coreos/kube-state-metrics:v1.9.8
ports: ports:
- name: metrics - name: metrics
containerPort: 8080 containerPort: 8080
@ -52,7 +52,7 @@ spec:
resources: resources:
requests: requests:
cpu: 10m cpu: 10m
memory: 150Mi memory: 32Mi
limits: limits:
cpu: 200m cpu: 200m
memory: 150Mi memory: 150Mi

View File

@ -19,12 +19,15 @@
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/ */
import { ClusterFeature, Catalog, K8sApi } from "@k8slens/extensions"; import { Catalog, K8sApi } from "@k8slens/extensions";
import semver from "semver"; import semver from "semver";
import * as path from "path"; import * as path from "path";
export interface MetricsConfiguration { export interface MetricsConfiguration {
// Placeholder for Metrics config structure // Placeholder for Metrics config structure
prometheus: {
enabled: boolean;
};
persistence: { persistence: {
enabled: boolean; enabled: boolean;
storageClass: string; storageClass: string;
@ -43,78 +46,72 @@ export interface MetricsConfiguration {
alertManagers: string[]; alertManagers: string[];
replicas: number; replicas: number;
storageClass: string; storageClass: string;
version?: string;
} }
export class MetricsFeature extends ClusterFeature.Feature { export interface MetricsStatus {
name = "metrics"; installed: boolean;
latestVersion = "v2.19.3-lens1"; canUpgrade: boolean;
}
templateContext: MetricsConfiguration = { export class MetricsFeature {
persistence: { name = "lens-metrics";
enabled: false, latestVersion = "v2.26.0-lens1";
storageClass: null,
size: "20G",
},
nodeExporter: {
enabled: true,
},
retention: {
time: "2d",
size: "5GB",
},
kubeStateMetrics: {
enabled: true,
},
alertManagers: null,
replicas: 1,
storageClass: null,
};
async install(cluster: Catalog.KubernetesCluster): Promise<void> { protected stack: K8sApi.ResourceStack;
constructor(protected cluster: Catalog.KubernetesCluster) {
this.stack = new K8sApi.ResourceStack(cluster, this.name);
}
get resourceFolder() {
return path.join(__dirname, "../resources/");
}
async install(config: MetricsConfiguration): Promise<string> {
// Check if there are storageclasses // Check if there are storageclasses
const storageClassApi = K8sApi.forCluster(cluster, K8sApi.StorageClass); const storageClassApi = K8sApi.forCluster(this.cluster, K8sApi.StorageClass);
const scs = await storageClassApi.list(); const scs = await storageClassApi.list();
this.templateContext.persistence.enabled = scs.some(sc => ( config.persistence.enabled = scs.some(sc => (
sc.metadata?.annotations?.["storageclass.kubernetes.io/is-default-class"] === "true" || sc.metadata?.annotations?.["storageclass.kubernetes.io/is-default-class"] === "true" ||
sc.metadata?.annotations?.["storageclass.beta.kubernetes.io/is-default-class"] === "true" sc.metadata?.annotations?.["storageclass.beta.kubernetes.io/is-default-class"] === "true"
)); ));
super.applyResources(cluster, path.join(__dirname, "../resources/")); config.version = this.latestVersion;
return this.stack.kubectlApplyFolder(this.resourceFolder, config, ["--prune"]);
} }
async upgrade(cluster: Catalog.KubernetesCluster): Promise<void> { async upgrade(config: MetricsConfiguration): Promise<string> {
return this.install(cluster); return this.install(config);
} }
async updateStatus(cluster: Catalog.KubernetesCluster): Promise<ClusterFeature.FeatureStatus> { async getStatus(): Promise<MetricsStatus> {
const status: MetricsStatus = { installed: false, canUpgrade: false};
try { try {
const statefulSet = K8sApi.forCluster(cluster, K8sApi.StatefulSet); const namespaceApi = K8sApi.forCluster(this.cluster, K8sApi.Namespace);
const prometheus = await statefulSet.get({name: "prometheus", namespace: "lens-metrics"}); const namespace = await namespaceApi.get({name: "lens-metrics"});
if (prometheus?.kind) { if (namespace?.kind) {
this.status.installed = true; const currentVersion = namespace.metadata.annotations?.extensionVersion || "0.0.0";
this.status.currentVersion = prometheus.spec.template.spec.containers[0].image.split(":")[1];
this.status.canUpgrade = semver.lt(this.status.currentVersion, this.latestVersion, true); status.installed = true;
status.canUpgrade = semver.lt(currentVersion, this.latestVersion, true);
} else { } else {
this.status.installed = false; status.installed = false;
} }
} catch(e) { } catch(e) {
if (e?.error?.code === 404) { if (e?.error?.code === 404) {
this.status.installed = false; status.installed = false;
} }
} }
return this.status; return status;
} }
async uninstall(cluster: Catalog.KubernetesCluster): Promise<void> { async uninstall(config: MetricsConfiguration): Promise<string> {
const namespaceApi = K8sApi.forCluster(cluster, K8sApi.Namespace); return this.stack.kubectlDeleteFolder(this.resourceFolder, config);
const clusterRoleBindingApi = K8sApi.forCluster(cluster, K8sApi.ClusterRoleBinding);
const clusterRoleApi = K8sApi.forCluster(cluster, K8sApi.ClusterRole);
await namespaceApi.delete({name: "lens-metrics"});
await clusterRoleBindingApi.delete({name: "lens-prometheus"});
await clusterRoleApi.delete({name: "lens-prometheus"});
} }
} }

View File

@ -0,0 +1,279 @@
/**
* 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 React from "react";
import { Component, Catalog, K8sApi } from "@k8slens/extensions";
import { observer } from "mobx-react";
import { computed, observable } from "mobx";
import { MetricsFeature, MetricsConfiguration } from "./metrics-feature";
interface Props {
cluster: Catalog.KubernetesCluster;
}
@observer
export class MetricsSettings extends React.Component<Props> {
@observable featureStates = {
prometheus: false,
kubeStateMetrics: false,
nodeExporter: false
};
@observable canUpgrade = false;
@observable upgrading = false;
@observable changed = false;
@observable inProgress = false;
config: MetricsConfiguration = {
prometheus: {
enabled: false
},
persistence: {
enabled: false,
storageClass: null,
size: "20G",
},
nodeExporter: {
enabled: false,
},
retention: {
time: "2d",
size: "5GB",
},
kubeStateMetrics: {
enabled: false,
},
alertManagers: null,
replicas: 1,
storageClass: null,
};
feature: MetricsFeature;
@computed get isTogglable() {
if (this.inProgress) return false;
if (!this.props.cluster.status.active) return false;
if (this.canUpgrade) return false;
if (!this.isActiveMetricsProvider) return false;
return true;
}
get metricsProvider() {
return this.props.cluster.spec?.metrics?.prometheus?.type || "";
}
get isActiveMetricsProvider() {
return (!this.metricsProvider || this.metricsProvider === "lens");
}
async componentDidMount() {
this.feature = new MetricsFeature(this.props.cluster);
await this.updateFeatureStates();
}
async updateFeatureStates() {
const status = await this.feature.getStatus();
this.canUpgrade = status.canUpgrade;
if (this.canUpgrade) {
this.changed = true;
}
const statefulSet = K8sApi.forCluster(this.props.cluster, K8sApi.StatefulSet);
try {
await statefulSet.get({name: "prometheus", namespace: "lens-metrics"});
this.featureStates.prometheus = true;
} catch(e) {
if (e?.error?.code === 404) {
this.featureStates.prometheus = false;
} else {
this.featureStates.prometheus = undefined;
}
}
const deployment = K8sApi.forCluster(this.props.cluster, K8sApi.Deployment);
try {
await deployment.get({name: "kube-state-metrics", namespace: "lens-metrics"});
this.featureStates.kubeStateMetrics = true;
} catch(e) {
if (e?.error?.code === 404) {
this.featureStates.kubeStateMetrics = false;
} else {
this.featureStates.kubeStateMetrics = undefined;
}
}
const daemonSet = K8sApi.forCluster(this.props.cluster, K8sApi.DaemonSet);
try {
await daemonSet.get({name: "node-exporter", namespace: "lens-metrics"});
this.featureStates.nodeExporter = true;
} catch(e) {
if (e?.error?.code === 404) {
this.featureStates.nodeExporter = false;
} else {
this.featureStates.nodeExporter = undefined;
}
}
}
async save() {
this.config.prometheus.enabled = !!this.featureStates.prometheus;
this.config.kubeStateMetrics.enabled = !!this.featureStates.kubeStateMetrics;
this.config.nodeExporter.enabled = !!this.featureStates.nodeExporter;
this.inProgress = true;
try {
if (!this.config.prometheus.enabled && !this.config.kubeStateMetrics.enabled && !this.config.nodeExporter.enabled) {
await this.feature.uninstall(this.config);
} else {
await this.feature.install(this.config);
}
} finally {
this.inProgress = false;
this.changed = false;
await this.updateFeatureStates();
}
}
async togglePrometheus(enabled: boolean) {
this.featureStates.prometheus = enabled;
this.changed = true;
}
async toggleKubeStateMetrics(enabled: boolean) {
this.featureStates.kubeStateMetrics = enabled;
this.changed = true;
}
async toggleNodeExporter(enabled: boolean) {
this.featureStates.nodeExporter = enabled;
this.changed = true;
}
@computed get buttonLabel() {
const allDisabled = !this.featureStates.kubeStateMetrics && !this.featureStates.nodeExporter && !this.featureStates.prometheus;
if (this.inProgress && this.canUpgrade) return "Upgrading ...";
if (this.inProgress && allDisabled) return "Uninstalling ...";
if (this.inProgress) return "Applying ...";
if (this.canUpgrade) return "Upgrade";
if (this.changed && allDisabled) {
return "Uninstall";
}
return "Apply";
}
render() {
return (
<>
{ !this.props.cluster.status.active && (
<section>
<p style={ {color: "var(--colorError)"} }>
Lens Metrics settings requires established connection to the cluster.
</p>
</section>
)}
{ !this.isActiveMetricsProvider && (
<section>
<p style={ {color: "var(--colorError)"} }>
Other metrics provider is currently active. See &quot;Metrics&quot; tab for details.
</p>
</section>
)}
<section>
<Component.SubTitle title="Prometheus" />
<Component.FormSwitch
control={
<Component.Switcher
disabled={this.featureStates.kubeStateMetrics === undefined || !this.isTogglable}
checked={!!this.featureStates.prometheus && this.props.cluster.status.active}
onChange={v => this.togglePrometheus(v.target.checked)}
name="prometheus"
/>
}
label="Enable bundled Prometheus metrics stack"
/>
<small className="hint">
Enable timeseries data visualization (Prometheus stack) for your cluster.
</small>
</section>
<section>
<Component.SubTitle title="Kube State Metrics" />
<Component.FormSwitch
control={
<Component.Switcher
disabled={this.featureStates.kubeStateMetrics === undefined || !this.isTogglable}
checked={!!this.featureStates.kubeStateMetrics && this.props.cluster.status.active}
onChange={v => this.toggleKubeStateMetrics(v.target.checked)}
name="node-exporter"
/>
}
label="Enable bundled kube-state-metrics stack"
/>
<small className="hint">
Enable Kubernetes API object metrics for your cluster.
Enable this only if you don&apos;t have existing kube-state-metrics stack installed.
</small>
</section>
<section>
<Component.SubTitle title="Node Exporter" />
<Component.FormSwitch
control={
<Component.Switcher
disabled={this.featureStates.nodeExporter === undefined || !this.isTogglable}
checked={!!this.featureStates.nodeExporter && this.props.cluster.status.active}
onChange={v => this.toggleNodeExporter(v.target.checked)}
name="node-exporter"
/>
}
label="Enable bundled node-exporter stack"
/>
<small className="hint">
Enable node level metrics for your cluster.
Enable this only if you don&apos;t have existing node-exporter stack installed.
</small>
</section>
<section>
<Component.Button
label={this.buttonLabel}
waiting={this.inProgress}
onClick={() => this.save()}
primary
disabled={!this.changed} />
{this.canUpgrade && (<small className="hint">
An update is available for enabled metrics components.
</small>)}
</section>
</>
);
}
}

View File

@ -16,8 +16,8 @@
"jsx": "react" "jsx": "react"
}, },
"include": [ "include": [
"./*.ts", "./**/*.ts",
"./*.tsx" "./**/*.tsx"
], ],
"exclude": [ "exclude": [
"node_modules", "node_modules",

View File

@ -28,9 +28,24 @@ import { productName } from "../vars";
import { CatalogCategory, CatalogCategorySpec } from "../catalog"; import { CatalogCategory, CatalogCategorySpec } from "../catalog";
import { app } from "electron"; import { app } from "electron";
export type KubernetesClusterPrometheusMetrics = {
address?: {
namespace: string;
service: string;
port: number;
prefix: string;
};
type?: string;
};
export type KubernetesClusterSpec = { export type KubernetesClusterSpec = {
kubeconfigPath: string; kubeconfigPath: string;
kubeconfigContext: string; kubeconfigContext: string;
metrics?: {
source: string;
prometheus?: KubernetesClusterPrometheusMetrics;
}
}; };
export interface KubernetesClusterStatus extends CatalogEntityStatus { export interface KubernetesClusterStatus extends CatalogEntityStatus {
@ -88,7 +103,6 @@ export class KubernetesCluster extends CatalogEntity<CatalogEntityMetadata, Kube
async onContextMenuOpen(context: CatalogEntityContextMenuContext) { async onContextMenuOpen(context: CatalogEntityContextMenuContext) {
context.menuItems = [ context.menuItems = [
{ {
icon: "settings",
title: "Settings", title: "Settings",
onlyVisibleForSource: "local", onlyVisibleForSource: "local",
onClick: async () => context.navigate(`/entity/${this.metadata.uid}/settings`) onClick: async () => context.navigate(`/entity/${this.metadata.uid}/settings`)
@ -97,7 +111,6 @@ export class KubernetesCluster extends CatalogEntity<CatalogEntityMetadata, Kube
if (this.metadata.labels["file"]?.startsWith(ClusterStore.storedKubeConfigFolder)) { if (this.metadata.labels["file"]?.startsWith(ClusterStore.storedKubeConfigFolder)) {
context.menuItems.push({ context.menuItems.push({
icon: "delete",
title: "Delete", title: "Delete",
onlyVisibleForSource: "local", onlyVisibleForSource: "local",
onClick: async () => ClusterStore.getInstance().removeById(this.metadata.uid), onClick: async () => ClusterStore.getInstance().removeById(this.metadata.uid),
@ -108,14 +121,20 @@ export class KubernetesCluster extends CatalogEntity<CatalogEntityMetadata, Kube
} }
if (this.status.phase == "connected") { if (this.status.phase == "connected") {
context.menuItems.unshift({ context.menuItems.push({
icon: "link_off",
title: "Disconnect", title: "Disconnect",
onClick: async () => { onClick: async () => {
ClusterStore.getInstance().deactivate(this.metadata.uid); ClusterStore.getInstance().deactivate(this.metadata.uid);
requestMain(clusterDisconnectHandler, this.metadata.uid); requestMain(clusterDisconnectHandler, this.metadata.uid);
} }
}); });
} else {
context.menuItems.push({
title: "Connect",
onClick: async () => {
context.navigate(`/cluster/${this.metadata.uid}`);
}
});
} }
const category = catalogCategoryRegistry.getCategoryForEntity<KubernetesClusterCategory>(this); const category = catalogCategoryRegistry.getCategoryForEntity<KubernetesClusterCategory>(this);

View File

@ -83,7 +83,6 @@ export interface CatalogEntityActionContext {
} }
export interface CatalogEntityContextMenu { export interface CatalogEntityContextMenu {
icon: string;
title: string; title: string;
onlyVisibleForSource?: string; // show only if empty or if matches with entity source onlyVisibleForSource?: string; // show only if empty or if matches with entity source
onClick: () => void | Promise<void>; onClick: () => void | Promise<void>;
@ -92,6 +91,10 @@ export interface CatalogEntityContextMenu {
} }
} }
export interface CatalogEntityAddMenu extends CatalogEntityContextMenu {
icon: string;
}
export interface CatalogEntitySettingsMenu { export interface CatalogEntitySettingsMenu {
group?: string; group?: string;
title: string; title: string;
@ -111,7 +114,7 @@ export interface CatalogEntitySettingsContext {
export interface CatalogEntityAddMenuContext { export interface CatalogEntityAddMenuContext {
navigate: (url: string) => void; navigate: (url: string) => void;
menuItems: CatalogEntityContextMenu[]; menuItems: CatalogEntityAddMenu[];
} }
export type CatalogEntitySpec = Record<string, any>; export type CatalogEntitySpec = Record<string, any>;

View File

@ -31,6 +31,7 @@ export const clusterSetFrameIdHandler = "cluster:set-frame-id";
export const clusterRefreshHandler = "cluster:refresh"; export const clusterRefreshHandler = "cluster:refresh";
export const clusterDisconnectHandler = "cluster:disconnect"; export const clusterDisconnectHandler = "cluster:disconnect";
export const clusterKubectlApplyAllHandler = "cluster:kubectl-apply-all"; export const clusterKubectlApplyAllHandler = "cluster:kubectl-apply-all";
export const clusterKubectlDeleteAllHandler = "cluster:kubectl-delete-all";
if (ipcMain) { if (ipcMain) {
handleRequest(clusterActivateHandler, (event, clusterId: ClusterId, force = false) => { handleRequest(clusterActivateHandler, (event, clusterId: ClusterId, force = false) => {
@ -67,14 +68,39 @@ if (ipcMain) {
} }
}); });
handleRequest(clusterKubectlApplyAllHandler, (event, clusterId: ClusterId, resources: string[]) => { handleRequest(clusterKubectlApplyAllHandler, async (event, clusterId: ClusterId, resources: string[], extraArgs: string[]) => {
appEventBus.emit({name: "cluster", action: "kubectl-apply-all"}); appEventBus.emit({name: "cluster", action: "kubectl-apply-all"});
const cluster = ClusterStore.getInstance().getById(clusterId); const cluster = ClusterStore.getInstance().getById(clusterId);
if (cluster) { if (cluster) {
const applier = new ResourceApplier(cluster); const applier = new ResourceApplier(cluster);
applier.kubectlApplyAll(resources); try {
const stdout = await applier.kubectlApplyAll(resources, extraArgs);
return { stdout };
} catch (error: any) {
return { stderr: error };
}
} else {
throw `${clusterId} is not a valid cluster id`;
}
});
handleRequest(clusterKubectlDeleteAllHandler, async (event, clusterId: ClusterId, resources: string[], extraArgs: string[]) => {
appEventBus.emit({name: "cluster", action: "kubectl-delete-all"});
const cluster = ClusterStore.getInstance().getById(clusterId);
if (cluster) {
const applier = new ResourceApplier(cluster);
try {
const stdout = await applier.kubectlDeleteAll(resources, extraArgs);
return { stdout };
} catch (error: any) {
return { stderr: error };
}
} else { } else {
throw `${clusterId} is not a valid cluster id`; throw `${clusterId} is not a valid cluster id`;
} }

View File

@ -0,0 +1,152 @@
/**
* 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 fse from "fs-extra";
import path from "path";
import hb from "handlebars";
import { ResourceApplier } from "../../main/resource-applier";
import { KubernetesCluster } from "../catalog-entities";
import logger from "../../main/logger";
import { app } from "electron";
import { requestMain } from "../ipc";
import { clusterKubectlApplyAllHandler, clusterKubectlDeleteAllHandler } from "../cluster-ipc";
import { ClusterStore } from "../cluster-store";
import yaml from "js-yaml";
import { productName } from "../vars";
export class ResourceStack {
constructor(protected cluster: KubernetesCluster, protected name: string) {}
/**
*
* @param folderPath folder path that is searched for files defining kubernetes resources.
* @param templateContext sets the template parameters that are to be applied to any templated kubernetes resources that are to be applied.
*/
async kubectlApplyFolder(folderPath: string, templateContext?: any, extraArgs?: string[]): Promise<string> {
const resources = await this.renderTemplates(folderPath, templateContext);
return this.applyResources(resources, extraArgs);
}
/**
*
* @param folderPath folder path that is searched for files defining kubernetes resources.
* @param templateContext sets the template parameters that are to be applied to any templated kubernetes resources that are to be applied.
*/
async kubectlDeleteFolder(folderPath: string, templateContext?: any, extraArgs?: string[]): Promise<string> {
const resources = await this.renderTemplates(folderPath, templateContext);
return this.deleteResources(resources, extraArgs);
}
protected async applyResources(resources: string[], extraArgs?: string[]): Promise<string> {
const clusterModel = ClusterStore.getInstance().getById(this.cluster.metadata.uid);
if (!clusterModel) {
throw new Error(`cluster not found`);
}
let kubectlArgs = extraArgs || [];
kubectlArgs = this.appendKubectlArgs(kubectlArgs);
if (app) {
return await new ResourceApplier(clusterModel).kubectlApplyAll(resources, kubectlArgs);
} else {
const response = await requestMain(clusterKubectlApplyAllHandler, this.cluster.metadata.uid, resources, kubectlArgs);
if (response.stderr) {
throw new Error(response.stderr);
}
return response.stdout;
}
}
protected async deleteResources(resources: string[], extraArgs?: string[]): Promise<string> {
const clusterModel = ClusterStore.getInstance().getById(this.cluster.metadata.uid);
if (!clusterModel) {
throw new Error(`cluster not found`);
}
let kubectlArgs = extraArgs || [];
kubectlArgs = this.appendKubectlArgs(kubectlArgs);
if (app) {
return await new ResourceApplier(clusterModel).kubectlDeleteAll(resources, kubectlArgs);
} else {
const response = await requestMain(clusterKubectlDeleteAllHandler, this.cluster.metadata.uid, resources, kubectlArgs);
if (response.stderr) {
throw new Error(response.stderr);
}
return response.stdout;
}
}
protected appendKubectlArgs(kubectlArgs: string[]) {
if (!kubectlArgs.includes("-l") && !kubectlArgs.includes("--label")) {
return kubectlArgs.concat(["-l", `app.kubernetes.io/name=${this.name}`]);
}
return kubectlArgs;
}
protected async renderTemplates(folderPath: string, templateContext: any): Promise<string[]> {
const resources: string[] = [];
logger.info(`[RESOURCE-STACK]: render templates from ${folderPath}`);
const files = await fse.readdir(folderPath);
for(const filename of files) {
const file = path.join(folderPath, filename);
const raw = await fse.readFile(file);
let resourceData: string;
if (filename.endsWith(".hb")) {
const template = hb.compile(raw.toString());
resourceData = template(templateContext);
} else {
resourceData = raw.toString();
}
if (!resourceData.trim()) continue;
const resourceArray = yaml.safeLoadAll(resourceData.toString());
resourceArray.forEach((resource) => {
if (resource?.metadata) {
resource.metadata.labels ||= {};
resource.metadata.labels["app.kubernetes.io/name"] = this.name;
resource.metadata.labels["app.kubernetes.io/managed-by"] = productName;
resource.metadata.labels["app.kubernetes.io/created-by"] = "resource-stack";
}
resources.push(yaml.safeDump(resource));
});
}
return resources;
}
}

View File

@ -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;
}
}

View File

@ -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";

View File

@ -28,7 +28,6 @@ import * as App from "./app";
import * as EventBus from "./event-bus"; import * as EventBus from "./event-bus";
import * as Store from "./stores"; import * as Store from "./stores";
import * as Util from "./utils"; import * as Util from "./utils";
import * as ClusterFeature from "./cluster-feature";
import * as Interface from "../interfaces"; import * as Interface from "../interfaces";
import * as Catalog from "./catalog"; import * as Catalog from "./catalog";
import * as Types from "./types"; import * as Types from "./types";
@ -37,7 +36,6 @@ export {
App, App,
EventBus, EventBus,
Catalog, Catalog,
ClusterFeature,
Interface, Interface,
Store, Store,
Types, Types,

View File

@ -32,13 +32,14 @@ export interface EntitySettingComponents {
} }
export interface EntitySettingRegistration { export interface EntitySettingRegistration {
title: string;
kind: string;
apiVersions: string[]; apiVersions: string[];
source?: string; kind: string;
title: string;
components: EntitySettingComponents; components: EntitySettingComponents;
source?: string;
id?: string; id?: string;
priority?: number; priority?: number;
group?: string;
} }
export interface RegisteredEntitySetting extends EntitySettingRegistration { export interface RegisteredEntitySetting extends EntitySettingRegistration {

View File

@ -30,6 +30,7 @@ export * from "../../renderer/components/checkbox";
export * from "../../renderer/components/radio"; export * from "../../renderer/components/radio";
export * from "../../renderer/components/select"; export * from "../../renderer/components/select";
export * from "../../renderer/components/slider"; export * from "../../renderer/components/slider";
export * from "../../renderer/components/switch";
export * from "../../renderer/components/input/input"; export * from "../../renderer/components/input/input";
// command-overlay // command-overlay

View File

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

View File

@ -29,7 +29,7 @@ import logger from "./logger";
import { apiKubePrefix } from "../common/vars"; import { apiKubePrefix } from "../common/vars";
import { Singleton } from "../common/utils"; import { Singleton } from "../common/utils";
import { catalogEntityRegistry } from "../common/catalog"; import { catalogEntityRegistry } from "../common/catalog";
import { KubernetesCluster } from "../common/catalog-entities/kubernetes-cluster"; import { KubernetesCluster, KubernetesClusterPrometheusMetrics } from "../common/catalog-entities/kubernetes-cluster";
export class ClusterManager extends Singleton { export class ClusterManager extends Singleton {
constructor() { constructor() {
@ -68,7 +68,7 @@ export class ClusterManager extends Singleton {
const index = catalogEntityRegistry.items.findIndex((entity) => entity.metadata.uid === cluster.id); const index = catalogEntityRegistry.items.findIndex((entity) => entity.metadata.uid === cluster.id);
if (index !== -1) { if (index !== -1) {
const entity = catalogEntityRegistry.items[index]; const entity = catalogEntityRegistry.items[index] as KubernetesCluster;
entity.status.phase = cluster.disconnected ? "disconnected" : "connected"; entity.status.phase = cluster.disconnected ? "disconnected" : "connected";
entity.status.active = !cluster.disconnected; entity.status.active = !cluster.disconnected;
@ -76,6 +76,17 @@ export class ClusterManager extends Singleton {
if (cluster.preferences?.clusterName) { if (cluster.preferences?.clusterName) {
entity.metadata.name = cluster.preferences.clusterName; entity.metadata.name = cluster.preferences.clusterName;
} }
entity.spec.metrics ||= { source: "local" };
if (entity.spec.metrics.source === "local") {
const prometheus: KubernetesClusterPrometheusMetrics = entity.spec?.metrics?.prometheus || {};
prometheus.type = cluster.preferences.prometheusProvider?.type;
prometheus.address = cluster.preferences.prometheus;
entity.spec.metrics.prometheus = prometheus;
}
catalogEntityRegistry.items.splice(index, 1, entity); catalogEntityRegistry.items.splice(index, 1, entity);
} }
} }

View File

@ -73,7 +73,15 @@ export class ResourceApplier {
}); });
} }
public async kubectlApplyAll(resources: string[]): Promise<string> { public async kubectlApplyAll(resources: string[], extraArgs = ["-o", "json"]): Promise<string> {
return this.kubectlCmdAll("apply", resources, extraArgs);
}
public async kubectlDeleteAll(resources: string[], extraArgs?: string[]): Promise<string> {
return this.kubectlCmdAll("delete", resources, extraArgs);
}
protected async kubectlCmdAll(subCmd: string, resources: string[], args: string[] = []): Promise<string> {
const { kubeCtl } = this.cluster; const { kubeCtl } = this.cluster;
const kubectlPath = await kubeCtl.getPath(); const kubectlPath = await kubeCtl.getPath();
const proxyKubeconfigPath = await this.cluster.getProxyKubeconfigPath(); const proxyKubeconfigPath = await this.cluster.getProxyKubeconfigPath();
@ -85,19 +93,24 @@ export class ResourceApplier {
resources.forEach((resource, index) => { resources.forEach((resource, index) => {
fs.writeFileSync(path.join(tmpDir, `${index}.yaml`), resource); fs.writeFileSync(path.join(tmpDir, `${index}.yaml`), resource);
}); });
const cmd = `"${kubectlPath}" apply --kubeconfig "${proxyKubeconfigPath}" -o json -f "${tmpDir}"`; args.push("-f", `"${tmpDir}"`);
const cmd = `"${kubectlPath}" ${subCmd} --kubeconfig "${proxyKubeconfigPath}" ${args.join(" ")}`;
console.log("shooting manifests with:", cmd); logger.info(`[RESOURCE-APPLIER] running cmd ${cmd}`);
exec(cmd, (error, stdout, stderr) => { exec(cmd, (error, stdout) => {
if (error) { if (error) {
reject(`Error applying manifests:${error}`); logger.error(`[RESOURCE-APPLIER] cmd errored: ${error}`);
} const splitError = error.toString().split(`.yaml": `);
if (stderr != "") { if (splitError[1]) {
reject(stderr); reject(splitError[1]);
} else {
reject(error);
}
return; return;
} }
resolve(stdout); resolve(stdout);
}); });
}); });

View File

@ -30,6 +30,7 @@ export {
CatalogEntityKindData, CatalogEntityKindData,
CatalogEntityActionContext, CatalogEntityActionContext,
CatalogEntityAddMenuContext, CatalogEntityAddMenuContext,
CatalogEntityAddMenu,
CatalogEntityContextMenu, CatalogEntityContextMenu,
CatalogEntityContextMenuContext CatalogEntityContextMenuContext
} from "../../common/catalog"; } from "../../common/catalog";

View File

@ -26,7 +26,7 @@ import { Icon } from "../icon";
import { disposeOnUnmount, observer } from "mobx-react"; import { disposeOnUnmount, observer } from "mobx-react";
import { observable, reaction } from "mobx"; import { observable, reaction } from "mobx";
import { autobind } from "../../../common/utils"; import { autobind } from "../../../common/utils";
import { CatalogCategory, CatalogEntityAddMenuContext, CatalogEntityContextMenu } from "../../api/catalog-entity"; import { CatalogCategory, CatalogEntityAddMenuContext, CatalogEntityAddMenu } from "../../api/catalog-entity";
import { EventEmitter } from "events"; import { EventEmitter } from "events";
import { navigate } from "../../navigation"; import { navigate } from "../../navigation";
@ -37,7 +37,7 @@ export type CatalogAddButtonProps = {
@observer @observer
export class CatalogAddButton extends React.Component<CatalogAddButtonProps> { export class CatalogAddButton extends React.Component<CatalogAddButtonProps> {
@observable protected isOpen = false; @observable protected isOpen = false;
protected menuItems = observable.array<CatalogEntityContextMenu>([]); protected menuItems = observable.array<CatalogEntityAddMenu>([]);
componentDidMount() { componentDidMount() {
disposeOnUnmount(this, [ disposeOnUnmount(this, [

View File

@ -29,7 +29,6 @@ import { navigate } from "../../navigation";
import { kebabCase } from "lodash"; import { kebabCase } from "lodash";
import { PageLayout } from "../layout/page-layout"; import { PageLayout } from "../layout/page-layout";
import { MenuItem, MenuActions } from "../menu"; import { MenuItem, MenuActions } from "../menu";
import { Icon } from "../icon";
import { CatalogEntityContextMenu, CatalogEntityContextMenuContext, catalogEntityRunContext } from "../../api/catalog-entity"; import { CatalogEntityContextMenu, CatalogEntityContextMenuContext, catalogEntityRunContext } from "../../api/catalog-entity";
import { Badge } from "../badge"; import { Badge } from "../badge";
import { HotbarStore } from "../../../common/hotbar-store"; import { HotbarStore } from "../../../common/hotbar-store";
@ -136,16 +135,16 @@ export class Catalog extends React.Component {
return ( return (
<MenuActions onOpen={() => item.onContextMenuOpen(this.contextMenu)}> <MenuActions onOpen={() => item.onContextMenuOpen(this.contextMenu)}>
<MenuItem key="add-to-hotbar" onClick={() => this.addToHotbar(item) }>
<Icon material="push_pin" small interactive={true} title="Pin to Hotbar"/> Pin to Hotbar
</MenuItem>
{ {
menuItems.map((menuItem, index) => ( menuItems.map((menuItem, index) => (
<MenuItem key={index} onClick={() => this.onMenuItemClick(menuItem)}> <MenuItem key={index} onClick={() => this.onMenuItemClick(menuItem)}>
<Icon material={menuItem.icon} small interactive={true} title={menuItem.title} /> {menuItem.title} {menuItem.title}
</MenuItem> </MenuItem>
)) ))
} }
<MenuItem key="add-to-hotbar" onClick={() => this.addToHotbar(item) }>
Pin to Hotbar
</MenuItem>
</MenuActions> </MenuActions>
); );
} }

View File

@ -32,6 +32,7 @@ import { CatalogEntity } from "../../api/catalog-entity";
import { catalogEntityRegistry } from "../../api/catalog-entity-registry"; import { catalogEntityRegistry } from "../../api/catalog-entity-registry";
import { entitySettingRegistry } from "../../../extensions/registries"; import { entitySettingRegistry } from "../../../extensions/registries";
import { EntitySettingsRouteParams } from "./entity-settings.route"; import { EntitySettingsRouteParams } from "./entity-settings.route";
import { groupBy } from "lodash";
interface Props extends RouteComponentProps<EntitySettingsRouteParams> { interface Props extends RouteComponentProps<EntitySettingsRouteParams> {
} }
@ -57,9 +58,15 @@ export class EntitySettings extends React.Component<Props> {
async componentDidMount() { async componentDidMount() {
const { hash } = navigation.location; const { hash } = navigation.location;
this.ensureActiveTab(); if (hash) {
const item = this.menuItems.find((item) => item.title === hash.slice(1));
document.getElementById(hash.slice(1))?.scrollIntoView(); if (item) {
this.activeTab = item.id;
}
}
this.ensureActiveTab();
} }
onTabChange = (tabId: string) => { onTabChange = (tabId: string) => {
@ -67,19 +74,25 @@ export class EntitySettings extends React.Component<Props> {
}; };
renderNavigation() { renderNavigation() {
const groups = Object.entries(groupBy(this.menuItems, (item) => item.group || "Extensions"));
return ( return (
<> <>
<h2>{this.entity.metadata.name}</h2> <h2>{this.entity.metadata.name}</h2>
<Tabs className="flex column" scrollable={false} onChange={this.onTabChange} value={this.activeTab}> <Tabs className="flex column" scrollable={false} onChange={this.onTabChange} value={this.activeTab}>
<div className="header">Settings</div> { groups.map((group) => (
{ this.menuItems.map((setting) => ( <>
<div className="header">{group[0]}</div>
{ group[1].map((setting, index) => (
<Tab <Tab
key={setting.id} key={index}
value={setting.id} value={setting.id}
label={setting.title} label={setting.title}
data-testid={`${setting.id}-tab`} data-testid={`${setting.id}-tab`}
/> />
))} ))}
</>
))}
</Tabs> </Tabs>
</> </>
); );
@ -111,7 +124,7 @@ export class EntitySettings extends React.Component<Props> {
<section> <section>
<h2 data-testid={`${activeSetting.id}-header`}>{activeSetting.title}</h2> <h2 data-testid={`${activeSetting.id}-header`}>{activeSetting.title}</h2>
<section> <section>
<activeSetting.components.View entity={this.entity} /> <activeSetting.components.View entity={this.entity} key={activeSetting.title} />
</section> </section>
</section> </section>
</PageLayout> </PageLayout>

View File

@ -43,6 +43,7 @@ entitySettingRegistry.add([
kind: "KubernetesCluster", kind: "KubernetesCluster",
source: "local", source: "local",
title: "General", title: "General",
group: "Settings",
components: { components: {
View: (props: { entity: CatalogEntity }) => { View: (props: { entity: CatalogEntity }) => {
const cluster = getClusterForEntity(props.entity); const cluster = getClusterForEntity(props.entity);
@ -68,6 +69,7 @@ entitySettingRegistry.add([
apiVersions: ["entity.k8slens.dev/v1alpha1"], apiVersions: ["entity.k8slens.dev/v1alpha1"],
kind: "KubernetesCluster", kind: "KubernetesCluster",
title: "Proxy", title: "Proxy",
group: "Settings",
components: { components: {
View: (props: { entity: CatalogEntity }) => { View: (props: { entity: CatalogEntity }) => {
const cluster = getClusterForEntity(props.entity); const cluster = getClusterForEntity(props.entity);
@ -88,6 +90,7 @@ entitySettingRegistry.add([
apiVersions: ["entity.k8slens.dev/v1alpha1"], apiVersions: ["entity.k8slens.dev/v1alpha1"],
kind: "KubernetesCluster", kind: "KubernetesCluster",
title: "Terminal", title: "Terminal",
group: "Settings",
components: { components: {
View: (props: { entity: CatalogEntity }) => { View: (props: { entity: CatalogEntity }) => {
const cluster = getClusterForEntity(props.entity); const cluster = getClusterForEntity(props.entity);
@ -108,6 +111,7 @@ entitySettingRegistry.add([
apiVersions: ["entity.k8slens.dev/v1alpha1"], apiVersions: ["entity.k8slens.dev/v1alpha1"],
kind: "KubernetesCluster", kind: "KubernetesCluster",
title: "Namespaces", title: "Namespaces",
group: "Settings",
components: { components: {
View: (props: { entity: CatalogEntity }) => { View: (props: { entity: CatalogEntity }) => {
const cluster = getClusterForEntity(props.entity); const cluster = getClusterForEntity(props.entity);
@ -128,6 +132,7 @@ entitySettingRegistry.add([
apiVersions: ["entity.k8slens.dev/v1alpha1"], apiVersions: ["entity.k8slens.dev/v1alpha1"],
kind: "KubernetesCluster", kind: "KubernetesCluster",
title: "Metrics", title: "Metrics",
group: "Settings",
components: { components: {
View: (props: { entity: CatalogEntity }) => { View: (props: { entity: CatalogEntity }) => {
const cluster = getClusterForEntity(props.entity); const cluster = getClusterForEntity(props.entity);

View File

@ -1,33 +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.
*/
.MetricsSelect {
$spacing: $padding;
--flex-gap: #{$spacing};
.Badge {
margin-top: $spacing;
}
.Button {
margin-top: $spacing;
}
}

View File

@ -19,8 +19,6 @@
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/ */
import "./cluster-metrics-setting.scss";
import React from "react"; import React from "react";
import { disposeOnUnmount, observer } from "mobx-react"; import { disposeOnUnmount, observer } from "mobx-react";
import { Select, SelectOption } from "../../select/select"; import { Select, SelectOption } from "../../select/select";

View File

@ -27,6 +27,7 @@ import { SubTitle } from "../../layout/sub-title";
import { Select, SelectOption } from "../../select"; import { Select, SelectOption } from "../../select";
import { Input } from "../../input"; import { Input } from "../../input";
import { observable, computed, autorun } from "mobx"; import { observable, computed, autorun } from "mobx";
import { productName } from "../../../../common/vars";
const options: SelectOption<string>[] = [ const options: SelectOption<string>[] = [
{ value: "", label: "Auto detect" }, { value: "", label: "Auto detect" },
@ -102,12 +103,8 @@ export class ClusterPrometheusSetting extends React.Component<Props> {
render() { render() {
return ( return (
<> <>
<SubTitle title="Prometheus installation method"/> <section>
<p> <SubTitle title="Prometheus"/>
Use pre-installed Prometheus service for metrics. Please refer to the{" "}
<a href="https://github.com/lensapp/lens/blob/master/troubleshooting/custom-prometheus.md" target="_blank" rel="noreferrer">guide</a>{" "}
for possible configuration changes.
</p>
<Select <Select
value={this.provider} value={this.provider}
onChange={({value}) => { onChange={({value}) => {
@ -117,8 +114,9 @@ export class ClusterPrometheusSetting extends React.Component<Props> {
options={options} options={options}
/> />
<small className="hint">What query format is used to fetch metrics from Prometheus</small> <small className="hint">What query format is used to fetch metrics from Prometheus</small>
</section>
{this.canEditPrometheusPath && ( {this.canEditPrometheusPath && (
<> <section>
<p>Prometheus service address.</p> <p>Prometheus service address.</p>
<Input <Input
theme="round-black" theme="round-black"
@ -129,9 +127,9 @@ export class ClusterPrometheusSetting extends React.Component<Props> {
/> />
<small className="hint"> <small className="hint">
An address to an existing Prometheus installation{" "} An address to an existing Prometheus installation{" "}
({"<namespace>/<service>:<port>"}). Lens tries to auto-detect address if left empty. ({"<namespace>/<service>:<port>"}). {productName} tries to auto-detect address if left empty.
</small> </small>
</> </section>
)} )}
</> </>
); );

View File

@ -1,57 +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 React from "react";
import { observer } from "mobx-react";
import { ClusterStore } from "../../../../common/cluster-store";
import { Cluster } from "../../../../main/cluster";
import { autobind } from "../../../utils";
import { Button } from "../../button";
import { ConfirmDialog } from "../../confirm-dialog";
interface Props {
cluster: Cluster;
}
@observer
export class RemoveClusterButton extends React.Component<Props> {
@autobind()
confirmRemoveCluster() {
const { cluster } = this.props;
ConfirmDialog.open({
message: <p>Are you sure you want to remove <b>{cluster.preferences.clusterName}</b> from Lens?</p>,
labelOk: "Yes",
labelCancel: "No",
ok: async () => {
await ClusterStore.getInstance().removeById(cluster.id);
}
});
}
render() {
return (
<Button accent onClick={this.confirmRemoveCluster} className="button-area">
Remove Cluster
</Button>
);
}
}

View File

@ -19,8 +19,6 @@
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/ */
import "./cluster-metrics-setting.scss";
import React from "react"; import React from "react";
import { disposeOnUnmount, observer } from "mobx-react"; import { disposeOnUnmount, observer } from "mobx-react";
import { Cluster } from "../../../../main/cluster"; import { Cluster } from "../../../../main/cluster";

View File

@ -83,6 +83,10 @@
.MenuActions.toolbar .Icon { .MenuActions.toolbar .Icon {
color: $drawerTitleText; color: $drawerTitleText;
} }
.Menu {
box-shadow: none;
}
} }
.drawer-content { .drawer-content {

View File

@ -105,13 +105,11 @@ export class HotbarEntityIcon extends React.Component<Props> {
if (!isPersisted) { if (!isPersisted) {
menuItems.unshift({ menuItems.unshift({
title: "Pin to Hotbar", title: "Pin to Hotbar",
icon: "push_pin",
onClick: () => add(entity, index) onClick: () => add(entity, index)
}); });
} else { } else {
menuItems.unshift({ menuItems.unshift({
title: "Unpin from Hotbar", title: "Unpin from Hotbar",
icon: "push_pin",
onClick: () => remove(entity.metadata.uid) onClick: () => remove(entity.metadata.uid)
}); });
} }

View File

@ -29,7 +29,6 @@ import GraphemeSplitter from "grapheme-splitter";
import { CatalogEntityContextMenu } from "../../../common/catalog"; import { CatalogEntityContextMenu } from "../../../common/catalog";
import { cssNames, IClassName, iter } from "../../utils"; import { cssNames, IClassName, iter } from "../../utils";
import { ConfirmDialog } from "../confirm-dialog"; import { ConfirmDialog } from "../confirm-dialog";
import { Icon } from "../icon";
import { Menu, MenuItem } from "../menu"; import { Menu, MenuItem } from "../menu";
import { MaterialTooltip } from "../+catalog/material-tooltip/material-tooltip"; import { MaterialTooltip } from "../+catalog/material-tooltip/material-tooltip";
import { observer } from "mobx-react"; import { observer } from "mobx-react";
@ -137,7 +136,7 @@ export const HotbarIcon = observer(({menuItems = [], ...props}: Props) => {
{ menuItems.map((menuItem) => { { menuItems.map((menuItem) => {
return ( return (
<MenuItem key={menuItem.title} onClick={() => onMenuItemClick(menuItem) }> <MenuItem key={menuItem.title} onClick={() => onMenuItemClick(menuItem) }>
<Icon material={menuItem.icon} small interactive={true} title={menuItem.title}/> {menuItem.title} {menuItem.title}
</MenuItem> </MenuItem>
); );
})} })}

View File

@ -20,7 +20,7 @@
*/ */
.Menu { .Menu {
--bgc: #{$contentColor}; --bgc: #{$layoutBackground};
position: absolute; position: absolute;
display: flex; display: flex;
@ -29,6 +29,8 @@
list-style: none; list-style: none;
border: 1px solid $borderColor; border: 1px solid $borderColor;
z-index: 101; z-index: 101;
box-shadow: rgba(0,0,0,0.24) 0px 8px 16px 0px;
border-radius: 4px;
&.portal { &.portal {
left: -1000px; left: -1000px;