Skip to content
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 1 addition & 9 deletions deploy-manage/api-keys.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
applies_to:
stack: ga
deployment:
eck: ga
ess: ga
Expand All @@ -9,14 +8,7 @@ applies_to:
serverless: ga
---

# Manage API keys

% What needs to be done: Write from scratch

% GitHub issue: https://github.com/elastic/docs-projects/issues/349

% Scope notes: Elasticsearch & Kibana authentication API Keys

# API keys

API keys are security mechanisms used to authenticate and authorize access to your deployments and {{es}} resources.

Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/cloud-organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ applies_to:

# Manage your Cloud organization [ec-organizations]

When you sign up to {{ecloud}}, you create an organization. This organization is the umbrella for all of your {{ecloud}} resources, users, and account settings. Every organization has a unique identifier.
When you [sign up for {{ecloud}}](/deploy-manage/deploy/elastic-cloud/create-an-organization.md), you create an organization. This organization is the umbrella for all of your {{ecloud}} resources, users, and account settings. Every organization has a unique identifier.

You can perform the following tasks to manage your Cloud organization:

Expand Down
64 changes: 30 additions & 34 deletions deploy-manage/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,9 @@
mapped_urls:
- https://www.elastic.co/guide/en/serverless/current/intro.html
- https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-deploy.html
- https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/get-elastic.html
---

% What needs to be done: Write from scratch

% GitHub issue: https://github.com/elastic/docs-projects/issues/334

% Scope notes: does plan for production content go here? With orchestrator layer - explain relationship between orchestrator and clusters how to help people to be aware of the other products that might need to be deployed? "these are the core products, you might add others on" describe relationship between orchestrators and ES Explain that when using orchestrators a lot of the reference configuration of the orchestrated applications is still applicable. The user needs to learn how to configure the applications when using an orchestrator, then afterwards, the documentation of the application will be valid and applicable to their use case. When a certain feature or configuration is not applicable in some deployment types, the document will specify it.

% Use migrated content from existing pages that map to this page:

% - [ ] ./raw-migrated-files/docs-content/serverless/intro.md
% - [ ] ./raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md

# Deploy

Whether you're planning to use Elastic's pre-built solutions or Serverless projects, build your own applications with {{es}}, or analyze your data using {{kib}} tools, you'll need to deploy Elastic first.
Expand All @@ -23,13 +13,20 @@ This page will help you understand your deployment options and choose the approa

## Core components

Every Elastic deployment requires {{es}} as its core data store and search/analytics engine.
Additionally, {{kib}} provides the user interface for all Elastic solutions and Serverless projects. It is required for most use cases, from data exploration to monitoring and security analysis.
All deployments include **{{es}}**. {{es}} is the distributed search and analytics engine, scalable data store, and vector database at the heart of all Elastic solutions.

Your choice of deployment type determines how you'll set up and manage these core components, plus any additional components you need.
In most cases, you also need to deploy **{{kib}}**. {{kib}} provides the user interface for all Elastic solutions and Serverless projects. It’s a powerful tool for visualizing and analyzing your data, and for managing and monitoring the {{stack}}. Although {{kib}} is not required to use {{es}}, it's required for most use cases, and is included by default when you deploy using certain deployment methods.

:::{tip}
Learn more about the [{{stack}}](/get-started/the-stack.md) to understand the core and optional components of an Elastic deployment.
Your choice of deployment type determines how you'll set up and manage these core components, as well as any additional components you need.

:::{admonition} Other {{stack}} components
This section focuses on deploying and managing {{es}} and {{kib}}, as well as supporting orchestration technologies. However, depending on your use case, you might need to deploy [other {{stack}} components](/get-started/the-stack.md). For example, you might need to add components to ingest logs or metrics.

