BlogHomepage

Onboarding Guide Walkthrough

This guide provides the fastest way to get the Garnet Platform up and running by following our interactive in-app Onboarding Guide. This process will help you generate an API key, set up your first security agent, and configure basic notifications.

Step 1: Sign In to Garnet

Begin by signing into the Garnet Platform dashboard.

  • Navigate to https://dashboard.garnet.ai/.

  • Sign in using your Google account that has been associated with your Garnet account.

    Sign in with Google

Step 2: Launch the Onboarding Guide

Once logged in, the Onboarding Guide is easily accessible to walk you through the setup.

  • From any page in the dashboard, click the "Onboarding Guide" button, typically found in the main navigation menu.

    Onboarding Guide Button

Step 3: Generate Your API Key

The first step within the Onboarding Guide is to generate an API key. This key authenticates your security agents with the Garnet Platform and is created with the minimum scope and permissions required for agent operations.

  • The Onboarding Guide will present the API key generation screen.

    Generate API Key screen in Onboarding Guide

  • Crucial: Click the copy icon next to the generated API key to copy it to your clipboard. This key will not be displayed again for security reasons. Store it safely in a password manager or secrets store.

    Copy button for API Key in Onboarding Guide

  • After copying the key, click "Continue" to proceed.

Step 4: Select Agent Setup

Next, you'll choose where you want to deploy your first Jibril security agent.

  • Select either "GitHub Actions" (for CI/CD pipeline security) or "Kubernetes" (for runtime protection of your clusters).

    Agent Setup Selection: GitHub Actions or Kubernetes

  • The Onboarding Guide will provide specific instructions within the modal for your chosen deployment type. For more detailed written guides that you can refer to alongside the in-app instructions or if you navigate away, see:

  • Once you have followed the in-app instructions for your chosen environment, click "Continue to Alerts" (or similar wording on the button) in the Onboarding Guide.

Step 5: Configure Notifications (Optional)

The final step in the guided onboarding is to set up basic alert notifications.

  • You can configure Slack notifications by enabling webhook notifications and pasting your Slack Incoming Webhook URL. Garnet provides high-confidence, high-impact alerts, so you can be confident in what you receive.

    Configure Slack Alerts in Onboarding Guide

  • More alert destinations are coming soon! You can configure additional notification methods or modify these settings later in the main platform "Settings" page. For more details, see Configure Notifications.

  • Click "Complete Setup" (or "Skip" if you prefer to configure alerts later).

Step 6: Setup Complete!

Congratulations! You have completed the initial setup of the Garnet Platform. Your Jibril agent should soon start reporting data, and you'll receive alerts for any detected security events.

Step 7: Understanding Garnet's Operation & Next Steps

Congratulations! You've successfully deployed your first Jibril agent with Garnet. The streamlined setup you just experienced is a core part of Garnet's value.

What Happens Now?

  • Active Monitoring: Your Jibril agent is now actively monitoring the environment you selected (GitHub Actions or Kubernetes). It observes system behaviors, looking for activities that match its security policies.

  • Focus on Real Detections: Garnet is designed to provide high-fidelity alerts on genuinely suspicious or malicious activities. You may not see alerts immediately, and that's okay. The goal isn't to generate noise, but to provide actionable insights when real issues arise.

  • Future Observations: As your monitored environment operates, any detected issues will:

    • Appear on the Issues Page.

    • Trigger notifications, if you configured them in Step 5.

How to Observe Garnet Over Time:

  1. Continue Normal Operations: Allow your CI/CD pipelines to run or your Kubernetes workloads to operate as usual. Garnet works in the background.

  2. Review Detections When They Occur: When Garnet identifies a potential threat, you'll be notified (if configured) and can review the details on the "Issues Page."

  3. Explore Event Data: For a deeper understanding of what your agent is seeing (even non-alerting events), you can explore the Viewing Events page. This can be useful for understanding baseline activity.

Next Steps:

Last updated