Add the /plan and /apply endpoints #997

remilapeyre · 2020-04-16T14:13:45Z

See #937

cep21 · 2020-04-22T20:19:29Z

This is awesome. I really hope it can get picked up into master!

lkysow · 2020-08-18T23:23:59Z

Hey sorry I haven't been able to get to these. They're the top of my review list now for the next release.

llamahunter · 2020-10-19T18:04:41Z

Are these programmatic endpoints coming soon?

lkysow · 2020-10-23T04:39:55Z

Hi All,
Sorry but I haven't found the time to get to these. I really apologize. I'm investigating other options to get these and other PRs reviewed more quickly.

jamengual · 2020-12-07T03:39:00Z

@remilapeyre can you fix the conclicts?

remilapeyre · 2020-12-07T23:43:23Z

Hi, I will try to come back to this some time this week. Also, I did not thought too long about the payload for the API you are welcome to share your thoughts about it.

jayceebernardino · 2021-04-15T17:24:04Z

Is there a plan to get this in?

infestonn · 2021-04-23T13:14:07Z

Any updates?

jamengual · 2021-04-23T21:51:30Z

We have been busy with other stuff so it is hard to say if this will get in before is reviewed. I do not have an ETA for you guys.

remilapeyre · 2021-05-16T15:29:03Z

Hi, due to lack of time to work on this, I won't have time to rebase the work or make all the corrections too get it merged, but feel free to reuse any part that may be useful if you want to open another PR

gmaghera · 2021-09-29T16:03:39Z

Is this still something planned?

smitthakkar96 · 2022-04-08T13:00:52Z

@nishkrishnan any plans to take this forward. I can help to rebase and address any code review comments if needed.

nitrocode · 2022-07-14T00:29:26Z

If this gets merged, Atlantis will be on its way to implement "Drift Detection" which is a notable feature in Spacelift and Terraform Enterprise.

jamengual · 2022-07-14T04:40:47Z

@nitrocode Someone will have to pick this up and finish it, it was created long ago and I will have to be updated it to the current master.

nitrocode · 2022-07-20T12:36:33Z

server/events/vcs/github_client.go

@@ -501,3 +501,7 @@ func (g *GithubClient) DownloadRepoConfigFile(pull models.PullRequest) (bool, []
 func (g *GithubClient) SupportsSingleFileDownload(repo models.Repo) bool {
 	return true
 }
+
+func (g *GithubClient) GetCloneURL(VCSHostType models.VCSHostType, repo string) (string, error) {
+	return "", fmt.Errorf("not yet implemented")


Is this needed for plan/apply endpoints to work for github? If so can we also prioritize this before merging? Most users of Atlantis are probably on GitHub

Thanks for the feedback! Implemented.

cep21 · 2022-07-20T16:11:44Z

A full drift detection workflow also needs to list all the valid callers of /plan. Otherwise we could manually parts the atlantis.yaml file. Is a /list also in scope?

nitrocode · 2022-07-21T00:04:02Z

server/controllers/api_controller.go

+	}
+	if result.HasErrors() {
+		code = http.StatusInternalServerError
+	}


Seems like the apiApply function call and the next 2 if statements are the only differences when compared to the Plan function. Can we combine these 2 functions together and use an if statement to check if it should do an apply or not? That way it would DRY up the code a bit

I understand there is plenty of room for improvement, but I'm less sure about the specific change you are proposing. Could you suggest the change you described to avoid confusion? Much appreciated!

lilincmu · 2022-07-21T00:48:48Z

A quick question about the API: how will the plan output work? I'm guessing the plan endpoint will have to return the body of the plan file so that the same plan file can be sent to the apply endpoint, otherwise your apply may happen with extra plans.

Is that right?

The output of plan endpoint currently is not the body of the plan file, but the output from terraform execution. I think the decision was made to avoid the back and forth transport of plan files in this POC version. And yes, the apply will cause extra plans.

A full drift detection workflow also needs to list all the valid callers of /plan. Otherwise we could manually parts the atlantis.yaml file. Is a /list also in scope?

No I think the main focus for this PR is to have a POC first, so that people can test with it and provide more feedback. However, it's highly encouraged to open an issue and elaborate more on features like the /list endpoint you described.

lilincmu · 2022-07-21T00:59:47Z

@runatlantis/maintainers May I have another look at this PR? I've done most of the changes I felt necessary, but please let me know if there's anything missing or can be improved!

lilincmu · 2022-07-21T01:12:17Z

`api/plan`

Sample request body

{
    "Repository": "<redacted>",
    "Ref": "main",
    "Type": "Gitlab",
    "Paths": [{
        "Directory": ".",
        "Workspace": "default"
    }]
}

Sample response

{
    "Error": null,
    "Failure": "",
    "ProjectResults": [
        {
            "Command": 1,
            "RepoRelDir": ".",
            "Workspace": "default",
            "Error": null,
            "Failure": "",
            "PlanSuccess": {
                "TerraformOutput": "\nTerraform used the selected providers to generate the following execution\nplan. Resource actions are indicated with the following symbols:\n+ create\n\nTerraform will perform the following actions:\n\n  # null_resource.null_1 will be created\n+ resource \"null_resource\" \"null_1\" {\n      + id = (known after apply)\n    }\n\nPlan: 1 to add, 0 to change, 0 to destroy.\n\n",
                "LockURL": "<redacted>",
                "RePlanCmd": "atlantis plan -d .",
                "ApplyCmd": "atlantis apply -d .",
                "HasDiverged": false
            },
            "PolicyCheckSuccess": null,
            "ApplySuccess": "",
            "VersionSuccess": "",
            "ProjectName": ""
        }
    ],
    "PlansDeleted": false
}

`api/apply`

Sample request body

{
    "Repository": "<redacted>",
    "Ref": "main",
    "Type": "Gitlab",
    "Paths": [{
        "Directory": ".",
        "Workspace": "default"
    }]
}

Sample response

{
    "Error": null,
    "Failure": "",
    "ProjectResults": [
        {
            "Command": 0,
            "RepoRelDir": ".",
            "Workspace": "default",
            "Error": null,
            "Failure": "",
            "PlanSuccess": null,
            "PolicyCheckSuccess": null,
            "ApplySuccess": "null_resource.null_1: Creating...\nnull_resource.null_1: Creation complete after 0s [id=7523377471507728929]\n\nApply complete! Resources: 1 added, 0 changed, 0 destroyed.\n\nOutputs:\n\ninstance_arn = \"<redacted>\"\n",
            "VersionSuccess": "",
            "ProjectName": ""
        }
    ],
    "PlansDeleted": false
}

smitthakkar96 · 2022-07-27T18:43:34Z

Good job and thanks to everyone involved. This was much needed 😍

jamengual · 2022-07-27T18:59:05Z

please test this a lot on the prerelease

https://github.com/runatlantis/atlantis/releases/tag/v0.19.8-pre.20220722

We need a lot of feedback.

nitrocode · 2022-07-31T15:35:53Z

Thank you @remilapeyre and @lilincmu and everyone involved! This is fantastic.

jurgen-weber-deltatre · 2022-08-05T01:18:27Z

YES!@!!!!! I am excited. :)

