opensearchhandler

package module
v2.0.10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 11, 2024 License: MIT Imports: 14 Imported by: 0

README

es-handler

Elasticsearch handler used by Terraform, Crossplane and k8s operator

How to use it

Get client / handler

You can look sample

Manage snapshot repository

You can look sample

Manage component template

You can look sample

Manage index template

You can look sample

Manage ingest pipline

You can look sample

Manage role

You can look sample

Manage role mapping

You can look sample

Manage user

You can look sample

Manage action group

You can look sample

Manage tenant

You can look sample

Manage security config

You can look sample

Manage audit config

You can look sample

Manage index state management

You can look sample

Manage snapshot management

You can look sample

Manage monitor policy

You can look sample

Get cluster health

You can look sample

Manage cluster settings

You can look sample

Contribute

PR are always welcome here!

Please use the branch release-branch.v2* to gettig start.

Implement the code and test that prove is work as expected.

Run test:

go test -v ./...

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func StandardDiff 

func StandardDiff(actual, expected any, log *logrus.Entry, ignore map[string]any) (diff string, err error)

StandardDiff permit to compare objects

Types

type OpensearchHandler 

type OpensearchHandler interface {
	Client() (client *opensearch.Client)

	// Snapshot repository scope
	SnapshotRepositoryUpdate(name string, repository *opensearch.SnapshotRepositoryMetaData) (err error)
	SnapshotRepositoryDelete(name string) (err error)
	SnapshotRepositoryGet(name string) (repository *opensearch.SnapshotRepositoryMetaData, err error)
	SnapshotRepositoryDiff(actualObject, expectedObject, originalObject *opensearch.SnapshotRepositoryMetaData) (patchResult *patch.PatchResult, err error)

	// Component template scope
	ComponentTemplateUpdate(name string, component *opensearch.IndicesGetComponentTemplate) (err error)
	ComponentTemplateDelete(name string) (err error)
	ComponentTemplateGet(name string) (component *opensearch.IndicesGetComponentTemplate, err error)
	ComponentTemplateDiff(actualObject, expectedObject, originalObject *opensearch.IndicesGetComponentTemplate) (patchResult *patch.PatchResult, err error)

	// Index template scope
	IndexTemplateUpdate(name string, template *opensearch.IndicesGetIndexTemplate) (err error)
	IndexTemplateDelete(name string) (err error)
	IndexTemplateGet(name string) (template *opensearch.IndicesGetIndexTemplate, err error)
	IndexTemplateDiff(actualObject, expectedObject, originalObject *opensearch.IndicesGetIndexTemplate) (patchResult *patch.PatchResult, err error)

	// Ingest pipline scope
	IngestPipelineUpdate(name string, pipeline *opensearch.IngestGetPipeline) (err error)
	IngestPipelineDelete(name string) (err error)
	IngestPipelineGet(name string) (pipeline *opensearch.IngestGetPipeline, err error)
	IngestPipelineDiff(actualObject, expectedObject, originalObject *opensearch.IngestGetPipeline) (patchResult *patch.PatchResult, err error)

	// Role scope
	RoleUpdate(name string, role *opensearch.SecurityPutRole) (err error)
	RoleDelete(name string) (err error)
	RoleGet(name string) (role *opensearch.SecurityRole, err error)
	RoleDiff(actualObject, expectedObject, originalObject *opensearch.SecurityPutRole) (patchResult *patch.PatchResult, err error)

	// Role mapping scope
	RoleMappingUpdate(name string, roleMapping *opensearch.SecurityPutRoleMapping) (err error)
	RoleMappingDelete(name string) (err error)
	RoleMappingGet(name string) (roleMapping *opensearch.SecurityRoleMapping, err error)
	RoleMappingDiff(actualObject, expectedObject, originalObject *opensearch.SecurityPutRoleMapping) (patchResult *patch.PatchResult, err error)

	// User scope
	UserUpdate(name string, user *opensearch.SecurityPutUser) (err error)
	UserDelete(name string) (err error)
	UserGet(name string) (user *opensearch.SecurityUser, err error)
	UserDiff(actualObject, expectedObject, originalObject *opensearch.SecurityPutUser) (patchResult *patch.PatchResult, err error)

	// Action groups scope
	ActionGroupUpdate(name string, actionGroup *opensearch.SecurityPutActionGroup) (err error)
	ActionGroupDelete(name string) (err error)
	ActionGroupGet(name string) (actionGroup *opensearch.SecurityActionGroup, err error)
	ActionGroupDiff(actualObject, expectedObject, originalObject *opensearch.SecurityPutActionGroup) (patchResult *patch.PatchResult, err error)

	// Tenanats scope
	TenantUpdate(name string, tenant *opensearch.SecurityPutTenant) (err error)
	TenantDelete(name string) (err error)
	TenantGet(name string) (tenant *opensearch.SecurityTenant, err error)
	TenantDiff(actualObject, expectedObject, originalObject *opensearch.SecurityPutTenant) (patchResult *patch.PatchResult, err error)

	// Security config scope
	SecurityConfigUpdate(config *opensearch.SecurityConfig) (err error)
	SecurityConfigGet() (config *opensearch.SecurityGetConfigResponse, err error)
	SecurityConfigDiff(actualObject, expectedObject, originalObject *opensearch.SecurityConfig) (patchResult *patch.PatchResult, err error)

	// Security audit scope
	SecurityAuditUpdate(config *opensearch.SecurityAudit) (err error)
	SecurityAuditGet() (config *opensearch.SecurityGetAuditResponse, err error)
	SecurityAuditDiff(actualObject, expectedObject, originalObject *opensearch.SecurityAudit) (patchResult *patch.PatchResult, err error)

	// Index State management scope
	IsmCreate(name string, policy *opensearch.IsmPutPolicy) (err error)
	IsmUpdate(name string, sequenceNumber int64, pimaryTerm int64, policy *opensearch.IsmPutPolicy) (err error)
	IsmDelete(name string) (err error)
	IsmGet(name string) (policy *opensearch.IsmGetPolicyResponse, err error)
	IsmDiff(actualObject, expectedObject, originalObject *opensearch.IsmPutPolicy) (patchResult *patch.PatchResult, err error)

	// Snapshot management scope
	SmCreate(name string, policy *opensearch.SmPutPolicy) (err error)
	SmUpdate(name string, sequenceNumber int64, pimaryTerm int64, policy *opensearch.SmPutPolicy) (err error)
	SmDelete(name string) (err error)
	SmGet(name string) (policy *opensearch.SmGetPolicyResponse, err error)
	SmDiff(actualObject, expectedObject, originalObject *opensearch.SmPutPolicy) (patchResult *patch.PatchResult, err error)

	// Monitor management scope
	MonitorCreate(monitor *opensearch.AlertingMonitor) (err error)
	MonitorUpdate(id string, sequenceNumber int64, pimaryTerm int64, monitor *opensearch.AlertingMonitor) (err error)
	MonitorDelete(id string) (err error)
	MonitorGet(name string) (monitor *opensearch.AlertingGetMonitorResponse, err error)
	MonitorDiff(actualObject, expectedObject, originalObject *opensearch.AlertingMonitor) (patchResult *patch.PatchResult, err error)

	// Cluster scope
	ClusterHealth() (health *opensearch.ClusterHealthResponse, err error)
	EnableRoutingRebalance() (err error)
	DisableRoutingRebalance() (err error)
	EnableRoutingAllocation() (err error)
	DisableRoutingAllocation() (err error)

	SetLogger(log *logrus.Entry)
}

