3c8fa527a7
* bump to a pre-8.0 version * export KibanaClient from /lib sub-folder * workaround the problem of the absence of estypes * update es client usage in pacakges * export estypes from another path * import errors from root * import errors from root 2 * update transport import * update import path for /api/types * update import path for /api/types * import errors from top export * use TransportResult instead if ApiResponse * fix errors in client_config * fix src/core/server/saved_objects/migrationsv2/actions/integration_tests/actions.test.ts * use KibanaClient in mock. we dont export the original Client * fix client mocks * fix errors on SO * fix remaining core errors * update estype import path * fix errors in data plugin * fix data_views * fix es_ui_shared * fix errors in interactive_setup * fix errors in ./test folder * add @elastic/transport to the runtime deps * fix errors in packages * fix erros in src/core * fix errors in test/ * fix an error in actions plugin * woraround and fix errors in APM plugin * fix errors in canvas * fix errors in event_log * fix errors in fleet * fix errors in ILM * fix errors in infra * fix errors in ingest_pipeline * fix errors in lens * fix errors in license_management * fix errors in licensing * fix errors in logstash * fix errors in ml * fix errors in monitoring * fix errors in observability * fix errors in rule_registry * fix errors in reporting * fix errors in rule_registry * fix errors in security * fix errors in security_solution * fix errors in snapshot_restore * fix errors in transform * fix errors in UA * fix errors in uptime * fix errors in x-pack/test * fix eslint errors * fix new errors * use default HTTP Connection. Undici does not support agent config options keepAlive and maxSockets * create does not accept require_alias option * update deps * use transport types exported from ES client package * fix ErrorCause | string errors * do not use enum * fix errors in data plugin * update x-pack code * fix transport * fix apm search request * do not crash on reporting * fix kbn-test build * mute reporting error to start * fix ftr build * another attempt * update import path * address or mute new errors * REMOVE me. pin transport version temporarily. * remove deep imports from transport package * fix jest crash * fix product check tests * remove unnecessary ts-expect-error * fix a few failed unit tests * bump to canary 24 * remove unnecessary ts-expect-error * remove dependency on transport * fix types in tests * mute errors in xpack tests * product check doesn;t spam in logs anymore * filterPath --> filter_path * ignoreUnavailable --> ignore_unavailable * ignoreUnavailable --> ignore_unavailable * trackScores --> track_scores * trackTotalHits --> track_total_hits * fix es-arcives * fix data plugin crashes * fix watcher test utils * rollback unnecessary changes * fix another problem in es-archiver * fix scroll. for whatever reason scroll fails when request scroll_id in body * add meta: true in kbn-securitysolution-es-utils * bump client to canary 25 * fix errors in accordance with the es client spec * update securityscolution-es-utils * unify scroll api in reporting and fix tests * fix unit tests in watcher * refactor APM to abort request with AbortController API * fix missing es client calls in tests * fix missing meta in detection engine FTR tests * fix another bunch of errors in js tests * fix wrong coercion * remove test-grep pattern * fix apm unit test * rename terminateAfter to terminate_after in infra plugin * rename terminateAfter to terminate_after in uptime plugin * rename terminateAfter to terminate_after in apm plugin * fix security roles FTR tests * fix reference * fix post_privilidges test * fix post_privilidges * bump client to 26 * add meta for index_management test helpers * remove ts-expect-error caused by bad type in reason * bump client to 27 * REMOVE me. workaround until fixed in the es client * fix incorrect type casting * swtich from camelCase params * use `HttpConnection` for FTR-related clients * bump client to 29 * Revert "REMOVE me. workaround until fixed in the es client" This reverts commit |
||
---|---|---|
.. | ||
common | ||
public | ||
server | ||
jest.config.js | ||
kibana.json | ||
README.md | ||
tsconfig.json |
Licensing plugin
- API
- Migration example
- The list of breaking changes Retrieves license data from Elasticsearch and becomes a source of license data for all Kibana plugins on server-side and client-side.
API:
Server-side
The licensing plugin retrieves license data from Elasticsearch at regular configurable intervals.
license$: Observable<ILicense>
Provides a steam of license data ILicense. Plugin emits new value whenever it detects changes in license info. If the plugin cannot retrieve a license from Elasticsearch, it will emitan empty license
object.refresh: () => Promise<ILicense>
allows a plugin to enforce license retrieval.
Client-side
The licensing plugin retrieves license data from licensing Kibana plugin and does not communicate with Elasticsearch directly.
license$: Observable<ILicense>
Provides a steam of license data ILicense. Plugin emits new value whenever it detects changes in license info. If the plugin cannot retrieve a license from Kibana, it will emitan empty license
object.refresh: () => Promise<ILicense>
allows a plugin to enforce license retrieval.
Migration example
The new platform licensing plugin became stateless now. It means that instead of storing all your data from checkLicense
within the plugin, you should react on license data change on both the client and server sides.
Before
// my_plugin/server/plugin.ts
function checkLicense(xpackLicenseInfo: XPackInfo){
if (!xpackLicenseInfo || !xpackLicenseInfo.isAvailable()) {
return {
isAvailable: false,
showLinks: true,
}
}
if (!xpackLicenseInfo.feature('name').isEnabled()) {
return {
isAvailable: false,
showLinks: false,
}
}
const hasRequiredLicense = xPackInfo.license.isOneOf([
'gold',
'platinum',
'trial',
]);
return {
isAvailable: hasRequiredLicense,
showLinks: hasRequiredLicense,
}
}
xpackMainPlugin.info.feature(pluginId).registerLicenseCheckResultsGenerator(checkLicense);
// my_plugin/client/plugin.ts
chrome.navLinks.update('myPlugin', {
hidden: !xpackInfo.get('features.myPlugin.showLinks', false)
});
After
// kibana.json
"requiredPlugins": ["licensing"],
// my_plugin/server/plugin.ts
import { LicensingPluginSetup } from '../licensing/server'
interface SetupDeps {
licensing: LicensingPluginSetup;
}
class MyPlugin {
setup(core: CoreSetup, deps: SetupDeps) {
deps.licensing.license$.subscribe(license => {
const { state, message } = license.check('myPlugin', 'gold')
const hasRequiredLicense = state === 'valid';
if (hasRequiredLicense && license.getFeature('name').isAvailable) {
// enable some server side logic
} else {
log(message);
// disable some server side logic
}
})
}
}
// my_plugin/public/plugin.ts
import { LicensingPluginSetup } from '../licensing/public'
class MyPlugin {
setup(core: CoreSetup, deps: SetupDeps) {
const appUpdater$ = new BehaviorSubject<AppUpdater>(() => {});
core.application.register({
id: 'myApp',
updater$: appUpdater$,
});
deps.licensing.license$.subscribe(license => {
const { state, message } = license.check('myPlugin', 'gold')
const hasRequiredLicense = state === 'valid';
const showLinks = hasRequiredLicense && license.getFeature('name').isAvailable;
appUpdater$.next(() => {
navLinkStatus: showLinks ? AppNavLinkStatus.visible : AppNavLinkStatus.hidden
});
})
}
}
The list of breaking changes
state
LP: The plugin allows consumers to calculate state on license change
event and store this
The signature calculation is based on this state + license content
NP: We decided that license service doesn't keep plugins state https://github.com/elastic/kibana/pull/49345#issuecomment-553451472. Plugins have to react on license change and calculate license state on every license change. If another plugin needs that information, it should be exposed via a plugin contract.
This change makes NP & LP licensing service not compatible. We have to keep both until all plugins migrate to the new platform service. The legacy plugin consumes license data from the LP plugin.
Network request failures
LP: The licensing plugin didn’t emit a license in case of network errors. NP: Emits the license even if the request failed.
clusterSource
LP: Allows specifying cluster source to perform polling.
NP: The plugin always uses a data
client. Provides createLicensePoller
on the server-side to create a license poller with custom ES cluster.
Initial value on the client
LP: Passed on the page via inlined xpackInitialInfo
NP: Should be fetched
Config
LP: xpack.xpack_main.xpack_api_polling_frequency_millis
NP: xpack.licensing.api_polling_frequency
Support for deprecated xpack.xpack_main.xpack_api_polling_frequency_millis
is removed in v8.0.0. See https://github.com/elastic/kibana/issues/103915 for more details.
License
NP: mode
field is provided, but deprecated.
sessionStorage
LP: License and signature were stored under different keys in session storage
NP: License and signature were stored under one key xpack.licensing
isOneOf
isOneOf
removed, use check
or hasAtLeast
instead
Endpoint
/api/xpack/v1/info
API endpoint is going to be removed. switch to /api/licensing/info
instead
Fetch error
getUnavailableReason
doesn't return Error
object anymore, but string