Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Custom container doc update #4054

Merged
merged 8 commits into from
Dec 14, 2023
Merged

docs: Custom container doc update #4054

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
21d38ed
Updating curl
jamengual Oct 12, 2023
e35aa9c
Merge branch 'main' of github.com:runatlantis/atlantis
jamengual Nov 9, 2023
f06b31c
Merge branch 'main' of github.com:runatlantis/atlantis
jamengual Dec 13, 2023
0b4acb5
Updating docs for custom image
jamengual Dec 13, 2023
8752e4f
Updating docs for custom image
jamengual Dec 13, 2023
1c8cc05
fixing note
jamengual Dec 13, 2023
5b09f6a
some style change
chenrui333 Dec 13, 2023
f58e1f2
Update runatlantis.io/docs/deployment.md
jamengual Dec 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions runatlantis.io/docs/custom-workflows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,7 @@ by CDKTF will be add to the Atlantis modified file list.
# Dockerfile
FROM ghcr.io/runatlantis/atlantis:v0.19.7

USER root
RUN apk add npm && npm i -g cdktf-cli
```

Expand Down
5 changes: 5 additions & 0 deletions runatlantis.io/docs/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,9 +554,14 @@ If you need to modify the Docker image that we provide, for instance to add the
FROM ghcr.io/runatlantis/atlantis:{latest version}

# copy a terraform binary of the version you need
USER root
COPY terragrunt /usr/local/bin/terragrunt
```

Beginning with version 0.26.0, the Atlantis image has been updated to run under the atlantis user, replacing the previous root user configuration. This change necessitates adjustments in existing container definitions and scripts to accommodate the new user settings. In scenarios where additional packages from other images are required, users can temporarily switch to the root user by inserting USER root in the Dockerfile. Following the installation of necessary packages, it is advisable to revert to the atlantis user for initiating the Atlantis service.
Additionally, the /docker-entrypoint.d/ directory offers a flexible option for introducing extra scripts to be executed prior to the launch of the Atlantis server. This feature is particularly beneficial for users seeking to customize their Atlantis instance without the need to develop a dedicated pipeline.
**Important Notice**: There is a critical update regarding the data directory in Atlantis. In versions prior to 0.26.0, the directory was configured to be accessible by the root user. However, with the transition to the atlantis user in newer versions, it is imperative to update the directory permissions accordingly in your current deployment when upgrading to a version later than 0.26.0. This step ensures seamless access and functionality for the atlantis user.

1. Build your Docker image
```bash
docker build -t {YOUR_DOCKER_ORG}/atlantis-custom .
Expand Down