func NewOpensearchHandler 

func NewOpensearchHandler(cfg *config.Config, log *logrus.Entry) (OpensearchHandler, error)

type OpensearchHandlerImpl 

type OpensearchHandlerImpl struct {
	// contains filtered or unexported fields
}

func (*OpensearchHandlerImpl) ActionGroupDelete added in v2.0.2 

func (h *OpensearchHandlerImpl) ActionGroupDelete(name string) (err error)

ActionGroupDelete permit to delete an action group

func (*OpensearchHandlerImpl) ActionGroupDiff added in v2.0.2 

func (h *OpensearchHandlerImpl) ActionGroupDiff(actualObject, expectedObject, originalObject *opensearch.SecurityPutActionGroup) (patchResult *patch.PatchResult, err error)

ActionGroupDiff permit to diff an action group (it use the 3-way diff)

func (*OpensearchHandlerImpl) ActionGroupGet added in v2.0.2 

func (h *OpensearchHandlerImpl) ActionGroupGet(name string) (actionGroup *opensearch.SecurityActionGroup, err error)

ActionGroupGet permit to get an action group

func (*OpensearchHandlerImpl) ActionGroupUpdate added in v2.0.2 

func (h *OpensearchHandlerImpl) ActionGroupUpdate(name string, actionGroup *opensearch.SecurityPutActionGroup) (err error)

