mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-05 06:59:23 +00:00
a237ebabba
* feat: adopt directory-based docs versioning with Edge channel Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
106 lines
3.8 KiB
Plaintext
106 lines
3.8 KiB
Plaintext
---
|
|
title: "Controle de Acesso Baseado em Funções (RBAC)"
|
|
description: "Controle o acesso a crews, ferramentas e dados com funções e visibilidade por automação."
|
|
icon: "shield"
|
|
mode: "wide"
|
|
---
|
|
|
|
## Visão Geral
|
|
|
|
O RBAC no CrewAI AMP permite gerenciar acesso de forma segura e escalável combinando **funções em nível de organização** com **controles de visibilidade em nível de automação**.
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/users_and_roles.png" alt="Visão geral de RBAC no CrewAI AMP" />
|
|
|
|
</Frame>
|
|
|
|
## Usuários e Funções
|
|
|
|
Cada membro da sua workspace possui uma função, que determina o acesso aos recursos.
|
|
|
|
Você pode:
|
|
|
|
- Usar funções pré-definidas (Owner, Member)
|
|
- Criar funções personalizadas com permissões específicas
|
|
- Atribuir funções a qualquer momento no painel de configurações
|
|
|
|
A configuração de usuários e funções é feita em Settings → Roles.
|
|
|
|
<Steps>
|
|
<Step title="Abrir Roles">
|
|
Vá em <b>Settings → Roles</b> no CrewAI AMP.
|
|
</Step>
|
|
<Step title="Escolher a função">
|
|
Use <b>Owner</b> ou <b>Member</b>, ou clique em <b>Create role</b> para
|
|
criar uma função personalizada.
|
|
</Step>
|
|
<Step title="Atribuir aos membros">
|
|
Selecione os usuários e atribua a função. Você pode alterar depois.
|
|
</Step>
|
|
</Steps>
|
|
|
|
### Resumo de configuração
|
|
|
|
| Área | Onde configurar | Opções |
|
|
| :------------------------ | :--------------------------------- | :--------------------------------------------------- |
|
|
| Usuários & Funções | Settings → Roles | Pré-definidas: Owner, Member; Funções personalizadas |
|
|
| Visibilidade da automação | Automation → Settings → Visibility | Private; Lista de usuários/funções |
|
|
|
|
## Controle de Acesso em Nível de Automação
|
|
|
|
Além das funções na organização, as **Automations** suportam visibilidade refinada para restringir acesso por usuário ou função.
|
|
|
|
Útil para:
|
|
|
|
- Manter automações sensíveis/experimentais privadas
|
|
- Gerenciar visibilidade em equipes grandes ou colaboradores externos
|
|
- Testar automações em contexto isolado
|
|
|
|
Em modo privado, somente usuários/funções na whitelist poderão:
|
|
|
|
- Ver a automação
|
|
- Executar/usar a API
|
|
- Acessar logs, métricas e configurações
|
|
|
|
O owner da organização sempre tem acesso, independente da visibilidade.
|
|
|
|
Configure em Automation → Settings → Visibility.
|
|
|
|
<Steps>
|
|
<Step title="Abrir a aba Visibility">
|
|
Acesse <b>Automation → Settings → Visibility</b>.
|
|
</Step>
|
|
<Step title="Definir visibilidade">
|
|
Selecione <b>Private</b> para restringir o acesso. O owner mantém acesso.
|
|
</Step>
|
|
<Step title="Permitir acesso">
|
|
Adicione usuários e funções que poderão ver/executar e acessar
|
|
logs/métricas/configurações.
|
|
</Step>
|
|
<Step title="Salvar e verificar">
|
|
Salve e confirme que não listados não conseguem ver ou executar a automação.
|
|
</Step>
|
|
</Steps>
|
|
|
|
### Resultado de acesso no modo Private
|
|
|
|
| Ação | Owner | Usuário/função na whitelist | Não listado |
|
|
| :-------------------------- | :---- | :-------------------------- | :---------- |
|
|
| Ver automação | ✓ | ✓ | ✗ |
|
|
| Executar/API | ✓ | ✓ | ✗ |
|
|
| Logs/métricas/configurações | ✓ | ✓ | ✗ |
|
|
|
|
<Tip>
|
|
O owner sempre possui acesso. Em modo privado, somente usuários/funções na
|
|
whitelist têm permissão.
|
|
</Tip>
|
|
|
|
<Frame>
|
|
<img src="/images/enterprise/visibility.png" alt="Configuração de visibilidade no CrewAI AMP" />
|
|
|
|
</Frame>
|
|
|
|
<Card title="Precisa de Ajuda?" icon="headset" href="mailto:support@crewai.com">
|
|
Fale com o nosso time para suporte em configuração e auditoria de RBAC.
|
|
</Card>
|