CrewAI Vault Tutorial

Introduction to CrewAI Vault

CrewAI Vault is a comprehensive security solution designed to protect sensitive data and ensure secure access control within the CrewAI ecosystem. This tutorial will guide you through the various features and functionalities of CrewAI Vault, from setup to advanced usage.

Setting Up CrewAI Vault

Setting up CrewAI Vault involves a few key steps. First, ensure that you have the necessary permissions and access to the CrewAI platform. Follow these steps to get started:

Running the above command initializes the Vault setup process. Follow the on-screen instructions to complete the setup.

Creating and Managing Secrets

CrewAI Vault allows you to store and manage secrets securely. Here's how you can create a new secret:

This command creates a new secret named "db_password" with the value "mypassword".

Listing Secrets

To list all the secrets stored in CrewAI Vault, use the following command:

ID          Name
1           db_password
2           api_key
                

Access Control

Access control is a crucial aspect of security in CrewAI Vault. You can manage user permissions and roles to ensure that only authorized personnel have access to sensitive data. Here's how to add a user with specific permissions:

This command adds a user named "alice" with the "admin" role.

Listing Users

To list all users and their roles, use the following command:

Username    Role
alice       admin
bob         viewer
                

Auditing and Logging

CrewAI Vault provides comprehensive auditing and logging capabilities to track all activities and access events. To view the audit logs, use the following command:

Timestamp           User    Action       Resource
2023-10-01 12:00    alice   create       secret:db_password
2023-10-01 12:05    bob     read         secret:api_key
                

Advanced Features

CrewAI Vault offers several advanced features such as secret versioning, dynamic secrets, and automated secret rotation. Here's an example of enabling secret versioning:

This command enables versioning for the secret "db_password", allowing you to track changes and revert to previous versions if necessary.

Conclusion

In this tutorial, we covered the basics of CrewAI Vault, from setup and secret management to access control and auditing. By following the steps outlined above, you can ensure that your sensitive data is securely managed and accessed within the CrewAI ecosystem.