Skip to content

Document entitlement errand as alternative to CF CLI commands #270

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
ameowlia wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document entitlement errand as alternative to CF CLI commands #270

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
24 changes: 24 additions & 0 deletions isolation-segments.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,30 @@ To delete an isolation segment:

The commands listed in the following sections manage the relationships between isolation segments, orgs, and spaces.

<% if vars.platform_code != 'CF' %>

### <a id="entitlement-errand"></a> Using the entitlement errand

As an alternative to manually managing org entitlements with CF CLI commands, you can use the Entitlement Errand to automatically associate organizations with isolation segments. The Entitlement Errand is a post-deploy errand that you configure in the <%= vars.segment_runtime_full %> tile.

When the Entitlement Errand runs, it:

* Creates an isolation segment in Cloud Controller if it doesn't already exist. This replaces running `cf create-isolation-segment SEGMENT-NAME`.
* Associates specified organizations with the isolation segment. This replaces running `cf enable-org-isolation ORG-NAME SEGMENT-NAME` for each organization.
* Optionally creates specified organizations that do not exist. This replaces running `cf create-org ORG-NAME` for organizations that need to be created.
* Optionally removes associations from organizations not in the configuration. This replaces running `cf disable-org-isolation ORG-NAME SEGMENT-NAME` for organizations that should no longer have access.
* Optionally restarts apps when entitlements change. This replaces manually running `cf restart APP-NAME` for each app in affected organizations.

For information about configuring the Entitlement Errand, see [Configure Entitlement Errand](./installing-pcf-is.html#entitlement-errand) in _Installing the <%= vars.segment_runtime_full %>_.

You can use the Entitlement Errand in addition to or instead of the CF CLI commands documented in the following sections. The errand is particularly useful for:

* Automating entitlement management during deployment
* Ensuring consistent entitlements across multiple environments
* Managing entitlements for multiple organizations at once

<% end %>

### <a id="enable_org_is"></a> Enabling an org to use isolation segments

Only admins can enable orgs to use isolation segments.
Expand Down