Skip to content
Open
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
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= First steps
:description: First steps with OpenSearch, covering a first cluster with users and roles, the REST API and OpenSearch Dashboards for indexing and searching data.

Once you have followed the steps in xref:getting_started/installation.adoc[] for the operator and its dependencies, you will now go through the steps to set up and connect to an OpenSearch instance.

Expand Down
1 change: 1 addition & 0 deletions docs/modules/opensearch/pages/getting_started/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Getting started
:description: Getting started with OpenSearch on Kubernetes, covering the Stackable operator and its dependencies, a first cluster and ingesting and searching data.

This guide helps you get started with OpenSearch using the Stackable Operator.
It covers the installation of the operator and its dependencies, setting up your first OpenSearch instance, connecting to it, and ingesting and searching for data.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Installation
:description: Installation of the Stackable operator for OpenSearch and the commons, secret and listener operators it depends on, with stackablectl or Helm.

On this page you will install the Stackable OpenSearch Operator as well as the commons, secret and listener operators which are required by all Stackable Operators.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Command Line Parameters
:description: Command-line parameters the Stackable operator for OpenSearch accepts, with their default values and usage examples.

This operator accepts the following command line parameters:

Expand Down
1 change: 1 addition & 0 deletions docs/modules/opensearch/pages/reference/crds.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
= CRD Reference
:description: CRD reference for the Stackable operator for OpenSearch on the Stackable Hub, covering every field, default and API version.

Find all CRD references for the Stackable Operator for OpenSearch at: {crd-ref}{crd-ref-release}&operator=opensearch-operator
1 change: 1 addition & 0 deletions docs/modules/opensearch/pages/reference/discovery.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
:exampleOpensearchPort: 31315

= Discovery
:description: Reference for the discovery ConfigMap the Stackable operator for OpenSearch publishes, with the connection parameters for reaching the cluster.
:page-aliases: discovery.adoc

The Stackable Operator for OpenSearch publishes a xref:concepts:service_discovery.adoc[service discovery ConfigMap] which exposes a client configuration bundle that allows access to the OpenSearch cluster.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Environment variables
:description: Environment variables the Stackable operator for OpenSearch accepts, with their default values and what each one controls.

This operator accepts the following environment variables:

Expand Down
1 change: 1 addition & 0 deletions docs/modules/opensearch/pages/reference/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Reference
:description: Reference for the Stackable operator for OpenSearch, covering CRD fields, discovery ConfigMap properties, command-line parameters and environment variables.

Consult the reference documentation section to find exhaustive information on:

Expand Down
1 change: 1 addition & 0 deletions docs/modules/opensearch/pages/troubleshooting/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Troubleshooting
:description: Troubleshooting OpenSearch on Kubernetes, covering the SSLHandshakeException warnings about AEAD cipher fragments that appear with TLS connections.

== Errors and warnings in the OpenSearch logs

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Configuration & Environment Overrides
:description: Overrides for OpenSearch, covering configuration properties, environment variables, CLI parameters and Pod specs per role or role group.

The cluster definition also supports overriding configuration properties, environment variables and CLI parameters,
either per role or per role group, where the more specific override (role group) has precedence over
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Cluster Operation
:description: Cluster operations for OpenSearch, covering how to pause reconciliation of a cluster or stop it entirely through its custom resource.

OpenSearch installations can be configured with different cluster operations like pausing reconciliation or stopping the cluster.
See xref:concepts:operations/cluster_operations.adoc[cluster operations] for more details.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Graceful shutdown
:description: Graceful shutdown of OpenSearch nodes, covering the configurable shutdown timeout and how the node process stops.

You can configure the graceful shutdown as described in xref:concepts:operations/graceful_shutdown.adoc[].

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Operations
:description: Operating OpenSearch with the Stackable operator, covering graceful shutdown, Pod disruptions, Pod placement and cluster operations.

This section of the documentation is intended for the operations teams that maintain a Stackable Data Platform installation.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Allowed Pod disruptions
:description: The PodDisruptionBudget the Stackable operator writes for OpenSearch nodes, and how to disable it.

You can configure the permitted Pod disruptions for OpenSearch nodes as described in xref:concepts:operations/pod_disruptions.adoc[].

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Pod Placement
:description: Pod placement for OpenSearch on Kubernetes, covering the default affinity that spreads the nodes of a cluster across Kubernetes nodes.

You can configure the Pod placement of the OpenSearch pods as described in xref:concepts:operations/pod_placement.adoc[].

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ On role groups with only the `cluster_manager` node role, you probably want to d

== Resource Requests

include::home:concepts:stackable_resource_requests.adoc[]
include::concepts:partial$stackable_resource_requests.adoc[]

A minimal HA setup consisting of 3 nodes has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements{external-link-icon}^]:

Expand Down
Loading