locate operation has stage for grafana

Author: xavier

prom-plugin/kaml/prom_kaml/assets/locate-existing-grafana.md

@@ -0,0 +1,9 @@
+# How this works
+
+The NMachine Prometheus Plugin has limited interoperability with
+Grafana. Namely, it provides a handy link (or port-forward), 
+and it can report on the worload's health if it is in the cluster.
+
+### If you don't have Grafana
+
+That's okay. The plugin mainly uses the Prometheus API.

prom-plugin/kaml/prom_kaml/kaml.py

@@ -1,8 +1,6 @@
 import os
 from typing import List, Dict, Type
 
-from kama_sdk.core.core.config_man import config_man
-
 from kama_sdk.core.core.kaml import KamlDescriptor
 from kama_sdk.core.core import utils
 from kama_sdk.model.base.model import Model

prom-plugin/kaml/prom_kaml/main/prom_client.py

@@ -1,10 +1,9 @@
-import json
 import time
 import traceback
 from datetime import datetime, timedelta
 from functools import lru_cache
 from json import JSONDecodeError
-from typing import Optional, Dict, Tuple
+from typing import Optional, Dict, Tuple, Any
 from urllib.parse import quote
 
 import requests
@@ -49,27 +48,30 @@ def do_invoke(self, path: str, url_args: Dict) -> Optional[PromData]:
 
   @lru_cache(maxsize=1)
   def find_server_svc(self) -> Optional[KatSvc]:
-    if config := self.config():
-      prom_ns = config.get(SVC_NS_KEY)
-      prom_name = config.get(SVC_NAME_KEY)
+    if self.config():
+      prom_ns = self.read_config(SVC_NS_KEY)
+      prom_name = self.read_config(SVC_NS_KEY)
       return KatSvc.find(prom_name, prom_ns)
 
+  def read_config(self, deep_key: str) -> Optional[Any]:
+    return utils.deep_get2(self.config(), deep_key)
+
   def config(self) -> Optional[Dict]:
     if self._config is None:
       root = config_man.manifest_variables(space='nmachine.prom')
       self._config = root
     return self._config
 
   def is_prom_server_in_cluster(self) -> bool:
-    return self.config().get(ACCESS_TYPE_KEY) == access_type_k8s
+    return self.read_config(ACCESS_TYPE_KEY) == access_type_k8s
 
   def get_base_in_cluster_url(self) -> str:
     if svc := self.find_server_svc():
       port = svc.first_tcp_port_num()
       return f"http://{svc.name}.{svc.namespace}:{port}"
 
   def get_base_out_of_cluster_url(self) -> str:
-    return self.config().get(URL_KEY)
+    return self.read_config(URL_KEY)
 
 
 def instant_path_and_args(query: str, ts: datetime = None) -> Tuple:
@@ -145,7 +147,7 @@ def invoke_pure_http(path, args) -> Optional[Dict]:
 access_type_k8s = 'kubernetes'
 access_type_generic = 'generic'
 
-URL_KEY = 'url'
-SVC_NS_KEY = 'service_namespace'
-SVC_NAME_KEY = 'service_name'
-ACCESS_TYPE_KEY = 'access_type'
+URL_KEY = 'prometheus.url'
+SVC_NS_KEY = 'prometheus.service_namespace'
+SVC_NAME_KEY = 'prometheus.service_name'
+ACCESS_TYPE_KEY = 'prometheus.access_type'

prom-plugin/kaml/prom_kaml/main/prom_data_supplier.py

@@ -12,6 +12,8 @@ class PromDataSupplier(Supplier):
 
   @cached_property
   def client(self) -> Optional[PromClient]:
+    print("INIT CONFIG")
+    print(self.client_config_root)
     if config := self.client_config_root:
       return PromClient(config)
     else:
@@ -58,8 +60,6 @@ def resolve(self) -> Union[PromMatrix, PromVector]:
       print(f"[kama_sdk:prom_supplier] bad req type {self._type}")
       response = None
 
-    print("sup RETURNNNNNNNNNNNNNNN")
-    print(response)
     return response
 
   def fetch_matrix(self) -> Optional[PromMatrix]:

prom-plugin/kaml/prom_kaml/yamls/operation/field-set.yaml

@@ -0,0 +1,12 @@
+kind: Operation
+id: nmachine.prom.operation.locate-existing
+title: Locate an existing Prometheus Server
+info: "Point the application to a Prometheus server that is already
+or is capable of monitoring the application"
+synopsis: assets::locate-existing-server.md
+tags: ['monitoring']
+labels:
+  public: true
+stages:
+  - id::nmachine.prom.stage.locate-existing-prom
+  - id::nmachine.prom.stage.locate-existing-grafana

prom-plugin/kaml/prom_kaml/yamls/operation/fields.yaml

