Alauda Data Services Search Engine E1
  • English

    • Introduction

    Alauda Data Services Search Engine E1 is a distribution of the OpenSearch® Kubernetes operator, built from source by Alauda. It deploys, configures and operates OpenSearch clusters and OpenSearch Dashboards on Alauda Container Platform (ACP).

    TOC

    What is includedSupported platformHow E1 differs from the upstream operatorUpgrading from operator 2.8.0LimitationsSource code and licenseTrademark

    What is included

    ComponentVersion
    OpenSearch operator3.0 (based on upstream operator v3.0.0)
    Custom resource API groupopensearch.org/v1
    OpenSearch engine3.8.0 (default), 2.19.6
    OpenSearch Dashboards3.8.0, 2.19.6 (use the same version as the engine)

    The operator manages the following custom resources in the opensearch.org/v1 API group:

    • OpenSearchCluster: an OpenSearch cluster made of one or more node pools, plus optional OpenSearch Dashboards
    • OpensearchUser, OpensearchRole, OpensearchUserRoleBinding, OpensearchTenant, OpensearchActionGroup: security plugin users, roles, role bindings, tenants and action groups
    • OpenSearchISMPolicy, OpensearchSnapshotPolicy: index state management and snapshot policies
    • OpensearchIndexTemplate, OpensearchComponentTemplate: index and component templates

    Supported platform

    • ACP 4.1, 4.2, 4.3 and 4.4
    • CPU architecture: amd64 and arm64
    • Network: IPv4, IPv6 and dual-stack clusters

    How E1 differs from the upstream operator

    E1 keeps the upstream operator's API and behaviour, with these defaults changed for ACP:

    • Restricted Pod Security by default. OpenSearch, bootstrap, security-update and Dashboards pods get a security context that is compatible with the Kubernetes restricted Pod Security level, unless your custom resource sets those fields itself. See Installation.
    • vm.max_map_count is a node prerequisite. The operator does not run the privileged init container that upstream uses to set vm.max_map_count. Each node that runs OpenSearch must already have vm.max_map_count set to 262144 or more.
    • Writable data volumes without a root init container. The operator sets a default pod fsGroup of 1000, so volumes that are mounted owned by root (for example Ceph RBD) are writable by OpenSearch.
    • A cluster without TLS runs with the security plugin disabled. If an OpenSearchCluster has no TLS configuration, its nodes serve plain HTTP with the security plugin disabled, instead of starting with the image's demo security configuration. See Create a cluster.
    • The bootstrap PVC inherits a storage class. If spec.bootstrap.storageClass is not set, the bootstrap pod's PVC uses the storage class of the cluster-manager node pool. See Storage.

    Upgrading from operator 2.8.0

    Operator 2.8.0 used the opensearch.opster.io/v1 API group. E1 3.0 uses opensearch.org/v1 and migrates existing resources automatically. See Upgrade.

    Limitations

    The operator supports only the AllNamespaces install mode, needs vm.max_map_count set on the nodes, and does not ship the Security Analytics and Skills plugins. See Known Limitations for the complete list.

    Source code and license

    E1 is based on the OpenSearch Kubernetes Operator, licensed under the Apache License 2.0. The source code of Alauda's fork is available from Alauda.

    Trademark

    OpenSearch® is a registered trademark of LF Projects, LLC. Alauda Data Services Search Engine E1 is not affiliated with or endorsed by the OpenSearch project.