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

chore(docs): remove deprecated flags from docs #3165

Merged
merged 2 commits into from
Feb 25, 2023
Merged

chore(docs): remove deprecated flags from docs #3165

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f190a3a
chore: remove deprecated flags from docs
nitrocode Feb 25, 2023
338377a
Merge branch 'main' into rm-deprecated-from-docs
jamengual Feb 25, 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
85 changes: 0 additions & 85 deletions runatlantis.io/docs/server-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,34 +84,6 @@ Values are chosen in this order:
which can run arbitrary code if given a malicious Terraform configuration.
:::

### `--allow-repo-config`
<Badge text="Deprecated" type="warn"/>
```bash
atlantis server --allow-repo-config
# or
ATLANTIS_ALLOW_REPO_CONFIG=true
```
This flag is deprecated. It allows all repos to use all restricted
`atlantis.yaml` keys. See [Repo Level Atlantis.yaml](repo-level-atlantis-yaml.html) for more details.

Instead of using this flag, create a server-side `--repo-config` file:
```yaml
# repos.yaml
repos:
- id: /.*/
allowed_overrides: [apply_requirements, workflow]
allow_custom_workflows: true
```
Or use
```bash
--repo-config-json='{"repos":[{"id":"/.*/", "allowed_overrides":["apply_requirements","workflow"], "allow_custom_workflows":true}]}'
````

::: warning SECURITY WARNING
This setting enables pull requests to run arbitrary code on the Atlantis server.
Only enable in trusted settings.
:::

### `--api-secret`
```bash
atlantis server --api-secret="secret"
Expand Down Expand Up @@ -354,17 +326,6 @@ and set `--autoplan-modules` to `false`.
Terraform version to default to. Will download to `<data-dir>/bin/terraform<version>`
if not in `PATH`. See [Terraform Versions](terraform-versions.html) for more details.

### `--disable-apply`
<Badge text="Deprecated" type="warn"/>
```bash
atlantis server --disable-apply
# or
ATLANTIS_DISABLE_APPLY=true
```
Deprecated for `--allow-commands`.

Disable all `atlantis apply` commands, regardless of which flags are passed with it.

### `--disable-apply-all`
```bash
atlantis server --disable-apply-all
Expand Down Expand Up @@ -799,10 +760,6 @@ This is useful when you have many projects and want to keep the pull request cle
```
:::

### `--repo-whitelist`
<Badge text="Deprecated" type="warn"/>
Deprecated for `--repo-allowlist`.

### `--repo-allowlist`
```bash
# NOTE: Use single quotes to avoid shell expansion of *.
Expand Down Expand Up @@ -833,44 +790,6 @@ This is useful when you have many projects and want to keep the pull request cle
* Allowlist all repositories
* `--repo-allowlist='*'`

### `--require-approval`
<Badge text="Deprecated" type="warn"/>
```bash
atlantis server --require-approval
# or
ATLANTIS_REQUIRE_APPROVAL=true
```
This flag is deprecated. It requires all pull requests to be approved
before `atlantis apply` is allowed. See [Command Requirements](command-requirements.html) for more details.

Instead of using this flag, create a server-side `--repo-config` file:
```yaml
# repos.yaml
repos:
- id: /.*/
apply_requirements: [approved]
```
Or use `--repo-config-json='{"repos":[{"id":"/.*/", "apply_requirements":["approved"]}]}'` instead.

### `--require-mergeable`
<Badge text="Deprecated" type="warn"/>
```bash
atlantis server --require-mergeable
# or
ATLANTIS_REQUIRE_MERGEABLE=true
```
This flag is deprecated. It causes all pull requests to be mergeable
before `atlantis apply` is allowed. See [Command Requirements](command-requirements.html) for more details.

Instead of using this flag, create a server-side `--repo-config` file:
```yaml
# repos.yaml
repos:
- id: /.*/
apply_requirements: [mergeable]
```
Or use `--repo-config-json='{"repos":[{"id":"/.*/", "apply_requirements":["mergeable"]}]}'` instead.

### `--silence-fork-pr-errors`
```bash
atlantis server --silence-fork-pr-errors
Expand All @@ -880,10 +799,6 @@ This is useful when you have many projects and want to keep the pull request cle
Normally, if Atlantis receives a pull request webhook from a fork and --allow-fork-prs is not set,
it will comment back with an error. This flag disables that commenting.

### `--silence-whitelist-errors`
<Badge text="Deprecated" type="warn"/>
Deprecated for `--silence-allowlist-errors`.

### `--silence-allowlist-errors`
```bash
atlantis server --silence-allowlist-errors
Expand Down