[console] Deprecate "proxyFilter" and "proxyConfig" on 8.x #113555

sebelga · 2021-09-30T16:31:12Z

Remove support for the "proxyFilter" and "proxyConfig" Kibana setting in console from 8.x.

How to test

Add the following in your kibana.yml

console.proxyFilter:
  - ^https?://(localhost|127\.0\.0\.1|\[::0\]).*
console.proxyConfig:
  - match:
      host: "*.internal.org" # allow any host that ends in .internal.org
      port: "{9200..9299}" # allow any port from 9200-9299
      protocol: "foo"
      path: "bar"
    timeout: 1000
    ssl:
      ca:
        - "/opt/certs/internal.ca"
      verify: false
      cert: "foo"
      key: "bar"

The Kibana server should throw an error mentioning that those settings are unknown.

Now change the MAJOR_VERSION constant in src/plugins/console/common/constants/plugin.ts to 7.16.0. The server will restart and won't throw an error for those settings anymore.

Test the deprecation in Upgrade Assistant:

Open x-pack/plugins/upgrade_assistant/public/plugin.ts
Change L20 with const readonly = false;
Navigate to Upgrade Assistant. You should see the 2 console settings under critical

Release note

We removed support for the console.proxyFilter and console.proxyConfig Kibana setting in favour of the standard server.ssl.* and elasticsearch.ssl.keyPassphrase settings.

Fixes #39494

sebelga · 2021-10-04T10:45:12Z

src/plugins/console/server/routes/api/console/proxy/params.test.ts

@@ -5,14 +5,17 @@
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */
+import { SemVer } from 'semver';


Turn on "Hide whitespace changes" in Github to review this file

…oxyConfig-proxyFilter-support

elasticmachine · 2021-10-04T10:47:35Z

Pinging @elastic/kibana-stack-management (Team:Stack Management)

kibanamachine · 2021-10-04T12:49:04Z

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

💚 Build #157308 succeeded a09a083
💔 Build #157210 failed 47d4973
💚 Build #157137 succeeded 3fc6e21
💔 Build #156832 failed 27c5f25

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

sabarasaba

Thanks for patching this up @sebelga! Code LGTM and was able to test everything and can confirm it works as expected.

I know its not on us, but I was expecting that when starting up the server with the deprecated settings and MAJOR_VERSION=8.0.0 I would see an error saying that certain setting was deprecated. But instead I got the following which didn't seem very user friendly:

