Quick Start¶
Welcome to Aegis Platform! Follow these steps to get started quickly.
1. Choose Your Deployment Option¶
Aegis can be deployed in three modes:
- SaaS (Recommended): Fully managed by Pegasys AI. After you express interest, our support team will contact you to understand your requirements and set up your instance(s). You will receive your unique endpoint URL(s), typically in the format
https://<unique-install-name>.aegis.pegasys.cloud
. - Self-Hosted: Contact support@pegasys.ai for tailored deployment instructions and assistance.
- Hybrid: Contact support@pegasys.ai to discuss your requirements and receive deployment guidance.
2. Access Your Aegis Instance¶
Once your instance is provisioned, you will receive the endpoint URL(s) from the Pegasys AI support team.
3. Next Steps¶
- Configuration: Learn how to configure your Aegis instance.
- Aegis UI Overview: Explore the UI and key features.
- Creating Rules: Start defining your security policies.
If you have any questions or need help, contact our support team at support@pegasys.ai.
Prerequisites¶
Before you begin, ensure you have:
- An Aegis account with appropriate permissions
- Access to your organization's infrastructure (AWS, Azure, GCP, or Kubernetes)
- Basic understanding of your security requirements
Step 1: Access the Aegis UI¶
- Navigate to
https://<unique-install-name>.aegis.pegasys.cloud
- Log in with your Single Sign On credentials
- Work with you organization's Aegis administrator to ensure you have the necessary permissions to create rules and policies
Step 2: Create Your First Ruleset¶
Rules are the building blocks of your security policies created in groups called Rulesets. Let's create a simple ruleset to get started.
- Navigate to Rules
- Click on "Rulesets>Manage Rulesets" in the left sidebar
- Provide a name for your ruleset, such as "K8s-Security-Baseline"
- Provide the "Policy-as-Prompt" in the description field, such as "Ensure Kubernetes deployments have a min of 2 replcas and have resource limits set"
- Provide labels to categorize your ruleset, such as "platform" = "kubernetes" and "benchmark" = "custom"
-
Click "Create Ruleset"
-
Test the Rule
- Click "Rulesets>Evaluate Rulesets"
- Select the ruleset you just created
- Choose a test Kubenetes Deployment yaml file or paste the YAML directly into the editor
- Click "Evaluate Ruleset"
Step 3: Create a Policy¶
Policies group Rulesets together for easier management.
- Navigate to Policies
-
Click "Policies>Manage Policies" in the left sidebar
-
Configure the Policy
- Name: "K8s AWS Production"
- Instrcution: "platform=kubernetes, provider=aws, environment=production"
- Category: "This creaets a policy for Kubernetes deployments on AWS in production by selecting the rulesets that match the policy instruction. This selection criterion is dynamic and applies to all rulesets in the future that match the policy instruction as well."
Step 4: Deploy Your Policy¶
- Review Configuration
-
As long as the rulesets in the policy matching the policy labels selector are "enabled", there are no further configuration steps needed to deploy the policy.
-
Test First (Recommended)
- Use the "Evaluate Policy" feature
- Select the policy you just created
- Provide a sample Kubernetes Deployment YAML file
- Click "Evaluate Policy"
Step 6: Monitor Events¶
- Navigate to Policy History
- Click on "Search" in the date range filter
-
Click the record for the policy evaluation records.
-
Review Activity
- The Dashboard will show you the results of the policy evaluation as well along with the trends
This quick start guide should have you running your first security policy within 30 minutes. As you become more familiar with Aegis, you can explore the advanced features and customization options available.