diff --git a/docs/api-doc-gen/config.json b/docs/api-doc-gen/config.json new file mode 100644 index 00000000..f323323c --- /dev/null +++ b/docs/api-doc-gen/config.json @@ -0,0 +1,28 @@ +{ + "hideMemberFields": [ + "TypeMeta" + ], + "hideTypePatterns": [ + "ParseError$", + "List$" + ], + "externalPackages": [ + { + "typeMatchPrefix": "^k8s\\.io/apimachinery/pkg/apis/meta/v1\\.Duration$", + "docsURLTemplate": "https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration" + }, + { + "typeMatchPrefix": "^k8s\\.io/(api|apimachinery/pkg/apis)/", + "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}" + }, + { + "typeMatchPrefix": "^github\\.com/knative/pkg/apis/duck/", + "docsURLTemplate": "https://pkg.go.dev/github.com/knative/pkg/apis/duck/{{arrIndex .PackageSegments -1}}#{{.TypeIdentifier}}" + } + ], + "typeDisplayNamePrefixOverrides": { + "k8s.io/api/": "Kubernetes ", + "k8s.io/apimachinery/pkg/apis/": "Kubernetes " + }, + "markdownDisabled": false +} diff --git a/docs/api-doc-gen/template/member.tpl b/docs/api-doc-gen/template/member.tpl new file mode 100644 index 00000000..448ce2fb --- /dev/null +++ b/docs/api-doc-gen/template/member.tpl @@ -0,0 +1,48 @@ +{{ define "members" }} + +{{ range .Members }} +{{ if not (hiddenMember .)}} + + + {{ fieldName . }}
+ + {{ if linkForType .Type }} + + {{ typeDisplayName .Type }} + + {{ else }} + {{ typeDisplayName .Type }} + {{ end }} + + + + {{ if fieldEmbedded . }} +

+ (Members of {{ fieldName . }} are embedded into this type.) +

+ {{ end}} + + {{ if isOptionalMember .}} + (Optional) + {{ end }} + + {{ safe (renderComments .CommentLines) }} + + {{ if and (eq (.Type.Name.Name) "ObjectMeta") }} + Refer to the Kubernetes API documentation for the fields of the + metadata field. + {{ end }} + + {{ if or (eq (fieldName .) "spec") }} +
+
+ + {{ template "members" .Type }} +
+ {{ end }} + + +{{ end }} +{{ end }} + +{{ end }} \ No newline at end of file diff --git a/docs/api-doc-gen/template/pkg.tpl b/docs/api-doc-gen/template/pkg.tpl new file mode 100644 index 00000000..aacf6e03 --- /dev/null +++ b/docs/api-doc-gen/template/pkg.tpl @@ -0,0 +1,49 @@ +{{ define "packages" }} + +{{ with .packages}} +

Packages:

+ +{{ end}} + +{{ range .packages }} +

+ {{- packageDisplayName . -}} +

+ + {{ with (index .GoPackages 0 )}} + {{ with .DocComments }} +
+ {{ safe (renderComments .) }} +
+ {{ end }} + {{ end }} + + Resource Types: + + + {{ range (visibleTypes (sortedTypes .Types))}} + {{ template "type" . }} + {{ end }} +
+{{ end }} + +

+ Generated with gen-crd-api-reference-docs + {{ with .gitCommit }} on git commit {{ . }}{{end}}. +

+ +{{ end }} \ No newline at end of file diff --git a/docs/api-doc-gen/template/type.tpl b/docs/api-doc-gen/template/type.tpl new file mode 100644 index 00000000..d4aed373 --- /dev/null +++ b/docs/api-doc-gen/template/type.tpl @@ -0,0 +1,81 @@ +{{ define "type" }} + +

+ {{- .Name.Name }} + {{ if eq .Kind "Alias" }}({{.Underlying}} alias){{ end -}} +

+{{ with (typeReferences .) }} +

+ (Appears on: + {{- $prev := "" -}} + {{- range . -}} + {{- if $prev -}}, {{ end -}} + {{- $prev = . -}} + {{ typeDisplayName . }} + {{- end -}} + ) +

+{{ end }} + +
+ {{ safe (renderComments .CommentLines) }} +
+ +{{ with (constantsOfType .) }} + + + + + + + + + {{- range . -}} + + {{- /* + renderComments implicitly creates a

element, so we + add one to the display name as well to make the contents + of the two cells align evenly. + */ -}} +

+ + + {{- end -}} + +
ValueDescription

{{ typeDisplayName . }}

