How can I verify config-as-code is configured correctly?

[David Keaveny]

I have created a new component in my Compass instance, and then added the provided `compass.yml` to my source repo, but I can't see anything to say that Compass is now pulling configuration from the file.

Are there plans to enable source control integration to Compass so changes made through the UI get added to the file by pull request?

[Enrique Serrano Valle]

@David Keaveny based on @Keith Furnell 's previous answer, and on the screenshot that you provided, I can see that the red dot in your GitHub repository (and the lack of a "data connection" lozenge) is indicating that Compass is not receiving events from your repository yet.

The fact that the "Compass App in GitHub" was installed a long time ago could be a clue to understand what is going on. It may be possible that this same organization was connected elsewhere, or that the installation of the "GitHub App in Compass" didn't complete successfully for you.

There's a previous thread with a fix for a situation where a GitHub organization was connected to a different Compass instance. A similar approach might work for your situation, reinstalling the "GitHub App in Compass" and ensuring that no prior "Compass App in GitHub" was interfering with it.

[David Keaveny]

I've never seen the Data Connection label on my connections :-(

I tried reinstalling the GitHub app in Compass, and now it won't reinstall at all; I've raised a ticket with support.

[David Keaveny]

GitHub App is back, and now I can see the Data Connection label against my repo :-) which is a definite improvement.

However, I still cannot see any sign that Compass is using my supplied compass.yml, such as the "Managed in compass.yml by GitHub for Compass" that @Keith Furnell refers to above.

[David Keaveny]

Now I'm just getting confused on how this tool is supposed to be used! When I finally managed to reinstall the GitHub app for Compass, it asked me if I wanted to import all my repos and add them as components; seeing as I have over 400 repos in my organisation, I said no, and just selected the one repo that I had been working with, and that I had added my compass.yml file to. Now I can see two services with the same name in Compass, the one I created originally and that I was trying to set up the compass.yml for, and a new one which is obviously from the import/sync process, because it is asking me if I want to publish/delete the component, and it also has a link for the component slug, which the original didn't have.

So, what's the best way for me to connect my existing Compass components to existing repos? It looks like if I'm creating new Compass components then the best way to do that is to use the Import function rather than the Create, but that doesn't help me with the existing components, Compass seems happy enough creating multiple components with the same name

[April G]

Hi @David Keaveny , if you are looking to connect an existing component to config-as-code, the best way to do so would be to add the component ID to the compass.yml and commit it: 

id: 'ari:cloud:compass:00000000-0000-0000-0000-000000000000:component/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000'

 If your compass.yml already has the id, the original commit event from GitHub may have been missed while the GitHub app was disconnected. Now that the app is reconnected, I would try committing a small update to your compass.yml to trigger it to re-sync. 

To manage your other existing components, if you visit their Component Overview pages and then navigate to the Config-as-code tab in the left sidebar, Compass will give you a generated compass.yml containing the component id that you can commit in your repo. 

[David Keaveny]

I tried adding the compass.yml for another component, and now I can see the config-as-code is being picked up:

[Keith Furnell]

FWIW we see a "Managed in compass.yml by GitHub for Compass" message pretty soon after committing to the repository.

Things that can be defined in compass.yml also become disabled in the UI once this happens (which may answer your second question).

[David Keaveny]

I can't see anything happening like that. If I look at the service overview, the Repositories section has a red dot against the + sign, but I can see my repo listed:

In my compass.yml I have also added a chat channel, so that's another sign it's not linking to my repo. Are there any other settings I should be looking for? I have the Compass app installed in my GitHub organisation, and enabled for all repositories (although having said that, I noticed in GitHub that it says the app was installed last year - does it auto-update, or offer other means for updating to latest versions?)

[Keith Furnell]

Normally trusted GitHub links get rendered as smart-links (the repository name in this case), so unless your repository is actually called "GitHub" maybe this is a clue that you've supplied something other than the root of a repo as URL?

[David Keaveny]

I explicitly renamed it; smart linking in the repo was definitely working

[David Keaveny]

Annoyingly, the Data Connection labels have disappeared from the overview page, both for GitHub and for SonarQube, although I can see metrics are being sent back.