Welcome to OpsLevel! Your organization is using OpsLevel to track your service and repo information using config-as-code.
In this guide, we will walk through setting up your team’s services using opslevel.yml files.
This document is meant as a step by step guide; for general information about opslevel.yml and more technical details please see our full opslevel.yml documentation.
1. Log into app.opslevel.com
2. Click on ‘Teams’ in the left menu bar, and then navigate to and click on your team. (If you don’t see your team, go ahead and create it).
3. Click on one of your services in the Services card. (If this card is empty, you can add a service here using the “New Service” button.)
4. Confirm the information about your service is up to date. To give you a feel for what info you can include in an opslevel.yml file, we will enter service info manually and then download the corresponding opslevel.yml file to check in. However, services can also be created directly in OpsLevel by checking in a new opslevel.yml file in your repo. (This will be covered at the end of this guide.)
A. First, confirm that there is no lock icon displayed in the top right of your service’s detail page. If so, this particular service is already managed through opslevel.yml.
B. Check the service name and description, and add a description if blank.
C. Check and update the fields in the Summary Tab.
D. Check and Update the Operations Tab. Confirm the service’s repo is listed in the Repository card, and be sure to include links to your service’s logs, your metrics dashboard, your runbook (if any), etc in the Operations Center card. These will be useful for anyone needing to operate your service.
5. Once you’re happy with how your service metadata is defined in OpsLevel, copy or download the .yml file.
6. Next, check-in the opslevel.yml file to the repo/path listed in the service’s Repositories card. (IMPORTANT: Confirm this service is connected to the right repo. If the two are not connected, adding an opslevel.yml file will create an entirely new service in OpsLevel.)
7. After merging your opslevel.yml file to your default branch (commonly ‘master’), confirm the service is now managed by opslevel.yml. Several fields should no longer be editable in the in summary tab, and a lock icon should appear in the top right corner. It sometimes helps to refresh the page.
Congratulations, this service is now managed using opslevel.yml! You can now do the same for any/all of your team’s other services already in OpsLevel by repeating Steps 3-7.
For any services that are missing, you can either create them in the OpsLevel UI (as described in Steps 3-7) or simply add a new opslevel.yml file directly to the repo.
If any of the above is unclear or you have any questions feel free to reach out at email@example.com or contact your OpsLevel administrator.