{{ safe (renderComments .CommentLines) }}
+{{ end }} + +{{ if .Members }} + + + + + + + + + {{ if isExportedType . }} + + + + + + + + + {{ end }} + {{ template "members" .}} + +
FieldDescription
+ apiVersion
+ string		 + + {{apiGroup .}} + +
+ kind
+ string + 		{{.Name.Name}}
+{{ end }} + +{{ end }} \ No newline at end of file diff --git a/docs/api-docs.md b/docs/api-docs.md index 5592bc5c..50675aae 100644 --- a/docs/api-docs.md +++ b/docs/api-docs.md @@ -1,1961 +1,6106 @@ -# API Reference - -## Packages -- [opensearch.opster.io/v1](#opensearchopsteriov1) - - -## opensearch.opster.io/v1 - -Package v1 contains API Schema definitions for the opster v1 API group - -### Resource Types -- [OpenSearchCluster](#opensearchcluster) -- [OpenSearchClusterList](#opensearchclusterlist) -- [OpenSearchISMPolicy](#opensearchismpolicy) -- [OpenSearchISMPolicyList](#opensearchismpolicylist) -- [OpensearchActionGroup](#opensearchactiongroup) -- [OpensearchActionGroupList](#opensearchactiongrouplist) -- [OpensearchComponentTemplate](#opensearchcomponenttemplate) -- [OpensearchComponentTemplateList](#opensearchcomponenttemplatelist) -- [OpensearchIndexTemplate](#opensearchindextemplate) -- [OpensearchIndexTemplateList](#opensearchindextemplatelist) -- [OpensearchRole](#opensearchrole) -- [OpensearchRoleList](#opensearchrolelist) -- [OpensearchTenant](#opensearchtenant) -- [OpensearchTenantList](#opensearchtenantlist) -- [OpensearchUser](#opensearchuser) -- [OpensearchUserList](#opensearchuserlist) -- [OpensearchUserRoleBinding](#opensearchuserrolebinding) -- [OpensearchUserRoleBindingList](#opensearchuserrolebindinglist) - - - -#### Action - - - -Actions are the steps that the policy sequentially executes on entering a specific state. - - - -_Appears in:_ -- [State](#state) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `alias` _[Alias](#alias)_ | | | | -| `allocation` _[Allocation](#allocation)_ | Allocate the index to a node with a specific attribute set | | | -| `close` _[Close](#close)_ | Closes the managed index. | | | -| `delete` _[Delete](#delete)_ | Deletes a managed index. | | | -| `forceMerge` _[ForceMerge](#forcemerge)_ | Reduces the number of Lucene segments by merging the segments of individual shards. | | | -| `indexPriority` _[IndexPriority](#indexpriority)_ | Set the priority for the index in a specific state. | | | -| `notification` _[Notification](#notification)_ | Name string `json:"name,omitempty"` | | | -| `open` _[Open](#open)_ | Opens a managed index. | | | -| `readOnly` _string_ | Sets a managed index to be read only. | | | -| `readWrite` _string_ | Sets a managed index to be writeable. | | | -| `replicaCount` _[ReplicaCount](#replicacount)_ | Sets the number of replicas to assign to an index. | | | -| `retry` _[Retry](#retry)_ | The retry configuration for the action. | | | -| `rollover` _[Rollover](#rollover)_ | Rolls an alias over to a new index when the managed index meets one of the rollover conditions. | | | -| `rollup` _[Rollup](#rollup)_ | Periodically reduce data granularity by rolling up old data into summarized indexes. | | | -| `shrink` _[Shrink](#shrink)_ | Allows you to reduce the number of primary shards in your indexes | | | -| `snapshot` _[Snapshot](#snapshot)_ | Back up your cluster’s indexes and state | | | -| `timeout` _string_ | The timeout period for the action. | | | - - -#### AdditionalVolume - - - - - - - -_Appears in:_ -- [DashboardsConfig](#dashboardsconfig) -- [GeneralConfig](#generalconfig) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `name` _string_ | Name to use for the volume. Required. | | | -| `path` _string_ | Path in the container to mount the volume at. Required. | | | -| `subPath` _string_ | SubPath of the referenced volume to mount. | | | -| `secret` _[SecretVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#secretvolumesource-v1-core)_ | Secret to use populate the volume | | | -| `configMap` _[ConfigMapVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#configmapvolumesource-v1-core)_ | ConfigMap to use to populate the volume | | | -| `emptyDir` _[EmptyDirVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#emptydirvolumesource-v1-core)_ | EmptyDir to use to populate the volume | | | -| `restartPods` _boolean_ | Whether to restart the pods on content change | | | - - -#### Alias - - - - - - - -_Appears in:_ -- [Action](#action) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `actions` _[AliasAction](#aliasaction) array_ | Allocate the index to a node with a specified attribute. | | | - - -#### AliasAction - - - - - - - -_Appears in:_ -- [Alias](#alias) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `add` _[AliasDetails](#aliasdetails)_ | | | | -| `remove` _[AliasDetails](#aliasdetails)_ | | | | - - - - -#### Allocation - - - - - - - -_Appears in:_ -- [Action](#action) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `exclude` _string_ | Allocate the index to a node with a specified attribute. | | | -| `include` _string_ | Allocate the index to a node with any of the specified attributes. | | | -| `require` _string_ | Don’t allocate the index to a node with any of the specified attributes. | | | -| `waitFor` _string_ | Wait for the policy to execute before allocating the index to a node with a specified attribute. | | | - - -#### BootstrapConfig - - - - - - - -_Appears in:_ -- [ClusterSpec](#clusterspec) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#resourcerequirements-v1-core)_ | | | | -| `tolerations` _[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#toleration-v1-core) array_ | | | | -| `nodeSelector` _object (keys:string, values:string)_ | | | | -| `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#affinity-v1-core)_ | | | | -| `jvm` _string_ | | | | -| `additionalConfig` _object (keys:string, values:string)_ | Extra items to add to the opensearch.yml, defaults to General.AdditionalConfig | | | - - -#### Close - - - - - - - -_Appears in:_ -- [Action](#action) - - - -#### ClusterSpec - - - -ClusterSpec defines the desired state of OpenSearchCluster - - - -_Appears in:_ -- [OpenSearchCluster](#opensearchcluster) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `general` _[GeneralConfig](#generalconfig)_ | INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
Important: Run "make" to regenerate code after modifying this file | | | -| `confMgmt` _[ConfMgmt](#confmgmt)_ | | | | -| `bootstrap` _[BootstrapConfig](#bootstrapconfig)_ | | | | -| `dashboards` _[DashboardsConfig](#dashboardsconfig)_ | | | | -| `security` _[Security](#security)_ | | | | -| `nodePools` _[NodePool](#nodepool) array_ | | | | -| `initHelper` _[InitHelperConfig](#inithelperconfig)_ | | | | - - -#### ClusterStatus - - - -ClusterStatus defines the observed state of Es - - - -_Appears in:_ -- [OpenSearchCluster](#opensearchcluster) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `phase` _string_ | INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
Important: Run "make" to regenerate code after modifying this file | | | -| `componentsStatus` _[ComponentStatus](#componentstatus) array_ | | | | -| `version` _string_ | | | | -| `initialized` _boolean_ | | | | -| `availableNodes` _integer_ | AvailableNodes is the number of available instances. | | | -| `health` _[OpenSearchHealth](#opensearchhealth)_ | | | | - - -#### ComponentStatus - - - - - - - -_Appears in:_ -- [ClusterStatus](#clusterstatus) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `component` _string_ | | | | -| `status` _string_ | | | | -| `description` _string_ | | | | -| `conditions` _string array_ | | | | - - -#### Condition - - - - - - - -_Appears in:_ -- [Transition](#transition) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `cron` _[Cron](#cron)_ | The cron job that triggers the transition if no other transition happens first. | | | -| `minDocCount` _integer_ | The minimum document count of the index required to transition. | | | -| `minIndexAge` _string_ | The minimum age of the index required to transition. | | | -| `minRolloverAge` _string_ | The minimum age required after a rollover has occurred to transition to the next state. | | | -| `minSize` _string_ | The minimum size of the total primary shard storage (not counting replicas) required to transition. | | | - - -#### ConfMgmt - - - -ConfMgmt defines which additional services will be deployed - - - -_Appears in:_ -- [ClusterSpec](#clusterspec) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `autoScaler` _boolean_ | | | | -| `VerUpdate` _boolean_ | | | | -| `smartScaler` _boolean_ | | | | - - -#### Cron - - - - - - - -_Appears in:_ -- [Condition](#condition) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `expression` _string_ | The cron expression that triggers the transition. | | | -| `timezone` _string_ | The timezone that triggers the transition. | | | - - -#### DashboardsConfig - - - - - - - -_Appears in:_ -- [ClusterSpec](#clusterspec) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `enable` _boolean_ | | | | -| `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#resourcerequirements-v1-core)_ | | | | -| `replicas` _integer_ | | | | -| `tls` _[DashboardsTlsConfig](#dashboardstlsconfig)_ | | | | -| `version` _string_ | | | | -| `basePath` _string_ | Base Path for Opensearch Clusters running behind a reverse proxy | | | -| `additionalConfig` _object (keys:string, values:string)_ | Additional properties for opensearch_dashboards.yaml | | | -| `opensearchCredentialsSecret` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core)_ | Secret that contains fields username and password for dashboards to use to login to opensearch, must only be supplied if a custom securityconfig is provided | | | -| `env` _[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#envvar-v1-core) array_ | | | | -| `additionalVolumes` _[AdditionalVolume](#additionalvolume) array_ | | | | -| `tolerations` _[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#toleration-v1-core) array_ | | | | -| `nodeSelector` _object (keys:string, values:string)_ | | | | -| `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#affinity-v1-core)_ | | | | -| `labels` _object (keys:string, values:string)_ | | | | -| `annotations` _object (keys:string, values:string)_ | | | | -| `service` _[DashboardsServiceSpec](#dashboardsservicespec)_ | | | | -| `pluginsList` _string array_ | | | | -| `podSecurityContext` _[PodSecurityContext](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#podsecuritycontext-v1-core)_ | Set security context for the dashboards pods | | | -| `securityContext` _[SecurityContext](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#securitycontext-v1-core)_ | Set security context for the dashboards pods' container | | | - - -#### DashboardsServiceSpec - - - - - - - -_Appears in:_ -- [DashboardsConfig](#dashboardsconfig) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `type` _[ServiceType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#servicetype-v1-core)_ | | ClusterIP | Enum: [ClusterIP NodePort LoadBalancer]
| -| `loadBalancerSourceRanges` _string array_ | | | | - - -#### DashboardsTlsConfig - - - - - - - -_Appears in:_ -- [DashboardsConfig](#dashboardsconfig) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `enable` _boolean_ | Enable HTTPS for Dashboards | | | -| `generate` _boolean_ | Generate certificate, if false secret must be provided | | | -| `TlsCertificateConfig` _[TlsCertificateConfig](#tlscertificateconfig)_ | foobar | | | - - -#### Delete - - - - - - - -_Appears in:_ -- [Action](#action) - - - -#### Destination - - - - - - - -_Appears in:_ -- [ErrorNotification](#errornotification) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `slack` _[DestinationURL](#destinationurl)_ | | | | -| `amazon` _[DestinationURL](#destinationurl)_ | | | | -| `chime` _[DestinationURL](#destinationurl)_ | | | | -| `customWebhook` _[DestinationURL](#destinationurl)_ | | | | - - -#### DestinationURL - - - - - - - -_Appears in:_ -- [Destination](#destination) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `url` _string_ | | | | - - -#### ErrorNotification - - - - - - - -_Appears in:_ -- [OpenSearchISMPolicySpec](#opensearchismpolicyspec) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `destination` _[Destination](#destination)_ | The destination URL. | | | -| `channel` _string_ | | | | -| `messageTemplate` _[MessageTemplate](#messagetemplate)_ | The text of the message | | | - - -#### ForceMerge - - - - - - - -_Appears in:_ -- [Action](#action) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `maxNumSegments` _integer_ | The number of segments to reduce the shard to. | | | - - -#### GeneralConfig - - - - - - - -_Appears in:_ -- [ClusterSpec](#clusterspec) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `httpPort` _integer_ | | 9200 | | -| `vendor` _string_ | | | Enum: [Opensearch Op OP os opensearch]
| -| `version` _string_ | | | | -| `serviceAccount` _string_ | | | | -| `serviceName` _string_ | | | | -| `setVMMaxMapCount` _boolean_ | | | | -| `defaultRepo` _string_ | | | | -| `additionalConfig` _object (keys:string, values:string)_ | Extra items to add to the opensearch.yml | | | -| `annotations` _object (keys:string, values:string)_ | Adds support for annotations in services | | | -| `drainDataNodes` _boolean_ | Drain data nodes controls whether to drain data notes on rolling restart operations | | | -| `pluginsList` _string array_ | | | | -| `command` _string_ | | | | -| `additionalVolumes` _[AdditionalVolume](#additionalvolume) array_ | Additional volumes to mount to all pods in the cluster | | | -| `monitoring` _[MonitoringConfig](#monitoringconfig)_ | | | | -| `keystore` _[KeystoreValue](#keystorevalue) array_ | Populate opensearch keystore before startup | | | -| `snapshotRepositories` _[SnapshotRepoConfig](#snapshotrepoconfig) array_ | | | | -| `podSecurityContext` _[PodSecurityContext](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#podsecuritycontext-v1-core)_ | Set security context for the cluster pods | | | -| `securityContext` _[SecurityContext](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#securitycontext-v1-core)_ | Set security context for the cluster pods' container | | | - - -#### ISMTemplate - - - - - - - -_Appears in:_ -- [OpenSearchISMPolicySpec](#opensearchismpolicyspec) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `indexPatterns` _string array_ | Index patterns on which this policy has to be applied | | | -| `priority` _integer_ | Priority of the template, defaults to 0 | | | - - -#### ImageSpec - - - - - - - -_Appears in:_ -- [DashboardsConfig](#dashboardsconfig) -- [GeneralConfig](#generalconfig) -- [InitHelperConfig](#inithelperconfig) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `image` _string_ | | | | -| `imagePullPolicy` _[PullPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#pullpolicy-v1-core)_ | | | | -| `imagePullSecrets` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core) array_ | | | | - - -#### IndexPermissionSpec - - - - - - - -_Appears in:_ -- [OpensearchRoleSpec](#opensearchrolespec) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `indexPatterns` _string array_ | | | | -| `dls` _string_ | | | | -| `fls` _string array_ | | | | -| `allowedActions` _string array_ | | | | -| `maskedFields` _string array_ | | | | - - -#### IndexPriority - - - - - - - -_Appears in:_ -- [Action](#action) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `priority` _integer_ | The priority for the index as soon as it enters a state. | | | - - -#### InitHelperConfig - - - - - - - -_Appears in:_ -- [ClusterSpec](#clusterspec) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#resourcerequirements-v1-core)_ | | | | -| `version` _string_ | | | | - - -#### KeystoreValue - - - - - - - -_Appears in:_ -- [GeneralConfig](#generalconfig) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `secret` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core)_ | Secret containing key value pairs | | | -| `keyMappings` _object (keys:string, values:string)_ | Key mappings from secret to keystore keys | | | - - -#### MessageTemplate - - - - - - - -_Appears in:_ -- [ErrorNotification](#errornotification) -- [Notification](#notification) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `source` _string_ | | | | - - -#### MonitoringConfig - - - - - - - -_Appears in:_ -- [GeneralConfig](#generalconfig) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `enable` _boolean_ | | | | -| `monitoringUserSecret` _string_ | | | | -| `scrapeInterval` _string_ | | | | -| `pluginUrl` _string_ | | | | -| `tlsConfig` _[MonitoringConfigTLS](#monitoringconfigtls)_ | | | | - - -#### MonitoringConfigTLS - - - - - - - -_Appears in:_ -- [MonitoringConfig](#monitoringconfig) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `serverName` _string_ | | | | -| `insecureSkipVerify` _boolean_ | | | | - - -#### NodePool - - - - - - - -_Appears in:_ -- [ClusterSpec](#clusterspec) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `component` _string_ | | | | -| `replicas` _integer_ | | | | -| `diskSize` _string_ | | | | -| `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#resourcerequirements-v1-core)_ | | | | -| `jvm` _string_ | | | | -| `roles` _string array_ | | | | -| `tolerations` _[Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#toleration-v1-core) array_ | | | | -| `nodeSelector` _object (keys:string, values:string)_ | | | | -| `affinity` _[Affinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#affinity-v1-core)_ | | | | -| `topologySpreadConstraints` _[TopologySpreadConstraint](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#topologyspreadconstraint-v1-core) array_ | | | | -| `persistence` _[PersistenceConfig](#persistenceconfig)_ | | | | -| `additionalConfig` _object (keys:string, values:string)_ | | | | -| `labels` _object (keys:string, values:string)_ | | | | -| `annotations` _object (keys:string, values:string)_ | | | | -| `env` _[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#envvar-v1-core) array_ | | | | -| `priorityClassName` _string_ | | | | -| `pdb` _[PdbConfig](#pdbconfig)_ | | | | -| `probes` _[ProbesConfig](#probesconfig)_ | | | | - - -#### Notification - - - - - - - -_Appears in:_ -- [Action](#action) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `destination` _string_ | | | | -| `messageTemplate` _[MessageTemplate](#messagetemplate)_ | | | | - - -#### Open - - - - - - - -_Appears in:_ -- [Action](#action) - - - -#### OpenSearchCluster - - - -Es is the Schema for the es API - - - -_Appears in:_ -- [OpenSearchClusterList](#opensearchclusterlist) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `opensearch.opster.io/v1` | | | -| `kind` _string_ | `OpenSearchCluster` | | | -| `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | -| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | -| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `spec` _[ClusterSpec](#clusterspec)_ | | | | -| `status` _[ClusterStatus](#clusterstatus)_ | | | | - - -#### OpenSearchClusterList - - - -EsList contains a list of Es - - - - - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `opensearch.opster.io/v1` | | | -| `kind` _string_ | `OpenSearchClusterList` | | | -| `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | -| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | -| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `items` _[OpenSearchCluster](#opensearchcluster) array_ | | | | - - -#### OpenSearchHealth - -_Underlying type:_ _string_ - -OpenSearchHealth is the health of the cluster as returned by the health API. - - - -_Appears in:_ -- [ClusterStatus](#clusterstatus) - - - -#### OpenSearchISMPolicy - - - - - - - -_Appears in:_ -- [OpenSearchISMPolicyList](#opensearchismpolicylist) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `opensearch.opster.io/v1` | | | -| `kind` _string_ | `OpenSearchISMPolicy` | | | -| `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | -| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | -| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `spec` _[OpenSearchISMPolicySpec](#opensearchismpolicyspec)_ | | | | -| `status` _[OpensearchISMPolicyStatus](#opensearchismpolicystatus)_ | | | | - - -#### OpenSearchISMPolicyList - - - -ISMPolicyList contains a list of ISMPolicy - - - - - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `opensearch.opster.io/v1` | | | -| `kind` _string_ | `OpenSearchISMPolicyList` | | | -| `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | -| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | -| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `items` _[OpenSearchISMPolicy](#opensearchismpolicy) array_ | | | | - - -#### OpenSearchISMPolicySpec - - - -ISMPolicySpec is the specification for the ISM policy for OS. - - - -_Appears in:_ -- [OpenSearchISMPolicy](#opensearchismpolicy) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `opensearchCluster` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core)_ | | | | -| `defaultState` _string_ | The default starting state for each index that uses this policy. | | | -| `description` _string_ | A human-readable description of the policy. | | | -| `errorNotification` _[ErrorNotification](#errornotification)_ | | | | -| `ismTemplate` _[ISMTemplate](#ismtemplate)_ | Specify an ISM template pattern that matches the index to apply the policy. | | | -| `policyId` _string_ | | | | -| `states` _[State](#state) array_ | The states that you define in the policy. | | | - - -#### OpensearchActionGroup - - - -OpensearchActionGroup is the Schema for the opensearchactiongroups API - - - -_Appears in:_ -- [OpensearchActionGroupList](#opensearchactiongrouplist) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `opensearch.opster.io/v1` | | | -| `kind` _string_ | `OpensearchActionGroup` | | | -| `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | -| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | -| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `spec` _[OpensearchActionGroupSpec](#opensearchactiongroupspec)_ | | | | -| `status` _[OpensearchActionGroupStatus](#opensearchactiongroupstatus)_ | | | | - - -#### OpensearchActionGroupList - - - -OpensearchActionGroupList contains a list of OpensearchActionGroup - - - - - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `opensearch.opster.io/v1` | | | -| `kind` _string_ | `OpensearchActionGroupList` | | | -| `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | -| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | -| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `items` _[OpensearchActionGroup](#opensearchactiongroup) array_ | | | | - - -#### OpensearchActionGroupSpec - - - -OpensearchActionGroupSpec defines the desired state of OpensearchActionGroup - - - -_Appears in:_ -- [OpensearchActionGroup](#opensearchactiongroup) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `opensearchCluster` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core)_ | | | | -| `allowedActions` _string array_ | | | | -| `type` _string_ | | | | -| `description` _string_ | | | | - - -#### OpensearchActionGroupState - -_Underlying type:_ _string_ - - - - - -_Appears in:_ -- [OpensearchActionGroupStatus](#opensearchactiongroupstatus) - - - -#### OpensearchActionGroupStatus - - - -OpensearchActionGroupStatus defines the observed state of OpensearchActionGroup - - - -_Appears in:_ -- [OpensearchActionGroup](#opensearchactiongroup) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `state` _[OpensearchActionGroupState](#opensearchactiongroupstate)_ | | | | -| `reason` _string_ | | | | -| `existingActionGroup` _boolean_ | | | | -| `managedCluster` _[UID](#uid)_ | | | | - - - - -#### OpensearchComponentTemplate - - - -OpensearchComponentTemplate is the schema for the OpenSearch component templates API - - - -_Appears in:_ -- [OpensearchComponentTemplateList](#opensearchcomponenttemplatelist) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `opensearch.opster.io/v1` | | | -| `kind` _string_ | `OpensearchComponentTemplate` | | | -| `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | -| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | -| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `spec` _[OpensearchComponentTemplateSpec](#opensearchcomponenttemplatespec)_ | | | | -| `status` _[OpensearchComponentTemplateStatus](#opensearchcomponenttemplatestatus)_ | | | | - - -#### OpensearchComponentTemplateList - - - -OpensearchComponentTemplateList contains a list of OpensearchComponentTemplate - - - - - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `opensearch.opster.io/v1` | | | -| `kind` _string_ | `OpensearchComponentTemplateList` | | | -| `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | -| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | -| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `items` _[OpensearchComponentTemplate](#opensearchcomponenttemplate) array_ | | | | - - -#### OpensearchComponentTemplateSpec - - - - - - - -_Appears in:_ -- [OpensearchComponentTemplate](#opensearchcomponenttemplate) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `opensearchCluster` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core)_ | | | | -| `name` _string_ | The name of the component template. Defaults to metadata.name | | | -| `template` _[OpensearchIndexSpec](#opensearchindexspec)_ | The template that should be applied | | | -| `version` _integer_ | Version number used to manage the component template externally | | | -| `allowAutoCreate` _boolean_ | If true, then indices can be automatically created using this template | | | -| `_meta` _[JSON](#json)_ | Optional user metadata about the component template | | | - - -#### OpensearchComponentTemplateState - -_Underlying type:_ _string_ - - - - - -_Appears in:_ -- [OpensearchComponentTemplateStatus](#opensearchcomponenttemplatestatus) - - - -#### OpensearchComponentTemplateStatus - - - - - - - -_Appears in:_ -- [OpensearchComponentTemplate](#opensearchcomponenttemplate) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `state` _[OpensearchComponentTemplateState](#opensearchcomponenttemplatestate)_ | | | | -| `reason` _string_ | | | | -| `existingComponentTemplate` _boolean_ | | | | -| `managedCluster` _[UID](#uid)_ | | | | -| `componentTemplateName` _string_ | Name of the currently managed component template | | | - - -#### OpensearchISMPolicyState - -_Underlying type:_ _string_ - - - - - -_Appears in:_ -- [OpensearchISMPolicyStatus](#opensearchismpolicystatus) - - - -#### OpensearchISMPolicyStatus - - - -OpensearchISMPolicyStatus defines the observed state of OpensearchISMPolicy - - - -_Appears in:_ -- [OpenSearchISMPolicy](#opensearchismpolicy) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `state` _[OpensearchISMPolicyState](#opensearchismpolicystate)_ | | | | -| `reason` _string_ | | | | -| `existingISMPolicy` _boolean_ | | | | -| `managedCluster` _[UID](#uid)_ | | | | -| `policyId` _string_ | | | | - - -#### OpensearchIndexAliasSpec - - - -Describes the specs of an index alias - - - -_Appears in:_ -- [OpensearchIndexSpec](#opensearchindexspec) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `index` _string_ | The name of the index that the alias points to. | | | -| `alias` _string_ | The name of the alias. | | | -| `filter` _[JSON](#json)_ | Query used to limit documents the alias can access. | | | -| `routing` _string_ | Value used to route indexing and search operations to a specific shard. | | | -| `isWriteIndex` _boolean_ | If true, the index is the write index for the alias | | | - - -#### OpensearchIndexSpec - - - -Describes the specs of an index - - - -_Appears in:_ -- [OpensearchComponentTemplateSpec](#opensearchcomponenttemplatespec) -- [OpensearchIndexTemplateSpec](#opensearchindextemplatespec) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `settings` _[JSON](#json)_ | Configuration options for the index | | | -| `mappings` _[JSON](#json)_ | Mapping for fields in the index | | | -| `aliases` _object (keys:string, values:[OpensearchIndexAliasSpec](#opensearchindexaliasspec))_ | Aliases to add | | | - - -#### OpensearchIndexTemplate - - - -OpensearchIndexTemplate is the schema for the OpenSearch index templates API - - - -_Appears in:_ -- [OpensearchIndexTemplateList](#opensearchindextemplatelist) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `opensearch.opster.io/v1` | | | -| `kind` _string_ | `OpensearchIndexTemplate` | | | -| `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | -| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | -| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `spec` _[OpensearchIndexTemplateSpec](#opensearchindextemplatespec)_ | | | | -| `status` _[OpensearchIndexTemplateStatus](#opensearchindextemplatestatus)_ | | | | - - -#### OpensearchIndexTemplateList - - - -OpensearchIndexTemplateList contains a list of OpensearchIndexTemplate - - - - - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `opensearch.opster.io/v1` | | | -| `kind` _string_ | `OpensearchIndexTemplateList` | | | -| `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | -| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | -| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `items` _[OpensearchIndexTemplate](#opensearchindextemplate) array_ | | | | - - -#### OpensearchIndexTemplateSpec - - - - - - - -_Appears in:_ -- [OpensearchIndexTemplate](#opensearchindextemplate) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `opensearchCluster` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core)_ | | | | -| `name` _string_ | The name of the index template. Defaults to metadata.name | | | -| `indexPatterns` _string array_ | Array of wildcard expressions used to match the names of indices during creation | | | -| `template` _[OpensearchIndexSpec](#opensearchindexspec)_ | The template that should be applied | | | -| `composedOf` _string array_ | An ordered list of component template names. Component templates are merged in the order specified,
meaning that the last component template specified has the highest precedence | | | -| `priority` _integer_ | Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen | | | -| `version` _integer_ | Version number used to manage the component template externally | | | -| `_meta` _[JSON](#json)_ | Optional user metadata about the index template | | | - - -#### OpensearchIndexTemplateState - -_Underlying type:_ _string_ - - - - - -_Appears in:_ -- [OpensearchIndexTemplateStatus](#opensearchindextemplatestatus) - - - -#### OpensearchIndexTemplateStatus - - - - - - - -_Appears in:_ -- [OpensearchIndexTemplate](#opensearchindextemplate) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `state` _[OpensearchIndexTemplateState](#opensearchindextemplatestate)_ | | | | -| `reason` _string_ | | | | -| `existingIndexTemplate` _boolean_ | | | | -| `managedCluster` _[UID](#uid)_ | | | | -| `indexTemplateName` _string_ | Name of the currently managed index template | | | - - -#### OpensearchRole - - - -OpensearchRole is the Schema for the opensearchroles API - - - -_Appears in:_ -- [OpensearchRoleList](#opensearchrolelist) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `opensearch.opster.io/v1` | | | -| `kind` _string_ | `OpensearchRole` | | | -| `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | -| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | -| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `spec` _[OpensearchRoleSpec](#opensearchrolespec)_ | | | | -| `status` _[OpensearchRoleStatus](#opensearchrolestatus)_ | | | | - - -#### OpensearchRoleList - - - -OpensearchRoleList contains a list of OpensearchRole - - - - - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `opensearch.opster.io/v1` | | | -| `kind` _string_ | `OpensearchRoleList` | | | -| `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | -| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | -| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `items` _[OpensearchRole](#opensearchrole) array_ | | | | - - -#### OpensearchRoleSpec - - - -OpensearchRoleSpec defines the desired state of OpensearchRole - - - -_Appears in:_ -- [OpensearchRole](#opensearchrole) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `opensearchCluster` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core)_ | | | | -| `clusterPermissions` _string array_ | | | | -| `indexPermissions` _[IndexPermissionSpec](#indexpermissionspec) array_ | | | | -| `tenantPermissions` _[TenantPermissionsSpec](#tenantpermissionsspec) array_ | | | | - - -#### OpensearchRoleState - -_Underlying type:_ _string_ - - - - - -_Appears in:_ -- [OpensearchRoleStatus](#opensearchrolestatus) - - - -#### OpensearchRoleStatus - - - -OpensearchRoleStatus defines the observed state of OpensearchRole - - - -_Appears in:_ -- [OpensearchRole](#opensearchrole) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `state` _[OpensearchRoleState](#opensearchrolestate)_ | | | | -| `reason` _string_ | | | | -| `existingRole` _boolean_ | | | | -| `managedCluster` _[UID](#uid)_ | | | | - - -#### OpensearchTenant - - - -OpensearchTenant is the Schema for the opensearchtenants API - - - -_Appears in:_ -- [OpensearchTenantList](#opensearchtenantlist) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `opensearch.opster.io/v1` | | | -| `kind` _string_ | `OpensearchTenant` | | | -| `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | -| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | -| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `spec` _[OpensearchTenantSpec](#opensearchtenantspec)_ | | | | -| `status` _[OpensearchTenantStatus](#opensearchtenantstatus)_ | | | | - - -#### OpensearchTenantList - - - -OpensearchTenantList contains a list of OpensearchTenant - - - - - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `opensearch.opster.io/v1` | | | -| `kind` _string_ | `OpensearchTenantList` | | | -| `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | -| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | -| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `items` _[OpensearchTenant](#opensearchtenant) array_ | | | | - - -#### OpensearchTenantSpec - - - -OpensearchTenantSpec defines the desired state of OpensearchTenant - - - -_Appears in:_ -- [OpensearchTenant](#opensearchtenant) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `opensearchCluster` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core)_ | | | | -| `description` _string_ | | | | - - -#### OpensearchTenantState - -_Underlying type:_ _string_ - - - - - -_Appears in:_ -- [OpensearchTenantStatus](#opensearchtenantstatus) - - - -#### OpensearchTenantStatus - - - -OpensearchTenantStatus defines the observed state of OpensearchTenant - - - -_Appears in:_ -- [OpensearchTenant](#opensearchtenant) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `state` _[OpensearchTenantState](#opensearchtenantstate)_ | | | | -| `reason` _string_ | | | | -| `existingTenant` _boolean_ | | | | -| `managedCluster` _[UID](#uid)_ | | | | - - -#### OpensearchUser - - - -OpensearchUser is the Schema for the opensearchusers API - - - -_Appears in:_ -- [OpensearchUserList](#opensearchuserlist) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `opensearch.opster.io/v1` | | | -| `kind` _string_ | `OpensearchUser` | | | -| `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | -| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | -| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `spec` _[OpensearchUserSpec](#opensearchuserspec)_ | | | | -| `status` _[OpensearchUserStatus](#opensearchuserstatus)_ | | | | - - -#### OpensearchUserList - - - -OpensearchUserList contains a list of OpensearchUser - - - - - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `opensearch.opster.io/v1` | | | -| `kind` _string_ | `OpensearchUserList` | | | -| `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | -| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | -| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `items` _[OpensearchUser](#opensearchuser) array_ | | | | - - -#### OpensearchUserRoleBinding - - - -OpensearchUserRoleBinding is the Schema for the opensearchuserrolebindings API - - - -_Appears in:_ -- [OpensearchUserRoleBindingList](#opensearchuserrolebindinglist) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `opensearch.opster.io/v1` | | | -| `kind` _string_ | `OpensearchUserRoleBinding` | | | -| `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | -| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | -| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `spec` _[OpensearchUserRoleBindingSpec](#opensearchuserrolebindingspec)_ | | | | -| `status` _[OpensearchUserRoleBindingStatus](#opensearchuserrolebindingstatus)_ | | | | - - -#### OpensearchUserRoleBindingList - - - -OpensearchUserRoleBindingList contains a list of OpensearchUserRoleBinding - - - - - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `apiVersion` _string_ | `opensearch.opster.io/v1` | | | -| `kind` _string_ | `OpensearchUserRoleBindingList` | | | -| `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | -| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | -| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `items` _[OpensearchUserRoleBinding](#opensearchuserrolebinding) array_ | | | | - - -#### OpensearchUserRoleBindingSpec - - - -OpensearchUserRoleBindingSpec defines the desired state of OpensearchUserRoleBinding - - - -_Appears in:_ -- [OpensearchUserRoleBinding](#opensearchuserrolebinding) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `opensearchCluster` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core)_ | | | | -| `roles` _string array_ | | | | -| `users` _string array_ | | | | -| `backendRoles` _string array_ | | | | - - -#### OpensearchUserRoleBindingState - -_Underlying type:_ _string_ - - - - - -_Appears in:_ -- [OpensearchUserRoleBindingStatus](#opensearchuserrolebindingstatus) - - - -#### OpensearchUserRoleBindingStatus - - - -OpensearchUserRoleBindingStatus defines the observed state of OpensearchUserRoleBinding - - - -_Appears in:_ -- [OpensearchUserRoleBinding](#opensearchuserrolebinding) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `state` _[OpensearchUserRoleBindingState](#opensearchuserrolebindingstate)_ | | | | -| `reason` _string_ | | | | -| `managedCluster` _[UID](#uid)_ | | | | -| `provisionedRoles` _string array_ | | | | -| `provisionedUsers` _string array_ | | | | -| `provisionedBackendRoles` _string array_ | | | | - - -#### OpensearchUserSpec - - - -OpensearchUserSpec defines the desired state of OpensearchUser - - - -_Appears in:_ -- [OpensearchUser](#opensearchuser) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `opensearchCluster` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core)_ | | | | -| `passwordFrom` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#secretkeyselector-v1-core)_ | | | | -| `opendistroSecurityRoles` _string array_ | | | | -| `backendRoles` _string array_ | | | | -| `attributes` _object (keys:string, values:string)_ | | | | - - -#### OpensearchUserState - -_Underlying type:_ _string_ - - - - - -_Appears in:_ -- [OpensearchUserStatus](#opensearchuserstatus) - - - -#### OpensearchUserStatus - - - -OpensearchUserStatus defines the observed state of OpensearchUser - - - -_Appears in:_ -- [OpensearchUser](#opensearchuser) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `state` _[OpensearchUserState](#opensearchuserstate)_ | | | | -| `reason` _string_ | | | | -| `managedCluster` _[UID](#uid)_ | | | | - - -#### PVCSource - - - - - - - -_Appears in:_ -- [PersistenceSource](#persistencesource) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `storageClass` _string_ | | | | -| `accessModes` _[PersistentVolumeAccessMode](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#persistentvolumeaccessmode-v1-core) array_ | | | | - - -#### PdbConfig - - - - - - - -_Appears in:_ -- [NodePool](#nodepool) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `enable` _boolean_ | | | | -| `minAvailable` _[IntOrString](#intorstring)_ | | | | -| `maxUnavailable` _[IntOrString](#intorstring)_ | | | | - - -#### PersistenceConfig - - - -PersistencConfig defines options for data persistence - - - -_Appears in:_ -- [NodePool](#nodepool) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `PersistenceSource` _[PersistenceSource](#persistencesource)_ | | | | - - -#### PersistenceSource - - - - - - - -_Appears in:_ -- [PersistenceConfig](#persistenceconfig) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `pvc` _[PVCSource](#pvcsource)_ | | | | -| `emptyDir` _[EmptyDirVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#emptydirvolumesource-v1-core)_ | | | | -| `hostPath` _[HostPathVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#hostpathvolumesource-v1-core)_ | | | | - - -#### ProbeConfig - - - - - - - -_Appears in:_ -- [ProbesConfig](#probesconfig) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `initialDelaySeconds` _integer_ | | | | -| `periodSeconds` _integer_ | | | | -| `timeoutSeconds` _integer_ | | | | -| `successThreshold` _integer_ | | | | -| `failureThreshold` _integer_ | | | | - - -#### ProbesConfig - - - - - - - -_Appears in:_ -- [NodePool](#nodepool) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `liveness` _[ProbeConfig](#probeconfig)_ | | | | -| `readiness` _[ReadinessProbeConfig](#readinessprobeconfig)_ | | | | -| `startup` _[ProbeConfig](#probeconfig)_ | | | | - - -#### ReadinessProbeConfig - - - - - - - -_Appears in:_ -- [ProbesConfig](#probesconfig) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `initialDelaySeconds` _integer_ | | | | -| `periodSeconds` _integer_ | | | | -| `timeoutSeconds` _integer_ | | | | -| `failureThreshold` _integer_ | | | | - - -#### ReplicaCount - - - - - - - -_Appears in:_ -- [Action](#action) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `numberOfReplicas` _integer_ | | | | - - -#### Retry - - - - - - - -_Appears in:_ -- [Action](#action) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `backoff` _string_ | The backoff policy type to use when retrying. | | | -| `count` _integer_ | The number of retry counts. | | | -| `delay` _string_ | The time to wait between retries. | | | - - -#### Rollover - - - - - - - -_Appears in:_ -- [Action](#action) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `minDocCount` _integer_ | The minimum number of documents required to roll over the index. | | | -| `minIndexAge` _string_ | The minimum age required to roll over the index. | | | -| `minPrimaryShardSize` _string_ | The minimum storage size of a single primary shard required to roll over the index. | | | -| `minSize` _string_ | The minimum size of the total primary shard storage (not counting replicas) required to roll over the index. | | | - - -#### Rollup - - - - - - - -_Appears in:_ -- [Action](#action) - - - -#### Security - - - -Security defines options for managing the opensearch-security plugin - - - -_Appears in:_ -- [ClusterSpec](#clusterspec) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `tls` _[TlsConfig](#tlsconfig)_ | | | | -| `config` _[SecurityConfig](#securityconfig)_ | | | | - - -#### SecurityConfig - - - - - - - -_Appears in:_ -- [Security](#security) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `securityConfigSecret` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core)_ | Secret that contains the differnt yml files of the opensearch-security config (config.yml, internal_users.yml, ...) | | | -| `adminSecret` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core)_ | TLS Secret that contains a client certificate (tls.key, tls.crt, ca.crt) with admin rights in the opensearch cluster. Must be set if transport certificates are provided by user and not generated | | | -| `adminCredentialsSecret` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core)_ | Secret that contains fields username and password to be used by the operator to access the opensearch cluster for node draining. Must be set if custom securityconfig is provided. | | | - - -#### Shrink - - - - - - - -_Appears in:_ -- [Action](#action) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `forceUnsafe` _boolean_ | If true, executes the shrink action even if there are no replicas. | | | -| `maxShardSize` _string_ | The maximum size in bytes of a shard for the target index. | | | -| `numNewShards` _integer_ | The maximum number of primary shards in the shrunken index. | | | -| `percentageOfSourceShards` _integer_ | Percentage of the number of original primary shards to shrink. | | | -| `targetIndexNameTemplate` _string_ | The name of the shrunken index. | | | - - -#### Snapshot - - - - - - - -_Appears in:_ -- [Action](#action) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `repository` _string_ | The repository name that you register through the native snapshot API operations. | | | -| `snapshot` _string_ | The name of the snapshot. | | | - - -#### SnapshotRepoConfig - - - - - - - -_Appears in:_ -- [GeneralConfig](#generalconfig) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `name` _string_ | | | | -| `type` _string_ | | | | -| `settings` _object (keys:string, values:string)_ | | | | - - -#### State - - - - - - - -_Appears in:_ -- [OpenSearchISMPolicySpec](#opensearchismpolicyspec) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `actions` _[Action](#action) array_ | The actions to execute after entering a state. | | | -| `name` _string_ | The name of the state. | | | -| `transitions` _[Transition](#transition) array_ | The next states and the conditions required to transition to those states. If no transitions exist, the policy assumes that it’s complete and can now stop managing the index | | | - - -#### TenantPermissionsSpec - - - - - - - -_Appears in:_ -- [OpensearchRoleSpec](#opensearchrolespec) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `tenantPatterns` _string array_ | | | | -| `allowedActions` _string array_ | | | | - - -#### TlsCertificateConfig - - - - - - - -_Appears in:_ -- [DashboardsTlsConfig](#dashboardstlsconfig) -- [TlsConfigHttp](#tlsconfighttp) -- [TlsConfigTransport](#tlsconfigtransport) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `secret` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core)_ | Optional, name of a TLS secret that contains ca.crt, tls.key and tls.crt data. If ca.crt is in a different secret provide it via the caSecret field | | | -| `caSecret` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core)_ | Optional, secret that contains the ca certificate as ca.crt. If this and generate=true is set the existing CA cert from that secret is used to generate the node certs. In this case must contain ca.crt and ca.key fields | | | - - -#### TlsConfig - - - -Configure tls usage for transport and http interface - - - -_Appears in:_ -- [Security](#security) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `transport` _[TlsConfigTransport](#tlsconfigtransport)_ | | | | -| `http` _[TlsConfigHttp](#tlsconfighttp)_ | | | | - - -#### TlsConfigHttp - - - - - - - -_Appears in:_ -- [TlsConfig](#tlsconfig) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `generate` _boolean_ | If set to true the operator will generate a CA and certificates for the cluster to use, if false secrets with existing certificates must be supplied | | | -| `TlsCertificateConfig` _[TlsCertificateConfig](#tlscertificateconfig)_ | | | | - - -#### TlsConfigTransport - - - - - - - -_Appears in:_ -- [TlsConfig](#tlsconfig) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `generate` _boolean_ | If set to true the operator will generate a CA and certificates for the cluster to use, if false secrets with existing certificates must be supplied | | | -| `perNode` _boolean_ | Configure transport node certificate | | | -| `TlsCertificateConfig` _[TlsCertificateConfig](#tlscertificateconfig)_ | | | | -| `nodesDn` _string array_ | Allowed Certificate DNs for nodes, only used when existing certificates are provided | | | -| `adminDn` _string array_ | DNs of certificates that should have admin access, mainly used for securityconfig updates via securityadmin.sh, only used when existing certificates are provided | | | - - - - -#### Transition - - - - - - - -_Appears in:_ -- [State](#state) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `conditions` _[Condition](#condition)_ | conditions for the transition. | | | -| `stateName` _string_ | The name of the state to transition to if the conditions are met. | | | - - +

Packages:

+ +

opensearch.opster.io/v1

+
+

Package v1 contains API Schema definitions for the opster v1 API group

+
+Resource Types: + +

Action +

+

+(Appears on:State) +

+
+

Actions are the steps that the policy sequentially executes on entering a specific state.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+alias
+ + +Alias + + +		 +
+allocation
+ + +Allocation + + +		 +

Allocate the index to a node with a specific attribute set

+
+close
+ + +Close + + +		 +

Closes the managed index.

+
+delete
+ + +Delete + + +		 +

Deletes a managed index.

+
+forceMerge
+ + +ForceMerge + + +		 +

Reduces the number of Lucene segments by merging the segments of individual shards.

+
+indexPriority
+ + +IndexPriority + + +		 +

Set the priority for the index in a specific state.

+
+notification
+ + +Notification + + +		 +

Name string json:"name,omitempty"

+
+open
+ + +Open + + +		 +

Opens a managed index.

+
+readOnly
+ +string + +		 +

Sets a managed index to be read only.

+
+readWrite
+ +string + +		 +

Sets a managed index to be writeable.

+
+replicaCount
+ + +ReplicaCount + + +		 +

Sets the number of replicas to assign to an index.

+
+retry
+ + +Retry + + +		 +

The retry configuration for the action.

+
+rollover
+ + +Rollover + + +		 +

Rolls an alias over to a new index when the managed index meets one of the rollover conditions.

+
+rollup
+ + +Rollup + + +		 +

Periodically reduce data granularity by rolling up old data into summarized indexes.

+
+shrink
+ + +Shrink + + +		 +

Allows you to reduce the number of primary shards in your indexes

+
+snapshot
+ + +Snapshot + + +		 +

Back up your cluster’s indexes and state

+
+timeout
+ +string + +		 +

The timeout period for the action.

+
+

AdditionalVolume +

+

+(Appears on:DashboardsConfig, GeneralConfig) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+name
+ +string + +		 +

Name to use for the volume. Required.

+
+path
+ +string + +		 +

Path in the container to mount the volume at. Required.

+
+subPath
+ +string + +		 +

SubPath of the referenced volume to mount.

+
+secret
+ + +Kubernetes core/v1.SecretVolumeSource + + +		 +

Secret to use populate the volume

+
+configMap
+ + +Kubernetes core/v1.ConfigMapVolumeSource + + +		 +

ConfigMap to use to populate the volume

+
+emptyDir
+ + +Kubernetes core/v1.EmptyDirVolumeSource + + +		 +

EmptyDir to use to populate the volume

+
+restartPods
+ +bool + +		 +

Whether to restart the pods on content change

+
+

Alias +

+

+(Appears on:Action) +

+
+
+ + + + + + + + + + + + + +
FieldDescription
+actions
+ + +[]AliasAction + + +		 +

Allocate the index to a node with a specified attribute.

+
+

AliasAction +

+

+(Appears on:Alias) +

+
+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+add
+ + +AliasDetails + + +		 +
+remove
+ + +AliasDetails + + +		 +
+

AliasDetails +

+

+(Appears on:AliasAction) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+index
+ +string + +		 +

The name of the index that the alias points to.

+
+aliases
+ +[]string + +		 +

The name of the alias.

+
+routing
+ +string + +		 +

Limit search to an associated shard value

+
+isWriteIndex
+ +bool + +		 +

Specify the index that accepts any write operations to the alias.

+
+

Allocation +

+

+(Appears on:Action) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+exclude
+ +string + +		 +

Allocate the index to a node with a specified attribute.

+
+include
+ +string + +		 +

Allocate the index to a node with any of the specified attributes.

+
+require
+ +string + +		 +

Don’t allocate the index to a node with any of the specified attributes.

+
+waitFor
+ +string + +		 +

Wait for the policy to execute before allocating the index to a node with a specified attribute.

+
+

BootstrapConfig +

+

+(Appears on:ClusterSpec) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+resources
+ + +Kubernetes core/v1.ResourceRequirements + + +		 +
+tolerations
+ + +[]Kubernetes core/v1.Toleration + + +		 +
+nodeSelector
+ +map[string]string + +		 +
+affinity
+ + +Kubernetes core/v1.Affinity + + +		 +
+jvm
+ +string + +		 +
+additionalConfig
+ +map[string]string + +		 +

Extra items to add to the opensearch.yml, defaults to General.AdditionalConfig

+
+

Close +

+

+(Appears on:Action) +

+
+
+

ClusterSpec +

+

+(Appears on:OpenSearchCluster) +

+
+

ClusterSpec defines the desired state of OpenSearchCluster

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+general
+ + +GeneralConfig + + +		 +

INSERT ADDITIONAL SPEC FIELDS - desired state of cluster +Important: Run “make” to regenerate code after modifying this file

+
+confMgmt
+ + +ConfMgmt + + +		 +
+bootstrap
+ + +BootstrapConfig + + +		 +
+dashboards
+ + +DashboardsConfig + + +		 +
+security
+ + +Security + + +		 +
+nodePools
+ + +[]NodePool + + +		 +
+initHelper
+ + +InitHelperConfig + + +		 +
+

ClusterStatus +

+

+(Appears on:OpenSearchCluster) +

+
+

ClusterStatus defines the observed state of Es

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+phase
+ +string + +		 +

INSERT ADDITIONAL STATUS FIELD - define observed state of cluster +Important: Run “make” to regenerate code after modifying this file

+
+componentsStatus
+ + +[]ComponentStatus + + +		 +
+version
+ +string + +		 +
+initialized
+ +bool + +		 +
+availableNodes
+ +int32 + +		 +

AvailableNodes is the number of available instances.

+
+health
+ + +OpenSearchHealth + + +		 +
+

ComponentStatus +

+

+(Appears on:ClusterStatus) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+component
+ +string + +		 +
+status
+ +string + +		 +
+description
+ +string + +		 +
+conditions
+ +[]string + +		 +
+

Condition +

+

+(Appears on:Transition) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+cron
+ + +Cron + + +		 +

The cron job that triggers the transition if no other transition happens first.

+
+minDocCount
+ +int64 + +		 +

The minimum document count of the index required to transition.

+
+minIndexAge
+ +string + +		 +

The minimum age of the index required to transition.

+
+minRolloverAge
+ +string + +		 +

The minimum age required after a rollover has occurred to transition to the next state.

+
+minSize
+ +string + +		 +

The minimum size of the total primary shard storage (not counting replicas) required to transition.

+
+

ConfMgmt +

+

+(Appears on:ClusterSpec) +

+
+

ConfMgmt defines which additional services will be deployed

+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+autoScaler
+ +bool + +		 +
+VerUpdate
+ +bool + +		 +
+smartScaler
+ +bool + +		 +
+

Cron +

+

+(Appears on:Condition) +

+
+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+expression
+ +string + +		 +

The cron expression that triggers the transition.

+
+timezone
+ +string + +		 +

The timezone that triggers the transition.

+
+

DashboardsConfig +

+

+(Appears on:ClusterSpec) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+ImageSpec
+ + +ImageSpec + + +		 +

+(Members of ImageSpec are embedded into this type.) +

+
+enable
+ +bool + +		 +
+resources
+ + +Kubernetes core/v1.ResourceRequirements + + +		 +
+replicas
+ +int32 + +		 +
+tls
+ + +DashboardsTlsConfig + + +		 +
+version
+ +string + +		 +
+basePath
+ +string + +		 +

Base Path for Opensearch Clusters running behind a reverse proxy

+
+additionalConfig
+ +map[string]string + +		 +

Additional properties for opensearch_dashboards.yaml

+
+opensearchCredentialsSecret
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +

Secret that contains fields username and password for dashboards to use to login to opensearch, must only be supplied if a custom securityconfig is provided

+
+env
+ + +[]Kubernetes core/v1.EnvVar + + +		 +
+additionalVolumes
+ + +[]AdditionalVolume + + +		 +
+tolerations
+ + +[]Kubernetes core/v1.Toleration + + +		 +
+nodeSelector
+ +map[string]string + +		 +
+affinity
+ + +Kubernetes core/v1.Affinity + + +		 +
+labels
+ +map[string]string + +		 +
+annotations
+ +map[string]string + +		 +
+service
+ + +DashboardsServiceSpec + + +		 +
+pluginsList
+ +[]string + +		 +
+podSecurityContext
+ + +Kubernetes core/v1.PodSecurityContext + + +		 +

Set security context for the dashboards pods

+
+securityContext
+ + +Kubernetes core/v1.SecurityContext + + +		 +

Set security context for the dashboards pods’ container

+
+

DashboardsServiceSpec +

+

+(Appears on:DashboardsConfig) +

+
+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+type
+ + +Kubernetes core/v1.ServiceType + + +		 +
+loadBalancerSourceRanges
+ +[]string + +		 +
+

DashboardsTlsConfig +

+

+(Appears on:DashboardsConfig) +

+
+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+enable
+ +bool + +		 +

Enable HTTPS for Dashboards

+
+generate
+ +bool + +		 +

Generate certificate, if false secret must be provided

+
+TlsCertificateConfig
+ + +TlsCertificateConfig + + +		 +

foobar

+
+

Delete +

+

+(Appears on:Action) +

+
+
+

Destination +

+

+(Appears on:ErrorNotification) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+slack
+ + +DestinationURL + + +		 +
+amazon
+ + +DestinationURL + + +		 +
+chime
+ + +DestinationURL + + +		 +
+customWebhook
+ + +DestinationURL + + +		 +
+

DestinationURL +

+

+(Appears on:Destination) +

+
+
+ + + + + + + + + + + + + +
FieldDescription
+url
+ +string + +		 +
+

ErrorNotification +

+

+(Appears on:OpenSearchISMPolicySpec) +

+
+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+destination
+ + +Destination + + +		 +

The destination URL.

+
+channel
+ +string + +		 +
+messageTemplate
+ + +MessageTemplate + + +		 +

The text of the message

+
+

ForceMerge +

+

+(Appears on:Action) +

+
+
+ + + + + + + + + + + + + +
FieldDescription
+maxNumSegments
+ +int64 + +		 +

The number of segments to reduce the shard to.

+
+

GeneralConfig +

+

+(Appears on:ClusterSpec) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+ImageSpec
+ + +ImageSpec + + +		 +

+(Members of ImageSpec are embedded into this type.) +

+
+httpPort
+ +int32 + +		 +
+vendor
+ +string + +		 +
+version
+ +string + +		 +
+serviceAccount
+ +string + +		 +
+serviceName
+ +string + +		 +
+setVMMaxMapCount
+ +bool + +		 +
+defaultRepo
+ +string + +		 +
+additionalConfig
+ +map[string]string + +		 +

Extra items to add to the opensearch.yml

+
+annotations
+ +map[string]string + +		 +

Adds support for annotations in services

+
+drainDataNodes
+ +bool + +		 +

Drain data nodes controls whether to drain data notes on rolling restart operations

+
+pluginsList
+ +[]string + +		 +
+command
+ +string + +		 +
+additionalVolumes
+ + +[]AdditionalVolume + + +		 +

Additional volumes to mount to all pods in the cluster

+
+monitoring
+ + +MonitoringConfig + + +		 +
+keystore
+ + +[]KeystoreValue + + +		 +

Populate opensearch keystore before startup

+
+snapshotRepositories
+ + +[]SnapshotRepoConfig + + +		 +
+podSecurityContext
+ + +Kubernetes core/v1.PodSecurityContext + + +		 +

Set security context for the cluster pods

+
+securityContext
+ + +Kubernetes core/v1.SecurityContext + + +		 +

Set security context for the cluster pods’ container

+
+

ISMTemplate +

+

+(Appears on:OpenSearchISMPolicySpec) +

+
+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+indexPatterns
+ +[]string + +		 +

Index patterns on which this policy has to be applied

+
+priority
+ +int + +		 +

Priority of the template, defaults to 0

+
+

ImageSpec +

+

+(Appears on:DashboardsConfig, GeneralConfig, InitHelperConfig) +

+
+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+image
+ +string + +		 +
+imagePullPolicy
+ + +Kubernetes core/v1.PullPolicy + + +		 +
+imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + +		 +
+

IndexPermissionSpec +

+

+(Appears on:OpensearchRoleSpec) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+indexPatterns
+ +[]string + +		 +
+dls
+ +string + +		 +
+fls
+ +[]string + +		 +
+allowedActions
+ +[]string + +		 +
+maskedFields
+ +[]string + +		 +
+

IndexPriority +

+

+(Appears on:Action) +

+
+
+ + + + + + + + + + + + + +
FieldDescription
+priority
+ +int64 + +		 +

The priority for the index as soon as it enters a state.

+
+

InitHelperConfig +

+

+(Appears on:ClusterSpec) +

+
+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+ImageSpec
+ + +ImageSpec + + +		 +

+(Members of ImageSpec are embedded into this type.) +

+
+resources
+ + +Kubernetes core/v1.ResourceRequirements + + +		 +
+version
+ +string + +		 +
+

KeystoreValue +

+

+(Appears on:GeneralConfig) +

+
+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+secret
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +

Secret containing key value pairs

+
+keyMappings
+ +map[string]string + +		 +

Key mappings from secret to keystore keys

+
+

MessageTemplate +

+

+(Appears on:ErrorNotification, Notification) +

+
+
+ + + + + + + + + + + + + +
FieldDescription
+source
+ +string + +		 +
+

MonitoringConfig +

+

+(Appears on:GeneralConfig) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+enable
+ +bool + +		 +
+monitoringUserSecret
+ +string + +		 +
+scrapeInterval
+ +string + +		 +
+pluginUrl
+ +string + +		 +
+tlsConfig
+ + +MonitoringConfigTLS + + +		 +
+

MonitoringConfigTLS +

+

+(Appears on:MonitoringConfig) +

+
+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+serverName
+ +string + +		 +
+insecureSkipVerify
+ +bool + +		 +
+

NodePool +

+

+(Appears on:ClusterSpec) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+component
+ +string + +		 +
+replicas
+ +int32 + +		 +
+diskSize
+ +string + +		 +
+resources
+ + +Kubernetes core/v1.ResourceRequirements + + +		 +
+jvm
+ +string + +		 +
+roles
+ +[]string + +		 +
+tolerations
+ + +[]Kubernetes core/v1.Toleration + + +		 +
+nodeSelector
+ +map[string]string + +		 +
+affinity
+ + +Kubernetes core/v1.Affinity + + +		 +
+topologySpreadConstraints
+ + +[]Kubernetes core/v1.TopologySpreadConstraint + + +		 +
+persistence
+ + +PersistenceConfig + + +		 +
+additionalConfig
+ +map[string]string + +		 +
+labels
+ +map[string]string + +		 +
+annotations
+ +map[string]string + +		 +
+env
+ + +[]Kubernetes core/v1.EnvVar + + +		 +
+priorityClassName
+ +string + +		 +
+pdb
+ + +PdbConfig + + +		 +
+probes
+ + +ProbesConfig + + +		 +
+

Notification +

+

+(Appears on:Action) +

+
+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+destination
+ +string + +		 +
+messageTemplate
+ + +MessageTemplate + + +		 +
+

Open +

+

+(Appears on:Action) +

+
+
+

OpenSearchCluster +

+
+

Es is the Schema for the es API

+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +ClusterSpec + + +		 +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+general
+ + +GeneralConfig + + +		 +

INSERT ADDITIONAL SPEC FIELDS - desired state of cluster +Important: Run “make” to regenerate code after modifying this file

+
+confMgmt
+ + +ConfMgmt + + +		 +
+bootstrap
+ + +BootstrapConfig + + +		 +
+dashboards
+ + +DashboardsConfig + + +		 +
+security
+ + +Security + + +		 +
+nodePools
+ + +[]NodePool + + +		 +
+initHelper
+ + +InitHelperConfig + + +		 +
+
+status
+ + +ClusterStatus + + +		 +
+

OpenSearchHealth +(string alias)

+

+(Appears on:ClusterStatus) +

+
+

OpenSearchHealth is the health of the cluster as returned by the health API.

+
+ + + + + + + + + + + + + + + + +
ValueDescription

"green"

"red"

"unknown"

"yellow"

+

OpenSearchISMPolicy +

+
+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +OpenSearchISMPolicySpec + + +		 +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+opensearchCluster
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +
+defaultState
+ +string + +		 +

The default starting state for each index that uses this policy.

+
+description
+ +string + +		 +

A human-readable description of the policy.

+
+errorNotification
+ + +ErrorNotification + + +		 +
+ismTemplate
+ + +ISMTemplate + + +		 +

Specify an ISM template pattern that matches the index to apply the policy.

+
+policyId
+ +string + +		 +
+states
+ + +[]State + + +		 +

The states that you define in the policy.

+
+
+status
+ + +OpensearchISMPolicyStatus + + +		 +
+

OpenSearchISMPolicySpec +

+

+(Appears on:OpenSearchISMPolicy) +

+
+

ISMPolicySpec is the specification for the ISM policy for OS.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+opensearchCluster
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +
+defaultState
+ +string + +		 +

The default starting state for each index that uses this policy.

+
+description
+ +string + +		 +

A human-readable description of the policy.

+
+errorNotification
+ + +ErrorNotification + + +		 +
+ismTemplate
+ + +ISMTemplate + + +		 +

Specify an ISM template pattern that matches the index to apply the policy.

+
+policyId
+ +string + +		 +
+states
+ + +[]State + + +		 +

The states that you define in the policy.

+
+

OpensearchActionGroup +

+
+

OpensearchActionGroup is the Schema for the opensearchactiongroups API

+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +OpensearchActionGroupSpec + + +		 +
+
+ + + + + + + + + + + + + + + + + +
+opensearchCluster
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +
+allowedActions
+ +[]string + +		 +
+type
+ +string + +		 +
+description
+ +string + +		 +
+
+status
+ + +OpensearchActionGroupStatus + + +		 +
+

OpensearchActionGroupSpec +

+

+(Appears on:OpensearchActionGroup) +

+
+

OpensearchActionGroupSpec defines the desired state of OpensearchActionGroup

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+opensearchCluster
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +
+allowedActions
+ +[]string + +		 +
+type
+ +string + +		 +
+description
+ +string + +		 +
+

OpensearchActionGroupState +(string alias)

+

+(Appears on:OpensearchActionGroupStatus) +

+
+
+ + + + + + + + + + + + + + + + +
ValueDescription

"CREATED"

"ERROR"

"IGNORED"

"PENDING"

+

OpensearchActionGroupStatus +

+

+(Appears on:OpensearchActionGroup) +

+
+

OpensearchActionGroupStatus defines the observed state of OpensearchActionGroup

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+state
+ + +OpensearchActionGroupState + + +		 +
+reason
+ +string + +		 +
+existingActionGroup
+ +bool + +		 +
+managedCluster
+ +k8s.io/apimachinery/pkg/types.UID + +		 +
+

OpensearchClusterSelector +

+
+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+name
+ +string + +		 +
+namespace
+ +string + +		 +
+

OpensearchComponentTemplate +

+
+

OpensearchComponentTemplate is the schema for the OpenSearch component templates API

+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +OpensearchComponentTemplateSpec + + +		 +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+opensearchCluster
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +
+name
+ +string + +		 +

The name of the component template. Defaults to metadata.name

+
+template
+ + +OpensearchIndexSpec + + +		 +

The template that should be applied

+
+version
+ +int + +		 +

Version number used to manage the component template externally

+
+allowAutoCreate
+ +bool + +		 +

If true, then indices can be automatically created using this template

+
+_meta
+ +k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + +		 +

Optional user metadata about the component template

+
+
+status
+ + +OpensearchComponentTemplateStatus + + +		 +
+

OpensearchComponentTemplateSpec +

+

+(Appears on:OpensearchComponentTemplate) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+opensearchCluster
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +
+name
+ +string + +		 +

The name of the component template. Defaults to metadata.name

+
+template
+ + +OpensearchIndexSpec + + +		 +

The template that should be applied

+
+version
+ +int + +		 +

Version number used to manage the component template externally

+
+allowAutoCreate
+ +bool + +		 +

If true, then indices can be automatically created using this template

+
+_meta
+ +k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + +		 +

Optional user metadata about the component template

+
+

OpensearchComponentTemplateState +(string alias)

+

+(Appears on:OpensearchComponentTemplateStatus) +

+
+
+ + + + + + + + + + + + + + + + +
ValueDescription

"CREATED"

"ERROR"

"IGNORED"

"PENDING"

+

OpensearchComponentTemplateStatus +

+

+(Appears on:OpensearchComponentTemplate) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+state
+ + +OpensearchComponentTemplateState + + +		 +
+reason
+ +string + +		 +
+existingComponentTemplate
+ +bool + +		 +
+managedCluster
+ +k8s.io/apimachinery/pkg/types.UID + +		 +
+componentTemplateName
+ +string + +		 +

Name of the currently managed component template

+
+

OpensearchISMPolicyState +(string alias)

+

+(Appears on:OpensearchISMPolicyStatus) +

+
+
+ + + + + + + + + + + + + + + + +
ValueDescription

"CREATED"

"ERROR"

"IGNORED"

"PENDING"

+

OpensearchISMPolicyStatus +

+

+(Appears on:OpenSearchISMPolicy) +

+
+

OpensearchISMPolicyStatus defines the observed state of OpensearchISMPolicy

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+state
+ + +OpensearchISMPolicyState + + +		 +
+reason
+ +string + +		 +
+existingISMPolicy
+ +bool + +		 +
+managedCluster
+ +k8s.io/apimachinery/pkg/types.UID + +		 +
+policyId
+ +string + +		 +
+

OpensearchIndexAliasSpec +

+

+(Appears on:OpensearchIndexSpec) +

+
+

Describes the specs of an index alias

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+index
+ +string + +		 +

The name of the index that the alias points to.

+
+alias
+ +string + +		 +

The name of the alias.

+
+filter
+ +k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + +		 +

Query used to limit documents the alias can access.

+
+routing
+ +string + +		 +

Value used to route indexing and search operations to a specific shard.

+
+isWriteIndex
+ +bool + +		 +

If true, the index is the write index for the alias

+
+

OpensearchIndexSpec +

+

+(Appears on:OpensearchComponentTemplateSpec, OpensearchIndexTemplateSpec) +

+
+

Describes the specs of an index

+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+settings
+ +k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + +		 +

Configuration options for the index

+
+mappings
+ +k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + +		 +

Mapping for fields in the index

+
+aliases
+ + +map[string]github.com/Opster/opensearch-k8s-operator/opensearch-operator/api/v1.OpensearchIndexAliasSpec + + +		 +

Aliases to add

+
+

OpensearchIndexTemplate +

+
+

OpensearchIndexTemplate is the schema for the OpenSearch index templates API

+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +OpensearchIndexTemplateSpec + + +		 +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+opensearchCluster
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +
+name
+ +string + +		 +

The name of the index template. Defaults to metadata.name

+
+indexPatterns
+ +[]string + +		 +

Array of wildcard expressions used to match the names of indices during creation

+
+template
+ + +OpensearchIndexSpec + + +		 +

The template that should be applied

+
+composedOf
+ +[]string + +		 +

An ordered list of component template names. Component templates are merged in the order specified, +meaning that the last component template specified has the highest precedence

+
+priority
+ +int + +		 +

Priority to determine index template precedence when a new data stream or index is created. +The index template with the highest priority is chosen

+
+version
+ +int + +		 +

Version number used to manage the component template externally

+
+_meta
+ +k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + +		 +

Optional user metadata about the index template

+
+
+status
+ + +OpensearchIndexTemplateStatus + + +		 +
+

OpensearchIndexTemplateSpec +

+

+(Appears on:OpensearchIndexTemplate) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+opensearchCluster
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +
+name
+ +string + +		 +

The name of the index template. Defaults to metadata.name

+
+indexPatterns
+ +[]string + +		 +

Array of wildcard expressions used to match the names of indices during creation

+
+template
+ + +OpensearchIndexSpec + + +		 +

The template that should be applied

+
+composedOf
+ +[]string + +		 +

An ordered list of component template names. Component templates are merged in the order specified, +meaning that the last component template specified has the highest precedence

+
+priority
+ +int + +		 +

Priority to determine index template precedence when a new data stream or index is created. +The index template with the highest priority is chosen

+
+version
+ +int + +		 +

Version number used to manage the component template externally

+
+_meta
+ +k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + +		 +

Optional user metadata about the index template

+
+

OpensearchIndexTemplateState +(string alias)

+

+(Appears on:OpensearchIndexTemplateStatus) +

+
+
+ + + + + + + + + + + + + + + + +
ValueDescription

"CREATED"

"ERROR"

"IGNORED"

"PENDING"

+

OpensearchIndexTemplateStatus +

+

+(Appears on:OpensearchIndexTemplate) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+state
+ + +OpensearchIndexTemplateState + + +		 +
+reason
+ +string + +		 +
+existingIndexTemplate
+ +bool + +		 +
+managedCluster
+ +k8s.io/apimachinery/pkg/types.UID + +		 +
+indexTemplateName
+ +string + +		 +

Name of the currently managed index template

+
+

OpensearchRole +

+
+

OpensearchRole is the Schema for the opensearchroles API

+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +OpensearchRoleSpec + + +		 +
+
+ + + + + + + + + + + + + + + + + +
+opensearchCluster
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +
+clusterPermissions
+ +[]string + +		 +
+indexPermissions
+ + +[]IndexPermissionSpec + + +		 +
+tenantPermissions
+ + +[]TenantPermissionsSpec + + +		 +
+
+status
+ + +OpensearchRoleStatus + + +		 +
+

OpensearchRoleSpec +

+

+(Appears on:OpensearchRole) +

+
+

OpensearchRoleSpec defines the desired state of OpensearchRole

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+opensearchCluster
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +
+clusterPermissions
+ +[]string + +		 +
+indexPermissions
+ + +[]IndexPermissionSpec + + +		 +
+tenantPermissions
+ + +[]TenantPermissionsSpec + + +		 +
+

OpensearchRoleState +(string alias)

+

+(Appears on:OpensearchRoleStatus) +

+
+
+ + + + + + + + + + + + + + + + +
ValueDescription

"IGNORED"

"CREATED"

"ERROR"

"PENDING"

+

OpensearchRoleStatus +

+

+(Appears on:OpensearchRole) +

+
+

OpensearchRoleStatus defines the observed state of OpensearchRole

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+state
+ + +OpensearchRoleState + + +		 +
+reason
+ +string + +		 +
+existingRole
+ +bool + +		 +
+managedCluster
+ +k8s.io/apimachinery/pkg/types.UID + +		 +
+

OpensearchTenant +

+
+

OpensearchTenant is the Schema for the opensearchtenants API

+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +OpensearchTenantSpec + + +		 +
+
+ + + + + + + + + +
+opensearchCluster
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +
+description
+ +string + +		 +
+
+status
+ + +OpensearchTenantStatus + + +		 +
+

OpensearchTenantSpec +

+

+(Appears on:OpensearchTenant) +

+
+

OpensearchTenantSpec defines the desired state of OpensearchTenant

+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+opensearchCluster
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +
+description
+ +string + +		 +
+

OpensearchTenantState +(string alias)

+

+(Appears on:OpensearchTenantStatus) +

+
+
+ + + + + + + + + + + + + + + + +
ValueDescription

"CREATED"

"ERROR"

"IGNORED"

"PENDING"

+

OpensearchTenantStatus +

+

+(Appears on:OpensearchTenant) +

+
+

OpensearchTenantStatus defines the observed state of OpensearchTenant

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+state
+ + +OpensearchTenantState + + +		 +
+reason
+ +string + +		 +
+existingTenant
+ +bool + +		 +
+managedCluster
+ +k8s.io/apimachinery/pkg/types.UID + +		 +
+

OpensearchUser +

+
+

OpensearchUser is the Schema for the opensearchusers API

+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +OpensearchUserSpec + + +		 +
+
+ + + + + + + + + + + + + + + + + + + + + +
+opensearchCluster
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +
+passwordFrom
+ + +Kubernetes core/v1.SecretKeySelector + + +		 +
+opendistroSecurityRoles
+ +[]string + +		 +
+backendRoles
+ +[]string + +		 +
+attributes
+ +map[string]string + +		 +
+
+status
+ + +OpensearchUserStatus + + +		 +
+

OpensearchUserRoleBinding +

+
+

OpensearchUserRoleBinding is the Schema for the opensearchuserrolebindings API

+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+metadata
+ + +Kubernetes meta/v1.ObjectMeta + + +		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
+spec
+ + +OpensearchUserRoleBindingSpec + + +		 +
+
+ + + + + + + + + + + + + + + + + +
+opensearchCluster
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +
+roles
+ +[]string + +		 +
+users
+ +[]string + +		 +
+backendRoles
+ +[]string + +		 +
+
+status
+ + +OpensearchUserRoleBindingStatus + + +		 +
+

OpensearchUserRoleBindingSpec +

+

+(Appears on:OpensearchUserRoleBinding) +

+
+

OpensearchUserRoleBindingSpec defines the desired state of OpensearchUserRoleBinding

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+opensearchCluster
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +
+roles
+ +[]string + +		 +
+users
+ +[]string + +		 +
+backendRoles
+ +[]string + +		 +
+

OpensearchUserRoleBindingState +(string alias)

+

+(Appears on:OpensearchUserRoleBindingStatus) +

+
+
+ + + + + + + + + + + + + + +
ValueDescription

"PENDING"

"CREATED"

"ERROR"

+

OpensearchUserRoleBindingStatus +

+

+(Appears on:OpensearchUserRoleBinding) +

+
+

OpensearchUserRoleBindingStatus defines the observed state of OpensearchUserRoleBinding

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+state
+ + +OpensearchUserRoleBindingState + + +		 +
+reason
+ +string + +		 +
+managedCluster
+ +k8s.io/apimachinery/pkg/types.UID + +		 +
+provisionedRoles
+ +[]string + +		 +
+provisionedUsers
+ +[]string + +		 +
+provisionedBackendRoles
+ +[]string + +		 +
+

OpensearchUserSpec +

+

+(Appears on:OpensearchUser) +

+
+

OpensearchUserSpec defines the desired state of OpensearchUser

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+opensearchCluster
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +
+passwordFrom
+ + +Kubernetes core/v1.SecretKeySelector + + +		 +
+opendistroSecurityRoles
+ +[]string + +		 +
+backendRoles
+ +[]string + +		 +
+attributes
+ +map[string]string + +		 +
+

OpensearchUserState +(string alias)

+

+(Appears on:OpensearchUserStatus) +

+
+
+ + + + + + + + + + + + + + +
ValueDescription

"CREATED"

"ERROR"

"PENDING"

+

OpensearchUserStatus +

+

+(Appears on:OpensearchUser) +

+
+

OpensearchUserStatus defines the observed state of OpensearchUser

+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+state
+ + +OpensearchUserState + + +		 +
+reason
+ +string + +		 +
+managedCluster
+ +k8s.io/apimachinery/pkg/types.UID + +		 +
+

PVCSource +

+

+(Appears on:PersistenceSource) +

+
+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+storageClass
+ +string + +		 +
+accessModes
+ + +[]Kubernetes core/v1.PersistentVolumeAccessMode + + +		 +
+

PdbConfig +

+

+(Appears on:NodePool) +

+
+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+enable
+ +bool + +		 +
+minAvailable
+ +k8s.io/apimachinery/pkg/util/intstr.IntOrString + +		 +
+maxUnavailable
+ +k8s.io/apimachinery/pkg/util/intstr.IntOrString + +		 +
+

PersistenceConfig +

+

+(Appears on:NodePool) +

+
+

PersistencConfig defines options for data persistence

+
+ + + + + + + + + + + + + +
FieldDescription
+,
+ + +PersistenceSource + + +		 +
+

PersistenceSource +

+

+(Appears on:PersistenceConfig) +

+
+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+pvc
+ + +PVCSource + + +		 +
+emptyDir
+ + +Kubernetes core/v1.EmptyDirVolumeSource + + +		 +
+hostPath
+ + +Kubernetes core/v1.HostPathVolumeSource + + +		 +
+

ProbeConfig +

+

+(Appears on:ProbesConfig) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+initialDelaySeconds
+ +int32 + +		 +
+periodSeconds
+ +int32 + +		 +
+timeoutSeconds
+ +int32 + +		 +
+successThreshold
+ +int32 + +		 +
+failureThreshold
+ +int32 + +		 +
+

ProbesConfig +

+

+(Appears on:NodePool) +

+
+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+liveness
+ + +ProbeConfig + + +		 +
+readiness
+ + +ReadinessProbeConfig + + +		 +
+startup
+ + +ProbeConfig + + +		 +
+

ReadinessProbeConfig +

+

+(Appears on:ProbesConfig) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+initialDelaySeconds
+ +int32 + +		 +
+periodSeconds
+ +int32 + +		 +
+timeoutSeconds
+ +int32 + +		 +
+failureThreshold
+ +int32 + +		 +
+

ReplicaCount +

+

+(Appears on:Action) +

+
+
+ + + + + + + + + + + + + +
FieldDescription
+numberOfReplicas
+ +int64 + +		 +
+

Retry +

+

+(Appears on:Action) +

+
+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+backoff
+ +string + +		 +

The backoff policy type to use when retrying.

+
+count
+ +int64 + +		 +

The number of retry counts.

+
+delay
+ +string + +		 +

The time to wait between retries.

+
+

Rollover +

+

+(Appears on:Action) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+minDocCount
+ +int64 + +		 +

The minimum number of documents required to roll over the index.

+
+minIndexAge
+ +string + +		 +

The minimum age required to roll over the index.

+
+minPrimaryShardSize
+ +string + +		 +

The minimum storage size of a single primary shard required to roll over the index.

+
+minSize
+ +string + +		 +

The minimum size of the total primary shard storage (not counting replicas) required to roll over the index.

+
+

Rollup +

+

+(Appears on:Action) +

+
+
+

Security +

+

+(Appears on:ClusterSpec) +

+
+

Security defines options for managing the opensearch-security plugin

+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+tls
+ + +TlsConfig + + +		 +
+config
+ + +SecurityConfig + + +		 +
+

SecurityConfig +

+

+(Appears on:Security) +

+
+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+securityConfigSecret
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +

Secret that contains the differnt yml files of the opensearch-security config (config.yml, internal_users.yml, …)

+
+adminSecret
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +

TLS Secret that contains a client certificate (tls.key, tls.crt, ca.crt) with admin rights in the opensearch cluster. Must be set if transport certificates are provided by user and not generated

+
+adminCredentialsSecret
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +

Secret that contains fields username and password to be used by the operator to access the opensearch cluster for node draining. Must be set if custom securityconfig is provided.

+
+

Shrink +

+

+(Appears on:Action) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+forceUnsafe
+ +bool + +		 +

If true, executes the shrink action even if there are no replicas.

+
+maxShardSize
+ +string + +		 +

The maximum size in bytes of a shard for the target index.

+
+numNewShards
+ +int + +		 +

The maximum number of primary shards in the shrunken index.

+
+percentageOfSourceShards
+ +int64 + +		 +

Percentage of the number of original primary shards to shrink.

+
+targetIndexNameTemplate
+ +string + +		 +

The name of the shrunken index.

+
+

Snapshot +

+

+(Appears on:Action) +

+
+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+repository
+ +string + +		 +

The repository name that you register through the native snapshot API operations.

+
+snapshot
+ +string + +		 +

The name of the snapshot.

+
+

SnapshotRepoConfig +

+

+(Appears on:GeneralConfig) +

+
+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+name
+ +string + +		 +
+type
+ +string + +		 +
+settings
+ +map[string]string + +		 +
+

State +

+

+(Appears on:OpenSearchISMPolicySpec) +

+
+
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+actions
+ + +[]Action + + +		 +

The actions to execute after entering a state.

+
+name
+ +string + +		 +

The name of the state.

+
+transitions
+ + +[]Transition + + +		 +

The next states and the conditions required to transition to those states. If no transitions exist, the policy assumes that it’s complete and can now stop managing the index

+
+

TenantPermissionsSpec +

+

+(Appears on:OpensearchRoleSpec) +

+
+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+tenantPatterns
+ +[]string + +		 +
+allowedActions
+ +[]string + +		 +
+

TlsCertificateConfig +

+

+(Appears on:DashboardsTlsConfig, TlsConfigHttp, TlsConfigTransport) +

+
+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+secret
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +

Optional, name of a TLS secret that contains ca.crt, tls.key and tls.crt data. If ca.crt is in a different secret provide it via the caSecret field

+
+caSecret
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +

Optional, secret that contains the ca certificate as ca.crt. If this and generate=true is set the existing CA cert from that secret is used to generate the node certs. In this case must contain ca.crt and ca.key fields

+
+

TlsConfig +

+

+(Appears on:Security) +

+
+

Configure tls usage for transport and http interface

+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+transport
+ + +TlsConfigTransport + + +		 +
+http
+ + +TlsConfigHttp + + +		 +
+

TlsConfigHttp +

+

+(Appears on:TlsConfig) +

+
+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+generate
+ +bool + +		 +

If set to true the operator will generate a CA and certificates for the cluster to use, if false secrets with existing certificates must be supplied

+
+TlsCertificateConfig
+ + +TlsCertificateConfig + + +		 +
+

TlsConfigTransport +

+

+(Appears on:TlsConfig) +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+generate
+ +bool + +		 +

If set to true the operator will generate a CA and certificates for the cluster to use, if false secrets with existing certificates must be supplied

+
+perNode
+ +bool + +		 +

Configure transport node certificate

+
+TlsCertificateConfig
+ + +TlsCertificateConfig + + +		 +
+nodesDn
+ +[]string + +		 +

Allowed Certificate DNs for nodes, only used when existing certificates are provided

+
+adminDn
+ +[]string + +		 +

DNs of certificates that should have admin access, mainly used for securityconfig updates via securityadmin.sh, only used when existing certificates are provided

+
+

TlsSecret +

+
+

Reference to a secret

+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+secretName
+ +string + +		 +
+key
+ +string + +		 +
+

Transition +

+

+(Appears on:State) +

+
+
+ + + + + + + + + + + + + + + + + +
FieldDescription
+conditions
+ + +Condition + + +		 +

conditions for the transition.

+
+stateName
+ +string + +		 +

The name of the state to transition to if the conditions are met.

+
+
+

+Generated with gen-crd-api-reference-docs +on git commit c559878. +

diff --git a/opensearch-operator/Makefile b/opensearch-operator/Makefile index f8cb99e6..28883df2 100644 --- a/opensearch-operator/Makefile +++ b/opensearch-operator/Makefile @@ -47,8 +47,8 @@ generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and $(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..." .PHONY: docs -docs: crdrefdocs - $(CRDREFDOCS) --output-path ../docs/api-docs.md --config crdrefdocs-config.yaml --renderer markdown +docs: gen-crd-api-reference-docs + $(GEN_CRD_API_REFERENCE_DOCS) -config ../docs/api-doc-gen/config.json -api-dir github.com/Opster/opensearch-k8s-operator/opensearch-operator/api/v1 -out-file ../docs/api-docs.md -template-dir ../docs/api-doc-gen/template .PHONY: fmt fmt: ## Run go fmt against code. @@ -116,7 +116,7 @@ $(LOCALBIN): ## Tool Binaries KUSTOMIZE ?= $(LOCALBIN)/kustomize CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen -CRDREFDOCS ?= $(LOCALBIN)/crd-ref-docs +GEN_CRD_API_REFERENCE_DOCS ?= $(LOCALBIN)/gen-crd-api-reference-docs ENVTEST ?= $(LOCALBIN)/setup-envtest MOCKERY ?= $(LOCALBIN)/mockery @@ -136,10 +136,10 @@ controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessar $(CONTROLLER_GEN): $(LOCALBIN) test -s $(LOCALBIN)/controller-gen || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION) -.PHONY: crdrefdocs -crdrefdocs: $(CRDREFDOCS) ## Download crd-ref-docs locally if necessary. -$(CRDREFDOCS): $(LOCALBIN) - test -s $(LOCALBIN)/crd-ref-docs || GOBIN=$(LOCALBIN) go install github.com/elastic/crd-ref-docs@latest +.PHONY: gen-crd-api-reference-docs +gen-crd-api-reference-docs: $(GEN_CRD_API_REFERENCE_DOCS) ## Download crd-ref-docs locally if necessary. +$(GEN_CRD_API_REFERENCE_DOCS): $(LOCALBIN) + test -s $(LOCALBIN)/crd-ref-docs || GOBIN=$(LOCALBIN) go install github.com/ahmetb/gen-crd-api-reference-docs@latest .PHONY: mockery mockery: $(MOCKERY) ## Download mockery locally if necessary. diff --git a/opensearch-operator/api/v1/doc.go b/opensearch-operator/api/v1/doc.go new file mode 100644 index 00000000..608bcbed --- /dev/null +++ b/opensearch-operator/api/v1/doc.go @@ -0,0 +1,20 @@ +/* +Copyright 2021. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package v1 contains API Schema definitions for the opster v1 API group +// +kubebuilder:object:generate=true +// +groupName=opensearch.opster.io +package v1 diff --git a/opensearch-operator/crdrefdocs-config.yaml b/opensearch-operator/crdrefdocs-config.yaml deleted file mode 100644 index 5bc48c69..00000000 --- a/opensearch-operator/crdrefdocs-config.yaml +++ /dev/null @@ -1,2 +0,0 @@ -render: - kubernetesVersion: 1.22 \ No newline at end of file