-
Notifications
You must be signed in to change notification settings - Fork 156
Add new Elastic intro section #2795
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
Merged
Merged
Changes from 10 commits
Commits
Show all changes
65 commits
Select commit
Hold shift + click to select a range
127557d
Add Elastic fundamentals
theletterf 06af8d7
Add Solutions topic
theletterf c825849
Additional docs
theletterf 3fedd12
Fix anchor links
theletterf 3b7eb42
Add fallback anchor
theletterf c56e358
Merge branch 'main' into add-elastic-new-intro-section
theletterf bcc20b9
Remove introduction
theletterf 9e4e97d
Merge branch 'add-elastic-new-intro-section' of github.com:elastic/do…
theletterf f45f736
Add heading
theletterf 52a644f
Merge branch 'main' into add-elastic-new-intro-section
theletterf 7257efe
Update get-started/index.md
theletterf fb225e7
Update get-started/the-stack.md
theletterf 991590c
Rename doc
theletterf e77ae9e
Switch to full title
theletterf c519fcb
Peer review edits
theletterf a18e934
Supplemental fixes
theletterf 19cfe38
Merge branch 'main' into add-elastic-new-intro-section
theletterf 71469f0
Update get-started/index.md
theletterf a748232
Update get-started/versioning-availability.md
theletterf 41f205c
Update get-started/howto-use-the-docs.md
theletterf 2b45927
Update get-started/versioning-availability.md
theletterf 3533348
Update get-started/versioning-availability.md
theletterf 2c01536
Update get-started/versioning-availability.md
theletterf 35028ec
More peer edits
theletterf 9723da3
Merge branch 'add-elastic-new-intro-section' of github.com:elastic/do…
theletterf dee924e
Merge branch 'main' into add-elastic-new-intro-section
theletterf 5d17933
Revert "Remove introduction"
lcawl 55a7c89
Re-separate solutions and stack overview
lcawl 0cabbca
Merge branch 'main' into add-elastic-new-intro-section
lcawl 2e79592
Re-add lingering anchors
lcawl 214d14e
Update introduction.md
jmikell821 da35dc4
Move the-stack.md to search-ai-platform.md
lcawl 955a58c
Edit search-api-platform.md
lcawl 7bce30f
Merge branch 'main' into add-elastic-new-intro-section
lcawl f238c59
Merge branch 'main' into add-elastic-new-intro-section
lcawl bdaec64
Fix broken links to the-stack.md
lcawl 9c8f2b5
Update introduction.md
jmikell821 a0cc0e9
Merge branch 'add-elastic-new-intro-section' of github.com:elastic/do…
jmikell821 3e0a07b
Edit more stack references in get-started
lcawl 7c4a1c1
Add applies_to in all get-started pages
lcawl 31afdc7
Add updated stack diagram
lcawl ebc39c0
More search-ai-platform.md edits
lcawl 8895ccf
Fixes directives + other edits
jmikell821 1894d9a
Quit commit to flip the order of solutions
jmikell821 da1c6c1
Merge branch 'main' into add-elastic-new-intro-section
lcawl cd5e8bf
Revert "Move the-stack.md to search-ai-platform.md"
lcawl 1947d14
Revert changes related to Elastic Stack
lcawl 349065d
Remove use of search-platform variable
lcawl c90f485
Updates anchor links + attributes and headings
jmikell821 4a3e353
Update index.md
jmikell821 0f87d9f
Merge branch 'main' into add-elastic-new-intro-section
theletterf fd58924
Merge branch 'main' into add-elastic-new-intro-section
theletterf 40195f9
Add Glossary crosslink
theletterf 7d84775
Minor edits + formatting changes
jmikell821 14d0008
Merge branch 'main' into add-elastic-new-intro-section
jmikell821 44c03ec
Incorporating some feedback.
jmikell821 e4ac982
Merge branch 'main' into add-elastic-new-intro-section
lcawl bbe5a67
Simplify Elasticsearch solution overview
lcawl d4a00be
Update extend/index.md
theletterf 215adf3
Merge branch 'main' into add-elastic-new-intro-section
lcawl dc0e7c7
Reset changes to introduction.md
lcawl 4eb3b45
Reset changes to versioning-availability.md
lcawl 7c2dd14
Add link to client docs
lcawl 98438ec
Merge branch 'main' into add-elastic-new-intro-section
theletterf 16962ba
Merge branch 'main' into add-elastic-new-intro-section
theletterf 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
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 |
---|---|---|
@@ -1,26 +1,58 @@ | ||
# Extend and contribute | ||
# Extend the Elastic platform | ||
|
||
This section contains information on how to extend or contribute to our various products. | ||
You can extend and build on the Elastic Platform in several ways. Whether you need to get data into Elasticsearch, add new functionality, edit the documentation, or build a custom application, here is an overview of the primary development paths to help you choose the right one for your project. | ||
|
||
## Contributing to Elastic documentation | ||
There are two main approaches to extending Elastic: creating standardized Integrations for data ingestion or building custom solutions by developing directly against our REST APIs. | ||
|
||
## Path 1: Create an Elastic Integration | ||
|
||
If your primary goal is to bring a new data source into the Elastic Stack in a standardized, reusable way, building an Elastic Integration is the best path. Integrations are pre-packaged assets that make it simple for users to collect and process data from a specific service or platform. | ||
|
||
This approach is ideal for shipping data, logs, metrics, and traces. By building an integration, you contribute to the ever-growing ecosystem that both you and the community can benefit from. | ||
|
||
* Integrations are built on a consistent framework, providing users with a turnkey experience, including dashboards, visualizations, and alerts. | ||
* **`elastic-package`** is a command-line tool that is your primary interface for creating, testing, and packaging your integration. It scaffolds the entire project structure, letting you focus on the logic for data collection. | ||
* Your integration will run on the Elastic Agent, our single, unified agent for data shipping. | ||
|
||
**When to choose this path** | ||
|
||
You can contribute to the Elastic documentation in several ways. | ||
* You want to ingest data from a new data source, like a database, API, or log file. | ||
* You want to provide a standardized, out-of-the-box experience for other users. | ||
* You need to process and structure data according to the Elastic Common Schema (ECS). | ||
|
||
Refer to [Contribute to Elastic documentation](./contribute/index.md) for an overview. | ||
**Ready to start?** Head over to the [Create an Integration](integrations://extend/index.md) guide. | ||
|
||
## Contributing to Elastic Projects | ||
## Path 2: Develop against the REST APIs | ||
|
||
You can contribute to various projects, including: | ||
For complete control and custom development, you can interact directly with Elastic's REST APIs. This path is perfect for building custom applications, automating complex workflows, and integrating Elastic into your existing infrastructure in a bespoke way. For example, you can programmatically manage your cluster, run complex queries, manage security settings, and interact with Kibana. | ||
|
||
- [Kibana](kibana://extend/index.md): Enhance our data visualization platform by contributing to Kibana. | ||
- [Logstash](logstash://extend/index.md): Help us improve the data processing pipeline with your contributions to Logstash. | ||
- [Beats](beats://extend/index.md): Add new features or beats to our lightweight data shippers. | ||
* The APIs provide direct access to the core capabilities of Elasticsearch and Kibana. If you can do it in the UI, you can automate it with the API. | ||
* Elastic provides and supports official clients for popular languages like Java, Go, .NET, PHP, Python, Ruby, and JavaScript. These clients simplify interacting with the API, handling requests, and processing responses. | ||
lcawl marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
* The APIs are secured using role-based access control (RBAC). You can create API keys or use bearer tokens with fine-grained permissions to ensure your interactions are safe. | ||
|
||
## Creating Integrations | ||
### Elastic APIs at a glance | ||
lcawl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Extend the capabilities of Elastic by creating integrations that connect Elastic products with other tools and systems. Visit our [Integrations Guide](integrations://extend/index.md) to get started. | ||
* Use the Elasticsearch APIs to: | ||
|
||
## Elasticsearch Plugins | ||
* Create, read, update, and delete documents. | ||
* Perform everything from simple keyword searches to complex analytical aggregations. | ||
* Monitor cluster health, manage nodes, and configure settings. | ||
* Manage users, roles, and API keys. | ||
|
||
Develop custom plugins to add new functionalities to Elasticsearch. Check out our [Elasticsearch Plugins Development Guide](elasticsearch://extend/index.md) for detailed instructions and best practices. | ||
* Use the Kibana APIs to programmatically control the Kibana front-end and its objects: | ||
|
||
* Create and manage dashboards, visualizations, and saved searches. | ||
* Automate the organization of content within Kibana. | ||
* Create and manage rules for detecting conditions within your data. | ||
|
||
**When to choose this path** | ||
|
||
* You are building a custom application that uses Elasticsearch as its backend. | ||
* You need to automate administrative tasks, such as creating users or managing index lifecycle policies. | ||
* You are integrating Elastic's search and analytics capabilities into another platform. | ||
|
||
Ready to get started? Explore the [Elasticsearch API Reference](elasticsearch://reference/elasticsearch/rest-apis/index.md) and the [Kibana API Reference](https://www.elastic.co/docs/api/doc/kibana/). | ||
theletterf marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## Contributing to Elastic documentation | ||
|
||
You can contribute to the Elastic documentation in several ways. Refer to [Contribute to Elastic documentation](./contribute/index.md) for an overview. |
This file contains hidden or 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 |
---|---|---|
@@ -1,17 +1,21 @@ | ||
--- | ||
navigation_title: Deployment options | ||
mapped_pages: | ||
- https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-deploy.html | ||
products: | ||
- id: elasticsearch | ||
--- | ||
|
||
# Deployment options [elasticsearch-intro-deploy] | ||
# Deployment options | ||
|
||
Use this page for a quick overview of your options for deploying Elastic. | ||
You can run Elastic on virtually any infrastructure, allowing you to choose the model that best fits your operational needs. | ||
|
||
:::{include} /deploy-manage/_snippets/deployment-options-overview.md | ||
::: | ||
These are the most common deployment types and their main features: | ||
jmikell821 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
:::{tip} | ||
Refer to [](/deploy-manage/index.md) for detailed information and guidance on choosing the right deployment for your needs. | ||
::: | ||
* **{{serverless-full}}**: This fully managed SaaS offering abstracts away all underlying infrastructure, automatically and seamlessly scaling resources to meet your workload demands. It's designed for operational simplicity, with usage-based pricing that allows you to focus on your data without managing clusters. | ||
theletterf marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
theletterf marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
* **{{ech}}**: This managed SaaS offering provides you with a dedicated cluster on your choice of cloud provider (AWS, GCP, or Azure). It offers a high degree of control over your cluster's configuration, allowing you to fine-tune nodes, hardware, and versions to meet specific performance and architectural requirements. | ||
* **Self-managed**: This approach allows you to install, operate, and maintain the Elastic Stack on your own hardware, whether on-premises or in your private cloud. It provides maximum control over your environment. | ||
* **{{eck}} (ECK)**: This extends Kubernetes by providing an official operator for deploying and managing Elastic products. It's ideal if you want to run and orchestrate Elastic on your own Kubernetes platform. | ||
* **{{ece}} (ECE):** This Elastic self-managed offering allows you to provision, manage, and monitor Elasticsearch and Kibana at any scale, on any infrastructure, while managing everything from a single console. It's ideal if you want to use the full Elastic Stack while maintaining control over your data and infrastructure. | ||
theletterf marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
For more information on Deployment modes, refer to [Detailed deployment comparison](/deploy-manage/deploy/deployment-comparison.md). | ||
theletterf marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or 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 was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
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.
This page feels unnecessary and could be a strong case for deletion. This middle-layer abstraction just adds an unnecessary stop between users and their actual destinations.
Arguments:
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.
The existing doc is quite useless. The idea for this version is to provide an overview of extensibility methods and some quick directions.
Deferring to @lcawl on this, since it's not really my area. :)
Uh oh!
There was an error while loading. Please reload this page.
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.
by drift I just meant "Extend" is a very abstract category, and the 3 things we actually talk about on this page drift further away from whatever extend even means, with "contribute to docs" being the furthest away and just feels tacked on at this stage
now that we've removed the contributed to kibana etc., I'm not sure we even need "Extend" as a section
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.
@georgewallace @lcawl WDYT?