❗️

Deprecated page

This page is deprecated. We provide no guarantees that these instructions are up to date with the latest version of Akita. Please visit this page instead for getting started instructions.

The Akita Client observes network traffic to your APIs and sends metadata to the Akita Cloud. Metadata describes the request, response, and type (string, integer, boolean, etc). It never contains any property or parameter values, ensuring that Akita never sees sensitive data.

📘

First Run

If you can deploy your service(s) locally, then running the Akita Client locally is a great way to test out Akita. The client will start capturing traffic on the local network and sending metadata to the Akita Cloud, which will analyze it and build a model of your APIs.

Follow instructions for Single Host or VM to start capturing traffic on your local machine with the Akita Client.

Choose your platform for instructions.

• Single Host or VM
• AWS ECS
• AWS Elastic Beanstalk
• AWS Fargate
• Docker
• Fly.io
• Kubernetes

Where should I run the Akita Client?

If you deploy your services by hand on bare metal or in a VM, follow the instructions in Single Host or VM to deploy Akita on the same machines as your services.

If you use a VM orchestration framework, see the instructions in Single Host or VM. You can use your orchestration framework to run these commands and deploy the Akita Client across your VMs.

If you use Kubernetes for container orchestration, follow the instructions in Kubernetes.

If you use Docker, AWS Elastic Container Service, or another container orchestration framework, you can find options for deploying Akita in Docker and AWS ECS.

If you're having trouble, you may want to check out our Troubleshooting page.

Don't see your platform? Still have questions? Get in touch and we'll help you get set up.