To learn how to deploy optional {{stack}} components, refer to the following sections:
* [Fleet and Elastic Agent](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/index.md)
* [APM](/solutions/observability/apps/application-performance-monitoring-apm.md)
* [Beats](asciidocalypse://docs/beats/docs/reference/index.md)
* [Logstash](asciidocalypse://docs/logstash/docs/reference/index.md)
:::

## Choosing your deployment type
Expand All @@ -41,22 +38,27 @@ Learn more about the [{{stack}}](/get-started/the-stack.md) to understand the co

#### Managed by Elastic

If you want to focus on using Elastic products rather than managing infrastructure, choose:
If you want to focus on using Elastic products rather than managing infrastructure, choose one of the following options:

- **Serverless**: Zero operational overhead, automatic scaling and updates, latest features
- **Cloud hosted**: Balance of control and managed operations, choice of resources and regions
- **{{serverless-full}}**: Zero operational overhead, automatic scaling and updates, latest features
- **{{ech}}**: Balance of control and managed operations, choice of resources and regions

Both of these options use [{{ecloud}}](/deploy-manage/deploy/elastic-cloud.md) as an orchestrator.

#### Self-hosted options

If you need to run Elastic on your infrastructure, choose between a fully self-managed deployment or using an orchestrator:

- **Fully self-managed**: Complete control and responsibility for your Elastic deployment
- **With orchestration**:
- **Elastic Cloud on Kubernetes (ECK)**: If you need Kubernetes-native orchestration
- **Elastic Cloud Enterprise (ECE)**: If you need a multi-tenant orchestration platform
- **{{eck}} (ECK)**: If you need Kubernetes-native orchestration
- **{{ece}} (ECE)**: If you need a multi-tenant orchestration platform

:::::{note}
:::{dropdown} About orchestration
::::{tip}
Documentation will specify when certain features or configurations are not applicable to specific deployment types.
::::

### About orchestration

An orchestrator automates the deployment and management of multiple Elastic clusters, handling tasks like scaling, upgrades, and monitoring.

Expand All @@ -66,27 +68,21 @@ Consider orchestration if you:
- Have a Kubernetes environment (ECK)
- Need to build a multi-tenant platform (ECE)

Orchestrators manage the lifecycle of your Elastic deployments but don't change how the core products work. When using ECK or ECE:
Orchestrators manage the lifecycle of your Elastic deployments but don't change how the core products work. When using an orchestrated deployment:
- You'll still use the same Elasticsearch and Kibana features and configurations
- Most product documentation remains applicable
- You can add other Elastic products as needed
- The orchestrator handles operational tasks while you focus on using and configuring the products

::::{tip}
Documentation will specify when certain features or configurations are not applicable to specific deployment types.
::::
:::
:::::

### Versioning and compatibility

In {{serverless-full}}, you automatically get access to the latest versions of Elastic features and you don't need to manage version compatibility.

With other deployment types ({{ecloud}} Hosted, ECE, and ECK), you control which {{stack}} versions you deploy and when you upgrade. The ECE and ECK orchestrators themselves also receive regular version updates, independent of the {{stack}} versions they manage.
With other deployment types (ECH, ECE, and ECK), you control which {{stack}} versions you deploy and when you upgrade. The ECE and ECK orchestrators themselves also receive regular version updates, independent of the {{stack}} versions they manage.

Consider this when choosing your deployment type:

- Choose Serverless if you want automatic access to the latest features and don't want to manage version compatibility
- Choose {{serverless-full}} if you want automatic access to the latest features and don't want to manage version compatibility
- Choose other deployment types if you need more control over version management

:::{tip}
Expand All @@ -95,8 +91,8 @@ Learn more about [versioning and availability](/get-started/versioning-availabil

### Cost considerations

- **Serverless**: Pay for what you use
- **Cloud hosted**: Subscription-based with resource allocation
- **{{serverless-full}}**: Pay for what you use
- **{{ech}}**: Subscription-based with resource allocation
- **Self-hosted options**: Infrastructure costs plus operational overhead mean a higher total cost of ownership (TCO)

:::::{tip}
Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/deploy/deployment-comparison.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# Deployment comparison reference
# Compare deployment options

This reference provides detailed comparisons of features and capabilities across Elastic's deployment options: self-managed deployments, Elastic Cloud Hosted, and Serverless. For a high-level overview of deployment types and guidance on choosing between them, see the [overview](../deploy.md).

Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/deploy/kibana-reporting-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ mapped_urls:
- https://www.elastic.co/guide/en/kibana/current/reporting-production-considerations.html
---

# Kibana reporting configuration
# Configure reporting

% What needs to be done: Refine

Expand Down
80 changes: 43 additions & 37 deletions deploy-manage/index.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,69 @@
---
mapped_urls:
- https://www.elastic.co/guide/en/kibana/current/introduction.html
- https://www.elastic.co/guide/en/kibana/current/setup.html
- https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/get-elastic.html
- https://www.elastic.co/guide/en/elasticsearch/reference/current/scalability.html
- https://www.elastic.co/guide/en/cloud/current/ec-faq-technical.html
- https://www.elastic.co/guide/en/elastic-stack/current/overview.html
- https://www.elastic.co/guide/en/elastic-stack/current/index.html
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-administering-deployments.html
- https://www.elastic.co/guide/en/kibana/current/management.html
---

# Deploy and manage

% What needs to be done: Write from scratch
To get started with Elastic, you need to choose a deployment method and deploy {{stack}} components.

% GitHub issue: https://github.com/elastic/docs-projects/issues/332
In this section, you'll learn about how to deploy and manage all aspects of your Elastic environment. You'll learn how to design resilient, highly available clusters and deployments, and how to maintain and scale your environment to grow with your use case.

% Scope notes: Explain that a basic deployment always has ES, usually has Kibana, might have xyz.
This section focuses on deploying and managing the core components of the {{stack}}: {{es}} and {{kib}}. It also documents deploying and managing supporting orchestration technologies. However, depending on your use case, you might need to deploy other components. [Learn more](/get-started/the-stack.md).

% Use migrated content from existing pages that map to this page:
:::{tip}
To get started quickly, you can set up a [local development and testing environment](/solutions/search/run-elasticsearch-locally.md), or sign up for a [Serverless](https://cloud.elastic.co/serverless-registration) or [Hosted](https://cloud.elastic.co/registration) trial in {{ecloud}}.
:::

% - [ ] ./raw-migrated-files/kibana/kibana/introduction.md
% - [ ] ./raw-migrated-files/kibana/kibana/setup.md
% - [ ] ./raw-migrated-files/tech-content/starting-with-the-elasticsearch-platform-and-its-solutions/get-elastic.md
% - [ ] ./raw-migrated-files/elasticsearch/elasticsearch-reference/scalability.md
% - [ ] ./raw-migrated-files/cloud/cloud/ec-faq-technical.md
% - [ ] ./raw-migrated-files/stack-docs/elastic-stack/overview.md
% Notes: redirect only
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-administering-deployments.md
% Notes: redirect only
% - [ ] ./raw-migrated-files/kibana/kibana/management.md
% Notes: redirect only
## Design and deploy

$$$adding_index_privileges$$$
Learn how to design and deploy a production-ready Elastic environment.

$$$faq-hw-architecture$$$
* [](/deploy-manage/deploy.md): Understand your deployment options and choose the approach that best fits your needs.

If you already know how you want to deploy, you can jump to the documentation for your preferred deployment method:
* [{{serverless-full}}](/deploy-manage/deploy/elastic-cloud/serverless.md)
* [{{ech}}](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md)
* [{{ece}}](/deploy-manage/deploy/cloud-enterprise.md)
* [{{eck}}](/deploy-manage/deploy/cloud-on-k8s.md)
* [Self-managed](/deploy-manage/deploy/self-managed.md)

$$$faq-master-nodes$$$
* [](/deploy-manage/distributed-architecture.md): Learn about the architecture of {{es}} and {{kib}}, and how Elastic stores and retrieves data and executes tasks in clusters with multiple nodes.
* [](/deploy-manage/production-guidance.md): Review tips and guidance that you can use to design a production environment that matches your workloads, policies, and deployment needs.
* [](/deploy-manage/reference-architectures.md): Explore blueprints for deploying clusters tailored to different use cases.
* [](/deploy-manage/tools.md): Learn about the tools available to safeguard data, ensure continuous availability, and maintain resilience in your {{es}} environment.
* [](/deploy-manage/autoscaling.md): Learn how to configure your [orchestrated](/deploy-manage/deploy.md#about-orchestration) deployment to scale based on policies and cluster signals. Applies to {{ech}}, {{ece}}, and {{eck}} deployments.

$$$faq-ssl$$$
:::{admonition} Serverless does it for you
If you deploy an {{serverless-full}} project, then you don't need to learn about Elastic architecture, production design, resilience, or scaling concepts. Serverless automatically scales and backs up your cluster for you, and is ready for production out of the box.
:::

$$$faq-autoscale$$$
## Secure and control access

$$$faq-ip-sniffing$$$
Learn how to secure your Elastic environment to restrict access to only authorized parties, and allow communication between your environment and external parties.

$$$faq-encryption-at-rest$$$
* [](/deploy-manage/security.md): Learn about security features that prevent bad actors from tampering with your data, and encrypt communications to, from, and within your cluster.
* [](/deploy-manage/users-roles.md): Manage user authentication and authorization at the level of your Cloud organization, your orchestrator, or your deployment or cluster.
* [](/deploy-manage/manage-spaces.md): Learn how to organize content in your {{kib}} instance, and restrict access to this content to specific users.
* [](/deploy-manage/api-keys.md): Authenticate and authorize programmatic access to your deployments and {{es}} resources.
* [](/deploy-manage/manage-connectors.md): Manage connection information between Elastic and third-party systems.
* [](/deploy-manage/remote-clusters.md): Enable communication between {{es}} clusters to support [cross-cluster replication](/deploy-manage/tools/cross-cluster-replication.md) and [cross-cluster search](/solutions/search/cross-cluster-search.md).

$$$faq-static-ip-elastic-cloud$$$
## Administer and maintain

**This page is a work in progress.** The documentation team is working to combine content pulled from the following pages:
Monitor the performance of your Elastic environment, administer your organization and license, and maintain the health of your environment.

% Doesn't exist
% * [/raw-migrated-files/kibana/kibana/introduction.md](/raw-migrated-files/kibana/kibana/introduction.md)
* [](/deploy-manage/monitor.md): View health and performance data for Elastic components, and receive recommendations and insights.
* [](/deploy-manage/cloud-organization.md): Administer your {{ecloud}} organization, including billing, organizational contacts, and service monitoring.
* [](/deploy-manage/license.md): Learn how to manage your Elastic license or subscription.
* [](/deploy-manage/maintenance.md): Learn how to isolate or deactivate parts of your Elastic environment to perform maintenance, or restart parts of Elastic.
* [](/deploy-manage/uninstall.md): Uninstall one or more Elastic components.

## Upgrade

You can [upgrade your Elastic environment](/deploy-manage/upgrade.md) to gain access to the latest features. Learn how to upgrade your cluster or deployment to the latest {{stack}} version, or upgrade your {{ece}} orchestrator or {{eck}} operator to the latest version.

* [/raw-migrated-files/kibana/kibana/setup.md](/raw-migrated-files/kibana/kibana/setup.md)
* [/raw-migrated-files/tech-content/starting-with-the-elasticsearch-platform-and-its-solutions/get-elastic.md](/raw-migrated-files/tech-content/starting-with-the-elasticsearch-platform-and-its-solutions/get-elastic.md)
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/scalability.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/scalability.md)
* [/raw-migrated-files/cloud/cloud/ec-faq-technical.md](/raw-migrated-files/cloud/cloud/ec-faq-technical.md)
* [/raw-migrated-files/stack-docs/elastic-stack/overview.md](/raw-migrated-files/stack-docs/elastic-stack/overview.md)
* [/raw-migrated-files/cloud/cloud-enterprise/ece-administering-deployments.md](/raw-migrated-files/cloud/cloud-enterprise/ece-administering-deployments.md)
* [/raw-migrated-files/kibana/kibana/management.md](/raw-migrated-files/kibana/kibana/management.md)
4 changes: 2 additions & 2 deletions deploy-manage/license.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ applies_to:
serverless:
---

# Manage your license
# Licenses and subscriptions

Your Elastic license determines which features are available and what level of support you receive.
Your Elastic license or subscription determines which features are available and what level of support you receive.

Depending on your deployment type, licenses and subscriptions are applied at different levels:

Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/manage-connectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ applies_to:
serverless:
---

# Manage connectors [connector-management]
# Connectors [connector-management]

Connectors serve as a central place to store connection information for both Elastic and third-party systems. They enable the linking of actions to rules, which execute as background tasks on the {{kib}} server when rule conditions are met. This allows rules to route actions to various destinations such as log files, ticketing systems, and messaging tools. Different {{kib}} apps may have their own rule types, but they typically share connectors. The **{{stack-manage-app}} > {{connectors-ui}}** provides a central location to view and manage all connectors in the current space.

Expand Down
Loading
Loading