[TIP] Enables TI plugin with kibana.yml feature flag #137838

PhilippeOberti · 2022-08-02T13:02:27Z

Summary

The Threat Intelligence plugin (introduced in this PR) and is not yet ready for General Availability. This PR hides the new plugin behind a feature flag. As the plugin is dynamically loaded within the Security Solution plugin, we're leveraging the already existing allowedExperimentalValues constant to:

show/hide the navbar entries in both old and new navigation
load the plugin

How to test

Threat Intelligence plugin disabled:

start Kibana without adding any Threat Intelligence entry to your kibana.yml
check that the in the old navigation, the Threat Intelligence entry doesn't appear in the Explore section of the sidenav
check that in the new navigation, the Threat Intelligence panel doesn't appear in the Explore section
check that trying to deep link to http://localhost:5601/app/security/threat_intelligence redirects to http://localhost:5601/app/security/get_started

Screen.Recording.2022-08-02.at.2.51.21.PM.mov

Threat Intelligence plugin enabled:

in your kibana.yml file, add the following entry at the bottom xpack.securitySolution.enableExperimental: ['threatIntelligenceEnabled']
check that

Screen.Recording.2022-08-02.at.2.57.27.PM.mov

When the Threat Intelligence plugin is ready for General Availability, we should be able to simply do a revert of this commit! :)

https://github.com/elastic/security-team/issues/4505

Checklist

Delete any items that are not applicable to this PR.

Unit or functional tests were updated or added to match the most common scenarios

PhilippeOberti · 2022-08-02T13:03:17Z

x-pack/plugins/security_solution/common/experimental_features.ts

@@ -22,9 +22,10 @@ export const allowedExperimentalValues = Object.freeze({
  pendingActionResponsesWithAck: true,
  policyListEnabled: true,
  policyResponseInFleetEnabled: true,
+  threatIntelligenceEnabled: false,


not sure I was allowed to use this object but it seemed to make sense, as the Threat Intelligence plugin is loaded within the Security Solution plugin

PhilippeOberti · 2022-08-02T13:05:11Z

x-pack/plugins/security_solution/public/common/links/app_links.ts

 ): Promise<AppLinkItems> => {
  const managementFilteredLinks = await getManagementFilteredLinks(core, plugins);

+  const threatHuntingFilteredLinks = {


I hesitated to go the opposite way (adding the threatIntelligence entry to the threatHuntingLandingLinks.link property) but going this current route meant modifying one less file.

no need to do this, links have support for experimentalFeatures, you can add the experimentalKey: 'threatIntelligenceEnabled', prop directly to the threat intelligence link definition at: https://github.com/elastic/kibana/blob/main/x-pack/plugins/security_solution/public/threat_intelligence/links.ts

haha I had took a note of this experimentalKey while working on another feature, tried it and didn't get it to work... I'll try again thank you :)

yeah that worked, I don't know what I did... must have forgotten to update my kibana.yml... 🤦‍♂️

lgestc · 2022-08-02T13:25:07Z

How does it work with our e2e suite?:)

x-pack/plugins/security_solution/public/types.ts

PhilippeOberti · 2022-08-02T13:27:00Z

How does it work with our e2e suite?:)

crap I forgot about that, looking into it now 😆

PhilippeOberti · 2022-08-02T13:55:44Z

How does it work with our e2e suite?:)

fixed with this https://github.com/elastic/kibana/pull/137838/files#diff-44620cc130a0b96260224571a9a76e86eae76d5924f3798cca8838224bf8340cR54

maxcold

Tested, works as expected

- show/hide navbar entries in both old and new navigation per feature flag value - load plugin per feature flag value - flag: xpack.securitySolution.enableExperimental: ['threatIntelligenceEnabled'] elastic/security-team#4505

semd · 2022-08-04T12:55:35Z

