Configure o CI/CD para seu agente do Databricks Apps
Um pipeline de CI/CD executa cada alteração no seu agente por meio de revisão de código e uma implantação automatizada, para que as implantações em produção não dependam do laptop de um único desenvolvedor. Depois que o pipeline for configurado, cada merge para sua branch principal implanta e reinicia seu agente no Databricks Apps.
Esta página aborda as partes específicas do agente. CI/CD para Databricks Apps com GitHub Actions documenta a configuração do fluxo de trabalho principal: federação de identidade de carga de trabalho, o ambiente GitHub e o YAML de implantação. Conclua essa página primeiro e, em seguida, retorne aqui para as adições que se aplicam a aplicativos de agente.
Requisitos
- Um aplicativo de agente implantado pelo menos uma vez no Databricks Apps usando o SDK de Agentes OpenAI, LangGraph ou um framework personalizado. Consulte Criar um agente de AI e implantá-lo no Databricks Apps.
- Uma entidade de serviço Databricks com uma política de federação do GitHub Actions e
CAN MANAGEno aplicativo. Consulte o Passo 1. Configurar a federação de identidades de workload. - A CLI do Databricks instalada e autenticada localmente. Consulte Instalar ou atualizar a CLI do Databricks.
O passo 1. Use o fluxo de trabalho inicial
Vários padrões de agente em databricks/app-templates incluem um .github/workflows/deploy.yml pronto para uso, para que você não precise escrever o fluxo de trabalho do zero.
- Selecione um padrão de agente em databricks/app-templates, como
agent-langgraphouagent-openai-agents-sdk. - No seu diretório de padrão clonado, verifique se
.github/workflows/deploy.ymlexiste. - Configurar o fluxo de trabalho:
- Se
deploy.ymlexistir : Abra-o, confirme se o passodatabricks bundle runfaz referência à key de recurso do seu pacote dedatabricks.yml, e siga os pré-requisitos no comentário do cabeçalho do arquivo. - Se
deploy.ymlnão existir : Copie-o de um padrão que exista, ou de o Passo 4. Adicionar o fluxo de trabalho de implantação. Em seguida, atualize odatabricks bundle run <key>passo para corresponder à key de recurso do seu pacote.
- Se
O passo 2. Preencher a ID do experimento do MLflow
Padrões de agente deixam MLFLOW_EXPERIMENT_ID vazio em databricks.yml. O script quickstart o preenche localmente na primeira configuração, mas um novo runner de CI não. Se experiment_id estiver vazio, databricks bundle deploy falha com um erro de tipo do Terraform (For input string: "").
Para corrigir, faça o commit do valor preenchido:
- Execute
uv run quickstart --profile <your-profile>localmente na máquina onde você criou o agente. - Verifique se o recurso de experimento em
databricks.yml(a entrada comname: 'experiment'emresources.apps.<key>.resources) agora tem umexperiment_idnumérico. - Faça o commit da alteração.
O experimento tem escopo de workspace, então o mesmo ID é válido para cada implantação de CI direcionada a esse workspace. Se você tiver implantado em vários workspaces, declare um experimento por destino em databricks.yml (um por bloco de targets.<env>) ou use uma variável de pacote.
O passo 3: Realizar um smoke test no agente implantado.
databricks bundle run retorna assim que o executor sinaliza para o agente começar, mas o processo do agente ainda pode falhar durante a inicialização. Após a verificação de integridade de Passo 5. Aguarde até que o aplicativo esteja íntegro, adicione o passo de teste de fumaça a deploy.yml que posta uma solicitação canary para /invocations:
- name: Smoke test invocations
env:
APP_NAME: my-agent
run: |
APP_URL=$(databricks apps get "$APP_NAME" --output json | jq -r '.url')
TOKEN=$(databricks auth token | jq -r '.access_token')
STATUS=$(curl -sS -o /tmp/canary.json -w "%{http_code}" \
-X POST "$APP_URL/invocations" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"input": [{"role": "user", "content": "ping"}], "stream": false}')
if [ "$STATUS" != "200" ]; then
echo "Smoke test failed with status $STATUS:" >&2
cat /tmp/canary.json >&2
exit 1
fi
echo "Smoke test passed."
Os Databricks Apps somente aceitam tokens OAuth para invocação. Use o tokens OAuth do workspace de databricks auth token; os Databricks Apps rejeitam qualquer outro tipo de tokens.