Requesting approval for flag configurations

4 minute read

In many cases, feature flags change the production environment or other regulated environments.

Any user with write access can make changes to flag configurations without receiving a review request. While a request is not required, users can request a review before their changes are applied.

Users with read only access can make changes to a flag configuration and submit the changes for review before they are applied.

Users with read only access cannot make changes to a flag without a review request.

Review requests can only be approved by a colleague with write permissions.

Submitting requests for flag configurations allows companies that require a higher level of governance to enforce change management policies and to stay compliant with SOC and SOX requirements.

Review requests allow companies to ensure internal processes are followed for training purposes or for an additional layer of administrative awareness.

Changes to flag configurations are captured in the Audit log for each individual flag as well as the main audit log for all flags.

Submitting a configuration approval request

When an approval requests is submitted, and a request is pending, the Audience page will be disabled to other users.

To request a review and approval for a feature flag:

  1. From the CloudBees Feature Management Home page, select the application.

  2. From the left pane, navigate to Flags in environments and select the environment.

  3. From the top left corner of the screen, select Create flag, or select an existing flag to make changes.

  4. Configure the flag.

  5. From the bottom right corner of your screen, in the Save Targeting dropdown list, select Request Changes to send the approval request to the administrators on your team.

    Selecting Request Changes
    Figure 1. Request Changes

    If your submission for approval is successful you will see the requested changes on your screen, you will receive an email notifying you that the change has been submitted, and an email will be sent to your administrator and colleagues with write permissions. An alert will briefly appear at the top of the page with the following message:

    Approval requested. Your changes have been sent for approval to your peers. Audience is now locked until a response has been received.
    Figure 2. Approval requested

    If your submission is unsuccessful the alert will briefly display an alert notifying you that the request failed, and the possible causes. And a second alert that persists will be displayed in the middle of your screen with a link to request support as follows:

    Error loading approval request. Audience is set read only. Another approval request may be preventing your changes from being saved. Please contact CloudBees Suppport if the issue persists.
    Figure 3. Approval request failed

Withdrawing an approval request

When an approval request is pending, the Audience tab is locked to other users. You can withdraw an approval request to unlock the tab and cancel the flag configuration change.

To withdraw a request that you created and is still pending:

  1. From the CloudBees Feature Management Home page, select the application.

  2. From the left pane, navigate to Flags in environments and select the environment.

  3. From the top left corner of the screen, select the flag that changes were requested for.

  4. On the Audience targeting page, in the bottom right of your screen, select Save Targeting Withdraw request to cancel the update to the feature flag configuration and unlock the Audience page.

Approving an approval request

Flag configurations that are submitted for approval can only be approved by an administrator.

To approve a pending feature flag approval request:

  1. From within the email requesting a review, select Approve or reject to open the flag configuration.

    If you are already within CloudBees Feature Management you can access the flag as follows:

    1. Select the CloudBees Feature Management Home page, select the application.

    2. From the left pane, navigate to Flags in environments and select the environment.

    3. From the top left corner of the screen, select the flag that changes were requested for.

  2. On the Audience targeting page, select Save Targeting Approve changes to approve the request and unlock the Audience page.

    Approve changes.

Rejecting an approval request

To reject a pending feature flag approval request:

  1. From within the email requesting a review, select Approve or reject to open the flag configuration.

    If you are already within CloudBees Feature Management you can access the flag as follows:

    1. Select the CloudBees Feature Management Home page, select the application.

    2. From the left pane, navigate to Flags in environments and select the environment.

    3. From the top left corner of the screen, select the flag that changes were requested for.

  2. On the Audience targeting page, select Save Targeting Reject changes to reject the request and unlock the Audience page.

    Reject changes

The Audience page is unlocked to allow new feature flag creation, and an email is sent to the feature flag author with the name of the reviewer and the status of the request.

Reviewing the feature flag audit log

Flag changes are recorded in the main audit log for all flag configurations, as well as the individual audit log for each flag.

This section describes how to view the audit log for an individual flag.

Refer to Audit log for more information about the main audit log for all flags.

The audit log tracks the following information:

  • The administrator that approved the change (if requested)

  • The type of change that was requested or implemented

  • The date and time the change was made

  • The flag configuration

  • The author of the change

To view previous changes to a feature flag and approval request information:

  1. From the CloudBees Feature Management Home page, select the application.

  2. From the left pane, navigate to Flags in environments and select the environment.

  3. Select the feature flag to open it.

  4. Select the Audit Log tab.

    The log defaults to display the last 30 days of activity.

  5. To view a different range of dates, select Last 30 days and then choose a display option, or select Date range and then select a date for the Start Date and End Date.

    The start and end date ranges.
    Figure 4. Selecting the audit log date range

The audit log displays all changes within the selected dates.