Skip to content

Commit 3d64dd8

Browse files
authored
Deploy and manage overview (#641)
1 parent 7adc5cf commit 3d64dd8

24 files changed

+173
-250
lines changed

deploy-manage/api-keys.md

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
applies_to:
3-
stack: ga
43
deployment:
54
eck: ga
65
ess: ga
@@ -9,14 +8,7 @@ applies_to:
98
serverless: ga
109
---
1110

12-
# Manage API keys
13-
14-
% What needs to be done: Write from scratch
15-
16-
% GitHub issue: https://github.com/elastic/docs-projects/issues/349
17-
18-
% Scope notes: Elasticsearch & Kibana authentication API Keys
19-
11+
# API keys
2012

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

deploy-manage/cloud-organization.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ applies_to:
99

1010
# Manage your Cloud organization [ec-organizations]
1111

12-
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.
12+
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.
1313

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

deploy-manage/deploy.md

+30-34
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,9 @@
22
mapped_urls:
33
- https://www.elastic.co/guide/en/serverless/current/intro.html
44
- https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-deploy.html
5+
- https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/get-elastic.html
56
---
67

7-
% What needs to be done: Write from scratch
8-
9-
% GitHub issue: https://github.com/elastic/docs-projects/issues/334
10-
11-
% 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.
12-
13-
% Use migrated content from existing pages that map to this page:
14-
15-
% - [ ] ./raw-migrated-files/docs-content/serverless/intro.md
16-
% - [ ] ./raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md
17-
188
# Deploy
199

2010
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.
@@ -23,13 +13,20 @@ This page will help you understand your deployment options and choose the approa
2313

2414
## Core components
2515

26-
Every Elastic deployment requires {{es}} as its core data store and search/analytics engine.
27-
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.
16+
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.
2817

29-
Your choice of deployment type determines how you'll set up and manage these core components, plus any additional components you need.
18+
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.
3019

31-
:::{tip}
32-
Learn more about the [{{stack}}](/get-started/the-stack.md) to understand the core and optional components of an Elastic deployment.
20+
Your choice of deployment type determines how you'll set up and manage these core components, as well as any additional components you need.
21+
22+
:::{admonition} Other {{stack}} components
23+
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.
24+
25+
To learn how to deploy optional {{stack}} components, refer to the following sections:
26+
* [Fleet and Elastic Agent](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/index.md)
27+
* [APM](/solutions/observability/apps/application-performance-monitoring-apm.md)
28+
* [Beats](asciidocalypse://docs/beats/docs/reference/index.md)
29+
* [Logstash](asciidocalypse://docs/logstash/docs/reference/index.md)
3330
:::
3431

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

4239
#### Managed by Elastic
4340

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

46-
- **Serverless**: Zero operational overhead, automatic scaling and updates, latest features
47-
- **Cloud hosted**: Balance of control and managed operations, choice of resources and regions
43+
- **{{serverless-full}}**: Zero operational overhead, automatic scaling and updates, latest features
44+
- **{{ech}}**: Balance of control and managed operations, choice of resources and regions
45+
46+
Both of these options use [{{ecloud}}](/deploy-manage/deploy/elastic-cloud.md) as the orchestration platform.
4847

4948
#### Self-hosted options
5049

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

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

58-
:::::{note}
59-
:::{dropdown} About orchestration
57+
::::{tip}
58+
Documentation will specify when certain features or configurations are not applicable to specific deployment types.
59+
::::
60+
61+
### About orchestration
6062

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

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

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

75-
::::{tip}
76-
Documentation will specify when certain features or configurations are not applicable to specific deployment types.
77-
::::
78-
:::
79-
:::::
80-
8177
### Versioning and compatibility
8278

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

85-
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.
81+
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.
8682

8783
Consider this when choosing your deployment type:
8884

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

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

9692
### Cost considerations
9793

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

10298
:::::{tip}

deploy-manage/deploy/deployment-comparison.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
# Deployment comparison reference
2+
# Compare deployment options
33

44
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).
55

deploy-manage/deploy/kibana-reporting-configuration.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ mapped_urls:
44
- https://www.elastic.co/guide/en/kibana/current/reporting-production-considerations.html
55
---
66

7-
# Kibana reporting configuration
7+
# Configure reporting
88

99
% What needs to be done: Refine
1010

deploy-manage/index.md

+43-37
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,69 @@
11
---
22
mapped_urls:
3-
- https://www.elastic.co/guide/en/kibana/current/introduction.html
43
- https://www.elastic.co/guide/en/kibana/current/setup.html
5-
- https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/get-elastic.html
6-
- https://www.elastic.co/guide/en/elasticsearch/reference/current/scalability.html
74
- https://www.elastic.co/guide/en/cloud/current/ec-faq-technical.html
8-
- https://www.elastic.co/guide/en/elastic-stack/current/overview.html
95
- https://www.elastic.co/guide/en/elastic-stack/current/index.html
106
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-administering-deployments.html
117
- https://www.elastic.co/guide/en/kibana/current/management.html
128
---
139

1410
# Deploy and manage
1511

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

18-
% GitHub issue: https://github.com/elastic/docs-projects/issues/332
14+
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.
1915

20-
% Scope notes: Explain that a basic deployment always has ES, usually has Kibana, might have xyz.
16+
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).
2117

22-
% Use migrated content from existing pages that map to this page:
18+
:::{tip}
19+
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}}.
20+
:::
2321

