Skip to content

Commit ba6b2d3

Browse files
authored
Merge branch 'main' into ben-migration-cleanup-cloudsec
2 parents 35bea7e + e8c3387 commit ba6b2d3

File tree

218 files changed

+2916
-6654
lines changed

Some content is hidden

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

218 files changed

+2916
-6654
lines changed
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
Field and document security is subject to the following limitations:
2+
3+
### Document level security limitations
4+
5+
When a user’s role enables [document level security](/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level.md) for a data stream or index:
6+
7+
* Document level security doesn’t affect global index statistics that relevancy scoring uses. This means that scores are computed without taking the role query into account. Documents that don’t match the role query are never returned.
8+
* The `has_child` and `has_parent` queries aren’t supported as query parameters in the role definition. The `has_child` and `has_parent` queries can be used in the search API with document level security enabled.
9+
* [Date math](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/rest-apis/common-options.md#date-math) expressions cannot contain `now` in [range queries with date fields](asciidocalypse://docs/elasticsearch/docs/reference/query-languages/query-dsl-range-query.md#ranges-on-dates).
10+
* Any query that makes remote calls to fetch query data isn’t supported, including the following queries:
11+
12+
* `terms` query with terms lookup
13+
* `geo_shape` query with indexed shapes
14+
* `percolate` query
15+
16+
* If suggesters are specified and document level security is enabled, the specified suggesters are ignored.
17+
* A search request cannot be profiled if document level security is enabled.
18+
* The [terms enum API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-terms-enum) does not return terms if document level security is enabled.
19+
* The [`multi_match`](asciidocalypse://docs/elasticsearch/docs/reference/query-languages/query-dsl-multi-match-query.md) query does not support specifying fields using wildcards.
20+
21+
:::{note}
22+
While document-level security prevents users from viewing restricted documents, it’s still possible to write search requests that return aggregate information about the entire index. A user whose access is restricted to specific documents in an index could still learn about field names and terms that only exist in inaccessible documents, and count how many inaccessible documents contain a given term.
23+
:::
24+
25+
### Field level security limitations
26+
27+
When a user’s role enables document or [field level security](/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level.md) for a data stream or index:
28+
29+
* The user cannot perform write operations:
30+
31+
* The update API isn’t supported.
32+
* Update requests included in bulk requests aren’t supported.
33+
34+
* The user cannot perform operations that effectively make contents accessible under another name, including actions from the following APIs:
35+
36+
* [Clone index API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clone)
37+
* [Shrink index API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shrink)
38+
* [Split index API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-split)
39+
* [Aliases API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-update-aliases)
40+
41+
* The request cache is disabled for search requests if either of the following are true:
42+
43+
* The role query that defines document level security is [templated](/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level.md#templating-role-query) using a [stored script](/explore-analyze/scripting/modules-scripting-using.md#script-stored-scripts).
44+
* The target indices are a mix of local and remote indices.

deploy-manage/api-keys/serverless-project-api-keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ For example, the following `role_descriptors` object defines a `books-read-only`
7070
}
7171
```
7272

73-
For the `role_descriptors` object schema, check out the [`/_security/api_key` endpoint](https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-security-create-api-key) docs. For supported privileges, check [Security privileges](../users-roles/cluster-or-deployment-auth/elasticsearch-privileges.md#privileges-list-indices).
73+
For the `role_descriptors` object schema, check out the [`/_security/api_key` endpoint](https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-security-create-api-key) docs. For supported privileges, check [Security privileges](/deploy-manage/users-roles/cluster-or-deployment-auth/elasticsearch-privileges.md#privileges-list-indices).
7474

7575

7676
## Update an API key [api-keys-update-an-api-key]

deploy-manage/deploy/cloud-enterprise/configure-host-rhel-cloud.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,16 +72,24 @@ Verify that required traffic is allowed. Check the [Networking prerequisites](ec
7272

7373
4. Install podman:
7474

75-
* For RHEL 8 and Rocky Linux, install version `4.*`.
75+
* Install the latest available version `4.*` using dnf.
7676

7777
```sh
7878
sudo dnf install podman-4.* podman-remote-4.*
7979
```
8080

81-
* For RHEL 9, install the latest available version `4.*` using dnf.
81+
* To prevent automatic Podman major version updates, configure the Podman version to be locked while still allowing minor and patch updates.
8282

8383
```sh
84-
sudo dnf install podman-4.* podman-remote-4.*
84+
## Install versionlock
85+
sudo dnf install 'dnf-command(versionlock)'
86+
87+
## Lock major version
88+
sudo dnf versionlock add --raw 'podman-4.*'
89+
sudo dnf versionlock add --raw 'podman-remote-4.*'
90+
91+
## Verify that podman-4.* and podman-remote-4.* appear in the output
92+
sudo dnf versionlock list
8593
```
8694

8795
5. [This step is for RHEL 9 and Rocky Linux 9 only] Switch the network stack from Netavark to CNI:

deploy-manage/deploy/cloud-enterprise/configure-host-rhel-onprem.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,16 +70,24 @@ Verify that required traffic is allowed.
7070

7171
4. Install podman:
7272

73-
* For RHEL 8 and Rocky Linux, install version `4.*`.
73+
* Install the latest available version `4.*` using dnf.
7474

7575
```sh
7676
sudo dnf install podman-4.* podman-remote-4.*
7777
```
7878

79-
* For RHEL 9, install the latest available version `4.*` using dnf.
79+
* To prevent automatic Podman major version updates, configure the Podman version to be locked while still allowing minor and patch updates.
8080

8181
```sh
82-
sudo dnf install podman-4.* podman-remote-4.*
82+
## Install versionlock
83+
sudo dnf install 'dnf-command(versionlock)'
84+
85+
## Lock major version
86+
sudo dnf versionlock add --raw 'podman-4.*'
87+
sudo dnf versionlock add --raw 'podman-remote-4.*'
88+
89+
## Verify that podman-4.* and podman-remote-4.* appear in the output
90+
sudo dnf versionlock list
8391
```
8492

8593
5. [This step is for RHEL 9 and Rocky Linux 9 only] Switch the network stack from Netavark to CNI:

deploy-manage/deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,16 +111,24 @@ Otherwise, when the file content changes, the corresponding user is mentioned as
111111

112112
4. Install podman:
113113

114-
* For RHEL 8 and Rocky Linux, install version `4.*`.
114+
* Install the latest available version `4.*` using dnf.
115115

116116
```sh
117117
sudo dnf install podman-4.* podman-remote-4.*
118118
```
119119

120-
* For RHEL 9, install the latest available version `4.*` using dnf.
120+
* To prevent automatic Podman major version updates, configure the Podman version to be locked while still allowing minor and patch updates.
121121

122122
```sh
123-
sudo dnf install podman-4.* podman-remote-4.*
123+
## Install versionlock
124+
sudo dnf install 'dnf-command(versionlock)'
125+
126+
## Lock major version
127+
sudo dnf versionlock add --raw 'podman-4.*'
128+
sudo dnf versionlock add --raw 'podman-remote-4.*'
129+
130+
## Verify that podman-4.* and podman-remote-4.* appear in the output
131+
sudo dnf versionlock list
124132
```
125133

126134
5. [This step is for RHEL 9 and Rocky Linux 9 only] Switch the network stack from Netavark to CNI:

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,14 @@ This section outlines the supported Kubernetes and Elastic Stack versions for EC
6868
ECK is compatible with the following Kubernetes distributions and related technologies:
6969

7070
* Kubernetes 1.28-1.32
71-
* OpenShift 4.12-4.17
71+
* OpenShift 4.13-4.18
7272
* Google Kubernetes Engine (GKE), Azure Kubernetes Service (AKS), and Amazon Elastic Kubernetes Service (EKS)
7373
* Helm: 3.2.0+
7474

7575
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.
7676

77+
Alpha, beta, and stable API versions follow the same [conventions used by Kubernetes](https://kubernetes.io/docs/concepts/overview/kubernetes-api/#api-versioning).
78+
7779
### Elastic Stack compatibility
7880

7981
ECK is compatible with the following Elastic Stack applications:
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.

deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2+
mapped_urls:
3+
- https://www.elastic.co/guide/en/cloud-heroku/current/ech-adding-plugins.html
4+
- https://www.elastic.co/guide/en/cloud-heroku/current/ech-adding-elastic-plugins.html
5+
- https://www.elastic.co/guide/en/cloud/current/ec-adding-plugins.html
26
applies_to:
37
deployment:
48
ess: ga
5-
mapped_pages:
6-
- https://www.elastic.co/guide/en/cloud/current/ec-adding-plugins.html
7-
- https://www.elastic.co/guide/en/cloud-heroku/current/ech-adding-elastic-plugins.html
89
---
910

1011
# Add plugins and extensions [ec-adding-plugins]

deploy-manage/monitor/autoops/ec-autoops-faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ $$$faq-autoops-monitoring$$$Does AutoOps monitor the entire Elastic Stack?
2020
: AutoOps is currently limited to {{es}} (not {{kib}}, Logstash and Beats).
2121

2222
$$$faq-autoops-supported-versions$$$What versions of Elasticsearch are supported for Elastic Cloud Hosted?
23-
: AutoOps is currently available for {{es}} versions 7.17 and above.
23+
: AutoOps supports {es} versions according to the [supported Elastic Stack versions](https://www.elastic.co/support/eol).
2424

2525
$$$faq-autoops-license$$$How is AutoOps currently licensed?
2626
: AutoOps current feature set is available to Elastic Cloud Hosted customers at all subscription tiers. For more information please refer to the [subscription page](https://www.elastic.co/subscriptions/cloud).

deploy-manage/monitor/stack-monitoring/elastic-cloud-stack-monitoring.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,13 @@ $$$ech-logging-and-monitoring-production$$$
6060

6161
$$$ech-logging-and-monitoring-retention$$$
6262

63+
% Please leave the AutoOps banner in the final content of this page
64+
65+
:::{important}
66+
If you’re using Elastic Cloud Hosted, then you can use AutoOps to monitor your cluster. AutoOps significantly simplifies cluster management with performance recommendations, resource utilization visibility, real-time issue detection and resolution paths. For more information, refer to [Monitor with AutoOps](/deploy-manage/monitor/autoops.md).
67+
:::
68+
69+
6370
**This page is a work in progress.** The documentation team is working to combine content pulled from the following pages:
6471

6572
* [/raw-migrated-files/cloud/cloud-heroku/ech-monitoring.md](/raw-migrated-files/cloud/cloud-heroku/ech-monitoring.md)

0 commit comments

Comments
 (0)