x-pack/plugins/security_solution/public/common/links/app_links.ts

 ): Promise<AppLinkItems> => {
  const managementFilteredLinks = await getManagementFilteredLinks(core, plugins);

+  const threatHuntingFilteredLinks = {


no need to do this, links have support for experimentalFeatures, you can add the experimentalKey: 'threatIntelligenceEnabled', prop directly to the threat intelligence link definition at: https://github.com/elastic/kibana/blob/main/x-pack/plugins/security_solution/public/threat_intelligence/links.ts

…ally

semd · 2022-08-04T13:32:24Z

Would it be possible to start the subPlugin normally in the plugin and check the experimental flag inside the threat_intelligence main component?

kibana/x-pack/plugins/security_solution/public/threat_intelligence/routes.tsx

Lines 14 to 25 in 70efbf0

    
           const ThreatIntelligenceRoutes = () => ( 
        
             <TrackApplicationView viewId={SecurityPageName.threatIntelligence}> 
        
               <ThreatIntelligencePage /> 
        
             </TrackApplicationView> 
        
           ); 
        
           export const routes: SecuritySubPluginRoutes = [ 
        
             { 
        
               path: THREAT_INTELLIGENCE_PATH, 
        
               render: ThreatIntelligenceRoutes, 
        
             }, 
        
           ];

So we don't have to do all those conditionals in the plugin.tsx and the types file. It will be easier to undo later on as well.
Suggestion:

import { useIsExperimentalFeatureEnabled } from '../common/hooks/use_experimental_features';

const ThreatIntelligenceRoutes = () => {
  const enabled = useIsExperimentalFeatureEnabled('threatIntelligenceEnabled');
  if (!enabled) {
    return null;
  }
  return (
    <TrackApplicationView viewId={SecurityPageName.threatIntelligence}>
      <ThreatIntelligencePage />
    </TrackApplicationView>
  );
};

export const routes: SecuritySubPluginRoutes = [
  {
    path: THREAT_INTELLIGENCE_PATH,
    component: ThreatIntelligenceRoutes,
  },
];

PhilippeOberti · 2022-08-04T13:34:46Z

Would it be possible to start the subPlugin normally in the plugin and check the experimental flag inside the threat_intelligence main component?

@semd absolutely! I thought I was being smart by not having the plugin load at all, but if this is not required/desired I'll gladly remove all the logic and make this PR a lot smaller!

Plugin is now loaded all the time, and the logic to show the indicators page or route back to the Get Started page from Security is handled within the Threat Intelligence folder

semd

Awesome! LGTM 🚀
thanks

MadameSheema · 2022-08-04T16:34:04Z

x-pack/test/security_solution_cypress/config.ts

@@ -52,6 +52,7 @@ export default async function ({ readConfigFile }: FtrConfigProviderContext) {
          'riskyHostsEnabled',
          'riskyUsersEnabled',
          'insightsRelatedAlertsByProcessAncestry',
+          'threatIntelligenceEnabled',


Is there any plan of adding specific TI plugin tests on Security Solution Cypress tests?

@MadameSheema we have some e2e Cypress tests in our plugin directly and this PR updates some e2e Cypress tests within the Security Solution plugin.

I wasn't thinking about adding any other tests, especially because this feature flag is temporary and should be very short lived. We're planning on releasing everything in 8.5 (plans could change though).

Did you have anything specify in mind you wanted me/us to add?

PhilippeOberti · 2022-08-08T08:42:25Z

@elasticmachine merge upstream

kibana-ci · 2022-08-08T09:56:20Z

💚 Build Succeeded

Buildkite Build
Commit: 0b2e554

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`securitySolution`	5.6MB	5.6MB	+240.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`securitySolution`	254.7KB	254.8KB	+29.0B

History

💚 Build #63190 succeeded 815f876
💚 Build #62739 succeeded 5bfd9bc
💔 Build #62601 failed a8fbab461e6ec997696df1f9fe20e0e2e73ceecd
💔 Build #62408 failed d136d198efc3d590c62ee2f8b5c37939236d747d

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

MadameSheema

LGTM

- show/hide navbar entries in both old and new navigation per feature flag value - load plugin per feature flag value - flag: xpack.securitySolution.enableExperimental: ['threatIntelligenceEnabled'] elastic/security-team#4505 (cherry picked from commit ff28e68)

kibanamachine · 2022-08-09T10:04:26Z

💚 All backports created successfully

Status	Branch	Result
✅	8.4

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

…elastic#138373) - show/hide navbar entries in both old and new navigation per feature flag value - load plugin per feature flag value - flag: xpack.securitySolution.enableExperimental: ['threatIntelligenceEnabled'] elastic/security-team#4505 (cherry picked from commit ff28e68) Co-authored-by: Philippe Oberti <[email protected]>

PhilippeOberti requested review from a team as code owners August 2, 2022 13:02

PhilippeOberti requested review from maxcold and lgestc August 2, 2022 13:02

PhilippeOberti commented Aug 2, 2022

View reviewed changes

PhilippeOberti added release_note:skip Skip the PR/issue when compiling release notes 8.4 candidate v8.4.0 Team: Protections Experience backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) labels Aug 2, 2022

lgestc reviewed Aug 2, 2022

View reviewed changes

x-pack/plugins/security_solution/public/types.ts Outdated Show resolved Hide resolved

PhilippeOberti requested a review from a team as a code owner August 2, 2022 13:55

PhilippeOberti requested a review from lgestc August 2, 2022 13:56

maxcold approved these changes Aug 2, 2022

View reviewed changes

PhilippeOberti force-pushed the tip-feature-flag branch from d136d19 to a8fbab4 Compare August 2, 2022 20:41

PhilippeOberti requested a review from a team as a code owner August 2, 2022 20:41

lgestc approved these changes Aug 3, 2022

View reviewed changes

PhilippeOberti added 2 commits August 3, 2022 12:43

[TIP] Enables TI plugin with kibana.yml feature flag

e6ca139

- show/hide navbar entries in both old and new navigation per feature flag value - load plugin per feature flag value - flag: xpack.securitySolution.enableExperimental: ['threatIntelligenceEnabled'] elastic/security-team#4505

[TIP] Add config entry for e2e Cypress tests

5bfd9bc

PhilippeOberti force-pushed the tip-feature-flag branch from a8fbab4 to 5bfd9bc Compare August 3, 2022 10:44

semd requested changes Aug 4, 2022

View reviewed changes

[TIP] Use experimentalKey feature instead of filtering out entry manu…

346e397

…ally

PhilippeOberti mentioned this pull request Aug 4, 2022

[TIP] Restrict content visibility for non-enterprise users #138097

Merged

1 task

PhilippeOberti force-pushed the tip-feature-flag branch from ee8c027 to 71cd3b6 Compare August 4, 2022 13:55

PhilippeOberti force-pushed the tip-feature-flag branch from 71cd3b6 to ad3b62c Compare August 4, 2022 13:56

[TIP] Simplified TI plugin logic

815f876

Plugin is now loaded all the time, and the logic to show the indicators page or route back to the Get Started page from Security is handled within the Threat Intelligence folder

PhilippeOberti force-pushed the tip-feature-flag branch from ad3b62c to 815f876 Compare August 4, 2022 13:57

semd approved these changes Aug 4, 2022

View reviewed changes

MadameSheema reviewed Aug 4, 2022

View reviewed changes

Merge branch 'main' into tip-feature-flag

0b2e554

MadameSheema approved these changes Aug 9, 2022

View reviewed changes

PhilippeOberti merged commit ff28e68 into elastic:main Aug 9, 2022

PhilippeOberti deleted the tip-feature-flag branch August 9, 2022 10:00

kibanamachine added the v8.5.0 label Aug 9, 2022

kibanamachine mentioned this pull request Aug 9, 2022

[8.4] [TIP] Enables TI plugin with kibana.yml feature flag (#137838) #138373

Merged

PhilippeOberti mentioned this pull request Sep 20, 2022

[TIP] Remove feature flag for Threat Intelligence plugin #141117

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TIP] Enables TI plugin with kibana.yml feature flag #137838

[TIP] Enables TI plugin with kibana.yml feature flag #137838

PhilippeOberti commented Aug 2, 2022 •

edited by kibanamachine

Loading

PhilippeOberti Aug 2, 2022

PhilippeOberti Aug 2, 2022

semd Aug 4, 2022

PhilippeOberti Aug 4, 2022 •

edited

Loading

PhilippeOberti Aug 4, 2022

lgestc commented Aug 2, 2022

PhilippeOberti commented Aug 2, 2022

PhilippeOberti commented Aug 2, 2022

maxcold left a comment

semd Aug 4, 2022

semd commented Aug 4, 2022

PhilippeOberti commented Aug 4, 2022

semd left a comment

MadameSheema Aug 4, 2022

PhilippeOberti Aug 8, 2022

PhilippeOberti commented Aug 8, 2022

kibana-ci commented Aug 8, 2022

MadameSheema left a comment

kibanamachine commented Aug 9, 2022

[TIP] Enables TI plugin with kibana.yml feature flag #137838

[TIP] Enables TI plugin with kibana.yml feature flag #137838

Conversation

PhilippeOberti commented Aug 2, 2022 • edited by kibanamachine Loading

Summary

How to test

Checklist

PhilippeOberti Aug 2, 2022

Choose a reason for hiding this comment

PhilippeOberti Aug 2, 2022

Choose a reason for hiding this comment

semd Aug 4, 2022

Choose a reason for hiding this comment

PhilippeOberti Aug 4, 2022 • edited Loading

Choose a reason for hiding this comment

PhilippeOberti Aug 4, 2022

Choose a reason for hiding this comment

lgestc commented Aug 2, 2022

PhilippeOberti commented Aug 2, 2022

PhilippeOberti commented Aug 2, 2022

maxcold left a comment

Choose a reason for hiding this comment

semd Aug 4, 2022

Choose a reason for hiding this comment

semd commented Aug 4, 2022

PhilippeOberti commented Aug 4, 2022

semd left a comment

Choose a reason for hiding this comment

MadameSheema Aug 4, 2022

Choose a reason for hiding this comment

PhilippeOberti Aug 8, 2022

Choose a reason for hiding this comment

PhilippeOberti commented Aug 8, 2022

kibana-ci commented Aug 8, 2022

💚 Build Succeeded

Metrics [docs]

Async chunks

Page load bundle

History

MadameSheema left a comment

Choose a reason for hiding this comment

kibanamachine commented Aug 9, 2022

💚 All backports created successfully

Questions ?

PhilippeOberti commented Aug 2, 2022 •

edited by kibanamachine

Loading

PhilippeOberti Aug 4, 2022 •

edited

Loading