Skip to content

[ECK] Update documentation for 3.1.0 #2019

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

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all 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
4 changes: 2 additions & 2 deletions deploy-manage/deploy/cloud-on-k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ This section outlines the supported Kubernetes and {{stack}} versions for ECK. C

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

* Kubernetes 1.28-1.32
* OpenShift 4.14-4.18
* Kubernetes 1.29-1.33
* OpenShift 4.15-4.19
* Google Kubernetes Engine (GKE), Azure Kubernetes Service (AKS), and Amazon Elastic Kubernetes Service (EKS)
* Helm: {{eck_helm_minimum_version}}+

Expand Down
17 changes: 16 additions & 1 deletion deploy-manage/deploy/cloud-on-k8s/configuration-fleet.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,23 @@ By default, every reference targets all instances in your {{es}}, {{kib}} and {{

## Customize {{agent}} configuration [k8s-elastic-agent-fleet-configuration-custom-configuration]

In contrast to {{agents}} in standalone mode, the configuration is managed through {{fleet}}, and it cannot be defined through `config` or `configRef` elements.
In contrast to {{agents}} in standalone mode, the configuration is managed through {{fleet}}, and it cannot be defined through `config` or `configRef` elements with a few exceptions.

One of those exceptions is the configuration of providers as described in [advanced Agent configuration managed by Fleet](/reference/fleet/advanced-kubernetes-managed-by-fleet.md). When {{agent}} is managed by {{fleet}} and is orchestrated by ECK, the configuration of providers can simply be done through the `.spec.config` element in the Agent resource as of {applies_to}`stack: ga 8.13`:

```yaml
apiVersion: agent.k8s.elastic.co/v1alpha1
kind: Agent
metadata:
name: elastic-agent
spec:
config:
fleet:
enabled: true
providers.kubernetes:
add_resource_metadata:
deployment: true
```

## Upgrade the {{agent}} specification [k8s-elastic-agent-fleet-configuration-upgrade-specification]

Expand Down
4 changes: 2 additions & 2 deletions docset.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
project: 'Elastic documentation'
max_toc_depth: 2

Expand Down Expand Up @@ -275,8 +275,8 @@
kib-pull: "https://github.com/elastic/kibana/pull/"
stack-version: "9.0.0"
ece_version: "4.0.1"
eck_version: "3.0.0"
eck_release_branch: "3.0"
eck_version: "3.1.0"
eck_release_branch: "3.1"
eck_helm_minimum_version: "3.2.0"
eck_resources_list: "Elasticsearch, Kibana, APM Server, Beats, Elastic Agent, Elastic Maps Server, and Logstash"
eck_resources_list_short: "APM Server, Beats, Elastic Agent, Elastic Maps Server, and Logstash"
Expand Down
1 change: 1 addition & 0 deletions reference/fleet/advanced-kubernetes-managed-by-fleet.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,4 +106,5 @@ volumes:

1. By default the manifests for {{agent}} managed by {{fleet}} have `hostNetwork:true`. In order to support multiple installations of {{agent}}s in the same node you should set `hostNetwork:false`. See this relevant [example](https://github.com/elastic/elastic-agent/tree/main/docs/manifests/hostnetwork) as described in [{{agent}} Manifests in order to support Kube-State-Metrics Sharding](https://github.com/elastic/elastic-agent/blob/main/docs/elastic-agent-ksm-sharding.md).
2. The volume `/usr/share/elastic-agent/state` must remain mounted in [elastic-agent-managed-kubernetes.yaml](https://github.com/elastic/elastic-agent/blob/main/deploy/kubernetes/elastic-agent-managed-kubernetes.yaml), otherwise custom config map provided above will be overwritten.
3. If {{agent}} is deployed through ECK, you can define the provider configuration in the `spec.config` field of the Kubernetes custom resource. Refer to [{{fleet}}-managed {{agent}} on ECK](/deploy-manage/deploy/cloud-on-k8s/configuration-fleet.md) for details.

Loading