Skip to content

Commit

Permalink
Merge branch 'main' into manage-data-curator
Browse files Browse the repository at this point in the history
  • Loading branch information
colleenmcginnis authored Feb 18, 2025
2 parents be9ee21 + 3913e85 commit eaf0b65
Show file tree
Hide file tree
Showing 185 changed files with 2,116 additions and 1,629 deletions.
4 changes: 3 additions & 1 deletion deploy-manage/api-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@

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

% Scope notes: Elasticsearch & Kibana authentication API Keys
% Scope notes: Elasticsearch & Kibana authentication API Keys

⚠️ **This page is a work in progress.** ⚠️
17 changes: 15 additions & 2 deletions deploy-manage/autoscaling/autoscaling-deciders.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ mapped_urls:

% What needs to be done: Refine

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

% Scope notes: Collapse to a single page, explain what deciders are

Expand All @@ -27,4 +27,17 @@ mapped_urls:
% - [ ] ./raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-frozen-storage-decider.md
% - [ ] ./raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-frozen-existence-decider.md
% - [ ] ./raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-machine-learning-decider.md
% - [ ] ./raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-fixed-decider.md
% - [ ] ./raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-fixed-decider.md

⚠️ **This page is a work in progress.** ⚠️

The documentation team is working to combine content pulled from the following pages:

* [/raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-deciders.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-deciders.md)
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-reactive-storage-decider.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-reactive-storage-decider.md)
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-proactive-storage-decider.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-proactive-storage-decider.md)
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-frozen-shards-decider.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-frozen-shards-decider.md)
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-frozen-storage-decider.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-frozen-storage-decider.md)
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-frozen-existence-decider.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-frozen-existence-decider.md)
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-machine-learning-decider.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-machine-learning-decider.md)
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-fixed-decider.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/autoscaling-fixed-decider.md)
9 changes: 8 additions & 1 deletion deploy-manage/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,11 @@ mapped_urls:
% 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
% - [ ] ./raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md

⚠️ **This page is a work in progress.** ⚠️

The documentation team is working to combine content pulled from the following pages:

* [/raw-migrated-files/docs-content/serverless/intro.md](/raw-migrated-files/docs-content/serverless/intro.md)
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md)
9 changes: 8 additions & 1 deletion deploy-manage/deploy/cloud-enterprise.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,11 @@ mapped_urls:
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/Elastic-Cloud-Enterprise-overview.md
% Notes: 2 child docs
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-administering-ece.md
% Notes: redirect only
% Notes: redirect only

⚠️ **This page is a work in progress.** ⚠️

The documentation team is working to combine content pulled from the following pages:

* [/raw-migrated-files/cloud/cloud-enterprise/Elastic-Cloud-Enterprise-overview.md](/raw-migrated-files/cloud/cloud-enterprise/Elastic-Cloud-Enterprise-overview.md)
* [/raw-migrated-files/cloud/cloud-enterprise/ece-administering-ece.md](/raw-migrated-files/cloud/cloud-enterprise/ece-administering-ece.md)
9 changes: 8 additions & 1 deletion deploy-manage/deploy/cloud-enterprise/air-gapped-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,11 @@ mapped_urls:

% - [ ] ./raw-migrated-files/stack-docs/elastic-stack/air-gapped-install.md
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-install-offline.md
% Notes: 3 child docs
% Notes: 3 child docs

⚠️ **This page is a work in progress.** ⚠️

The documentation team is working to combine content pulled from the following pages:

* [/raw-migrated-files/stack-docs/elastic-stack/air-gapped-install.md](/raw-migrated-files/stack-docs/elastic-stack/air-gapped-install.md)
* [/raw-migrated-files/cloud/cloud-enterprise/ece-install-offline.md](/raw-migrated-files/cloud/cloud-enterprise/ece-install-offline.md)
10 changes: 9 additions & 1 deletion deploy-manage/deploy/cloud-enterprise/create-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,12 @@ mapped_urls:

% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-create-deployment.md
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-access-kibana.md
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana.md
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana.md

⚠️ **This page is a work in progress.** ⚠️

The documentation team is working to combine content pulled from the following pages:

* [/raw-migrated-files/cloud/cloud-enterprise/ece-create-deployment.md](/raw-migrated-files/cloud/cloud-enterprise/ece-create-deployment.md)
* [/raw-migrated-files/cloud/cloud-enterprise/ece-access-kibana.md](/raw-migrated-files/cloud/cloud-enterprise/ece-access-kibana.md)
* [/raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana.md](/raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana.md)
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@

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

