From 0304415f865256747348319c66e5d3d371e86225 Mon Sep 17 00:00:00 2001
From: David Yastremsky <58150256+dyastremsky@users.noreply.github.com>
Date: Fri, 8 Nov 2024 10:08:13 -0800
Subject: [PATCH] Add authentication instructions to GenAI-Perf tutorial (#170)

---
 genai-perf/README.md                          | 20 +++++++++++++++++++
 .../genai-perf-templates/README_template      | 20 +++++++++++++++++++
 2 files changed, 40 insertions(+)

diff --git a/genai-perf/README.md b/genai-perf/README.md
index 3029d3fe..24e2bb72 100644
--- a/genai-perf/README.md
+++ b/genai-perf/README.md
@@ -309,6 +309,26 @@ inference. Other modes such as the [embeddings](docs/embeddings.md) and
 
 </br>
 
+<!--
+======================
+AUTHENTICATION
+======================
+-->
+
+## Authentication
+
+GenAI-Perf can benchmark secure endpoints such as OpenAI, which require API
+key authentication. To do so, you must add your API key directly in the command.
+At the end of your command, append the below flags. Replace the key with your
+API key. The `--` flag allows arguments to pass directly into Perf Analyzer in
+superuser mode. The `-H` flag is used to add HTTP headers.
+
+```bash
+-- -H "Authorization: Bearer ${API_KEY}" -H "Accept: text/event-stream"
+```
+
+</br>
+
 <!--
 ======================
 METRICS
diff --git a/templates/genai-perf-templates/README_template b/templates/genai-perf-templates/README_template
index 15a7d1ee..c8655bb2 100644
--- a/templates/genai-perf-templates/README_template
+++ b/templates/genai-perf-templates/README_template
@@ -309,6 +309,26 @@ inference. Other modes such as the [embeddings](docs/embeddings.md) and
 
 </br>
 
+<!--
+======================
+AUTHENTICATION
+======================
+-->
+
+## Authentication
+
+GenAI-Perf can benchmark secure endpoints such as OpenAI, which require API
+key authentication. To do so, you must add your API key directly in the command.
+At the end of your command, append the below flags. Replace the key with your
+API key. The `--` flag allows arguments to pass directly into Perf Analyzer in
+superuser mode. The `-H` flag is used to add HTTP headers.
+
+```bash
+-- -H "Authorization: Bearer ${API_KEY}" -H "Accept: text/event-stream"
+```
+
+</br>
+
 <!--
 ======================
 METRICS