Skip to content

Welcome to Atlantis!#1

Open
karusaurio wants to merge 1 commit into
mainfrom
example
Open

Welcome to Atlantis!#1
karusaurio wants to merge 1 commit into
mainfrom
example

Conversation

@karusaurio
Copy link
Copy Markdown
Owner

In this pull request we will learn how to use Atlantis.

  1. In a couple of seconds you should see the output of Atlantis automatically running terraform plan.

  2. You can manually run plan by typing a comment:

    atlantis plan
    

    Usually you'll let Atlantis automatically run plan for you though.

  3. To see all the comment commands available, type:

    atlantis help
    
  4. To see the help for a specific command, for example atlantis plan, type:

    atlantis plan --help
    
  5. Atlantis holds a "Lock" on this directory to prevent other pull requests modifying
    the Terraform state until this pull request is merged. To view the lock, go to the Atlantis UI: http://localhost:4141.
    If you wanted, you could manually delete the plan and lock from the UI if you weren't ready to apply. Instead, we will apply it!

  6. To terraform apply this change (which does nothing because it is creating a null_resource), type:

    atlantis apply
    

    NOTE: Because this example isn't using remote state storage the state will be lost once the pull request is merged. To use Atlantis properly, you must be using remote state.

  7. Finally, merge the pull request to unlock this directory.

Thank you for trying out Atlantis! Next, try using Atlantis on your own repositories: www.runatlantis.io/guide/getting-started.html.

@karusaurio
Copy link
Copy Markdown
Owner Author

Ran Plan for dir: . workspace: default

Terraform used the selected providers to generate the following execution
plan. Resource actions are indicated with the following symbols:
+ create

Terraform will perform the following actions:

  # null_resource.example will be created
+ resource "null_resource" "example" {
      + id = (known after apply)
    }

Plan: 1 to add, 0 to change, 0 to destroy.
  • ▶️ To apply this plan, comment:
    atlantis apply -d .
  • 🚮 To delete this plan and lock, click here
  • 🔁 To plan this project again, comment:
    atlantis plan -d .

  • ⏩ To apply all unapplied plans from this Pull Request, comment:
    atlantis apply
  • 🚮 To delete all plans and locks from this Pull Request, comment:
    atlantis unlock

@karusaurio
Copy link
Copy Markdown
Owner Author

atlantis help

@karusaurio
Copy link
Copy Markdown
Owner Author

atlantis
Terraform Pull Request Automation

Usage:
  atlantis <command> [options] -- [terraform options]

Examples:
  # show atlantis help
  atlantis help

  # run plan in the root directory passing the -target flag to terraform
  atlantis plan -d . -- -target=resource

  # apply all unapplied plans from this pull request
  atlantis apply

  # apply the plan for the root directory and staging workspace
  atlantis apply -d . -w staging

Commands:
  plan     Runs 'terraform plan' for the changes in this pull request.
           To plan a specific project, use the -d, -w and -p flags.
  apply    Runs 'terraform apply' on all unapplied plans from this pull request.
           To only apply a specific plan, use the -d, -w and -p flags.
  unlock   Removes all atlantis locks and discards all plans for this PR.
           To unlock a specific plan you can use the Atlantis UI.
  approve_policies
           Approves all current policy checking failures for the PR.
  version  Print the output of 'terraform version'
  help     View help.

Flags:
  -h, --help   help for atlantis

Use "atlantis [command] --help" for more information about a command.

@karusaurio
Copy link
Copy Markdown
Owner Author

atlantis plan

@karusaurio
Copy link
Copy Markdown
Owner Author

Ran Plan for dir: . workspace: default

Terraform used the selected providers to generate the following execution
plan. Resource actions are indicated with the following symbols:
+ create

Terraform will perform the following actions:

  # null_resource.example will be created
+ resource "null_resource" "example" {
      + id = (known after apply)
    }

Plan: 1 to add, 0 to change, 0 to destroy.
  • ▶️ To apply this plan, comment:
    atlantis apply -d .
  • 🚮 To delete this plan and lock, click here
  • 🔁 To plan this project again, comment:
    atlantis plan -d .

  • ⏩ To apply all unapplied plans from this Pull Request, comment:
    atlantis apply
  • 🚮 To delete all plans and locks from this Pull Request, comment:
    atlantis unlock

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant