From 5d44e69f0f87b1556e671c26c4153b9fb155d7a7 Mon Sep 17 00:00:00 2001 From: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com> Date: Wed, 17 Jul 2024 14:10:29 -0400 Subject: [PATCH] creates Google vertex guide for ESS (#5549) --- docs/AI-for-security/ai-for-security.asciidoc | 1 + .../connect-to-vertex.asciidoc | 119 ++++++++++++++++++ .../connector-guides-landing-pg.asciidoc | 1 + 3 files changed, 121 insertions(+) create mode 100644 docs/AI-for-security/connect-to-vertex.asciidoc diff --git a/docs/AI-for-security/ai-for-security.asciidoc b/docs/AI-for-security/ai-for-security.asciidoc index 01974f06e8..0364ad951e 100644 --- a/docs/AI-for-security/ai-for-security.asciidoc +++ b/docs/AI-for-security/ai-for-security.asciidoc @@ -15,6 +15,7 @@ include::connector-guides-landing-pg.asciidoc[leveloffset=+1] include::connect-to-azure-openai.asciidoc[leveloffset=+2] include::connect-to-bedrock.asciidoc[leveloffset=+2] include::connect-to-openai.asciidoc[leveloffset=+2] +include::connect-to-vertex.asciidoc[leveloffset=+2] include::connect-to-byo.asciidoc[leveloffset=+2] diff --git a/docs/AI-for-security/connect-to-vertex.asciidoc b/docs/AI-for-security/connect-to-vertex.asciidoc new file mode 100644 index 0000000000..5cd253f7fb --- /dev/null +++ b/docs/AI-for-security/connect-to-vertex.asciidoc @@ -0,0 +1,119 @@ +[[connect-to-vertex]] += Connect to Google Vertex + +:frontmatter-description: Set up a Google Vertex LLM connector. +:frontmatter-tags-products: [security] +:frontmatter-tags-content-type: [guide] +:frontmatter-tags-user-goals: [get-started] + +This page provides step-by-step instructions for setting up a Google Vertex AI connector for the first time. This connector type enables you to leverage Vertex AI's large language models (LLMs) within {elastic-sec}. You'll first need to enable Vertex AI, then generate an API key, and finally configure the connector in your {elastic-sec} project. + +IMPORTANT: Before continuing, you should have an active project in one of Google Vertex AI's https://cloud.google.com/vertex-ai/docs/general/locations#feature-availability[supported regions]. + +[discrete] +== Enable the Vertex AI API + +1. Log in to the GCP console and navigate to **Vertex AI → Vertex AI Studio → Overview**. +2. If you're new to Vertex AI, the **Get started with Vertex AI Studio** popup appears. Click **Vertex AI API**, then click **ENABLE**. + +The following video demonstrates these steps. + +======= +++++ + + +
+++++ +======= + +NOTE: For more information about enabling the Vertex AI API, refer to https://cloud.google.com/vertex-ai/docs/start/cloud-environment[Google's documentation]. + +[discrete] +== Create a Vertex AI service account + +1. In the GCP console, navigate to **APIs & Services → Library**. +2. Search for **Vertex AI API**, select it, and click **MANAGE**. +3. In the left menu, navigate to **Credentials** then click **+ CREATE CREDENTIALS** and select **Service account**. +4. Name the new service account, then click **CREATE AND CONTINUE**. +5. Under **Select a role**, select **Vertex AI User**, then click **CONTINUE**. +6. Click **Done**. + +The following video demonstrates these steps. + +======= +++++ + + +
+++++ +======= + +[discrete] +== Generate an API key + +1. Return to Vertex AI's **Credentials** menu and click **Manage service accounts**. +2. Search for the service account you just created, select it, then click the link that appears under **Email**. +3. Go to the **KEYS** tab, click **ADD KEY**, then select **Create new key**. +4. Select **JSON**, then click **CREATE** to download the key. Keep it somewhere secure. + +The following video demonstrates these steps. + +======= +++++ + + +
+++++ +======= + +[discrete] +== Configure the Google Gemini connector + +Finally, configure the connector in your Elastic deployment: + +1. Log in to your Elastic deployment. +2. Navigate to **Stack Management → Connectors → Create Connector → Google Gemini**. +3. Name your connector to help keep track of the model version you are using. +4. Under **URL**, enter the URL for your region. +5. Enter your **GCP Region** and **GCP Project ID**. +6. Under **Default model**, specify either `gemini-1.5.pro` or `gemini-1.5-flash`. https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models[Learn more about the models]. +7. Under **Authentication**, enter your API key. +8. Click **Save**. + +The following video demonstrates these steps. + +======= +++++ + + +
+++++ +======= diff --git a/docs/AI-for-security/connector-guides-landing-pg.asciidoc b/docs/AI-for-security/connector-guides-landing-pg.asciidoc index 9e0c68205d..aa08cfad26 100644 --- a/docs/AI-for-security/connector-guides-landing-pg.asciidoc +++ b/docs/AI-for-security/connector-guides-landing-pg.asciidoc @@ -8,4 +8,5 @@ Setup guides are available for the following LLM providers: * <> * <> * <> +* <> * <>