Skip to content
Snippets Groups Projects
Commit 344a438d authored by Sören Henning's avatar Sören Henning
Browse files

Some grammar/style fixes

parent 884f3182
No related branches found
No related tags found
1 merge request!164Add Theodolite docs
Pipeline #5649 passed
...@@ -11,19 +11,23 @@ Patchers can be seen as functions which take a value as input and modify a Kuber ...@@ -11,19 +11,23 @@ Patchers can be seen as functions which take a value as input and modify a Kuber
## Available Patchers ## Available Patchers
* **ReplicaPatcher**: Allows to modify the number of Replicas for a Kubernetes deployment. * **ReplicaPatcher**: Modifies the number of replicas for a Kubernetes deployment.
* **type**: "ReplicaPatcher" * **type**: "ReplicaPatcher"
* **resource**: "uc1-kstreams-deployment.yaml" * **resource**: "uc1-kstreams-deployment.yaml"
* **NumSensorsLoadGeneratorReplicaPatcher**: Allows to scale the number of load generators. Scales according to the following formula: (value + 15_000 - 1) / 15_000 * **NumSensorsLoadGeneratorReplicaPatcher**: Modifies the number of load generators, according to the following formula: *(value + loadGenMaxRecords - 1) / loadGenMaxRecords*
* **type**: "NumSensorsLoadGeneratorReplicaPatcher" * **type**: "NumSensorsLoadGeneratorReplicaPatcher"
* **resource**: "uc1-load-generator-deployment.yaml" * **resource**: "uc1-load-generator-deployment.yaml"
* **properties**:
* loadGenMaxRecords: 150000
* **NumNestedGroupsLoadGeneratorReplicaPatcher**: Allows to scale the number of load generators. Scales according to the following formula: (4^(value) + 15_000 -1) /15_000 * **NumNestedGroupsLoadGeneratorReplicaPatcher**: Modifies the number of load generators, according to the following formula: *(4^(value) + loadGenMaxRecords - 1) / loadGenMaxRecords*
* **type**: "NumNestedGroupsLoadGeneratorReplicaPatcher" * **type**: "NumNestedGroupsLoadGeneratorReplicaPatcher"
* **resource**: "uc1-load-generator-deployment.yaml" * **resource**: "uc1-load-generator-deployment.yaml"
* **properties**:
* loadGenMaxRecords: 150000
* **EnvVarPatcher**: Allows to modify the value of an environment variable for a container in a Kubernetes deployment. * **EnvVarPatcher**: Modifies the value of an environment variable for a container in a Kubernetes deployment.
* **type**: "EnvVarPatcher" * **type**: "EnvVarPatcher"
* **resource**: "uc1-load-generator-deployment.yaml" * **resource**: "uc1-load-generator-deployment.yaml"
* **properties**: * **properties**:
...@@ -35,23 +39,23 @@ Patchers can be seen as functions which take a value as input and modify a Kuber ...@@ -35,23 +39,23 @@ Patchers can be seen as functions which take a value as input and modify a Kuber
* **resource**: "uc1-load-generator-deployment.yaml" * **resource**: "uc1-load-generator-deployment.yaml"
* **properties**: * **properties**:
* variableName: "env" * variableName: "env"
* **value**: "prod" * **example 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" * **resource**: "uc1-kstreams-deployment.yaml"
* **properties**: * **properties**:
* container: "uc-application" * container: "uc-application"
* variableName: "cpu" or "memory" * variableName: "cpu" or "memory"
* **value**:"1000m" or "2Gi" * **example value**:"1000m" or "2Gi"
* **SchedulerNamePatcher**: Changes the scheduler for Kubernetes resources. * **SchedulerNamePatcher**: Changes the scheduler for Kubernetes resources.
* **type**: "SchedulerNamePatcher" * **type**: "SchedulerNamePatcher"
* **resource**: "uc1-kstreams-deployment.yaml" * **resource**: "uc1-kstreams-deployment.yaml"
* **value**: "random-scheduler" * **example 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" * **type**: "ImagePatcher"
* **resource**: "uc1-kstreams-deployment.yaml" * **resource**: "uc1-kstreams-deployment.yaml"
* **properties**: * **properties**:
* container: "uc-application" * container: "uc-application"
* **value**: "dockerhub-org/image-name" * **example value**: "dockerhub-org/image-name"
...@@ -81,7 +81,7 @@ configMap: ...@@ -81,7 +81,7 @@ configMap:
#### Filesystem #### Filesystem
Alternatively, resources can also be read from the filesystem, Theodolite has access to. This usually requires that the Benchmark resources are available in a volume, which is mounted into the container Theodolite. Alternatively, resources can also be read from the filesystem, Theodolite has access to. This usually requires that the Benchmark resources are available in a volume, which is mounted into the Theodolite container.
```yaml ```yaml
filesystem: filesystem:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment