Merge branch 'main' into update-api

levoai · Dec 26, 2024 · 390013b · 390013b
2 parents a7b8324 + afd78da
commit 390013b
Show file tree

Hide file tree

Showing 110 changed files with 2,288 additions and 585 deletions.
diff --git a/docs/assets/cloudflare/Wrangler_access_granted.png b/docs/assets/cloudflare/Wrangler_access_granted.png
diff --git a/docs/assets/cloudflare/Wrangler_consentform.png b/docs/assets/cloudflare/Wrangler_consentform.png
diff --git a/docs/assets/testruns-step-2.png b/docs/assets/testruns-step-2.png
diff --git a/docs/assets/testruns-step-3.png b/docs/assets/testruns-step-3.png
diff --git a/docs/assets/testruns-step-4.png b/docs/assets/testruns-step-4.png
diff --git a/docs/assets/testruns-step-5.png b/docs/assets/testruns-step-5.png
diff --git a/docs/assets/testruns-step-6.png b/docs/assets/testruns-step-6.png
diff --git a/docs/guides/api-observability.md b/docs/guides/api-observability.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 1
+description: Explore Levo.ai's frictionless API observability guide. Auto-discover and document all your APIs seamlessly while preserving privacy.
 ---
 
 # Frictionless API Observability

diff --git a/docs/guides/general/general.md b/docs/guides/general/general.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 1
+description: Discover general tasks for using Levo.ai. Follow our guides on OS compatibility, private registry setup, and supported platforms for optimal performance.
 ---
 
 This section describes tasks that are common when using Levo.

diff --git a/docs/guides/general/private-registry.md b/docs/guides/general/private-registry.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 2
+title: "Secure & Organize APIs: Leverage a Private Registry"
 ---
 
 # Use a Private Docker Registry for Kubernetes Installations
@@ -25,18 +26,17 @@ region="us-west-2"
 registry="your.registry"
 
 helm repo add levoai https://charts.levo.ai || true
-helm repo update
+helm repo update levoai
 images=($(helm template levoai/levoai-satellite | yq -N '..|.image? | select(.)' | sort -u))
 images+=($(helm template levoai/levoai-ebpf-sensor | yq -N '..|.image? | select(.)' | sort -u))
 
 for image in "${images[@]}"; do
-  echo "Pushing $image to $registry"
-  docker pull "$image"
-  image_name=levoai/${image##*/}
-  repo_name=${image_name%:*}
+  src_image=${image#"docker.io/"}
+  dest_image="$registry/$src_image"
+  repo_name=${src_image%:*}
   aws ecr describe-repositories --repository-names $repo_name --region $region || aws ecr create-repository --repository-name $repo_name --region $region
-  docker tag "$image" "$registry/$image_name"
-  docker push "$registry/$image_name"
+  echo "Copying $src_image to $dest_image"
+  docker buildx imagetools create --tag $dest_image $src_image
 done
 ```
 
@@ -55,7 +55,6 @@ kubectl create secret docker-registry ecr-auth --docker-server=your.registry --d
 ```yaml
 sensor:
   imageRepo: your.registry/levoai/ebpf_sensor
-  imageTag: 0.30.1
 ```
 
 ### Satellite
@@ -65,43 +64,8 @@ global:
   levoai_config_override:
     onprem-api:
       org-id: <id>
-      refresh-token: 
-  busyboxImage: your.registry/levoai/busybox
-
-levoai-collector:
-  image: your.registry/levoai/collector
-  imageTag: 0.17.2
+      refresh-token: <token>
+  imageRegistry: your.registry
   imagePullSecrets:
     - name: ecr-auth
-
-levoai-ion:
-  image:
-    repository: your.registry/levoai/ion
-    tag: 0.6.0
-  imagePullSecrets: 
-    - name: ecr-auth
-
-rabbitmq:
-  metrics:
-    enabled: true
-  image:
-    registry: your.registry
-    repository: levoai/rabbitmq
-    tag: 3.12.8-debian-11-r1
-    pullSecrets:
-      - ecr-auth
-
-satellite:
-  image:
-    repository: your.registry/levoai/satellite
-    tag: 0.2.462
-  imagePullSecrets: 
-    - name: ecr-auth
-
-tagger:
-  image:
-    repository: your.registry/levoai/satellite
-    tag: 0.2.462
-  imagePullSecrets: 
-    - name: ecr-auth
-```
+```
diff --git a/docs/guides/key-concepts.md b/docs/guides/key-concepts.md
@@ -1,6 +1,7 @@
 ---
 sidebar_position: 0
 keywords: [API Security, eBPF, API Observability]
+description: Understand key concepts in Levo.ai's API observability. Learn about sensors, satellites, and API catalog creation for effective API management and security.
 ---
 
 # Key Concepts

diff --git a/docs/guides/security-testing/common-tasks/api-rbac/api-rbac-glob.md b/docs/guides/security-testing/common-tasks/api-rbac/api-rbac-glob.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 2
+title: API Role-Based Access Control Testing Guide
 ---
 
 # Associating RBAC Information Using Pattern Matching (Glob)

diff --git a/docs/guides/security-testing/common-tasks/authn-authz/authn-authz.md b/docs/guides/security-testing/common-tasks/authn-authz/authn-authz.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 0
+title: "API Security Testing: AuthN & AuthZ Best Practices"
 ---
 
 # Providing Authentication / Authorization for Tests

diff --git a/docs/guides/security-testing/common-tasks/authn-authz/authz.md b/docs/guides/security-testing/common-tasks/authn-authz/authz.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 3
+title: "Levo.ai Guide: Testing API Authorization Controls"
 ---
 
 # Providing Authorization Information for Authorization Abuse Tests

diff --git a/docs/guides/security-testing/common-tasks/authn-authz/horizontal-authz.md b/docs/guides/security-testing/common-tasks/authn-authz/horizontal-authz.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 4
+title: "Stop Unauthorized Access: Secure APIs with Horizontal AuthZ"
 ---
 
 # Providing Authorization Information for `Horizontal Authorization Abuse` Test Cases

diff --git a/...guides/security-testing/common-tasks/authn-authz/horizontal-n-vertical-authz.md b/...guides/security-testing/common-tasks/authn-authz/horizontal-n-vertical-authz.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 6
+title: "Prevent Data Leaks & Access Issues: Test Both AuthZ Types"
 ---
 
 # Providing Authorization Information for Test Plans - `Horizontal & Vertical Authorization Abuse` Test Cases

diff --git a/docs/guides/security-testing/common-tasks/authn-authz/vertical-authz.md b/docs/guides/security-testing/common-tasks/authn-authz/vertical-authz.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 5
+title: "Secure Your APIs: Implement Robust Vertical AuthZ Testing"
 ---
 
 # Providing Authorization Information for `Vertical Authorization Abuse` Test Cases

diff --git a/docs/guides/security-testing/common-tasks/common-tasks.md b/docs/guides/security-testing/common-tasks/common-tasks.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 1
+description: Discover common tasks in Levo.ai's security testing. Learn about API authentication, RBAC info, and running test plans with our comprehensive guide.
+title: Common Security Testing Tasks | Levo.ai Documentation
 ---
 
 # Common Tasks

diff --git a/...des/security-testing/common-tasks/running-test-plans/run-zero-conf-test-plan.md b/...des/security-testing/common-tasks/running-test-plans/run-zero-conf-test-plan.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 2
+title: "Effortless API Security Testing: Run Zero-Conf Test Plans"
 ---
 
 # How do I run a Zero Configuration Test Plan?

diff --git a/docs/guides/security-testing/test-sample-app/crapi/crapi.md b/docs/guides/security-testing/test-sample-app/crapi/crapi.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 1
+title: "API Security Testing Tutorial: CRAPI Sample Application"
 ---
 
 # Evaluate Levo using the sample application `crAPI`

diff --git a/docs/guides/security-testing/test-your-app/test-app-schema-conformance.md b/docs/guides/security-testing/test-your-app/test-app-schema-conformance.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 2
+title: "Levo.ai: Automate API Schema Conformance Testing"
 ---
 
 # Using your own app to evaluate Levo's schema conformance testing

diff --git a/docs/guides/security-testing/test-your-app/test-app-security/choices.md b/docs/guides/security-testing/test-your-app/test-app-security/choices.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 1
+title: "Levo.ai Guide: Choosing Tools for API Security Testing"
 ---
 
 # Automatically test APIs for security vulnerabilities

diff --git a/...curity-testing/test-your-app/test-app-security/data-driven/configure-env-yml.md b/...curity-testing/test-your-app/test-app-security/data-driven/configure-env-yml.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 5
+title: Configure env.yml for Data-Driven Security Testing
 ---
 
 # Configure `environment.yml`

diff --git a/...curity-testing/test-your-app/test-app-security/data-driven/execute-test-plan.md b/...curity-testing/test-your-app/test-app-security/data-driven/execute-test-plan.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 6
+description: Execute your test plan with Levo.ai. Follow our guide to use Levo CLI for testing live API endpoints and view detailed results to ensure robust security.
+title: Execute Data-Driven Test Plan | Levo.ai Documentation
 ---
 
 # Execute Test Plan

diff --git a/...urity-testing/test-your-app/test-app-security/data-driven/generate-test-plan.md b/...urity-testing/test-your-app/test-app-security/data-driven/generate-test-plan.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 3
+description: Generate a security test plan for your app. Follow our zero-configuration guide for comprehensive API security testing and ensure robust protection.
+title: Generate Data-Driven Test Plan | Levo.ai Documentation
 ---
 
 

diff --git a/...des/security-testing/test-your-app/test-app-security/data-driven/import-apis.md b/...des/security-testing/test-your-app/test-app-security/data-driven/import-apis.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 2
+description: "Secure Your APIs: Import Specs, Bypass Authorization & Test with Levo. Auto-gen or upload, Levo simplifies API security testing."
+title: Import APIs for Data-Driven Testing | Levo.ai Documentation
 ---
 
 

diff --git a/...security-testing/test-your-app/test-app-security/zero-conf/configure-env-yml.md b/...security-testing/test-your-app/test-app-security/zero-conf/configure-env-yml.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 4
+title: Configure env.yml for Zero-Config Testing | Levo.ai
 ---
 
 # Configure `environment.yml`

diff --git a/...security-testing/test-your-app/test-app-security/zero-conf/execute-test-plan.md b/...security-testing/test-your-app/test-app-security/zero-conf/execute-test-plan.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 5
+title: Execute Zero-Config Test Plan | Levo.ai Documentation
 ---
 
 # Execute Test Plan

diff --git a/...ecurity-testing/test-your-app/test-app-security/zero-conf/generate-test-plan.md b/...ecurity-testing/test-your-app/test-app-security/zero-conf/generate-test-plan.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 3
+description: Generate a security test plan for your app. Follow our zero-configuration guide for comprehensive API security testing and ensure robust protection.
+title: Auto Generate Test Plan | Levo.ai Documentation
 ---
 
 

diff --git a/...uides/security-testing/test-your-app/test-app-security/zero-conf/import-apis.md b/...uides/security-testing/test-your-app/test-app-security/zero-conf/import-apis.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 2
+description: "Secure Your APIs: Import Specs, Bypass Authorization & Test with Levo. Auto-gen or upload, Levo simplifies API security testing."
+title: Import APIs for Zero-Config Testing | Levo.ai Documentation
 ---
 
 

diff --git a/docs/guides/security-testing/test-your-app/testing-your-own-apps.md b/docs/guides/security-testing/test-your-app/testing-your-own-apps.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 1
+title: "API Security Testing: DIY Guide for Your Apps"
 ---
 
 # How do I use Levo with my own applications?

diff --git a/docs/install-api-portal.mdx b/docs/install-api-portal.mdx
@@ -55,14 +55,11 @@ By leveraging Levo's API Portal, developers can gain deep insights into their AP
 
 ```bash
 docker run --rm --name=levoai-api-portal \
--e REFRESH_TOKEN='<REFRESH_TOKEN>' -e APP_NAME='<APP_NAME>' \
--e ENV_NAME='<ENV_NAME>' -e LEVO_ORG_ID='<LEVO_ORG_ID>' \
--p 8000:80 levoai/api-portal:latest
+-e REFRESH_TOKEN='<REFRESH_TOKEN>' -e LEVO_ORG_ID='<LEVO_ORG_ID>' \
+-p 8080:8080 levoai/api-portal:latest
 ```
 
-
 > ##### **_NOTE:_**
-> ##### * Default `ENV_NAME` environment value is `staging`.
 > ##### * If user is part of multiple orgs, you would have to add `-e LEVO_ORG_ID='<LEVO_ORG_ID>` otherwise optional.
 > ##### * If you are running for an app from Levo's India Saas instance, add this environment variable `-e LEVO_BASE_URL='https://api.india-1.levo.ai'`.
 
@@ -80,30 +77,27 @@ docker run --rm --name=levoai-api-portal \
 - Add Levo Helm repo
 
 ```bash
-helm repo add levoai https://levoai.github.io/helm-charts/
+helm repo add levoai https://charts.levo.ai && helm repo update levoai
 ```
 
 - Run following command to install the API Portal Helm Chart
 
 ```bash
 helm install levoai-api-portal levoai/levoai-api-portal \
 --set levoAuthKey="your_auth_key" \
---set levoAppName="your_app_name" \
---set levoEnvName="your_env_name" \
 --set levoOrgId="your_org_id"
 ```
 
 > ##### **_NOTE:_**
-> ##### * Default `ENV_NAME` environment value is `staging`.
 > ##### * If user is part of multiple orgs, you would have to add `-e LEVO_ORG_ID='<LEVO_ORG_ID>'` otherwise optional.
 > ##### * If you are running for an app from Levo's India Saas instance, add this environment variable `-e LEVO_BASE_URL='https://api.india-1.levo.ai'`.
 
 <br/>
 
-- Port forward and navigate to `http://localhost:8000` to view the API docs.
+- Port forward and navigate to `http://localhost:8000` to view the API docs or setup LoadBalancer as per your requirements.
 
 ```bash
-kubectl port-forward services/levoai-api-portal 8000:80
+kubectl port-forward services/levoai-api-portal 8080:80
 ```
 
 ### Install via Terraform

diff --git a/docs/install-code-analysis-tools.md b/docs/install-code-analysis-tools.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 6
+description: Install Levo.ai code analysis tools with our comprehensive guide. Enhance your API security with easy setup and detailed instructions.
 ---
 
 # Install Code Analysis Tools

diff --git a/docs/install-log-parsing-sensors.md b/docs/install-log-parsing-sensors.md
diff --git a/docs/install-log-parsing-sensors/_category_.json b/docs/install-log-parsing-sensors/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "Install Log Parsing Sensors",
+  "position": 5
+}