ActionGroupUpdate permit to update an action group

func (*OpensearchHandlerImpl) Client 

func (h *OpensearchHandlerImpl) Client() *opensearch.Client

func (*OpensearchHandlerImpl) ClusterHealth 

func (h *OpensearchHandlerImpl) ClusterHealth() (health *opensearch.ClusterHealthResponse, err error)

ClusterHealth permit to get the cluster health

func (*OpensearchHandlerImpl) ComponentTemplateDelete 

func (h *OpensearchHandlerImpl) ComponentTemplateDelete(name string) (err error)

ComponentTemplateDelete permit to delete component template

func (*OpensearchHandlerImpl) ComponentTemplateDiff 

func (h *OpensearchHandlerImpl) ComponentTemplateDiff(actualObject, expectedObject, originalObject *opensearch.IndicesGetComponentTemplate) (patchResult *patch.PatchResult, err error)

ComponentTemplateDiff permit to check if 2 component template are the same

func (*OpensearchHandlerImpl) ComponentTemplateGet 

func (h *OpensearchHandlerImpl) ComponentTemplateGet(name string) (component *opensearch.IndicesGetComponentTemplate, err error)

ComponentTemplateGet permit to get component template

func (*OpensearchHandlerImpl) ComponentTemplateUpdate 

func (h *OpensearchHandlerImpl) ComponentTemplateUpdate(name string, component *opensearch.IndicesGetComponentTemplate) (err error)

ComponentTemplateUpdate permit to update component template

func (*OpensearchHandlerImpl) DisableRoutingAllocation added in v2.0.10 

func (h *OpensearchHandlerImpl) DisableRoutingAllocation() (err error)

DisableRoutingAllocation permit to disable cluster routing allocation It put `cluster.routing.allocation.enable` to primaries

func (*OpensearchHandlerImpl) DisableRoutingRebalance added in v2.0.10 

func (h *OpensearchHandlerImpl) DisableRoutingRebalance() (err error)

DisableRoutingRebalance permit to disable cluster routing rebalance It put `cluster.routing.rebalance.enable` to none

func (*OpensearchHandlerImpl) EnableRoutingAllocation added in v2.0.10 

func (h *OpensearchHandlerImpl) EnableRoutingAllocation() (err error)

EnableRoutingAllocation permit to enable cluster routing allocation It put `cluster.routing.allocation.enable` to all

func (*OpensearchHandlerImpl) EnableRoutingRebalance added in v2.0.10 

func (h *OpensearchHandlerImpl) EnableRoutingRebalance() (err error)

EnableRoutingRebalance permit to enable cluster routing rebalance It put `cluster.routing.rebalance.enable` to all

func (*OpensearchHandlerImpl) IndexTemplateDelete 

func (h *OpensearchHandlerImpl) IndexTemplateDelete(name string) (err error)

IndexTemplateDelete permit to delete index template

func (*OpensearchHandlerImpl) IndexTemplateDiff 

func (h *OpensearchHandlerImpl) IndexTemplateDiff(actualObject, expectedObject, originalObject *opensearch.IndicesGetIndexTemplate) (patchResult *patch.PatchResult, err error)

IndexTemplateDiff permit to check if 2 index template is the same

func (*OpensearchHandlerImpl) IndexTemplateGet 

func (h *OpensearchHandlerImpl) IndexTemplateGet(name string) (template *opensearch.IndicesGetIndexTemplate, err error)