jayceebernardino · 2022-08-05T14:08:19Z

Thank you so much for this!

Dilergore · 2022-08-17T06:27:00Z

I think documentation would be required for this, especially about the request/response bodies. BTW this is awesome, thanks!

vincentgna · 2022-08-18T03:42:25Z

Please note a caveat regarding WebAuthentication middleware: #2455 (for ppl getting Unauthorized this may help resolve your problem)

lilincmu · 2022-08-23T22:14:11Z

If you have policy checks enabled, the /plan endpoint probably won't work, as described in #2456.

nitrocode · 2022-11-15T00:18:16Z

Relevant repo

https://github.com/cresta/atlantis-drift-detection

* Add the /plan and /apply endpoints * Resolve conflicts * Fix wrong merge * Add missing methods for mocks * Fix linting error * Fix linting error * Move api plan/apply into APIController * Extract commond code into helper functions * Implement GetCloneURL for GitHub Co-authored-by: Li Lin <li.lin@hashicorp.com>

Add the /plan and /apply endpoints

c8afddf

cep21 mentioned this pull request Apr 21, 2020

Drift detection via cron or API #1002

Closed

lkysow mentioned this pull request May 19, 2020

How to do force drift detection with atlantis #1035

Open

lkysow added the api-endpoints Adding API endpoints to Atlantis label May 25, 2020

jamengual added the waiting-on-review Waiting for a review from a maintainer label Jan 31, 2021

nitrocode mentioned this pull request Jul 14, 2022

feature request: UI button to trigger atlantis for reconciling environment drift #2075

Open

lilincmu added 2 commits July 19, 2022 14:50

Merge branch 'master' into http-api

0f5d884

Resolve conflicts

7f71142

remilapeyre requested a review from a team as a code owner July 19, 2022 22:02

lilincmu added 4 commits July 19, 2022 15:05

Fix wrong merge

40f76f6

Add missing methods for mocks

439623f

Fix linting error

34be22a

Fix linting error

08c7a4d

lilincmu removed the request for review from a team July 19, 2022 23:08

lilincmu marked this pull request as draft July 20, 2022 00:12

nitrocode reviewed Jul 20, 2022

