-
Notifications
You must be signed in to change notification settings - Fork 8.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[core-new-docs] Adds a dev-doc for core documentation #92976
Merged
TinaHeiligers
merged 6 commits into
elastic:master
from
TinaHeiligers:core-docs/server-and-core-components
Mar 3, 2021
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
e06f658
Converts core README from .md to .mdx and adds the heading needed to …
TinaHeiligers 6af9125
Adds new section for core intro, converts core-conventions to .mdx
TinaHeiligers 726213c
Reverts converting core-conventions from .md to .mdx
TinaHeiligers 99bf86e
Deletes header
TinaHeiligers 6ab5c78
Renames doc title
TinaHeiligers f0d0c04
Merge branch 'master' into core-docs/server-and-core-components
TinaHeiligers File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
id: kibServerAndCoreComponents | ||
slug: /kibana-dev-docs/core-intro | ||
title: Core components | ||
summary: An introduction to the Kibana server and core components. | ||
date: 2021-02-26 | ||
tags: ['kibana','onboarding', 'dev', 'architecture'] | ||
--- | ||
|
||
Core is a set of systems (frontend, backend etc.) that Kibana and its plugins are built on top of. | ||
|
||
## Integration with the "legacy" Kibana | ||
|
||
Most of the existing core functionality is still spread over "legacy" Kibana and it will take some time to upgrade it. | ||
Kibana is started using existing "legacy" CLI that bootstraps `core` which in turn creates the "legacy" Kibana server. | ||
At the moment `core` manages HTTP connections, handles TLS configuration and base path proxy. All requests to Kibana server | ||
will hit HTTP server exposed by the `core` first and it will decide whether request can be solely handled by the new | ||
platform or request should be proxied to the "legacy" Kibana. This setup allows `core` to gradually introduce any "pre-route" | ||
processing logic, expose new routes or replace old ones handled by the "legacy" Kibana currently. | ||
|
||
Once config has been loaded and some of its parts were validated by the `core` it's passed to the "legacy" Kibana where | ||
it will be additionally validated so that we can make config validation stricter with the new config validation system. | ||
Even though the new validation system provided by the `core` is also based on Joi internally it is complemented with custom | ||
rules tailored to our needs (e.g. `byteSize`, `duration` etc.). That means that config values that were previously accepted | ||
by the "legacy" Kibana may be rejected by the `core` now. | ||
|
||
### Logging | ||
`core` has its own <DocLink id="kibCoreLogging" text="logging system"/> and will output log records directly (e.g. to file or terminal) when configured. When no specific configuration is provided, logs are forwarded to the "legacy" Kibana so that they look the same as the rest of the | ||
log records throughout Kibana. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We'll probably want to rewrite some of this eventually, but for now since you're just copying from the existing
README
, it's probably fine to keep as-is.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That was my thinking too. It will be a team effort and we'll probably need to set time aside before the new docs system "goes live". For now, I just wanted to add somewhere to house core's documentation.