Skip to content

Commit

Permalink
minior changes
Browse files Browse the repository at this point in the history
Signed-off-by: Kushal Shukla <[email protected]>
  • Loading branch information
kushalShukla-web committed Nov 21, 2024
1 parent 2c1f884 commit 3e834aa
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 17 deletions.
7 changes: 4 additions & 3 deletions prombench/docs/eks.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,8 @@ In this setup, you have two choices:
Here’s how each option works:
- **Option 1: Download data from object storage**

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.
> Note: Make sure this secret applied before ```3b_prometheus-test_deployment.yaml```
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.
> Note: Make sure this secret applied before `3b_prometheus-test_deployment.yaml`

- **Option 2: Skip downloading data**

Expand All @@ -132,8 +132,9 @@ metadata:
type: Opaque
stringData:
object-config.yml:
```

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

> **⚠️ 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.

Expand Down
12 changes: 6 additions & 6 deletions prombench/docs/gke.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,17 +96,16 @@ Run Prombench tests in [Google Kubernetes Engine (GKE)](https://cloud.google.com
```bash
make node_create
```
3. **Setting Up Benchmarking Data**

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.
3. **Setting Up Benchmarking Data**
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.

In this setup, you have two choices:

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

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.
> Note: Make sure this secret applied before ```3b_prometheus-test_deployment.yaml```
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.
> Note: Make sure this secret applied before `3b_prometheus-test_deployment.yaml`

- **Option 2: Skip downloading data**

Expand All @@ -122,8 +121,9 @@ metadata:
type: Opaque
stringData:
object-config.yml:
```

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

> **⚠️ 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.

Expand Down
12 changes: 6 additions & 6 deletions prombench/docs/kind.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,17 +114,16 @@ If used with the GitHub integration:
export PR_NUMBER=<PR to benchmark against the selected $RELEASE>
```

2. ### Setting Up Benchmarking Data

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.
3. **Setting Up Benchmarking Data**
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.

In this setup, you have two choices:

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

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.
> Note: Make sure this secret applied before ```3b_prometheus-test_deployment.yaml```
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.
> Note: Make sure this secret applied before `3b_prometheus-test_deployment.yaml`

- **Option 2: Skip downloading data**

Expand All @@ -140,8 +139,9 @@ metadata:
type: Opaque
stringData:
object-config.yml:
```

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

> **⚠️ 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.

Expand Down
4 changes: 2 additions & 2 deletions tools/prometheus-builder/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ git checkout pr-branch
# where it will copy the key.yml file from the Prometheus directory to the volume section of the
# emptyDir. This file will later be used by the data-downloader init container.
if [ -f "$DIR/key.yml" ]; then
echo "INFO:: key.yml file is Present on $DIR/key.yml directory."
echo "INFO:: key.yml file is Present on $DIR/key.yml directory so download the block from ObjecStorage."
cp "$DIR/key.yml" "$STORAGE/key.yml"
else
echo "INFO:: key.yml File does not exist on $DIR/key.yml directory."
echo "INFO:: key.yml File does not exist on $DIR/key.yml directory so data is not downloaded from ObjectStorage."
fi

echo ">> Creating prometheus binaries"
Expand Down

0 comments on commit 3e834aa

Please sign in to comment.