Add optimize and --no-optimize flags #16302

jbudz · 2018-01-25T21:36:35Z

This adds an optimize flag to bin/kibana and a no-optimize flag to bin/kibana-plugin. This doesn't change any current behavior beyond adding the new flags. If the optimize flag is used the server will not start after bundling.

epixa · 2018-01-25T21:38:06Z

Not against this, but it does seem like a breaking change

kimjoar · 2018-01-28T17:59:33Z

src/cli_plugin/install/install.js

@@ -30,8 +30,6 @@ export default async function install(settings, logger) {

    await renamePlugin(settings.workingPath, path.join(settings.pluginDir, settings.plugins[0].name));

-    await rebuildCache(settings, logger);


What if we kept rebuildCache as the default, but added a skip-optimize or something like that would skip rebuild? Then users could opt into this. We could also document this as the "recommended approach", but we can't make it a default just yet because it would be a breaking change.

Thoughts on taking a separate approach for 6.x (if any)? I'm fine targeting this for 7.0 only even if it's getting removed.

I ask because we do have workarounds documented, but there's so many bin/plugin install guides that's its usually not followed.

Part of the reason I'm so heavy handed in this PR is I'm not sure why we bundle on plugin install. I've had suspicions that we went this way on v1 and never revisited, but if there's more context I'd love to hear it.

Targeting this for K7 is okey with me (even if that means making no changes to 6.x).

Let's do --skip-optimize for 6.x and --optimize for 7.0. Just make sure to add it to the breaking changes in master. And we should update all references in our docs to use --skip-optimize to help folks migrate to this pattern sooner.

Also, if you do what I just suggested, I strongly recommend making one PR that makes the --skip-optimize change to both master/6.x, then follow up with a PR that adds the --optimize argument, breaking change doc, and a clear error message when someone uses --skip-optimize

jbudz · 2018-07-05T19:40:40Z

@elastic/kibana-operations I was about to close this out with #7322 as the approach but I wanted to throw up a refactor of this for a quick glance.

It's lower risk with no breaking changes, and when 7322 is in this would hopefully be a simple revert.

elasticmachine · 2018-07-05T20:46:04Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

tylersmalley · 2018-07-31T22:50:47Z

@jbudz want to make the changes mentioned in #16302 (comment) and we can move forward with this PR?

jbudz · 2018-08-01T13:44:18Z

I can but that was how it was organized originally. I think the comment implies getting this merged and backported, and then opening a breaking PR to master on top of this one.

Either way not a problem, lemme know.

jbudz · 2018-08-01T13:46:14Z

Updated the top level description to indicate current state, sorry about that.

tylersmalley · 2018-08-06T14:37:17Z

src/cli_plugin/install/index.js

@@ -47,6 +47,7 @@ export default function pluginInstall(program) {
    .command('install <plugin/url>')
    .option('-q, --quiet', 'disable all process messaging except errors')
    .option('-s, --silent', 'disable all process messaging')
+    .option('--no-optimize', 'disable optimization after plugin extraction')


--skip-optimize was mentioned here, but I am OK with --no-optimize as the option.

++ for Commander convention.

tylersmalley · 2018-08-06T14:39:22Z

@jbudz I pointed out one inconsistency with the feedback. Can we also update the docs as Court mentioned to use this option?

elasticmachine · 2018-08-10T20:42:14Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

tylersmalley · 2018-09-04T23:56:54Z

@jbudz this LGTM - just one more small ask. Can we remove --no-optimize from all of the commands in the docs and instead add a section similar to what we have done for --plugin-dir.

Something like:

Installing plugins while deferring optimization

The majority of the time spent installing a plugin is running the optimizer. If you're installing multiple plugins it can make sense to omit that step and only run it once. This can be done by providing --no-optimize to the plugin installation command. You can either execute bin/kibana --optimize to run the optimizer, or it will be ran the first time Kibana is started.

elasticmachine · 2018-09-05T01:46:06Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

elasticmachine · 2018-09-06T19:15:36Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

tylersmalley · 2018-09-07T00:56:22Z

@jbudz looks like this was caught by prettier.

17:53:14 ERROR kibana failed
17:53:14       /var/lib/jenkins/workspace/elastic+kibana+pull-request+multijob-intake/kibana/src/core/server/bootstrap.ts
17:53:14       ERROR: 89:21  prettier  Insert `;`

elasticmachine · 2018-09-17T13:28:14Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2018-09-17T15:26:16Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2018-09-17T17:24:11Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

jbudz · 2018-09-17T17:45:06Z

I pushed three changes since the approval, tsc/lint/snapshot fixes. Merging away.

* Add optimize flags * update docs to --no-optimize * docs * extra newline * lint * update mocks * update default config * update snapshots

jbudz · 2018-09-17T17:48:48Z

6.x/5: 0eb4f58

jbudz added review Team:Operations Team label for Operations Team labels Jan 25, 2018

jbudz changed the title ~~[plugins] Remove optimization step~~ [plugins installation] Move optimization step to server Jan 25, 2018

jbudz changed the title ~~[plugins installation] Move optimization step to server~~ [plugin installation] Move optimize step to server Jan 25, 2018

jbudz added the release_note:breaking label Jan 25, 2018

kimjoar reviewed Jan 28, 2018

View reviewed changes

jbudz added updates_needed and removed review labels Jan 29, 2018

jbudz force-pushed the plugins/optimize branch from cafc504 to 1302cc2 Compare July 5, 2018 19:34

jbudz added review and removed release_note:breaking updates_needed labels Jul 5, 2018

jbudz requested a review from tylersmalley July 16, 2018 16:10

tylersmalley reviewed Aug 6, 2018

View reviewed changes

jbudz force-pushed the plugins/optimize branch from 1302cc2 to a5843be Compare August 10, 2018 18:36

jbudz changed the title ~~[plugin installation] Move optimize step to server~~ Add optimize and --no-optimize flags Aug 10, 2018

jbudz force-pushed the plugins/optimize branch from a5843be to 1115f63 Compare September 6, 2018 17:36

tylersmalley approved these changes Sep 7, 2018

View reviewed changes

jbudz added 5 commits September 17, 2018 08:09

Add optimize flags

67c54e3

update docs to --no-optimize

04edfb7

docs

52d642d

extra newline

7100bed

lint

4bd12db

jbudz force-pushed the plugins/optimize branch from 5810070 to 4bd12db Compare September 17, 2018 13:12

jbudz added 2 commits September 17, 2018 08:40

update mocks

8c25a90

update default config

31fa1ee

update snapshots

7225f1f

jbudz merged commit f5d44f6 into elastic:master Sep 17, 2018

jbudz added v7.0.0 v6.5.0 labels Sep 17, 2018

jbudz added a commit that referenced this pull request Sep 17, 2018

Add optimize and --no-optimize flags (#16302)

0eb4f58

* Add optimize flags * update docs to --no-optimize * docs * extra newline * lint * update mocks * update default config * update snapshots

mistic mentioned this pull request Oct 2, 2018

Multiple plugin installation #10744

Closed

joshdover mentioned this pull request Oct 10, 2018

[kibana-plugin CLI][master] add optimize task and skip-optimize option on install task #14991

Closed

jbudz mentioned this pull request Dec 11, 2018

[plugin cli] defer optimization #26983

Merged

tylersmalley mentioned this pull request Feb 7, 2019

add command line option to execute the optimize task standalone #6057

Closed

tsullivan mentioned this pull request Mar 29, 2019

Kibana missing styles after optimization #11588

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add optimize and --no-optimize flags #16302

Add optimize and --no-optimize flags #16302

jbudz commented Jan 25, 2018 •

edited

Loading

epixa commented Jan 25, 2018

kimjoar Jan 28, 2018

jbudz Jan 29, 2018

jbudz Jan 29, 2018

kimjoar Jan 29, 2018

epixa Jan 29, 2018

epixa Jan 29, 2018

jbudz commented Jul 5, 2018

elasticmachine commented Jul 5, 2018

tylersmalley commented Jul 31, 2018

jbudz commented Aug 1, 2018

jbudz commented Aug 1, 2018

tylersmalley Aug 6, 2018

tylersmalley Aug 6, 2018

tylersmalley commented Aug 6, 2018

elasticmachine commented Aug 10, 2018

tylersmalley commented Sep 4, 2018 •

edited

Loading

elasticmachine commented Sep 5, 2018

elasticmachine commented Sep 6, 2018

tylersmalley commented Sep 7, 2018

elasticmachine commented Sep 17, 2018

elasticmachine commented Sep 17, 2018

elasticmachine commented Sep 17, 2018

jbudz commented Sep 17, 2018

jbudz commented Sep 17, 2018

		@@ -30,8 +30,6 @@ export default async function install(settings, logger) {

		await renamePlugin(settings.workingPath, path.join(settings.pluginDir, settings.plugins[0].name));

		await rebuildCache(settings, logger);

Add optimize and --no-optimize flags #16302

Add optimize and --no-optimize flags #16302

Conversation

jbudz commented Jan 25, 2018 • edited Loading

epixa commented Jan 25, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jbudz commented Jul 5, 2018

elasticmachine commented Jul 5, 2018

💚 Build Succeeded

tylersmalley commented Jul 31, 2018

jbudz commented Aug 1, 2018

jbudz commented Aug 1, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tylersmalley commented Aug 6, 2018

elasticmachine commented Aug 10, 2018

💚 Build Succeeded

tylersmalley commented Sep 4, 2018 • edited Loading

Installing plugins while deferring optimization

elasticmachine commented Sep 5, 2018

💚 Build Succeeded

elasticmachine commented Sep 6, 2018

💔 Build Failed

tylersmalley commented Sep 7, 2018

elasticmachine commented Sep 17, 2018

💔 Build Failed

elasticmachine commented Sep 17, 2018

💔 Build Failed

elasticmachine commented Sep 17, 2018

💚 Build Succeeded

jbudz commented Sep 17, 2018

jbudz commented Sep 17, 2018

jbudz commented Jan 25, 2018 •

edited

Loading

tylersmalley commented Sep 4, 2018 •

edited

Loading