-
Notifications
You must be signed in to change notification settings - Fork 140
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
base: main
Are you sure you want to change the base?
Changes from 17 commits
127557d
06af8d7
c825849
3fedd12
3b7eb42
c56e358
bcc20b9
9e4e97d
f45f736
52a644f
7257efe
fb225e7
991590c
e77ae9e
c519fcb
a18e934
19cfe38
71469f0
a748232
41f205c
2b45927
3533348
2c01536
35028ec
9723da3
dee924e
5d17933
55a7c89
0cabbca
2e79592
214d14e
da35dc4
955a58c
7bce30f
f238c59
bdaec64
9c8f2b5
a0cc0e9
3e0a07b
7c4a1c1
31afdc7
ebc39c0
8895ccf
1894d9a
da1c6c1
cd5e8bf
1947d14
349065d
c90f485
4a3e353
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,58 @@ | ||
# Extend and contribute | ||
# Extend and contribute | ||
|
||
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. | ||
* 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 | ||
|
||
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/). | ||
|
||
## 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. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,38 @@ | ||
--- | ||
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 | ||
|
||
You can run Elastic on virtually any infrastructure, allowing you to select the model that best fits your operational needs. | ||
|
||
Use this page for a quick overview of your options for deploying Elastic. | ||
|
||
:::{include} /deploy-manage/_snippets/deployment-options-overview.md | ||
::: | ||
## Why your deployment choice matters | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we talk about open source Elastic on this page? (in self-managed and/or local development I guess) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hmm, any suggested angle? +CC @lcawl There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Agree that we should probably add that option. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you maybe clarify the intent? Do you mean just the open source nature of the stack components like in https://www.elastic.co/platform/#born-to-be-open ? |
||
|
||
Your deployment type significantly impacts both the capabilities available across your Elastic environment and the amount of manual work required to set up and maintain it. Some deployment types provide automated orchestration that handles scaling, upgrades, and monitoring across multiple clusters, while others require you to manage these operational tasks manually. | ||
|
||
The choice you make determines how much time you'll spend on infrastructure management versus focusing on using Elastic's features to solve your business problems. | ||
|
||
## Quick start options | ||
|
||
These are the most common deployment types and their main features: | ||
jmikell821 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
* **[{{ecloud}}](/deploy-manage/deploy/elastic-cloud.md)**: Get a hosted solution up and running in minutes. | ||
* **[{{ech}}](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md)**: This managed SaaS offering managed through [{{ecloud}}](/deploy-manage/deploy/elastic-cloud.md) 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. Sign up for a [14-day free trial](https://cloud.elastic.co/registration). | ||
* **[{{serverless-full}}](/deploy-manage/deploy/elastic-cloud/serverless.md)**: This fully managed SaaS offering managed through [{{ecloud}}](/deploy-manage/deploy/elastic-cloud.md) 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. Sign up for a [14-day free trial](https://cloud.elastic.co/serverless-registration). | ||
* **[Local development](/deploy-manage/deploy/self-managed/local-development-installation-quickstart.md)**: Get started quickly with {{es}} and {{kib}} in Docker for local development and testing. | ||
|
||
## Advanced options | ||
|
||
* **[Self-managed](/deploy-manage/deploy/self-managed.md)**: This approach allows you to install, operate, and maintain the {{stack}} on your own hardware, whether on-premises or in your private cloud. It provides maximum control over your environment. | ||
* **[{{ece}}](/deploy-manage/deploy/cloud-enterprise.md)**: This Elastic self-managed offering allows you to provision, manage, and monitor {{es}} and {{kib}} at any scale, on any infrastructure, while managing everything from a single console. | ||
* **[{{eck}}](/deploy-manage/deploy/cloud-on-k8s.md)**: 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. | ||
|
||
:::{tip} | ||
Refer to [](/deploy-manage/index.md) for detailed information and guidance on choosing the right deployment for your needs. | ||
::: | ||
Refer to [Deploy and manage](/deploy-manage/index.md) for detailed information and guidance on selecting the right deployment for your needs. | ||
::: |
Uh oh!
There was an error while loading. Please reload this page.