Charmed OpenSearch
- By Canonical Data Platform
- Databases
| Channel | Revision | Published | Runs on |
|---|---|---|---|
| 2/edge | 90 | 08 May 2024 |
juju deploy opensearch --channel 2/edge
Deploy universal operators easily with Juju, the Universal Operator Lifecycle Manager.
Platform:
charms.opensearch.v0.opensearch_distro
-
- Last updated 21 Oct 2022
- Revision Library version 0.1
Base class for Opensearch distributions.
Index
class OpenSearchError
Description
Base exception class for OpenSearch errors. None
class OpenSearchMissingError
Description
Exception thrown when an action is attempted on OpenSearch when it's not installed. None
class OpenSearchInstallError
Description
Exception thrown when OpenSearch fails to be installed. None
class OpenSearchMissingSysReqError
Description
Exception thrown when OpenSearch fails to be installed. None
Methods
OpenSearchMissingSysReqError. __init__( self , missing_requirements )
class OpenSearchStartError
Description
Exception thrown when OpenSearch fails to start. None
class OpenSearchStopError
Description
Exception thrown when OpenSearch fails to stop. None
class OpenSearchRestartError
Description
Exception thrown when OpenSearch fails to restart. None
class OpenSearchNotStartedError
Description
Exception thrown when attempting an operation when the OpenSearch service is stopped. None
class OpenSearchCmdError
Description
Exception thrown when an OpenSearch bin command fails. None
class OpenSearchHttpError
Description
Exception thrown when an OpenSearch REST call fails. None
class Paths
Description
This class represents the group of Paths that need to be exposed. None
Methods
Paths. __init__( self , home: str , conf: str , data: str , logs: str , jdk: str , tmp: str )
Constructor of Paths.
Arguments
Home path of Opensearch, equivalent to the env variable ${OPENSEARCH_HOME}
Path to the config folder of opensearch
Path to the data folder of opensearch
Path to the logs folder of opensearch
Path of the jdk that comes bundled with the opensearch distro
JNA temporary directory
class OpenSearchDistribution
Description
This class represents an interface for a Distributed Opensearch (snap, tarball, oci img). None
Methods
OpenSearchDistribution. __init__( self , charm , peer_relation_name )
OpenSearchDistribution. install( self )
Description
Install the package. None
OpenSearchDistribution. start( self )
Description
Start the opensearch service. None
OpenSearchDistribution. restart( self )
Description
Restart the opensearch service. None
OpenSearchDistribution. stop( self )
Description
Stop the opensearch service. None
OpenSearchDistribution. is_started( self )
Description
Check if OpenSearch is started. None
OpenSearchDistribution. is_node_up( self )
Description
Get status of current node. This assumes OpenSearch is Running. None
OpenSearchDistribution. run_bin( self , bin_script_name: str , args: str )
Description
Run opensearch provided bin command, relative to OPENSEARCH_HOME/bin. None
OpenSearchDistribution. run_script( self , script_name: str , args: str )
Description
Run script provided by Opensearch in another directory, relative to OPENSEARCH_HOME. None
OpenSearchDistribution. request( self , method: str , endpoint: str , payload , host )
Make an HTTP request.
Arguments
matching the known http methods.
relative to the base uri.
JSON / map body payload.
host of the node we wish to make a request on, by default current host.
OpenSearchDistribution. write_file( path: str , data: str , override: bool )
Description
Persists data into file. Useful for files generated on the fly, such as certs etc. None
OpenSearchDistribution. host( self )
Description
Host IP address of the current node. None
OpenSearchDistribution. network_hosts( self )
Description
All HTTP/Transport hosts for the current node. None
OpenSearchDistribution. port( self )
Description
Return Port of OpenSearch. None
OpenSearchDistribution. missing_sys_requirements( )
Description
Checks the system requirements. None