IndexTemplateGet permit to get index template

func (*OpensearchHandlerImpl) IndexTemplateUpdate 

func (h *OpensearchHandlerImpl) IndexTemplateUpdate(name string, template *opensearch.IndicesGetIndexTemplate) (err error)

IndexTemplateUpdate permit to create or update index template

func (*OpensearchHandlerImpl) IngestPipelineDelete 

func (h *OpensearchHandlerImpl) IngestPipelineDelete(name string) (err error)

IngestPipelineDelete permit to delete ingest pipeline

func (*OpensearchHandlerImpl) IngestPipelineDiff 

func (h *OpensearchHandlerImpl) IngestPipelineDiff(actualObject, expectedObject, originalObject *opensearch.IngestGetPipeline) (patchResult *patch.PatchResult, err error)

IngestPipelineDiff permit to check if 2 ingest pipeline are the same

func (*OpensearchHandlerImpl) IngestPipelineGet 

func (h *OpensearchHandlerImpl) IngestPipelineGet(name string) (pipeline *opensearch.IngestGetPipeline, err error)

IngestPipelineGet permit to get ingest pipeline

func (*OpensearchHandlerImpl) IngestPipelineUpdate 

func (h *OpensearchHandlerImpl) IngestPipelineUpdate(name string, pipeline *opensearch.IngestGetPipeline) (err error)

IngestPipelineUpdate permit to create or update ingest pipeline

func (*OpensearchHandlerImpl) IsmCreate added in v2.0.2 

func (h *OpensearchHandlerImpl) IsmCreate(name string, policy *opensearch.IsmPutPolicy) (err error)

IsmCreate permit to crate new ISM policy

func (*OpensearchHandlerImpl) IsmDelete added in v2.0.2 

func (h *OpensearchHandlerImpl) IsmDelete(name string) (err error)

IsmDelete permit to delete ISM policy

func (*OpensearchHandlerImpl) IsmDiff added in v2.0.2 

func (h *OpensearchHandlerImpl) IsmDiff(actualObject, expectedObject, originalObject *opensearch.IsmPutPolicy) (patchResult *patch.PatchResult, err error)

IsmDiff permit to diff ISM policy

func (*OpensearchHandlerImpl) IsmGet added in v2.0.2 

func (h *OpensearchHandlerImpl) IsmGet(name string) (policy *opensearch.IsmGetPolicyResponse, err error)

IsmGet permit to get ISM policy

func (*OpensearchHandlerImpl) IsmUpdate added in v2.0.2 

func (h *OpensearchHandlerImpl) IsmUpdate(name string, sequenceNumber int64, pimaryTerm int64, policy *opensearch.IsmPutPolicy) (err error)

IsmUpdate permit to update ISM policy

func (*OpensearchHandlerImpl) MonitorCreate added in v2.0.2 

func (h *OpensearchHandlerImpl) MonitorCreate(monitor *opensearch.AlertingMonitor) (err error)

func (*OpensearchHandlerImpl) MonitorDelete added in v2.0.2 

func (h *OpensearchHandlerImpl) MonitorDelete(id string) (err error)

func (*OpensearchHandlerImpl) MonitorDiff added in v2.0.2 

func (h *OpensearchHandlerImpl) MonitorDiff(actualObject, expectedObject, originalObject *opensearch.AlertingMonitor) (patchResult *patch.PatchResult, err error)

func (*OpensearchHandlerImpl) MonitorGet added in v2.0.2 

func (h *OpensearchHandlerImpl) MonitorGet(name string) (monitor *opensearch.AlertingGetMonitorResponse, err error)

func (*OpensearchHandlerImpl) MonitorUpdate added in v2.0.2 

func (h *OpensearchHandlerImpl) MonitorUpdate(id string, sequenceNumber int64, pimaryTerm int64, monitor *opensearch.AlertingMonitor) (err error)

func (*OpensearchHandlerImpl) RoleDelete added in v2.0.2 

func (h *OpensearchHandlerImpl) RoleDelete(name string) (err error)

RoleDelete permit to delete role