@@ -0,0 +1,80 @@
+kind: Stage
+id: nmachine.prom.stage.locate-existing-grafana
+title: Locate Grafana Server
+info: "If you have a monitoring service inside
+ or outside in your cluster,
+you can point this application to it in order to give
+Nectar data capabilities"
+
+steps:
+  - id: nmachine.prom.step.locate-existing-grafana
+    title: Location the Grafana Homepage
+    info: "State whether the server is inside or outside
+    the cluster, and point to it."
+    synopsis: assets::locate-existing-grafana.md
+
+    commit:
+      standard:
+        kind: MergeSupplier
+        source: [get::props default_commit->.standard, {enabled: true}]
+
+    action:
+      kind: MultiAction
+      inherit: sdk.action.step_apply_application_manifest_e2e_action
+      config_space: nmachine.prom
+
+    fields:
+      - id::grafana.access_type
+      - id::grafana.url
+      - id::grafana.service_namespace
+      - id::grafana.service_name
+
+    summary_desc: get::nmachine.prom.locate_op_summary
+
+---
+
+kind: Field
+id: grafana.access_type
+variable: id::grafana.access_type
+
+---
+
+kind: Field
+id: grafana.url
+variable: id::grafana.url
+visible:
+  kind: Predicate
+  challenge: get::props inputs->.grafana.access_type
+  check_against: generic
+
+---
+
+kind: Field
+id: grafana.service_namespace
+variable: id::grafana.service_namespace
+visible:
+  kind: Predicate
+  challenge: get::props inputs->.grafana.access_type
+  check_against: kubernetes
+
+---
+
+kind: Field
+id: grafana.service_name
+visible:
+  kind: Predicate
+  challenge: get::props inputs->.grafana.service_namespace
+  operator: presence
+variable:
+  kind: ManifestVariable
+  inherit: grafana.service_name
+  input:
+    kind: SelectInput
+    options:
+      kind: ResourcesSupplier
+      many: true
+      selector:
+        res_kind: Service
+        namespace: "get::props inputs->.grafana.service_namespace"
+      output: options_format
+      serializer: legacy

prom-plugin/kaml/prom_kaml/yamls/operation/locate-existing-prom-operation.yaml

@@ -0,0 +1,93 @@
+kind: Stage
+id: nmachine.prom.stage.locate-existing-prom
+title: Locate Prometheus API
+info: "If you have a monitoring service inside
+ or outside in your cluster,
+you can point this application to it in order to give
+Nectar data capabilities"
+
+steps:
+  - id: nmachine.prom.step.locate-existing-prom
+    title: Locate Prometheus API
+    info: "State whether the server is inside or outside
+    the cluster, and point to it."
+    synopsis: assets::locate-existing-server.md
+
+    commit:
+      standard:
+        kind: MergeSupplier
+        source: [get::props default_commit->.standard, {enabled: true}]
+
+    action:
+      kind: MultiAction
+      inherit: sdk.action.step_apply_application_manifest_e2e_action
+      config_space: nmachine.prom
+
+    fields:
+      - id::prometheus.access_type
+      - id::prometheus.url
+      - id::prometheus.service_namespace
+      - id::prometheus.service_name
+
+    summary_desc: get::nmachine.prom.locate_op_summary
+
+---
+
+id: sdk.misc.ping-monitoring-server
+kind: MultiAction
+sub_actions:
+  - sdk.action.commit_step_values_action
+  - kind: RunPredicatesAction
+    title: Try to reach monitoring server
+    info: Send HTTP to ${endpoint}
+    endpoint: get::sdk.supplier.config.prefs .monitoring.url
+
+---
+
+kind: Field
+id: prometheus.access_type
+variable: id::prometheus.access_type
+
+---
+
+kind: Field
+id: prometheus.url
+variable: id::prometheus.url
+visible:
+  kind: Predicate
+  print_debug: [inputs]
+  challenge: get::props inputs->.prometheus.access_type
+  check_against: generic
+
+---
+
+kind: Field
+id: prometheus.service_namespace
+variable: id::prometheus.service_namespace
+visible:
+  kind: Predicate
+  print_debug: [inputs]
+  challenge: get::props inputs->.prometheus.access_type
+  check_against: kubernetes
+
+---
+
+kind: Field
+id: prometheus.service_name
+visible:
+  kind: Predicate
+  challenge: get::props inputs->.prometheus.service_namespace
+  operator: presence
+variable:
+  kind: ManifestVariable
+  inherit: prometheus.service_name
+  input:
+    kind: SelectInput
+    options:
+      kind: ResourcesSupplier
+      many: true
+      selector:
+        res_kind: Service
+        namespace: "get::props inputs->.prometheus.service_namespace"
+      output: options_format
+      serializer: legacy