erver    log   [16:19:33.479] [fatal][root] ValidationError: [config validation of [console].proxyFilter]: definition for this key is missing
    at ObjectType.validate (/Users/ignacio/Projects/elastic/kibana/node_modules/@kbn/config-schema/target_node/types/type.js:95:13)
    at ConfigService.validateAtPath (/Users/ignacio/Projects/elastic/kibana/node_modules/@kbn/config/target_node/config_service.js:244:19)
    at MapSubscriber.project (/Users/ignacio/Projects/elastic/kibana/node_modules/@kbn/config/target_node/config_service.js:252:169)
    at MapSubscriber._next (/Users/ignacio/Projects/elastic/kibana/node_modules/rxjs/src/internal/operators/map.ts:84:29)
    at MapSubscriber.Subscriber.next (/Users/ignacio/Projects/elastic/kibana/node_modules/rxjs/src/internal/Subscriber.ts:99:12)
    at DistinctUntilChangedSubscriber._next (/Users/ignacio/Projects/elastic/kibana/node_modules/rxjs/src/internal/operators/distinctUntilChanged.ts:121:24)
    at DistinctUntilChangedSubscriber.Subscriber.next (/Users/ignacio/Projects/elastic/kibana/node_modules/rxjs/src/internal/Subscriber.ts:99:12)
    at MapSubscriber._next (/Users/ignacio/Projects/elastic/kibana/node_modules/rxjs/src/internal/operators/map.ts:89:22)
    at MapSubscriber.Subscriber.next (/Users/ignacio/Projects/elastic/kibana/node_modules/rxjs/src/internal/Subscriber.ts:99:12)
    at ReplaySubject._subscribe (/Users/ignacio/Projects/elastic/kibana/node_modules/rxjs/src/internal/ReplaySubject.ts:82:20) {
  cause: SchemaTypeError: definition for this key is missing
      at ObjectType.onError (/Users/ignacio/Projects/elastic/kibana/node_modules/@kbn/config-schema/target_node/types/type.js:137:14)
      at Object.error (/Users/ignacio/Projects/elastic/kibana/node_modules/@kbn/config-schema/target_node/types/type.js:79:47)
      at Object.internals.finalize (/Users/ignacio/Projects/elastic/kibana/node_modules/joi/lib/validator.js:472:36)
      at Object.exports.validate (/Users/ignacio/Projects/elastic/kibana/node_modules/joi/lib/validator.js:333:38)
      at Object.internals.entry (/Users/ignacio/Projects/elastic/kibana/node_modules/joi/lib/validator.js:142:28)
      at Object.exports.entry (/Users/ignacio/Projects/elastic/kibana/node_modules/joi/lib/validator.js:27:30)
      at internals.Base.validate (/Users/ignacio/Projects/elastic/kibana/node_modules/joi/lib/base.js:548:26)
      at ObjectType.validate (/Users/ignacio/Projects/elastic/kibana/node_modules/@kbn/config-schema/target_node/types/type.js:89:29)
      at ConfigService.validateAtPath (/Users/ignacio/Projects/elastic/kibana/node_modules/@kbn/config/target_node/config_service.js:244:19)
      at MapSubscriber.project (/Users/ignacio/Projects/elastic/kibana/node_modules/@kbn/config/target_node/config_service.js:252:169) {
    cause: undefined,
    path: [ 'proxyFilter' ]
  }
}

 FATAL  Error: [config validation of [console].proxyFilter]: definition for this key is missing

I'm not sure if this issue should be raised to another team or if it's somehow expected 🤔

sabarasaba · 2021-10-04T14:07:46Z

src/plugins/console/kibana.json

@@ -1,12 +1,14 @@
 {
  "id": "console",
-  "version": "kibana",
+  "version": "8.0.0",
+  "kibanaVersion": "kibana",


I'm curious about this. I see in the docs that its the version of kibana the plugin is compatible with, so by specifying "kibana" it means that is compatible with all versions? 🤔

I haven't given it too much thoughts to be honest. I just followed what all the other plugins are doing 😄 "kibana" seems to be the kibana version declared everywhere.

sebelga · 2021-10-04T15:18:01Z

Thanks for the review @sabarasaba !

I'm not sure if this issue should be raised to another team or if it's somehow expected

Yes it is expected. But that's why we have the Upgrade assistant 😊 A user should not have any deprecated settings anymore before migrating.

…13555)

sabarasaba · 2021-10-04T15:35:01Z

Yes it is expected. But that's why we have the Upgrade assistant 😊 A user should not have any deprecated settings anymore before migrating.

Indeed! I just felt that the error message could be improved to say something like "this setting was deprecated in x.y.z" rather than "unknown setting". I'll check if there's an issue created for that already and if not I can create one!

