kubiya_knowledge
resource allows you to create and manage knowledge resources in the Kubiya platform. Knowledge resources provide specific information, documentation, and context that agents can reference when performing tasks, ensuring consistent and informed responses.
Knowledge resources are essential for providing agents with domain-specific information, procedures, and context that enables more accurate and useful interactions.
Prerequisites
Before using this resource, ensure you have:- A Kubiya account with API access
- An API key (generated from Kubiya dashboard under Admin → Kubiya API Keys)
- At least one group configured in your Kubiya organization
- Content files prepared (markdown, text, or other supported formats)
Quick Start
Configuration Examples
Create comprehensive troubleshooting documentation:
Advanced Configurations
Compliance and Security Policies
Compliance and Security Policies
Store compliance documentation and security policies:
Team-Specific Documentation
Team-Specific Documentation
Create documentation organized by team function:
Arguments Reference
Required Arguments
The name of the knowledge resource. Must be unique within your organization.
A description of the knowledge resource’s content and purpose. Helps users understand what information is contained.
The actual content of the knowledge resource. Can be inline text or loaded from files using the
file()
function.The format of the content. Supported formats include:
markdown
- Markdown formatted text (recommended)text
- Plain textjson
- JSON data structuresyaml
- YAML formatted datahtml
- HTML formatted content
List of groups that can access this knowledge resource. At least one group is required. Groups must exist in your Kubiya organization.
Optional Arguments
Labels for categorizing and searching knowledge resources. Use consistent labeling for better organization and discoverability.
Attributes Reference
In addition to all arguments above, the following attributes are exported:The unique identifier of the knowledge resource.
The timestamp when the knowledge resource was created.
The timestamp when the knowledge resource was last updated.
The email of the user who created the knowledge resource.
Content Organization Patterns
Structure your documentation for maximum clarity:
Import
Knowledge resources can be imported using their ID:Best Practices
Content Management
- Store knowledge content in version-controlled files for better change tracking
- Use markdown format for documentation to ensure better readability and formatting
- Keep content current with regular updates and reviews
- Structure content with clear headings and logical organization
Access Control
- Assign appropriate groups based on content sensitivity and relevance
- Use granular group assignments to ensure proper access control
- Review access permissions regularly to maintain security
- Consider creating specialized groups for different types of content
Organization & Discovery
- Use consistent labels for easy discovery and categorization
- Implement a labeling taxonomy across your organization
- Include practical examples in technical documentation
- Cross-reference related knowledge resources using labels
Quality & Maintenance
- Implement review processes for critical documentation updates
- Test all code examples and procedures before publishing
- Include troubleshooting sections for complex procedures
- Set up regular review cycles for different types of content
Supported Content Formats
Format Support:
- Markdown: Full markdown support with tables, code blocks, and formatting
- Text: Plain text content for simple documentation
- JSON: Structured data for configuration examples and schemas
- YAML: Configuration files and structured data
- HTML: Rich formatted content with custom styling
Content Limitations:
- Maximum content size may be limited by platform tier
- Binary content is not supported; use base64 encoding if needed
- External references and links should be accessible to users
- Keep content focused and relevant to avoid information overload
Compatibility
Requirements:
- Kubiya Terraform Provider version >= 1.0.0
- Terraform >= 1.0
- Groups must exist in your Kubiya organization before being referenced
- Content should be properly formatted according to the specified format type
Troubleshooting
Content Loading Issues
Content Loading Issues
- Verify file paths are correct when using the
file()
function - Check that content format matches the specified format parameter
- Ensure content encoding is UTF-8 for proper character support
- Test content rendering in the Kubiya interface
Access Control Problems
Access Control Problems
- Confirm that all specified groups exist in your Kubiya organization
- Check group memberships for users who should have access
- Verify that agents referencing knowledge have appropriate group assignments
- Review group permissions and access policies
Search and Discovery Issues
Search and Discovery Issues
- Use consistent and meaningful labels across related content
- Ensure knowledge resource names are descriptive and searchable
- Check that content includes relevant keywords in descriptions
- Verify that related knowledge resources are properly cross-referenced