func (*OpensearchHandlerImpl) RoleDiff added in v2.0.2 

func (h *OpensearchHandlerImpl) RoleDiff(actualObject, expectedObject, originalObject *opensearch.SecurityPutRole) (patchResult *patch.PatchResult, err error)

RoleDiff permit to check if 2 role are the same

func (*OpensearchHandlerImpl) RoleGet added in v2.0.2 

func (h *OpensearchHandlerImpl) RoleGet(name string) (role *opensearch.SecurityRole, err error)

RoleGet permit to get role

func (*OpensearchHandlerImpl) RoleMappingDelete added in v2.0.2 

func (h *OpensearchHandlerImpl) RoleMappingDelete(name string) (err error)

RoleMappingDelete permit to delete role mapping

func (*OpensearchHandlerImpl) RoleMappingDiff added in v2.0.2 

func (h *OpensearchHandlerImpl) RoleMappingDiff(actualObject, expectedObject, originalObject *opensearch.SecurityPutRoleMapping) (patchResult *patch.PatchResult, err error)

RoleMappingDiff permit to check if 2 role mapping are the same

func (*OpensearchHandlerImpl) RoleMappingGet added in v2.0.2 

func (h *OpensearchHandlerImpl) RoleMappingGet(name string) (roleMapping *opensearch.SecurityRoleMapping, err error)

RoleMappingGet permit to get role mapping

func (*OpensearchHandlerImpl) RoleMappingUpdate added in v2.0.2 

func (h *OpensearchHandlerImpl) RoleMappingUpdate(name string, roleMapping *opensearch.SecurityPutRoleMapping) (err error)

RoleMappingUpdate permit to create or update role mapping

func (*OpensearchHandlerImpl) RoleUpdate added in v2.0.2 

func (h *OpensearchHandlerImpl) RoleUpdate(name string, role *opensearch.SecurityPutRole) (err error)

RoleUpdate permit to update role

func (*OpensearchHandlerImpl) SecurityAuditDiff added in v2.0.2 

func (h *OpensearchHandlerImpl) SecurityAuditDiff(actualObject, expectedObject, originalObject *opensearch.SecurityAudit) (patchResult *patch.PatchResult, err error)

SecurityAuditDiff permit to diff a security audit (it use the 3-way diff)

func (*OpensearchHandlerImpl) SecurityAuditGet added in v2.0.2 

func (h *OpensearchHandlerImpl) SecurityAuditGet() (audit *opensearch.SecurityGetAuditResponse, err error)

SecurityAuditGet permit to get the security audit

func (*OpensearchHandlerImpl) SecurityAuditUpdate added in v2.0.2 

func (h *OpensearchHandlerImpl) SecurityAuditUpdate(audit *opensearch.SecurityAudit) (err error)

SecurityAuditUpdate permit to update the security audit

func (*OpensearchHandlerImpl) SecurityConfigDiff added in v2.0.2 

func (h *OpensearchHandlerImpl) SecurityConfigDiff(actualObject, expectedObject, originalObject *opensearch.SecurityConfig) (patchResult *patch.PatchResult, err error)

SecurityConfigDiff permit to diff a security config (it use the 3-way diff)

func (*OpensearchHandlerImpl) SecurityConfigGet added in v2.0.2 

func (h *OpensearchHandlerImpl) SecurityConfigGet() (config *opensearch.SecurityGetConfigResponse, err error)

SecurityConfigGet permit to get the security config

func (*OpensearchHandlerImpl) SecurityConfigUpdate added in v2.0.2 

func (h *OpensearchHandlerImpl) SecurityConfigUpdate(config *opensearch.SecurityConfig) (err error)

SecurityConfigUpdate permit to update the security config

func (*OpensearchHandlerImpl) SetLogger 

func (h *OpensearchHandlerImpl) SetLogger(log *logrus.Entry)

func (*OpensearchHandlerImpl) SmCreate added in v2.0.2 

func (h *OpensearchHandlerImpl) SmCreate(name string, policy *opensearch.SmPutPolicy) (err error)

func (*OpensearchHandlerImpl) SmDelete added in v2.0.2 

