Skip to content

Commit b795fea

Browse files
minior changes
Signed-off-by: Kushal Shukla <kushalshukla110@gmail.com>
1 parent 2c1f884 commit b795fea

File tree

3 files changed

+16
-15
lines changed

3 files changed

+16
-15
lines changed

prombench/docs/eks.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,8 @@ In this setup, you have two choices:
115115
Here’s how each option works:
116116
- **Option 1: Download data from object storage**
117117

118-
To download data from object storage, create a Kubernetes secret with exact named `bucket-secret` and file name ```object-config.yml``` with the necessary credentials as per your object storage. This secret enables access to the stored data.
119-
> Note: Make sure this secret applied before ```3b_prometheus-test_deployment.yaml```
118+
To download data from object storage, create a Kubernetes secret with exact named `bucket-secret` and file name `object-config.yml` with the necessary credentials as per your object storage. This secret enables access to the stored data.
119+
> Note: Make sure this secret applied before `3b_prometheus-test_deployment.yaml`
120120

121121
- **Option 2: Skip downloading data**
122122

@@ -132,8 +132,9 @@ metadata:
132132
type: Opaque
133133
stringData:
134134
object-config.yml:
135+
```
135136

136-
Regardless of the option chosen, data stored in Prometheus will only be retained based on the configured retention settings (`--storage.tsdb.retention.size`).
137+
Regardless of the option chosen, data stored in Prometheus will only be retained based on the configured retention settings (```--storage.tsdb.retention.size```).
137138

138139
> **⚠️ Warning:** The benchmark will change its basis when the retention size limit is reached and older downloaded blocks are deleted. Ensure that you have sufficient retention settings configured to avoid data loss that could affect benchmarking results.
139140

prombench/docs/gke.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -96,17 +96,16 @@ Run Prombench tests in [Google Kubernetes Engine (GKE)](https://cloud.google.com
9696
```bash
9797
make node_create
9898
```
99-
3. **Setting Up Benchmarking Data**
100-
101-
When setting up a benchmarking environment, it’s often useful to have pre-generated data available.This data can help speed up testing and make benchmarks more realistic by simulating actual workloads.
99+
3. **Setting Up Benchmarking Data**
100+
When setting up a benchmarking environment, it’s often useful to have pre-generated data available.This data can help speed up testing and make benchmarks more realistic by simulating actual workloads.
102101

103102
In this setup, you have two choices:
104103

105104
Here’s how each option works:
106105
- **Option 1: Download data from object storage**
107106

108-
To download data from object storage, create a Kubernetes secret with exact named `bucket-secret` and file name ```object-config.yml``` with the necessary credentials as per your object storage. This secret enables access to the stored data.
109-
> Note: Make sure this secret applied before ```3b_prometheus-test_deployment.yaml```
107+
To download data from object storage, create a Kubernetes secret with exact named `bucket-secret` and file name `object-config.yml` with the necessary credentials as per your object storage. This secret enables access to the stored data.
108+
> Note: Make sure this secret applied before `3b_prometheus-test_deployment.yaml`
110109

111110
- **Option 2: Skip downloading data**
112111

@@ -122,8 +121,9 @@ metadata:
122121
type: Opaque
123122
stringData:
124123
object-config.yml:
124+
```
125125

126-
Regardless of the option chosen, data stored in Prometheus will only be retained based on the configured retention settings (`--storage.tsdb.retention.size`).
126+
Regardless of the option chosen, data stored in Prometheus will only be retained based on the configured retention settings (```--storage.tsdb.retention.size```).
127127

128128
> **⚠️ Warning:** The benchmark will change its basis when the retention size limit is reached and older downloaded blocks are deleted. Ensure that you have sufficient retention settings configured to avoid data loss that could affect benchmarking results.
129129

prombench/docs/kind.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -114,17 +114,16 @@ If used with the GitHub integration:
114114
export PR_NUMBER=<PR to benchmark against the selected $RELEASE>
115115
```
116116

117-
2. ### Setting Up Benchmarking Data
118-
119-
When setting up a benchmarking environment, it’s often useful to have pre-generated data available.This data can help speed up testing and make benchmarks more realistic by simulating actual workloads.
117+
3. **Setting Up Benchmarking Data**
118+
When setting up a benchmarking environment, it’s often useful to have pre-generated data available.This data can help speed up testing and make benchmarks more realistic by simulating actual workloads.
120119

121120
In this setup, you have two choices:
122121

123122
Here’s how each option works:
124123
- **Option 1: Download data from object storage**
125124

126-
To download data from object storage, create a Kubernetes secret with exact named `bucket-secret` and file name ```object-config.yml``` with the necessary credentials as per your object storage. This secret enables access to the stored data.
127-
> Note: Make sure this secret applied before ```3b_prometheus-test_deployment.yaml```
125+
To download data from object storage, create a Kubernetes secret with exact named `bucket-secret` and file name `object-config.yml` with the necessary credentials as per your object storage. This secret enables access to the stored data.
126+
> Note: Make sure this secret applied before `3b_prometheus-test_deployment.yaml`
128127
129128
- **Option 2: Skip downloading data**
130129

@@ -140,8 +139,9 @@ metadata:
140139
type: Opaque
141140
stringData:
142141
object-config.yml:
142+
```
143143
144-
Regardless of the option chosen, data stored in Prometheus will only be retained based on the configured retention settings (`--storage.tsdb.retention.size`).
144+
Regardless of the option chosen, data stored in Prometheus will only be retained based on the configured retention settings (```--storage.tsdb.retention.size```).
145145

146146
> **⚠️ Warning:** The benchmark will change its basis when the retention size limit is reached and older downloaded blocks are deleted. Ensure that you have sufficient retention settings configured to avoid data loss that could affect benchmarking results.
147147

0 commit comments

Comments
 (0)