24-
% - [ ] ./raw-migrated-files/kibana/kibana/introduction.md
25-
% - [ ] ./raw-migrated-files/kibana/kibana/setup.md
26-
% - [ ] ./raw-migrated-files/tech-content/starting-with-the-elasticsearch-platform-and-its-solutions/get-elastic.md
27-
% - [ ] ./raw-migrated-files/elasticsearch/elasticsearch-reference/scalability.md
28-
% - [ ] ./raw-migrated-files/cloud/cloud/ec-faq-technical.md
29-
% - [ ] ./raw-migrated-files/stack-docs/elastic-stack/overview.md
30-
% Notes: redirect only
31-
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-administering-deployments.md
32-
% Notes: redirect only
33-
% - [ ] ./raw-migrated-files/kibana/kibana/management.md
34-
% Notes: redirect only
22+
## Design and deploy
3523

36-
$$$adding_index_privileges$$$
24+
Learn how to design and deploy a production-ready Elastic environment.
3725

38-
$$$faq-hw-architecture$$$
26+
* [](/deploy-manage/deploy.md): Understand your deployment options and choose the approach that best fits your needs.
27+
28+
If you already know how you want to deploy, you can jump to the documentation for your preferred deployment method:
29+
* [{{serverless-full}}](/deploy-manage/deploy/elastic-cloud/serverless.md)
30+
* [{{ech}}](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md)
31+
* [{{ece}}](/deploy-manage/deploy/cloud-enterprise.md)
32+
* [{{eck}}](/deploy-manage/deploy/cloud-on-k8s.md)
33+
* [Self-managed](/deploy-manage/deploy/self-managed.md)
3934

40-
$$$faq-master-nodes$$$
35+
* [](/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.
36+
* [](/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.
37+
* [](/deploy-manage/reference-architectures.md): Explore blueprints for deploying clusters tailored to different use cases.
38+
* [](/deploy-manage/tools.md): Learn about the tools available to safeguard data, ensure continuous availability, and maintain resilience in your {{es}} environment.
39+
* [](/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.
4140

42-
$$$faq-ssl$$$
41+
:::{admonition} Serverless does it for you
42+
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.
43+
:::
4344

44-
$$$faq-autoscale$$$
45+
## Secure and control access
4546

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

48-
$$$faq-encryption-at-rest$$$
49+
* [](/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.
50+
* [](/deploy-manage/users-roles.md): Manage user authentication and authorization at the level of your Cloud organization, your orchestrator, or your deployment or cluster.
51+
* [](/deploy-manage/manage-spaces.md): Learn how to organize content in {{kib}}, and restrict access to this content to specific users.
52+
* [](/deploy-manage/api-keys.md): Authenticate and authorize programmatic access to your deployments and {{es}} resources.
53+
* [](/deploy-manage/manage-connectors.md): Manage connection information between Elastic and third-party systems.
54+
* [](/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).
4955

50-
$$$faq-static-ip-elastic-cloud$$$
56+
## Administer and maintain
5157

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

54-
% Doesn't exist
55-
% * [/raw-migrated-files/kibana/kibana/introduction.md](/raw-migrated-files/kibana/kibana/introduction.md)
60+
* [](/deploy-manage/monitor.md): View health and performance data for Elastic components, and receive recommendations and insights.
61+
* [](/deploy-manage/cloud-organization.md): Administer your {{ecloud}} organization, including billing, organizational contacts, and service monitoring.
62+
* [](/deploy-manage/license.md): Learn how to manage your Elastic license or subscription.
63+
* [](/deploy-manage/maintenance.md): Learn how to isolate or deactivate parts of your Elastic environment to perform maintenance, or restart parts of Elastic.
64+
* [](/deploy-manage/uninstall.md): Uninstall one or more Elastic components.
65+
66+
## Upgrade
67+
68+
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.
5669

57-
* [/raw-migrated-files/kibana/kibana/setup.md](/raw-migrated-files/kibana/kibana/setup.md)
58-
* [/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)
59-
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/scalability.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/scalability.md)
60-
* [/raw-migrated-files/cloud/cloud/ec-faq-technical.md](/raw-migrated-files/cloud/cloud/ec-faq-technical.md)
61-
* [/raw-migrated-files/stack-docs/elastic-stack/overview.md](/raw-migrated-files/stack-docs/elastic-stack/overview.md)
62-
* [/raw-migrated-files/cloud/cloud-enterprise/ece-administering-deployments.md](/raw-migrated-files/cloud/cloud-enterprise/ece-administering-deployments.md)
63-
* [/raw-migrated-files/kibana/kibana/management.md](/raw-migrated-files/kibana/kibana/management.md)

deploy-manage/license.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ applies_to:
88
serverless:
99
---
1010

11-
# Manage your license
11+
# Licenses and subscriptions
1212

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

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

deploy-manage/manage-connectors.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ applies_to:
77
serverless:
88
---
99

10-
# Manage connectors [connector-management]
10+
# Connectors [connector-management]
1111

1212
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.
1313

0 commit comments

Comments
 (0)