…3555) (#113781) * [console] Deprecate "proxyFilter" and "proxyConfig" on 8.x (#113555) * Change MAJOR_VERSION to 7.16.0

sebelga · 2021-10-06T15:53:22Z

That would be great indeed @sabarasaba 👍

sebelga added 4 commits September 30, 2021 17:24

Deprecate "proxyFilter" and "proxyConfig" on 8.x

27c5f25

Fix jest tests

3fc6e21

Update server config to deprecate proxyFilter and proxyConfig settings

47d4973

Fix TS issue

a09a083

sebelga commented Oct 4, 2021

View reviewed changes

Merge remote-tracking branch 'upstream/master' into console/remove-pr…

a49d87c

…oxyConfig-proxyFilter-support

sebelga marked this pull request as ready for review October 4, 2021 10:46

sebelga requested a review from a team as a code owner October 4, 2021 10:46

sebelga added Breaking Change release_note:breaking Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more v7.16.0 v8.0.0 labels Oct 4, 2021

sebelga requested a review from yuliacech October 4, 2021 10:47

sebelga requested review from sabarasaba and removed request for yuliacech October 4, 2021 13:31

sabarasaba approved these changes Oct 4, 2021

View reviewed changes

sebelga merged commit 4693c38 into elastic:master Oct 4, 2021

sebelga deleted the console/remove-proxyConfig-proxyFilter-support branch October 4, 2021 15:19

sebelga mentioned this pull request Oct 4, 2021

[7.x] [console] Deprecate "proxyFilter" and "proxyConfig" on 8.x (#113555) #113781

Merged

sebelga added a commit to sebelga/kibana that referenced this pull request Oct 4, 2021

[console] Deprecate "proxyFilter" and "proxyConfig" on 8.x (elastic#1…

416a9b7

…13555)

cjcenizal mentioned this pull request Oct 4, 2021

Improve deprecation warnings for proxyFilter and proxyConfig settings #113810

Closed

sebelga added a commit that referenced this pull request Oct 4, 2021

[7.x] [console] Deprecate "proxyFilter" and "proxyConfig" on 8.x (#11…

cef53a9

…3555) (#113781) * [console] Deprecate "proxyFilter" and "proxyConfig" on 8.x (#113555) * Change MAJOR_VERSION to 7.16.0

cjcenizal mentioned this pull request Oct 5, 2021

[Breaking change] Add deprecation from removed proxyConfig and proxyFilter Console settings #109872

Closed

cjcenizal mentioned this pull request Oct 11, 2021

[Breaking] Remove deprecated enabled settings from plugins. #113495

Merged

KOTungseth added a commit to KOTungseth/kibana that referenced this pull request Nov 15, 2021

[DOCS] Adds elastic#113555 to 8.0.0-beta1 release notes

d3fca5d

KOTungseth mentioned this pull request Nov 15, 2021

[DOCS] Adds #113555 to 8.0.0-beta1 release notes #118562

Merged

KOTungseth added a commit that referenced this pull request Nov 15, 2021

[DOCS] Adds #113555 to 8.0.0-beta1 release notes (#118562)

30b6755

cjcenizal added Feature:Console Dev Tools Console Feature Feature:Dev Tools labels Dec 2, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[console] Deprecate "proxyFilter" and "proxyConfig" on 8.x #113555

[console] Deprecate "proxyFilter" and "proxyConfig" on 8.x #113555

sebelga commented Sep 30, 2021 •

edited

Loading

sebelga Oct 4, 2021

elasticmachine commented Oct 4, 2021

kibanamachine commented Oct 4, 2021

sabarasaba left a comment

sabarasaba Oct 4, 2021

sebelga Oct 4, 2021

sebelga commented Oct 4, 2021

sabarasaba commented Oct 4, 2021

sebelga commented Oct 6, 2021

[console] Deprecate "proxyFilter" and "proxyConfig" on 8.x #113555

[console] Deprecate "proxyFilter" and "proxyConfig" on 8.x #113555

Conversation

sebelga commented Sep 30, 2021 • edited Loading

How to test

Test the deprecation in Upgrade Assistant:

Release note

sebelga Oct 4, 2021

Choose a reason for hiding this comment

elasticmachine commented Oct 4, 2021

kibanamachine commented Oct 4, 2021

💚 Build Succeeded

Metrics [docs]

History

sabarasaba left a comment

Choose a reason for hiding this comment

sabarasaba Oct 4, 2021

Choose a reason for hiding this comment

sebelga Oct 4, 2021

Choose a reason for hiding this comment

sebelga commented Oct 4, 2021

sabarasaba commented Oct 4, 2021

sebelga commented Oct 6, 2021

sebelga commented Sep 30, 2021 •

edited

Loading