feat: add flag to allow enable/disable project autodiscovery

[mtavaresmedeiros]

what

• The idea is to create a flag in the repository configuration side that allows disabling the autodiscovery.

why

• After this change: feat: support atlantis.yaml without defined projects #2300, if we not specify a project in atlantis.yaml, the Atlantis will do an automatic discovery in the entire environment and try to do the plan/apply in modified files.

• In cases where we use multiples Atlantis servers in the same repository, it can be a problem because the Atlantis server from one environment can try to do a discovery and get projects from another environment.
  example of a dir structure:
  .
  |── prod
  │   └── project1
  │   └── main.tf
  |── stage
  |── test
  └── project1
  └── main.tf

We are using the terragrunt-atlantis-config to create theatlantis.yamlin the pre_workflow_hooks. when the terragrunt-atlantis-config run in a directory that doesn't have any project(like the "stage" dir in the example above) or in a directory that does not exist(I know that it looks strange, but try to think about one scenario in which you have multiples Atlantis servers, then when you will create a new repository, for sure that you will start with the test environment, but you would like to configure it (webhooks) to support when the users create the manifest to another environment, I mean you wouldn't like to add the webhooks only when the guy create the new stage, right?), it will create a atlantis.yaml without any project, it means that it will trigger the automatic discovery and will try to do the plan/apply for any project that was modified in the pull request.

tests

• autodiscover disabled:

{"level":"info","ts":"2023-04-04T14:38:19.764Z","caller":"events/project_command_builder.go:357","msg":"successfully parsed atlantis.yaml file","json":{"repo":"xxxxx/infra-app-env-terragrunt","pull":"5"}}
{"level":"info","ts":"2023-04-04T14:38:19.764Z","caller":"events/project_command_builder.go:392","msg":"No projects are defined in atlantis.yaml. Auto discovery is disabled. Will skip automatic detection","json":{"repo":"xxxxxxx/infra-app-env-terragrunt","pull":"5"}}
{"level":"info","ts":"2023-04-04T14:38:19.764Z","caller":"events/plan_command_runner.go:97","msg":"determined there was no project to run plan in","json":{"repo":"xxxxxxx/infra-app-env-terragrunt","pull":"5"}}

• autodiscover enabled:

{"level":"info","ts":"2023-04-04T14:54:59.977Z","caller":"events/project_command_builder.go:357","msg":"successfully parsed atlantis.yaml file","json":{"repo":"xxxx/infra-app-env-terragrunt","pull":"5"}}
{"level":"info","ts":"2023-04-04T14:54:59.977Z","caller":"events/project_command_builder.go:395","msg":"No projects are defined in atlantis.yaml. Auto discovery is enabled, will resume automatic detection","json":{"repo":"xxxxx/infra-app-env-terragrunt","pull":"5"}}

references

• Related to feat: support atlantis.yaml without defined projects #2300

Extra

Obs: about the terragrunt-atlantis-config, I create a forked and updated it to support this new flag( if approved).

[nitrocode]

@mtavaresmedeiros please fill out the pr template. This also helps summarize the changes for pr reviewers

[mtavaresmedeiros]

@mtavaresmedeiros please fill out the pr template. This also helps summarize the changes for pr reviewers

Done

[nitrocode]

@mtavaresmedeiros apologies for the long review... Do you mind resolving the conflicts when you get a chance?

[nitrocode]

In issue #3339, an additional global configuration (in the Atlantis server repos.yaml) would be nice to enable/disable auto discovery. This way the repo owner can create the Atlantis configuration file and override the setting if desired.

So if the repo configuration atlantis.yaml file did not exist or did not override the setting, Atlantis would no longer run plans on auto discovered projects in that repo.

What do you think about adding that within this PR?

[mtavaresmedeiros]

@nitrocode Sure, I will work on it 👍.

[github-actions]

This issue is stale because it has been open for 1 month with no activity. Remove stale label or comment or this will be closed in 1 month.

[mtavaresmedeiros]

@nitrocode , Hello man, do you think that we can merge it, and I work on the global config a little bit later? I am trying to find a time to work on it but it is a little complicated.

[jamengual]

@mtavaresmedeiros do you think you have time to finish this?

[github-actions]

This issue is stale because it has been open for 1 month with no activity. Remove stale label or comment or this will be closed in 1 month.

[FalconerTC]

@mtavaresmedeiros I'd love to see this feature merged. A scenario I have run into is that pull-request into a branch that Atlantis is not configured to run against is considered as having zero projects so auto-discovery runs.

[mtavaresmedeiros]

Hello guys,

Sorry, I am trying to find a time to finish it, I will try this week.

[GenPage]

I approved the tests, should hopefully help

[mtavaresmedeiros]

I think that we are done guys, sorry the delay, can you have a look on it?

[marcportabellaclotet-mt]

Is there any update on this topic?
Seems that tests are waiting for a maintainer to be executed.
Thanks again.
Looking forward to have this issue merged and released ;)

[nitrocode]

Please add documentation for the repo and global configuration

[nitrocode]

I kicked off the tests again.

Can you check these remaining items?

• I think we didn't merge the pr because there wasn't a global configuration to disable autodiscovery so the only way to disable autodiscovery was using a repo config.
• I also noticed that there isn't any runatlantis.io docs for this new config. Anytime a new feature is added, we try to update the docs so users know how to use it. Otherwise they have to dig through code or pr comments.
• if autodisover is enabled and projects are defined, will it still auto discover projects that are not defined? We have another pr that is similar to this feat: add autodiscover enabled feature #3895 by @jskrill

Thanks @mtavaresmedeiros for all your efforts. It's pretty close.

[nitrocode]

Also relevant comment #3895

Might be good for the authors to work together on this implementation.

[mtavaresmedeiros]

I kicked off the tests again.

Can you check these remaining items?

* I think we didn't merge the pr because there wasn't a global configuration to disable autodiscovery so the only way to disable autodiscovery was using a repo config.

* I also noticed that there isn't any runatlantis.io docs for this new config. Anytime a new feature is added, we try to update the docs so users know how to use it. Otherwise they have to dig through code or pr comments.

* if autodisover is enabled and projects are defined, will it still auto discover projects that are not defined? We have another pr that is similar to this [feat: add discover_projects_with_missing_config feature #3895](https://github.com/runatlantis/atlantis/pull/3895) by @jskrill

Thanks @mtavaresmedeiros for all your efforts. It's pretty close.

Hi,
The Topics 1 and 2 are done,

About topic 3, follow de default behavior, it will check only the projects that are in the "atlantis.yaml" or do the discover if not have projects. And not sure what is the benefit of it, if you want the discovery in the repository, just do not specify the projects...

[GenPage]

@mtavaresmedeiros Thank you for the PR. Can you confirm if #3895 delivers the same feature as yours, including global auto-discover? There are many conflicts in the PR now, and I believe this PR is no longer needed due to 3895 being merged.

[mtavaresmedeiros]

yesss. it is fine, thx.