LinearB On-Premise Agent Documentation
Tip
Before starting the installation process, we recommend your install glow from https://github.com/charmbracelet/glow for easier viewing of README and guide files
Welcome to the LinearB On-Premise Agent Documentation! This repository contains all the guides and resources required to install, configure, and manage LinearB's On-Premise Agent effectively. To streamline your navigation, this main README provides a flow of documentation with links to detailed guides for specific sections.
💡 Get Started
Start by reviewing the Installation Prerequisites Guide to ensure your environment is ready for the LinearB On-Premise Agent.
For further assistance, refer to the respective guides linked below.
Happy Installing!
📚 Documentation Index
1. Installation Prerequisites Guide [README-prerequisites.md]
- Detailed OS and software requirements.
- Required ports and FQDNs access.
- Prerequisite configuration details for deployment.
2. Setup K3D cluster (optional) [README-k3d.md]
- Instructions for creating a K3D cluster.
- Relevant only for K3D hosted agent and not for other K8S supported platforms.
3. Agent Installation Guide
3.1 Agent upgrade to v4.0.0 [README-upgrade-to-v4.md]
- Step-by-step guide to upgrade the agent successfully to v4.x.x.
3.2 Agent Installation Guide [README-deploy.md]
- Step-by-step guide to deploying the LinearB On-Premise Agent.
- Command examples and configuration instructions.
4. Integrations Guide
- Details about required permissions for Jira fields.
- Configuration of selective fields in
local-values.yaml.
5. Troubleshooting Guide
- Common issues and their solutions.
- Logs and debugging tips.