Learn the basics
This guide will help you understand the basic concepts of Lunar and get started with monitoring your engineering practices.
Prerequisites
Before you begin, make sure you have:
Installed Lunar following the installation guide
Access to your code repositories
Basic understanding of your CI/CD pipeline setup
Basic Concepts
Lunar operates on a few key concepts:
Components: These are your software projects (services, libraries, repositories)
Collectors: These gather information about your components
Policies: These define rules and standards for your components
Checks: These are the results of policy evaluations
Your First Lunar Setup
1. Populate your Lunar Configuration
Start by creating a lunar-config.yml
file in your project root:
You will need to replace github.com/my-org/my-service
with a real repository you want to monitor.
To apply this configuration, run
You should be able to see the new domain, the new component, and its component JSON being populated in the Lunar UI.
2. Define Your First Policy
Add a policy to check your component:
Apply the new configuration:
You should be able to see the new policy, and the checks being populated for this component in the Lunar UI.
See also
Learn more about key concepts
Explore configuration options
Check out the plugin SDKs for advanced usage
Last updated