View reviewed changes

lilincmu added 2 commits July 20, 2022 15:38

Move api plan/apply into APIController

bd36139

Extract commond code into helper functions

4511dfd

nitrocode reviewed Jul 21, 2022

View reviewed changes

Implement GetCloneURL for GitHub

c4438a7

lilincmu marked this pull request as ready for review July 21, 2022 00:58

lilincmu requested a review from a team July 21, 2022 00:59

jamengual merged commit b409cb8 into runatlantis:master Jul 27, 2022

lilincmu mentioned this pull request Aug 19, 2022

fix: allow requests to /api/* without authentication #2455

Merged

nitrocode mentioned this pull request Nov 3, 2022

Document all API endpoints #2640

Open

1 task

nitrocode mentioned this pull request Dec 29, 2022

Atlantis plan via curl #1263

Closed

jamengual mentioned this pull request Jan 6, 2023

docs: Add api-secret flag #2940

Merged

nitrocode mentioned this pull request Jan 8, 2023

/api/plan does not create workspace if it does not exist #2949

Open

nitrocode mentioned this pull request Jan 16, 2023

Atlantis 1.0.0 Release #2496

Open

7 tasks

lilincmu mentioned this pull request Jan 19, 2023

docs: /api/plan and /api/apply endpoints #3013

Merged

nitrocode added this to the v0.19.8 milestone Mar 23, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add the /plan and /apply endpoints #997

Add the /plan and /apply endpoints #997

remilapeyre commented Apr 16, 2020

cep21 commented Apr 22, 2020

lkysow commented Aug 18, 2020

llamahunter commented Oct 19, 2020

lkysow commented Oct 23, 2020

jamengual commented Dec 7, 2020

remilapeyre commented Dec 7, 2020

jayceebernardino commented Apr 15, 2021

infestonn commented Apr 23, 2021

jamengual commented Apr 23, 2021

remilapeyre commented May 16, 2021

gmaghera commented Sep 29, 2021

smitthakkar96 commented Apr 8, 2022

nitrocode commented Jul 14, 2022

jamengual commented Jul 14, 2022

nitrocode Jul 20, 2022

lilincmu Jul 21, 2022

cep21 commented Jul 20, 2022

nitrocode Jul 21, 2022

lilincmu Jul 21, 2022

lilincmu commented Jul 21, 2022

lilincmu commented Jul 21, 2022

lilincmu commented Jul 21, 2022

smitthakkar96 commented Jul 27, 2022

jamengual commented Jul 27, 2022

nitrocode commented Jul 31, 2022

jurgen-weber-deltatre commented Aug 5, 2022

jayceebernardino commented Aug 5, 2022

Dilergore commented Aug 17, 2022

vincentgna commented Aug 18, 2022 •

edited

lilincmu commented Aug 23, 2022 •

edited

nitrocode commented Nov 15, 2022

Add the /plan and /apply endpoints #997

Add the /plan and /apply endpoints #997

Conversation

remilapeyre commented Apr 16, 2020

cep21 commented Apr 22, 2020

lkysow commented Aug 18, 2020

llamahunter commented Oct 19, 2020

lkysow commented Oct 23, 2020

jamengual commented Dec 7, 2020

remilapeyre commented Dec 7, 2020

jayceebernardino commented Apr 15, 2021

infestonn commented Apr 23, 2021

jamengual commented Apr 23, 2021

remilapeyre commented May 16, 2021

gmaghera commented Sep 29, 2021

smitthakkar96 commented Apr 8, 2022

nitrocode commented Jul 14, 2022

jamengual commented Jul 14, 2022

nitrocode Jul 20, 2022

Choose a reason for hiding this comment

lilincmu Jul 21, 2022

Choose a reason for hiding this comment

cep21 commented Jul 20, 2022

nitrocode Jul 21, 2022

Choose a reason for hiding this comment

lilincmu Jul 21, 2022

Choose a reason for hiding this comment

lilincmu commented Jul 21, 2022

lilincmu commented Jul 21, 2022

lilincmu commented Jul 21, 2022

api/plan

Sample request body

Sample response

api/apply

Sample request body

Sample response

smitthakkar96 commented Jul 27, 2022

jamengual commented Jul 27, 2022

nitrocode commented Jul 31, 2022

jurgen-weber-deltatre commented Aug 5, 2022

jayceebernardino commented Aug 5, 2022

Dilergore commented Aug 17, 2022

vincentgna commented Aug 18, 2022 • edited

lilincmu commented Aug 23, 2022 • edited

nitrocode commented Nov 15, 2022

`api/plan`

`api/apply`

vincentgna commented Aug 18, 2022 •

edited

lilincmu commented Aug 23, 2022 •

edited