How-To Guides
Litmus Edge Manager Admin Cons...
How to Setup Git Provider Integration
8 min
git provider is a one directional integration that synchronizes litmus edge template files from your edge devices to a git repository of your choice (github, gitlab, or azure devops) this integration enables you to maintain version control, track configuration changes, and ensure compliance across your distributed edge deployments when you configure git provider, litmus edge manager (lem) automatically pushes template updates to your git repository based on a schedule you define (hourly, daily, weekly, or monthly) or when edge devices are backed up before you begin, decide how to organize your repositories you can create one repository with folders mirroring your company or project structure separate repositories per project or company note we recommend using a private repository to protect your edge configuration data the examples in this topic use github as a repository note also see docid\ ac86nrgxaxkany3krwrmm for additional overview and workflow information prerequisites before you configure git provider integration, ensure you have administrative access to litmus edge manager admin console a github, gitlab, or azure devops account with repository creation permissions appropriate permissions on your git repo step 1 create a git repository to setup a github repository in github, create a new public or private reposito ry we recommend adding a private repo the example repo here is named le templates record the repository name step 2 configure git provider in lem to setup the lem and git integration in lem admin console, navigate to integration > git provider in provider type , select one of github, gitlab, or azure devops this example uses github in ssh url, provide the github url with the following syntax git\@github com \<your org>/\<github repo> git for example git\@github com\ gpm litmus/lem template git copy the value from ss h public key step 3 add the deploy key to your git repository in github, add the public key as a deploy key navigate to settings > deploy keys and click add deploy key provide a key name in title and paste the ssh public key in key select allow write access and click add key in lem admin console and in integration > git provider , click validate if successful, the repository access successful message displays close the success message and click save step 5 configure synchronization settings to configure synchronization settings navigate to edge devices > edge git integration verify that edge devices populate on the page in synchronization frequency , specify how often git synchronization occurs hourly, daily, weekly, or monthly syncs occur at 00 00 (utc) daily, weekly on mondays, and monthly on the first day of the month step 6 configure synchronization settings next configure in the integration for edge devices belonging to your company here you also view the number edge devices and synced devices, last sync and commit id, and integration status you set tracking at the project level the following columns display in project tracking field description company company to which the devices belongs project project to which the devices belong track enable to push changes to git based on the selected synchronization frequency sync on backup enable to push changes to git when the device is backed up edge devices number of devices in the project synced devices number of devices that have been synchronized last sync time the last time that a synchronization was performed from all edge devices in the current project to lem last commit git commit hash which is a unique identifier representing a specific commit in a git repository status status of the integration new , waiting , running , canceling , success , error , or cancel action options to enable or disable tracking on the predefined schedule, on device backup, or to run a manual synch to configure the integration for edge devices navigate to edge devices > edge git integration in project tracking , set the synchronization frequency for devices in a company to sync templates based on the synchronization frequency, select track when the device is backed up, select sync on backup to enable the integration, in the actions shortcut menu, select enable sync on backup or run manual sync to test the sync, click run manual sync in git, verify that the commit appears and contains the correct json template file