func (h *OpensearchHandlerImpl) SmDelete(name string) (err error)

func (*OpensearchHandlerImpl) SmDiff added in v2.0.2 

func (h *OpensearchHandlerImpl) SmDiff(actualObject, expectedObject, originalObject *opensearch.SmPutPolicy) (patchResult *patch.PatchResult, err error)

func (*OpensearchHandlerImpl) SmGet added in v2.0.2 

func (h *OpensearchHandlerImpl) SmGet(name string) (policy *opensearch.SmGetPolicyResponse, err error)

func (*OpensearchHandlerImpl) SmUpdate added in v2.0.2 

func (h *OpensearchHandlerImpl) SmUpdate(name string, sequenceNumber int64, pimaryTerm int64, policy *opensearch.SmPutPolicy) (err error)

func (*OpensearchHandlerImpl) SnapshotRepositoryDelete 

func (h *OpensearchHandlerImpl) SnapshotRepositoryDelete(name string) (err error)

SnapshotRepositoryDelete permit to delete snapshot repository

func (*OpensearchHandlerImpl) SnapshotRepositoryDiff 

func (h *OpensearchHandlerImpl) SnapshotRepositoryDiff(actualObject, expectedObject, originalObject *opensearch.SnapshotRepositoryMetaData) (patchResult *patch.PatchResult, err error)

SnapshotRepositoryDiff permit to check if 2 repositories are the same

func (*OpensearchHandlerImpl) SnapshotRepositoryGet 

func (h *OpensearchHandlerImpl) SnapshotRepositoryGet(name string) (repository *opensearch.SnapshotRepositoryMetaData, err error)

SnapshotRepositoryGet permit to get snapshot repository

func (*OpensearchHandlerImpl) SnapshotRepositoryUpdate 

func (h *OpensearchHandlerImpl) SnapshotRepositoryUpdate(name string, repository *opensearch.SnapshotRepositoryMetaData) (err error)

SnapshotRepositoryUpdate permit to create or update snapshot repository

func (*OpensearchHandlerImpl) TenantDelete added in v2.0.2 

func (h *OpensearchHandlerImpl) TenantDelete(name string) (err error)

TenantDelete permit to delete a tenant

func (*OpensearchHandlerImpl) TenantDiff added in v2.0.2 

func (h *OpensearchHandlerImpl) TenantDiff(actualObject, expectedObject, originalObject *opensearch.SecurityPutTenant) (patchResult *patch.PatchResult, err error)

TenantDiff permit to diff a tenant (it use a 3-way diff)

func (*OpensearchHandlerImpl) TenantGet added in v2.0.2 

func (h *OpensearchHandlerImpl) TenantGet(name string) (actionGroup *opensearch.SecurityTenant, err error)

TenantGet permit to get a tenant

func (*OpensearchHandlerImpl) TenantUpdate added in v2.0.2 

func (h *OpensearchHandlerImpl) TenantUpdate(name string, tenant *opensearch.SecurityPutTenant) (err error)

TenantUpdate permit to update a tenant

func (*OpensearchHandlerImpl) UserDelete added in v2.0.2 

func (h *OpensearchHandlerImpl) UserDelete(name string) (err error)

UserDelete permit to delete the user

func (*OpensearchHandlerImpl) UserDiff added in v2.0.2 

func (h *OpensearchHandlerImpl) UserDiff(actualObject, expectedObject, originalObject *opensearch.SecurityPutUser) (patchResult *patch.PatchResult, err error)

UserDiff permit to check if 2 users are the same

func (*OpensearchHandlerImpl) UserGet added in v2.0.2 

func (h *OpensearchHandlerImpl) UserGet(name string) (user *opensearch.SecurityUser, err error)

UserGet permit to get the user

func (*OpensearchHandlerImpl) UserUpdate added in v2.0.2 

func (h *OpensearchHandlerImpl) UserUpdate(name string, user *opensearch.SecurityPutUser) (err error)

UserCreate permit to create new user

Source Files

View all Source files

Directories

Path Synopsis
Code generated by MockGen.
 Code generated by MockGen.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.