docs: Explicit restrictions of atlantis user apply to the --data-dir flag
#2908
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jamengual
reviewed
Jan 3, 2023
nitrocode
changed the title
--data-dir flag usage.--data-dir flag
nitrocode
reviewed
Jan 3, 2023
| Terraform binaries here. If Atlantis loses this directory, [locks](locking.html) | ||
| will be lost and unapplied plans will be lost. | ||
|
|
||
| Note that the atlantis user is restricted to `/home/atlantis/`. |
There was a problem hiding this comment.
I'd mention the gosu portion in the atlantis-base image
There was a problem hiding this comment.
Is it not rather confusing to document this under the --data-dir flag?
nitrocode
changed the title
--data-dir flag--data-dir flag
|
Not sure why the CI build is failing though, it seems unrelated to my change |
bschaatsbergen
deleted the
document-atlantis-user-filesystem-restriction
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
what
As the atlantis user is restricted to the home directory of atlantis (
/home/atlantis), setting the--data-dirflag to another path will result in a permission denied error.I've updated the documentation to be more explicit on this common pitfall.
why
This is a common made mistake as we nowhere document how restricted the atlantis user is, I had to look at the docker-base to understand why, what and where the atlantis user permissions were applied.
tests
references
--data-diris not/home/atlantisresults in permission denied #2903