add resources key to schema file

Author: josibake

src/warnet/backend/kubernetes_backend.py

@@ -384,33 +384,62 @@ def create_bitcoind_container(self, tank: Tank) -> client.V1Container:
         bitcoind_options = tank.get_bitcoin_conf(peers)
         container_env = [client.V1EnvVar(name="BITCOIN_ARGS", value=bitcoind_options)]
 
-        bitcoind_container = client.V1Container(
-            name=container_name,
-            image=container_image,
-            env=container_env,
-            liveness_probe=client.V1Probe(
+        if tank.resources:
+            resources = client.V1ResourceRequirements(
+                    requests=tank.resources["requests"],
+                    limits=tank.resources["limits"],
+                )
+        else:
+            resources = client.V1ResourceRequirements()
+
+        liveness_probe = client.V1Probe(
                 failure_threshold=3,
                 initial_delay_seconds=5,
                 period_seconds=5,
                 timeout_seconds=1,
                 _exec=client.V1ExecAction(command=["pidof", "bitcoind"]),
-            ),
-            readiness_probe=client.V1Probe(
+        )
+        readiness_probe = client.V1Probe(
                 failure_threshold=1,
                 initial_delay_seconds=0,
                 period_seconds=1,
                 timeout_seconds=1,
                 tcp_socket=client.V1TCPSocketAction(port=tank.rpc_port),
-            ),
-            security_context=client.V1SecurityContext(
+        )
+        security_context = client.V1SecurityContext(
                 privileged=True,
                 capabilities=client.V1Capabilities(add=["NET_ADMIN", "NET_RAW"]),
-            ),
         )
-        self.log.debug(
-            f"Created bitcoind container for tank {tank.index} using {bitcoind_options=:}"
-        )
-        return bitcoind_container
+        if tank.resources:
+            bitcoind_container = client.V1Container(
+                name=container_name,
+                image=container_image,
+                env=container_env,
+                liveness_probe=liveness_probe,
+                readiness_probe=readiness_probe,
+                security_context=security_context,
+                resources=client.V1ResourceRequirements(
+                    requests=tank.resources["requests"],
+                    limits=tank.resources["limits"],
+                ),
+            )
+            self.log.debug(
+                f"Created bitcoind container for tank {tank.index} using {bitcoind_options=:}"
+            )
+            return bitcoind_container
+        else:
+            bitcoind_container = client.V1Container(
+                name=container_name,
+                image=container_image,
+                env=container_env,
+                liveness_probe=liveness_probe,
+                readiness_probe=readiness_probe,
+                security_context=security_context,
+            )
+            self.log.debug(
+                f"Created bitcoind container for tank {tank.index} using {bitcoind_options=:}"
+            )
+            return bitcoind_container
 
     def create_prometheus_container(self, tank) -> client.V1Container:
         env = [

src/warnet/cli/graph.py

@@ -40,7 +40,8 @@ def create(number: int, outfile: Path, version: str, bitcoin_conf: Path, random:
 @click.option("--outfile", type=click.Path())
 @click.option("--cb", type=str)
 @click.option("--ln_image", type=str)
-def import_json(infile: Path, outfile: Path, cb: str, ln_image: str):
+@click.option("--ci", is_flag=True)
+def import_json(infile: Path, outfile: Path, cb: str, ln_image: str, ci: bool = False):
     """
     Create a cycle graph with nodes imported from lnd `describegraph` JSON file,
     and additionally include 7 extra random outbounds per node. Include lightning
@@ -64,6 +65,8 @@ def import_json(infile: Path, outfile: Path, cb: str, ln_image: str):
             graph.nodes[n]["ln_cb_image"] = cb
         if ln_image:
             graph.nodes[n]["ln_image"] = ln_image
+        if ci:
+            graph.nodes[n]["resources"] = "{}"
 
     # Save a map of LN pubkey -> Tank index
     ln_ids = {}

src/warnet/graph_schema.json

@@ -16,66 +16,79 @@
   "node": {
     "type": "object",
     "properties": {
-      "version": {
-        "type": "string",
-        "comment": "Bitcoin Core version with an available Warnet tank image on Dockerhub. May also be a GitHub repository with format user/repository:branch to build from source code"},
       "image": {
         "type": "string",
-        "comment": "Bitcoin Core Warnet tank image on Dockerhub with the format repository/image:tag"},
+        "default": "bitcoindevproject/bitcoin:27.0",
+        "comment": "Bitcoin Core Warnet tank image on Dockerhub with the format repository/image:tag"
+      },
       "bitcoin_config": {
         "type": "string",
         "default": "",
-        "comment": "A string of Bitcoin Core options in command-line format, e.g. '-debug=net -blocksonly'"},
+        "comment": "A string of Bitcoin Core options in command-line format, e.g. '-debug=net -blocksonly'"
+      },
       "tc_netem": {
         "type": "string",
-        "comment": "A tc-netem command as a string beginning with 'tc qdisc add dev eth0 root netem'"},
+        "comment": "A tc-netem command as a string beginning with 'tc qdisc add dev eth0 root netem'"
+      },
       "exporter": {
         "type": "boolean",
         "default": false,
-        "comment": "Whether to attach a Prometheus data exporter to the tank"},
+        "comment": "Whether to attach a Prometheus data exporter to the tank"
+      },
       "metrics": {
         "type": "string",
-        "comment": "A space-separated string of RPC queries to scrape by Prometheus"},
+        "comment": "A space-separated string of RPC queries to scrape by Prometheus"
+      },
       "collect_logs": {
         "type": "boolean",
-        "default": false,
-        "comment": "Whether to collect Bitcoin Core debug logs with Promtail"},
+        "default": true,
+        "comment": "Whether to collect Bitcoin Core debug logs with Promtail"
+      },
       "build_args": {
         "type": "string",
         "default": "",
-        "comment": "A string of configure options used when building Bitcoin Core from source code, e.g. '--without-gui --disable-tests'"},
+        "comment": "A string of configure options used when building Bitcoin Core from source code, e.g. '--without-gui --disable-tests'"
+      },
       "ln": {
         "type": "string",
-        "comment": "Attach a lightning network node of this implementation (currently only supports 'lnd' or 'cln')"},
+        "comment": "Attach a lightning network node of this implementation (currently only supports 'lnd' or 'cln')"
+      },
       "ln_image": {
         "type": "string",
-        "comment": "Specify a lightning network node image from Dockerhub with the format repository/image:tag"},
+        "comment": "Specify a lightning network node image from Dockerhub with the format repository/image:tag"
+      },
       "ln_cb_image": {
         "type": "string",
-        "comment": "Specify a lnd Circuit Breaker image from Dockerhub with the format repository/image:tag"},
+        "comment": "Specify a lnd Circuit Breaker image from Dockerhub with the format repository/image:tag"
+      },
       "ln_config": {
         "type": "string",
-        "comment": "A string of arguments for the lightning network node in command-line format, e.g. '--protocol.wumbo-channels --bitcoin.timelockdelta=80'"}
+        "comment": "A string of arguments for the lightning network node in command-line format, e.g. '--protocol.wumbo-channels --bitcoin.timelockdelta=80'"
+      },
+      "resources": {
+        "type": "string",
+        "comment": "Kubernetes resource requests and limits for the node",
+        "default": "{'requests':{'cpu':'500m', 'memory':'500Mi'}, 'limits':{'cpu':'1000m', 'memory':'1500Mi'}}"
+      }
     },
-    "additionalProperties": false,
-    "oneOf": [
-      {"required": ["version"]},
-      {"required": ["image"]}
-    ],
+   "additionalProperties": false,
     "required": []
   },
   "edge": {
     "type": "object",
     "properties": {
       "channel_open": {
         "type": "string",
-        "comment": "Indicate that this edge is a lightning channel with these arguments passed to lnd openchannel"},
+        "comment": "Indicate that this edge is a lightning channel with these arguments passed to lnd openchannel"
+      },
       "source_policy": {
         "type": "string",
-        "comment": "Update the channel originator policy by passing these arguments passed to lnd updatechanpolicy"},
+        "comment": "Update the channel originator policy by passing these arguments passed to lnd updatechanpolicy"
+      },
       "target_policy": {
         "type": "string",
-        "comment": "Update the channel partner policy by passing these arguments passed to lnd updatechanpolicy"}
+        "comment": "Update the channel partner policy by passing these arguments passed to lnd updatechanpolicy"
+      }
     },
     "additionalProperties": false,
     "required": []

src/warnet/tank.py

@@ -46,6 +46,7 @@ def __init__(self, index: int, warnet):
         self.bitcoin_network = warnet.bitcoin_network
         self.version: str = ""
         self.image: str = ""
+        self.resources: dict = dict()
         self.bitcoin_config = ""
         self.netem = None
         self.exporter = False
@@ -81,7 +82,10 @@ def parse_graph_node(self, node):
             value = node.get(property, specs.get("default"))
             if property == "version":
                 self._parse_version(value)
-            setattr(self, property, value)
+            if property == "resources":
+                setattr(self, property, eval(value))
+            else:
+                setattr(self, property, value)
             graph_properties[property] = value
 
         if self.version and self.image:

src/warnet/utils.py

@@ -421,15 +421,8 @@ def create_cycle_graph(n: int, version: str, bitcoin_conf: str | None, random_ve
                 conf_contents = dump_bitcoin_conf(conf_dict, for_graph=True)
 
     # populate our custom fields
-    for i, node in enumerate(graph.nodes()):
-        if random_version:
-            graph.nodes[node]["version"] = random.choice(WEIGHTED_TAGS)
-        else:
-            # One node demoing the image tag
-            if i == 1:
-                graph.nodes[node]["image"] = f"bitcoindevproject/bitcoin:{version}"
-            else:
-                graph.nodes[node]["version"] = version
+    for node in graph.nodes():
+        graph.nodes[node]["image"] = f"bitcoindevproject/bitcoin:{version}"
         graph.nodes[node]["bitcoin_config"] = conf_contents
         graph.nodes[node]["tc_netem"] = ""
         graph.nodes[node]["build_args"] = ""

test/data/services.graphml

@@ -11,6 +11,7 @@
   <key id="ln_image"        attr.name="ln_image"         attr.type="string"   for="node" />
   <key id="ln_cb_image"     attr.name="ln_cb_image"      attr.type="string"   for="node" />
   <key id="ln_config"       attr.name="ln_config"        attr.type="string"   for="node" />
+  <key id="resources"       attr.name="resources"        attr.type="string"   for="node" />
   <key id="channel_open"    attr.name="channel_open"     attr.type="string"   for="edge" />
   <key id="source_policy"   attr.name="source_policy"    attr.type="string"   for="edge" />
   <key id="target_policy"   attr.name="target_policy"    attr.type="string"   for="edge" />
@@ -21,6 +22,7 @@
         <data key="bitcoin_config">-uacomment=w0 -debug=validation</data>
         <data key="exporter">true</data>
         <data key="ln">lnd</data>
+        <data key="resources">{'requests':{'cpu':'25m', 'memory':'100Mi'}, 'limits':{'cpu':'100m', 'memory':'250Mi'}}</data>
     </node>
   </graph>
 </graphml>

test/graph_test.py

@@ -41,7 +41,7 @@ def test_graph_creation_and_import(self):
         self.log.info(f"CLI tool importing json and writing test graph file: {self.tf_import}")
         self.log.info(
             self.warcli(
-                f"graph import-json {self.json_file_path} --outfile={self.tf_import} --ln_image=carlakirkcohen/lnd:attackathon --cb=carlakirkcohen/circuitbreaker:attackathon-test",
+                f"graph import-json {self.json_file_path} --outfile={self.tf_import} --ln_image=carlakirkcohen/lnd:attackathon --cb=carlakirkcohen/circuitbreaker:attackathon-test --ci",
                 network=False,
             )
         )