Skip to content

Commit 1aa17ad

Browse files
committed
config overviews with links almost completed
1 parent ebfeaba commit 1aa17ad

File tree

4 files changed

+83
-68
lines changed

4 files changed

+83
-68
lines changed

deploy-manage/deploy/cloud-on-k8s/configure-deployments.md

Lines changed: 20 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,57 +6,44 @@ mapped_pages:
66
- https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-update-deployment.html
77
---
88

9-
% the security link needs to be refined to point to the eck related section around security
10-
% same for upgrade link
11-
12-
% WORK IN PROGRESS, TOGETHER WITH CONFIGURE.md
13-
149
# Configure deployments [k8s-orchestrating-elastic-stack-applications]
1510

1611
This section provides details around {{kib}} and {{es}} configuration when running on ECK. For general information about how ECK applies configuration changes and the syntax to use in the YAML manifests, refer to [](./update-deployments.md).
1712

18-
* [**{{es}} configuration**](elasticsearch-configuration.md) → Review configuration possibilities to tune your {{es}} cluster running on ECK, learn how [nodes orchestration](./nodes-orchestration.md) work, [storage recommendations](./storage-recommendations.md), and more.
19-
20-
* [Users and roles]() (SECURITY)
21-
22-
* [](./requests-routing-to-elasticsearch-nodes.md) → Control the nodes receiving incoming traffic when using multiple `nodeSets` with different [node roles](https://www.elastic.co/guide/en/elasticsearch/reference/current/node-roles-overview.html).
23-
24-
* [{{es}} autoscaling on ECK](../../autoscaling/deployments-autoscaling-on-eck.md):
13+
* [**{{es}} configuration**](elasticsearch-configuration.md): Review configuration possibilities to tune your {{es}} cluster running on ECK, learn how [nodes orchestration](./nodes-orchestration.md) work, [storage recommendations](./storage-recommendations.md), and more.
2514

26-
* [Snapshot and Restore](../../tools/snapshot-and-restore/cloud-on-k8s.md)
27-
28-
* [**Stack monitoring**](https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-stack-monitoring.html) → Monitor your deployments smoothly with the help of ECK.
29-
30-
* [**Remote clusters**](/deploy-manage/remote-clusters/eck-remote-clusters.md) → Configure {{es}} remote clusters functionality for Cross Cluster Search (CCS) and Cross Cluster Replication.
31-
32-
* [**{{kib}} configuration**](kibana-configuration.md) → Learn how to connect {{kib}} to an {{es}} cluster, apply advanced configuration settings, and tune the HTTP configuration.
15+
* [**{{kib}} configuration**](kibana-configuration.md): Learn how to connect {{kib}} to an {{es}} cluster, apply advanced configuration settings, and tune the HTTP configuration.
3316

3417
Additionally, the following topics apply to both {{es}} and {{kib}}, and in some cases, to other applications supported by ECK:
3518

36-
* [Configure secure settings]() (LINK TBD, SECURITY CONFIGURE ES AND KIB SECURE SETTINGS)
19+
* [**Customize Pods**](customize-pods.md): Learn how to adapt the `podTemplate` field to your needs.
3720

38-
* [**Access services**](accessing-services.md) → Learn how to access to the orchestrated clusters and how to adapt the Kubernetes services to your needs.
21+
* [**Manage compute resources**](manage-compute-resources.md): Important considerations around CPU and memory `requests` and `limits` when running production workloads.
3922

40-
* [**TLS certificates**](./tls-certificates.md) → Use your own SSL/TLS certificates for the HTTP endpoint of {{es}} or {{kib}}.
23+
* [**Access services**](accessing-services.md): Learn how to access to the orchestrated clusters and how to adapt the Kubernetes services to your needs.
4124

42-
* [**Secure the Elastic Stack**](../../security.md) → Manage users and roles, authentication realms, and more.
25+
* [**Recipes**](recipes.md): Advanced use cases examples available in our GitHub repository.
4326

44-
* [**Recipes**](recipes.md) → Advanced use cases examples available in our GitHub repository.
27+
* [**Connect to external Elastic resources**](connect-to-external-elastic-resources.md): Use custom `secrets` for the `elasticsearchRef` and `kibanaRef` parameters.
4528

46-
* [**Customize Pods**](customize-pods.md) → Learn how to adapt the `podTemplate` field to your needs.
29+
ECK also facilitates configuration and operation activities with advanced features, such as:
4730

48-
* [**Manage compute resources**](manage-compute-resources.md) → Important considerations around CPU and memory when running production workloads.
31+
* [**Elastic Stack configuration policies**](elastic-stack-configuration-policies.md): Organize your {{es}} and {{kib}} configuration settings through `StackConfigPolicy` resources that can be referenced within your deployments. This helps to keep your manifests simplified.
4932

50-
* [**Autoscaling stateless applications**](../../autoscaling/autoscaling-stateless-applications-on-eck.md) → Use [Horizontal Pod Autoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) for {{kib}} or other stateless applications.
33+
## Other sections
5134

52-
* [**Connect to external Elastic resources**](connect-to-external-elastic-resources.md) → Use `secrets` with custom settings for `elasticsearchRef` and `kibanaRef` parameters.
35+
Other sections of the Elastic documentation cover additional topics related to deployments configuration on ECK:
5336

54-
ECK also facilitates configuration and operation activities with advanced features, such as:
37+
**Security**
5538

56-
* [**Elastic Stack configuration policies**](elastic-stack-configuration-policies.md) → Organize your {{es}} and {{kib}} configuration settings through `StackConfigPolicy` resources that can be referenced within your deployments.
39+
* [**HTTP TLS certificates**](./tls-certificates.md): Use your own SSL/TLS certificates for the HTTP endpoint of {{es}} and {{kib}}.
40+
41+
**Monitoring and Logging**
5742

58-
* [**Stack monitoring**](https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-stack-monitoring.html) → Monitor your deployments smoothly with the help of ECK.
43+
* [**Stack monitoring**](https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-stack-monitoring.html): Use ECK to manage logs and metrics for your deployments.
5944

60-
* [**Remote clusters**](/deploy-manage/remote-clusters/eck-remote-clusters.md) → Configure {{es}} remote clusters functionality for Cross Cluster Search (CCS) and Cross Cluster Replication.
45+
**Remote Clusters**
46+
* [**Remote clusters**](/deploy-manage/remote-clusters/eck-remote-clusters.md): Configure {{es}} remote clusters functionality for Cross Cluster Search (CCS) and Cross Cluster Replication.
6147

62-
* [**Upgrade the Elastic Stack version**](../../upgrade/deployment-or-cluster.md) → Upgrade orchestrated applications on ECK.
48+
**Autoscaling**
49+
* [**Autoscaling stateless applications**](../../autoscaling/autoscaling-stateless-applications-on-eck.md): Use [Horizontal Pod Autoscaler](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) for {{kib}} or other stateless applications.

deploy-manage/deploy/cloud-on-k8s/configure.md

Lines changed: 1 addition & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,6 @@ The following guides cover common ECK configuration tasks:
3232

3333
Other sections of the Elastic documentation cover additional topics related to ECK configuration:
3434

35-
* **Security**
36-
* (topis related with ECK security (TLS certificates?), not deployments stuff ), CA certificates?
37-
3835
* **Monitoring**
3936
* [Configure the metrics endpoint](/deploy-manage/monitor/orchestrators/eck-metrics-configuration.md) (monitor an orchestrator)
4037

@@ -43,30 +40,4 @@ Other sections of the Elastic documentation cover additional topics related to E
4340

4441
* **Maintenance**
4542
* [Upgrade ECK](../../upgrade/orchestrator/upgrade-cloud-on-k8s.md)
46-
* [Uninstall ECK](../../uninstall/uninstall-elastic-cloud-on-kubernetes.md)
47-
48-
(Apps related)
49-
* **Snapshots and Restore**
50-
* Manage snapshots repositories --> Pending to add to configure deployments.
51-
52-
* **Remote Clusters**
53-
* Configure interconnection between your {{es}} clusters with the help of ECK.
54-
55-
* **Monitoring**
56-
* Stack Monitoring (for deployments)
57-
58-
* **Licensing**
59-
* [Manage licenses in ECK](../../license/manage-your-license-in-eck.md)
60-
61-
* **Maintenance**
62-
* [Upgrade ECK](../../upgrade/orchestrator/upgrade-cloud-on-k8s.md)
63-
* [Uninstall ECK](../../uninstall/uninstall-elastic-cloud-on-kubernetes.md)
64-
65-
* **Autoscaling**
66-
* Autoscaling stateless applications
67-
* Elasticsearch autoscaling on ECK
68-
69-
* Security
70-
* SAML authentication
71-
* Users and roles
72-
* Built-in users
43+
* [Uninstall ECK](../../uninstall/uninstall-elastic-cloud-on-kubernetes.md)

deploy-manage/deploy/cloud-on-k8s/elasticsearch-configuration.md

Lines changed: 57 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,22 @@ mapped_pages:
55
- https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-elasticsearch-specification.html
66
---
77

8-
% WORK IN PROGRESS HERE!
98
# Elasticsearch configuration [k8s-elasticsearch-specification]
109

1110
Before you deploy and run ECK in production, take some time to look at the basic and advanced settings available on this page. These settings are related both to Elasticsearch and Kubernetes functionality.
1211

12+
**Read first**
13+
* [Nodes orchestration](nodes-orchestration.md): Learn how ECK orchestrates nodes, applies changes or upgrades the cluster.
14+
* [Storage recommendations](storage-recommendations.md): Kubernetes storage considerations for {{es}} workloads.
15+
1316
**Basic {{es}} settings**
1417

1518
* [Node configuration](node-configuration.md): Configure the `elasticsearch.yml` of your {{es}} nodes.
1619
* [Volume claim templates](volume-claim-templates.md): Configure storage in your {{es}} nodes.
17-
* [Virtual memory](virtual-memory.md)
18-
* [Custom configuration files and plugins](custom-configuration-files-plugins.md)
20+
* [Virtual memory](virtual-memory.md): Methods to accomplish {{es}} virtual memory system configuration requirement.
21+
* [Custom configuration files and plugins](custom-configuration-files-plugins.md): Learn how to
1922
* [Init containers for plugin downloads](init-containers-for-plugin-downloads.md)
23+
* [Settings managed by ECK](settings-managed-by-eck.md): List of {{es}} settings that you cannot update.
2024

2125
**Kubernetes and system related configuration**
2226
* [Security Context](security-context.md): Kubernetes security context and kernel capabilities.
@@ -37,7 +41,7 @@ Before you deploy and run ECK in production, take some time to look at the basic
3741
In other sections of the documentation you can find information for the following configuration use cases:
3842

3943
* [Secure settings](../../security/secure-settings.md)
40-
* [Remote clusters](../../remote-clusters/eck-remote-clusters.md)
44+
* [Remote clusters](../../remote-clusters/eck-remote-clusters.md): Configure {{es}} remote clusters functionality for Cross Cluster Search (CCS) and Cross Cluster Replication.
4145
* [Create automated snapshots](../../tools/snapshot-and-restore/cloud-on-k8s.md)
4246
* [Elasticsearch autoscaling](../../autoscaling/deployments-autoscaling-on-eck.md)
4347

@@ -52,3 +56,52 @@ In other sections of the documentation you can find information for the followin
5256
* [JVM heap dumps](../../../troubleshoot/deployments/cloud-on-k8s/jvm-heap-dumps.md)
5357
* [ECK diagnostics utility](../../../troubleshoot/deployments/cloud-on-k8s/run-eck-diagnostics.md)
5458

59+
60+
***** REMOVED *****
61+
62+
**Remote Clusters**
63+
* [**Remote clusters**](/deploy-manage/remote-clusters/eck-remote-clusters.md): Configure {{es}} remote clusters functionality for Cross Cluster Search (CCS) and Cross Cluster Replication.
64+
65+
(Apps related)
66+
* **Snapshots and Restore**
67+
* Manage snapshots repositories --> Pending to add to configure deployments.
68+
69+
* **Remote Clusters**
70+
* Configure interconnection between your {{es}} clusters with the help of ECK.
71+
72+
* **Monitoring**
73+
* Stack Monitoring (for deployments)
74+
75+
* **Licensing**
76+
* [Manage licenses in ECK](../../license/manage-your-license-in-eck.md)
77+
78+
* **Maintenance**
79+
* [Upgrade ECK](../../upgrade/orchestrator/upgrade-cloud-on-k8s.md)
80+
* [Uninstall ECK](../../uninstall/uninstall-elastic-cloud-on-kubernetes.md)
81+
82+
* **Autoscaling**
83+
* Autoscaling stateless applications
84+
* Elasticsearch autoscaling on ECK
85+
86+
* Security
87+
* Secure settings
88+
* SAML authentication
89+
* Users and roles
90+
* Built-in users
91+
* [**Secure the Elastic Stack**](../../security.md): Manage users and roles, authentication realms, and more.
92+
93+
94+
* [Users and roles]() (SECURITY)
95+
96+
* [](./requests-routing-to-elasticsearch-nodes.md): Control the nodes receiving incoming traffic when using multiple `nodeSets` with different [node roles](https://www.elastic.co/guide/en/elasticsearch/reference/current/node-roles-overview.html).
97+
98+
* [{{es}} autoscaling on ECK](../../autoscaling/deployments-autoscaling-on-eck.md):
99+
100+
* [Snapshot and Restore](../../tools/snapshot-and-restore/cloud-on-k8s.md)
101+
102+
* [**Stack monitoring**](https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-stack-monitoring.html): Monitor your deployments smoothly with the help of ECK.
103+
104+
* [**Remote clusters**](/deploy-manage/remote-clusters/eck-remote-clusters.md): Configure {{es}} remote clusters functionality for Cross Cluster Search (CCS) and Cross Cluster Replication.
105+
106+
107+

deploy-manage/deploy/cloud-on-k8s/manage-deployments.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,8 @@ In this section, you'll learn how to perform the following tasks in ECK:
2424
For a complete reference on configuration possibilities for {{es}} and {{kib}}, see:
2525

2626
- [](./elasticsearch-configuration.md)
27-
- [](./kibana-configuration.md)
27+
- [](./kibana-configuration.md)
28+
29+
Other references for managing deployments:
30+
31+
* [**Upgrade the Elastic Stack version**](../../upgrade/deployment-or-cluster.md): Upgrade orchestrated applications on ECK.

0 commit comments

Comments
 (0)