% Scope notes: Introduction about the content of this big section (which covers install and configuration possibilities of the orchestrator)
% Scope notes: Introduction about the content of this big section (which covers install and configuration possibilities of the orchestrator)

⚠️ **This page is a work in progress.** ⚠️
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,11 @@ mapped_urls:
% Use migrated content from existing pages that map to this page:

% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-generate-roles-token.md
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-revoke-roles-token.md
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-revoke-roles-token.md

⚠️ **This page is a work in progress.** ⚠️

The documentation team is working to combine content pulled from the following pages:

* [/raw-migrated-files/cloud/cloud-enterprise/ece-generate-roles-token.md](/raw-migrated-files/cloud/cloud-enterprise/ece-generate-roles-token.md)
* [/raw-migrated-files/cloud/cloud-enterprise/ece-revoke-roles-token.md](/raw-migrated-files/cloud/cloud-enterprise/ece-revoke-roles-token.md)
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,11 @@ mapped_urls:
% Use migrated content from existing pages that map to this page:

% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-manage-integrations-server.md
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-integrations-server-api-example.md
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-integrations-server-api-example.md

⚠️ **This page is a work in progress.** ⚠️

The documentation team is working to combine content pulled from the following pages:

* [/raw-migrated-files/cloud/cloud-enterprise/ece-manage-integrations-server.md](/raw-migrated-files/cloud/cloud-enterprise/ece-manage-integrations-server.md)
* [/raw-migrated-files/cloud/cloud-enterprise/ece-integrations-server-api-example.md](/raw-migrated-files/cloud/cloud-enterprise/ece-integrations-server-api-example.md)
4 changes: 3 additions & 1 deletion deploy-manage/deploy/cloud-enterprise/tools-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@

% What needs to be done: Write from scratch

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

⚠️ **This page is a work in progress.** ⚠️
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,13 @@ mapped_urls:
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-change-deployment.md
% Notes: another redirect
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md
% Notes: mostly redirect
% Notes: mostly redirect

⚠️ **This page is a work in progress.** ⚠️

The documentation team is working to combine content pulled from the following pages:

* [/raw-migrated-files/cloud/cloud-enterprise/ece-stack-getting-started.md](/raw-migrated-files/cloud/cloud-enterprise/ece-stack-getting-started.md)
* [/raw-migrated-files/cloud/cloud-enterprise/ece-administering-deployments.md](/raw-migrated-files/cloud/cloud-enterprise/ece-administering-deployments.md)
* [/raw-migrated-files/cloud/cloud-enterprise/ece-change-deployment.md](/raw-migrated-files/cloud/cloud-enterprise/ece-change-deployment.md)
* [/raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md](/raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md)
90 changes: 80 additions & 10 deletions deploy-manage/deploy/cloud-on-k8s.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,93 @@
---
applies:
eck: all
mapped_urls:
- https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-overview.html
- https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-advanced-topics.html
- https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-supported.html
- https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s_learn_more_about_eck.html
---

# Elastic Cloud on Kubernetes
# Elastic Cloud on Kubernetes [k8s-overview]

% What needs to be done: Refine
Built on the Kubernetes Operator pattern, {{eck}} (ECK) extends the basic Kubernetes orchestration capabilities to support the setup and management of Elasticsearch, Kibana, APM Server, Beats, Elastic Agent, Elastic Maps Server, and Logstash on Kubernetes.

% GitHub issue: https://github.com/elastic/docs-projects/issues/357
## ECK overview

% Scope notes: Maybe we can even leave it as it is.
With Elastic Cloud on Kubernetes, you can streamline critical operations, such as:

% Use migrated content from existing pages that map to this page:
1. Managing and monitoring multiple clusters
2. Scaling cluster capacity and storage
3. Performing safe configuration changes through rolling upgrades
4. Securing clusters with TLS certificates
5. Setting up hot-warm-cold architectures with availability zone awareness

% - [ ] ./raw-migrated-files/cloud-on-k8s/cloud-on-k8s/k8s-overview.md
% - [ ] ./raw-migrated-files/cloud-on-k8s/cloud-on-k8s/k8s-advanced-topics.md
% Notes: redirect only
% - [ ] ./raw-migrated-files/cloud-on-k8s/cloud-on-k8s/k8s-supported.md
% - [ ] ./raw-migrated-files/cloud-on-k8s/cloud-on-k8s/k8s_learn_more_about_eck.md
This section provides everything you need to install, configure, and manage Elastic Stack applications with ECK, including:

- [](./cloud-on-k8s/deploy-an-orchestrator.md): ECK installation methods and configuration options. Deploy ECK on managed Kubernetes platforms like GKE, AKS, and EKS, on self-managed Kubernetes clusters, on OpenShift, and even in air-gapped environments.
- [](./cloud-on-k8s/manage-deployments.md): Handle {{es}} clusters and {{kib}} instances through ECK.
- [](./cloud-on-k8s/orchestrate-other-elastic-applications.md): Run APM Server, Beats, Elastic Agent, Elastic Maps Server, and Logstash on Kubernetes.
- [](./cloud-on-k8s/tools-apis.md): A collection of tools and APIs available in ECK based environments.

Other sections of the documentation include the following important topics around ECK:

- [Logging and Monitoring](../monitor.md): Configure stack monitoring and logs forwarding with the help of ECK.
- [Remote Clusters](../remote-clusters.md): Configure remote clusters on ECK.
- [](../tools.md): Add snapshot repositories to your {{es}} clusters for automatic snapshots.
- [Security](../security.md): Secure communications, manage HTTP certificates, or add secure settings to your applications.
- [Users and Roles](../users-roles.md): Configure authentication and authorization mechanisms, built-in users, external providers, and more.
- [Autoscaling](../autoscaling.md): Learn how to use {{es}} autoscaling on ECK, or use Horizontal Pod Autoscaler functionality for stateless workloads.
- [Licensing](../license/manage-your-license-in-eck.md): Manage licenses on ECK.

::::{important}
ECK is an Elastic self-managed product offered in two licensing tiers: Basic and Enterprise. For more details refer to [Elastic subscriptions](https://www.elastic.co/subscriptions) and [](/deploy-manage/license/manage-your-license-in-eck.md) documentation.
::::

## Quickstart [eck-quickstart]

If you want to get started quickly, follow these guides to deploy ECK and set up an {{es}} cluster:

* [Install ECK using YAML manifests](./cloud-on-k8s/install-using-yaml-manifest-quickstart.md)
* [Deploy an {{es}} cluster](./cloud-on-k8s/elasticsearch-deployment-quickstart.md)
* [Deploy a {{kib}} instance](./cloud-on-k8s/kibana-instance-quickstart.md)

Afterwards, you can:

* Learn how to [update your deployment](./cloud-on-k8s/update-deployments.md)
* Check out [our recipes](./cloud-on-k8s/recipes.md) for multiple use cases
* Find further sample resources [in the project repository](https://github.com/elastic/cloud-on-k8s/tree/2.16/config/samples)

## Supported versions [k8s-supported]

This section outlines the supported Kubernetes and Elastic Stack versions for ECK. Check the full [Elastic support matrix](https://www.elastic.co/support/matrix#matrix_kubernetes) for more information.

### Kubernetes compatibility

ECK is compatible with the following Kubernetes distributions and related technologies:

* Kubernetes 1.28-1.32
* OpenShift 4.12-4.17
* Google Kubernetes Engine (GKE), Azure Kubernetes Service (AKS), and Amazon Elastic Kubernetes Service (EKS)
* Helm: 3.2.0+

ECK should work with all conformant **installers** listed in these [FAQs](https://github.com/cncf/k8s-conformance/blob/master/faq.md#what-is-a-distribution-hosted-platform-and-an-installer). Distributions include source patches and so may not work as-is with ECK.

### Elastic Stack compatibility

ECK is compatible with the following Elastic Stack applications:

* Elasticsearch, Kibana, APM Server: 6.8+, 7.1+, 8+
* Enterprise Search: 7.7+, 8+
* Beats: 7.0+, 8+
* Elastic Agent: 7.10+ (standalone), 7.14+ (Fleet), 8+
* Elastic Maps Server: 7.11+, 8+
* Logstash: 8.7+

Elastic Stack application images for the OpenShift-certified Elasticsearch (ECK) Operator are only available from version 7.10 and later.

## Learn more about ECK [k8s_learn_more_about_eck]

* [Orchestrate Elasticsearch on Kubernetes](https://www.elastic.co/elasticsearch-kubernetes)
* [ECK post on the Elastic Blog](https://www.elastic.co/blog/introducing-elastic-cloud-on-kubernetes-the-elasticsearch-operator-and-beyond?elektra=products&storm=sub1)
* [Getting Started With Elastic Cloud on Kubernetes (ECK)](https://www.youtube.com/watch?v=PIJmlYBIFXM)
* [Running the Elastic Stack on Kubernetes with ECK](https://www.youtube.com/watch?v=Wf6E3vkvEFM)
Loading

0 comments on commit eaf0b65

Please sign in to comment.