Skip to content

Document sync target removal protection for environment groups #255

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

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document sync target removal protection for environment groups #255

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions applications/configure/environment-groups.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,16 @@ Environment groups can be deleted from the **Settings** tab on the environment g
You cannot delete an environment group that is synced to an application. Unsync the environment group from all applications before deleting it.
</Warning>

## Managing Sync Targets

An environment group can be synced to one or more clusters in your project. The list of clusters an environment group is available on is called its **sync targets**. You can update the sync target list from the environment group's **Settings** tab on the dashboard.

<Warning>
You cannot remove a cluster from an environment group's sync targets while applications on that cluster are still linked to the group. Unsync the environment group from any applications running on the cluster before removing it from the sync target list.
</Warning>

If you attempt to remove a sync target that still has linked applications, the update is rejected and no changes are applied — the environment group remains available on all of its current sync targets.

## CLI Reference

For the full list of flags and options, see the [porter env](/standard/cli/command-reference/porter-env) CLI reference.