From 7265f9d452e558be9244466aacfbe98d2cd21b2b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=B6ren=20Henning?= <soeren.henning@email.uni-kiel.de>
Date: Fri, 19 Nov 2021 17:46:57 +0100
Subject: [PATCH] Update patcher docs
---
docs/patchers.md | 34 ++++++++++++++++++++--------------
1 file changed, 20 insertions(+), 14 deletions(-)
diff --git a/docs/patchers.md b/docs/patchers.md
index 572f107fb..9418f6494 100644
--- a/docs/patchers.md
+++ b/docs/patchers.md
@@ -1,50 +1,56 @@
-## Patchers
+---
+title: Patchers
+has_children: false
+#nav_order: 1
+---
-* **ReplicaPatcher**: Allows to modify the number of Replicas for a kubernetes deployment.
+# Patchers
+
+Patchers can be seen as functions which take a value as input and modify a Kubernetes resource in a patcher-specific way.
+
+## Available Patchers
+
+* **ReplicaPatcher**: Allows to modify the number of Replicas for a Kubernetes deployment.
* **type**: "ReplicaPatcher"
* **resource**: "uc1-kstreams-deployment.yaml"
-* **NumSensorsLoadGeneratorReplicaPatcher**: Allows to scale the nummer of load generators. Scales arcording to the following formular: (value + 15_000 - 1) / 15_000
+* **NumSensorsLoadGeneratorReplicaPatcher**: Allows to scale the number of load generators. Scales according to the following formula: (value + 15_000 - 1) / 15_000
* **type**: "NumSensorsLoadGeneratorReplicaPatcher"
* **resource**: "uc1-load-generator-deployment.yaml"
-* **NumNestedGroupsLoadGeneratorReplicaPatcher**: Allows to scale the nummer of load generators. Scales arcording to the following formular: (4^(value) + 15_000 -1) /15_000
+* **NumNestedGroupsLoadGeneratorReplicaPatcher**: Allows to scale the number of load generators. Scales according to the following formula: (4^(value) + 15_000 -1) /15_000
* **type**: "NumNestedGroupsLoadGeneratorReplicaPatcher"
* **resource**: "uc1-load-generator-deployment.yaml"
-* **ReplicaPatcher**: Allows to modify the number of Replicas for a kubernetes deployment.
- * **type**: "ReplicaPatcher"
- * **resource**: "uc1-kstreams-deployment.yaml"
-
-* **EnvVarPatcher**: Allows to modify the value of an environment variable for a container in a kubernetes deployment.
+* **EnvVarPatcher**: Allows to modify the value of an environment variable for a container in a Kubernetes deployment.
* **type**: "EnvVarPatcher"
* **resource**: "uc1-load-generator-deployment.yaml"
* **properties**:
* container: "workload-generator"
* variableName: "NUM_SENSORS"
-* **NodeSelectorPatcher**: Changes the node selection field in kubernetes resources.
+* **NodeSelectorPatcher**: Changes the node selection field in Kubernetes resources.
* **type**: "NodeSelectorPatcher"
* **resource**: "uc1-load-generator-deployment.yaml"
* **properties**:
* variableName: "env"
* **value**: "prod"
-* **ResourceLimitPatcher**: Changes the resource limit for a kubernetes resource.
+* **ResourceLimitPatcher**: Changes the resource limit for a Kubernetes resource.
* **resource**: "uc1-kstreams-deployment.yaml"
* **properties**:
* container: "uc-application"
* variableName: "cpu" or "memory"
* **value**:"1000m" or "2Gi"
-* **SchedulerNamePatcher**: Changes the sheduler for kubernetes resources.
+* **SchedulerNamePatcher**: Changes the scheduler for Kubernetes resources.
* **type**: "SchedulerNamePatcher"
* **resource**: "uc1-kstreams-deployment.yaml"
* **value**: "random-scheduler"
-* **ImagePatcher**: Changes the image of a kubernetes resource. Currently not fully implemented.
+* **ImagePatcher**: Changes the image of a Kubernetes resource. Currently not fully implemented.
* **type**: "ImagePatcher"
* **resource**: "uc1-kstreams-deployment.yaml"
* **properties**:
* container: "uc-application"
- * **value**: "dockerhubrepo/imagename"
+ * **value**: "dockerhub-org/image-name"
--
GitLab