Removal of security_configuration_redesign/_ee feature flags
Why are we doing this work
This issue tracks the removal of the security_configuration_redesign
and security_configuration_redesign_ee
feature flags, for the redesign of the Security Config Page tracked here.
Both will be removed at the same time, as the security_configuration_redesign
has been enabled in production for more than a milestone already, and security_configuration_redesign_ee
will have been enabled in production for nearly a milestone. Removing both flags together would allow for the removal of a lot of code and duplication (tech debt).
Relevant links
security_configuration_redesign
rollout issuesecurity_configuration_redesign_ee
rollout issue- Design Issue
(Optional) Release the feature with the feature flag
If you're still unsure whether the feature is deemed stable but want to release it in the current milestone, you can change the default state of the feature flag to be enabled. To do so, follow these steps:
- [-] Create a merge request with the following changes. Ask for review and merge it.
- [-] Set the
default_enabled
attribute in the feature flag definition totrue
. - [-] Create a changelog entry.
- [-] Set the
- [-] Ensure that the above MR has been deployed to both production and canary.
If the merge request was deployed before the code cutoff,
the feature can be officially announced in a release blog post.
- [-]
/chatops run auto_deploy status <merge-commit>
- [-]
- [-] Close the feature issue to indicate the feature will be released in the current milestone.
WARNING: This approach has the downside that it makes it difficult for us to clean up the flag. For example, on-premise users could disable the feature on their GitLab instance. But when you remove the flag at some point, they suddenly see the feature as enabled and they can't roll it back to the previous behavior. To avoid this potential breaking change, use this approach only for urgent matters.
Release the feature
After the feature has been deemed stable, the clean up should be done as soon as possible to permanently enable the feature and reduce complexity in the codebase.
-
Create a merge request to remove security_configuration_redesign(?:_ee)?
feature flag. Ask for review and merge it.-
Remove all references to the feature flag from the codebase. -
Remove the YAML definitions for the feature from the repository. -
Create a changelog entry.
-
-
Ensure that the above MR has been deployed to both production and canary. If the merge request was deployed before the code cutoff, the feature can be officially announced in a release blog post. -
/chatops run auto_deploy status <merge-commit>
-
-
Close the feature issue to indicate the feature will be released in the current milestone. -
Clean up the feature flag from all environments by running these chatops command in #production
channel:-
/chatops run feature delete security_configuration_redesign(?:_ee)? --dev
-
/chatops run feature delete security_configuration_redesign(?:_ee)? --staging
-
/chatops run feature delete security_configuration_redesign(?:_ee)?
-
-
Close this rollout issue.
Rollback Steps
-
This feature can be disabled by running the following Chatops command:
/chatops run feature set security_configuration_redesign false
/chatops run feature set security_configuration_redesign_ee false
Implementation plan
- Remove YAML definitions for feature flags
- Remove all code branches based on either feature flag
- Remove references to flags in documentation
- Remove code and tests related to old design, e.g. (non-exhaustive):
- EE
ee/security_configuration/components/app.vue
ee/security_configuration/components/configuration_table.vue
ee/security_configuration/components/feature_status.vue
ee/security_configuration/components/manage_dast_profiles.vue
ee/security_configuration/components/manage_feature.vue
ee/security_configuration/components/manage_generic.vue
ee/security_configuration/components/status_dast_profiles.vue
ee/security_configuration/components/status_view_history.vue
ee/security_configuration/components/status_generic.vue
- Unused constants in
ee/security_configuration/components/constants.js
- Unused initialisation in
ee/security_configuration/index.js
- CE
~/security_configuration/components/app.vue
~/security_configuration/components/configuration_table.vue
- Unused constants in
~/security_configuration/components/constants.js
- Unused initialisation in
~/security_configuration/index.js
- EE