Skip to content

Commit 42374d6

Browse files
authored
Merge branch 'main' into 1697/read-access
2 parents 62e88e3 + 79881a2 commit 42374d6

File tree

54 files changed

+347
-1615
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+347
-1615
lines changed
Lines changed: 5 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
navigation_title: Air gapped environments
2+
navigation_title: Air-gapped environments
33
applies_to:
44
deployment:
55
eck: all
@@ -8,51 +8,9 @@ mapped_urls:
88
- https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-air-gapped.html
99
---
1010

11-
# Air gapped install
12-
13-
% What needs to be done: Refine
14-
15-
% GitHub issue: https://github.com/elastic/docs-projects/issues/309
16-
17-
% Scope notes: Curate and merget the content to have a proper guide for air gapped installations. Similar to ECE activity
18-
19-
% Use migrated content from existing pages that map to this page:
20-
21-
% - [ ] ./raw-migrated-files/stack-docs/elastic-stack/air-gapped-install.md
22-
23-
% already removed
24-
% - [ ] ./raw-migrated-files/cloud-on-k8s/cloud-on-k8s/k8s-air-gapped.md
25-
26-
% Internal links rely on the following IDs being on this page (e.g. as a heading ID, paragraph ID, etc):
27-
28-
$$$air-gapped-install$$$
29-
30-
$$$k8s-container-registry-override$$$
31-
32-
$$$k8s-eck-diag-air-gapped$$$
33-
34-
% There are two concepts and areas to explore here:
35-
% ECK installation on air-gapped. This has no complexity as it's all a matter of docker registry and docker images.
36-
% Managing deployments on an ECK running on air-gapped is something not really covered in the official ECK book and partly covered in stack-docs
37-
38-
% In this doc we will focus on ECK operator installation in air gapped environments, and we will link to Manage Deployments -> Air gapped (doesn't exist yet) for the content and examples about the rest.
39-
40-
% from fleet air-gapped
41-
% Kibana is able to reach the Elastic Package Registry to download package metadata and content.
42-
% Elastic Agents are able to download binaries during upgrades from the Elastic Artifact Registry.
43-
44-
% what about Elasticsearch requirements for example for GeoIP database, etc?
45-
46-
Pending to determine what to do with this:
47-
* Syncing container images for ECK and all other {{stack}} components over to a locally-accessible container repository.
48-
* Modifying the ECK helm chart configuration so that ECK is aware that it is supposed to use your offline container repository instead of the public Elastic repository.
49-
* Optionally, disabling ECK telemetry collection in the ECK helm chart. This configuration propagates to all other Elastic components, such as {{kib}}.
50-
* Building your custom deployment container image for the {{artifact-registry}}.
51-
* Building your custom deployment container image for the Elastic Endpoint Artifact Repository.
52-
5311
# Running in air-gapped environments [k8s-air-gapped]
5412

55-
The ECK operator can be run in an air-gapped environment without access to the open internet when it is configured not to pull container images from `docker.elastic.co`.
13+
The ECK operator can be run in an air-gapped environment without access to the open internet when configured to avoid pulling container images from `docker.elastic.co`.
5614

5715
By default ECK does not require you to specify the container image for each Elastic Stack application you deploy.
5816

@@ -63,13 +21,13 @@ metadata:
6321
name: quickstart
6422
spec:
6523
version: 8.16.1
66-
# image: docker.elastic.co/elasticsearch/elasticsearch:8.16.1 <1>
24+
# image: docker.elastic.co/elasticsearch/elasticsearch:8.16.1 // <1>
6725
nodeSets:
6826
- name: default
6927
count: 1
7028
# podTemplate:
7129
# spec:
72-
# imagePullSecrets: <2>
30+
# imagePullSecrets: // <2>
7331
# - name: private-registry-credentials-secret
7432
```
7533

@@ -113,49 +71,4 @@ For example, if your private registry is `my.registry` and all Elastic images ar
11371

11472
The [eck-diagnostics tool](../../../troubleshoot/deployments/cloud-on-k8s/run-eck-diagnostics.md) optionally runs diagnostics for Elastic Stack applications in a separate container that is deployed into the Kubernetes cluster.
11573

116-
In air-gapped environments with no access to the `docker.elastic.co` registry, you should copy the latest support-diagnostics container image to your internal image registry and then run the tool with the additional flag `--diagnostic-image <custom-support-diagnostics-image-name>`. To find out which support diagnostics container image matches your version of eck-diagnostics run the tool once without arguments and it will print the default image in use.
117-
118-
119-
% FROM THE OTHER CONTENT (ELASTIC-STACK):
120-
121-
### 2. Kubernetes & OpenShift Install [air-gapped-kubernetes-and-openshift]
122-
123-
Setting up air-gapped Kubernetes or OpenShift installs of the {{stack}} has some unique concerns, but the general dependencies are the same as in the self-managed install case on a regular Linux machine.
124-
125-
126-
#### 2.1. Elastic Kubernetes Operator (ECK) [air-gapped-k8s-os-elastic-kubernetes-operator]
127-
128-
The Elastic Kubernetes operator is an additional component in the Kubernetes OpenShift install that, essentially, does a lot of the work in installing, configuring, and updating deployments of the {{stack}}. For details, refer to the [{{eck}} install instructions](../../../deploy-manage/deploy/cloud-on-k8s/air-gapped-install.md).
129-
130-
The main requirements are:
131-
132-
* Syncing container images for ECK and all other {{stack}} components over to a locally-accessible container repository.
133-
* Modifying the ECK helm chart configuration so that ECK is aware that it is supposed to use your offline container repository instead of the public Elastic repository.
134-
* Optionally, disabling ECK telemetry collection in the ECK helm chart. This configuration propagates to all other Elastic components, such as {{kib}}.
135-
* Building your custom deployment container image for the {{artifact-registry}}.
136-
* Building your custom deployment container image for the Elastic Endpoint Artifact Repository.
137-
138-
139-
#### 2.2. Elastic Package Registry [air-gapped-k8s-os-elastic-package-registry]
140-
141-
The container image can be downloaded from the official Elastic Docker repository, as described in the {{fleet}} and {{elastic-agent}} [air-gapped environments](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/air-gapped.md) documentation.
142-
143-
This container would, ideally, run as a Kubernetes deployment. Refer to [Appendix C - EPR Kubernetes Deployment](../../../deploy-manage/deploy/self-managed/air-gapped-install.md#air-gapped-epr-kubernetes-example) for examples.
144-
145-
146-
#### 2.3. {{artifact-registry}} [air-gapped-k8s-os-elastic-artifact-registry]
147-
148-
A custom container would need to be created following similar instructions to setting up a web server in the [self-managed install case](../../../deploy-manage/deploy/self-managed/air-gapped-install.md#air-gapped-elastic-artifact-registry). For example, a container file using an NGINX base image could be used to run a build similar to the example described in [Appendix B - {{artifact-registry}}](../../../deploy-manage/deploy/self-managed/air-gapped-install.md#air-gapped-elastic-artifact-registry-example).
149-
150-
151-
#### 2.4. Elastic Endpoint Artifact Repository [air-gapped-k8s-os-elastic-endpoint-artifact-repository]
152-
153-
Just like the {{artifact-registry}}. A custom container needs to be created following similar instructions to setting up a web server for the [self-managed install case](../../../deploy-manage/deploy/self-managed/air-gapped-install.md#air-gapped-elastic-artifact-registry).
154-
155-
156-
#### 2.5. Ironbank Secure Images for Elastic [air-gapped-k8s-os-ironbank-secure-images]
157-
158-
Besides the public [Elastic container repository](https://www.docker.elastic.co), most {{stack}} container images are also available in Platform One’s [Iron Bank](https://ironbank.dso.mil/repomap?vendorFilters=Elastic&page=1&sort=1).
159-
160-
161-
74+
In air-gapped environments with no access to the `docker.elastic.co` registry, you should copy the latest support-diagnostics container image to your internal image registry and then run the tool with the additional flag `--diagnostic-image <custom-support-diagnostics-image-name>`. To find out which support diagnostics container image matches your version of eck-diagnostics, run the tool once without arguments and it will print the default image in use.

docset.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ project: 'Elastic documentation'
22

33
features:
44
primary-nav: true
5+
landing-page: true
56

67
exclude:
78
- 'README.md'

manage-data/lifecycle/data-tiers.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,12 +111,28 @@ To add a data tier to an existing deployment:
111111

112112
#### Disable a data tier [disable-a-data-tier]
113113

114+
:::{important}
115+
Disabling a data tier, attempting to scale nodes down in size, reducing availability zones, or reverting an [autoscaling](/deploy-manage/autoscaling.md) change can all result in cluster instability, cluster inaccessibility, and even data corruption or loss in extreme cases.
116+
117+
To avoid this, especially for [production environments](/deploy-manage/production-guidance.md), and in addition to making configuration changes to your indices and ILM as described on this page:
118+
* Review the disk size, CPU, JVM memory pressure, and other [performance metrics](/deploy-manage/monitor/monitoring-data/access-performance-metrics-on-elastic-cloud.md) of your deployment **before** attempting to perform the scaling down action.
119+
* Make sure that you have enough resources and [availability zones](/deploy-manage/production-guidance/availability-and-resilience.md) to handle your workloads after scaling down.
120+
* Check that your [deployment hardware profile](/deploy-manage/deploy/elastic-cloud/ec-change-hardware-profile.md) (for {{ech}}) or [deployment template](/deploy-manage/deploy/cloud-enterprise/configure-deployment-templates.md) (for {{ece}}) is correct for your business use case. For example, if you need to scale due to CPU pressure increases and are using a *Storage Optimized* hardware profile, consider switching to a *CPU Optimized* configuration instead.
121+
122+
Read [https://www.elastic.co/cloud/shared-responsibility](https://www.elastic.co/cloud/shared-responsibility) for additional details.
123+
If in doubt, reach out to Support.
124+
:::
125+
114126
The process of disabling a data tier depends on whether we are dealing with [searchable snapshots](#ece-disable-searchable-snapshot-data-tier) or [regular indices](#ece-disable-non-searchable-snapshot-data-tier).
115127

116128
The hot and warm tiers store regular indices, while the frozen tier stores searchable snapshots. However, the cold tier can store either regular indices or searchable snapshots. To check if a cold tier contains searchable snapshots perform the following request:
117129

118130
```sh
131+
# cold data tier searchable snapshot indices
119132
GET /_cat/indices/restored-*
133+
134+
# frozen data tier searchable snapshot indices
135+
GET /_cat/indices/partial-*
120136
```
121137

122138
##### Non-searchable snapshot data tier [ece-disable-non-searchable-snapshot-data-tier]

raw-migrated-files/docs-content/serverless/security-automated-response-actions.md

Lines changed: 0 additions & 39 deletions
This file was deleted.

raw-migrated-files/docs-content/serverless/security-dashboards-overview.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

raw-migrated-files/docs-content/serverless/security-data-quality-dash.md

Lines changed: 0 additions & 113 deletions
This file was deleted.

0 commit comments

Comments
 (0)