Prerequisites
Before you begin, ensure you have:- Completed the Onboarding steps.
- Access to the Self-Service repository.
- Access to the Applications Live repository.
Step 1: Create a New Repository
Use the Self-Service GitOps workflow to provision a new repository based on the standard Agno template.- Clone the Self-Service repository.
- Create a new branch (e.g.,
feat/my-first-agent). - Open
self-service.tfvarsand add your new repository definition under therepositoriesblock:
- Commit your changes and push the branch.
- Open a Pull Request (PR) and merge it after approval.
- The platform will automatically provision your new repository with the template contents, CI/CD pipelines, and branch protection rules.
Step 2: Project Setup & Features
Once your repository is provisioned, clone it to your local machine. The template automatically sets up:- Assistant Agent: A basic agent implementation in
src/agents. - API Server: FastAPI application in
src/apiserving the agent. - BB AI SDK: Pre-configured SDK for AI Gateway and Observability.
- AI Gateway: Integrated via
bb-ai-sdkfor secure model access. - Observability: Hooks for Langfuse/LangWatch via
bb-ai-sdk. - CI/CD Pipelines: GitHub Actions for linting, testing, publishing, and provisioning (see CI/CD Workflows).
Setup and Run Locally
- Clone the repository:
- Create virtual environment:
- Copy environment template:
- Configure credentials - Edit
.envwith required values:
- Install dependencies and run:
Step 3: Configure Environment
The environment configuration is already set up in Step 2. This section provides additional context about environment variables used by the SDK.
bb-ai-sdk uses these environment variables:
- AI Gateway:
AI_GATEWAY_ENDPOINT,AI_GATEWAY_API_KEY - Observability:
LANGFUSE_PUBLIC_KEY,LANGFUSE_SECRET_KEY,LANGFUSE_HOST
For SDK usage patterns (AI Gateway client, observability initialization), see BB AI SDK Get Started.
Step 4: Deploy to Runtime
Deploying your agent involves building a Docker image and updating the Applications Live repository to run it.1. Build and Publish Image
The CI/CD pipeline automatically builds and publishes a Docker image to the container registry when you merge tomain or publish a release.
- Ensure your latest code is merged to
main. - Note the image tag generated by the release workflow (e.g.,
v0.1.0). Review Build & Publish Workflow and Release Workflow for details.
2. Update Applications Live
- Clone the Applications Live repository.
- Navigate to your runtime environment folder (e.g.,
dev/). - Create or update the values file for your application (e.g.,
my-first-agent.yaml):
- Commit, push, and merge the PR. ArgoCD will sync the changes and deploy your agent to the namespace.
Step 5: Expose via APIM
To access your agent’s API from outside the cluster, you need to expose it via API Management (APIM).- In the Applications Live repository, locate the APIM configuration section.
- Define an API definition for your agent:
- Merge the changes.
- Your agent is now accessible at
https://api.dev.backbase.cloud/v1.
You have successfully created, deployed, and exposed your first agentic application!