Skip to content

Commit

Permalink
Update docs for release 0.9.0 (Elasticsearch) (#303)
Browse files Browse the repository at this point in the history
xref: https://github.com/kubedb/project/issues/235
xref: https://github.com/kubedb/project/issues/192
xref: https://github.com/kubedb/project/issues/170
xref: https://github.com/kubedb/project/issues/288

Update Concept:
- [x] update elasticsearch.md
- [x] add doc for ElasticsearchVersion

Update Guides:
- [x] README
- [x] Quickstart
- [x] Clustering
- [x] Snapshotting
- [x] Initialization
- [x] Private Registry
- [x] Custom Configuration
- [x] Monitoring
- [x] Search Guard
- [x] Kibana
- [x] X-Pack
- [x] Cli

Update Example:
- [x] Quickstart
- [x] Clustering
- [x] Snapshotting
- [x] Initialization
- [x] Private Registry
- [x] Custom Configuration
- [x] Monitoring
- [x] Search Guard
- [x] Kibana
- [x] X-Pack
- [x] Cli
- [x] es-overview.yaml
  • Loading branch information
Md. Emruz Hossain authored and tamalsaha committed Oct 14, 2018
1 parent 11e4194 commit edcc0cc
Show file tree
Hide file tree
Showing 55 changed files with 2,177 additions and 1,282 deletions.
79 changes: 79 additions & 0 deletions docs/concepts/catalog/elasticsearch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
title: ElasticsearchVersion
menu:
docs_0.9.0-beta.0:
identifier: elasticsearh-version
name: ElasticsearchVersion
parent: catalog
weight: 10
menu_name: docs_0.9.0-beta.0
section_menu_id: concepts
---

# ElasticsearchVersion

## What is ElasticsearchVersion

`ElasticsearchVersion` is a Kubernetes `Custom Resource Definitions` (CRD). It provides a declarative configuration to specify the docker images to be used for [Elasticsearch](https://www.elastic.co/products/elasticsearch) database deployed with KubeDB in Kubernetes native way.

When you install KubeDB, `ElasticsearchVersion` crd will be created automatically for every supported Elasticsearch versions. You have to specify the name of `ElasticsearchVersion` crd in `spec.version` field of [Elasticsearch](/docs/concepts/databases/elasticsearch.md) crd. Then, KubeDB will use the docker images specified in the `ElasticsearchVersion` crd to create your expected database.

Using a separate crd for specifying respective docker images allows us to modify the images independent of KubeDB operator. This will also allow the users to use a custom image for database.

## ElasticsearchVersion Specification

As with all other Kubernetes objects, a ElasticsearchVersion needs `apiVersion`, `kind`, and `metadata` fields. It also needs a `.spec` section.

```yaml
apiVersion: catalog.kubedb.com/v1alpha1
kind: ElasticsearchVersion
metadata:
name: "6.2.4-v1"
labels:
app: kubedb
spec:
version: "6.2.4"
deprecated: false
db:
image: "kubedb/elasticsearch:6.2.4-v1"
exporter:
image: "kubedb/elasticsearch_exporter:1.0.2"
tools:
image: "kubedb/elasticsearch-tools:6.2.4-v1"
```
### metadata.name
`metadata.name` is a required field that specify the name of the `ElasticsearchVersion` crd. You have to specify this name in `spec.version` field of [Elasticsearch](/docs/concepts/databases/elasticsearch.md) crd.

We follow this convention for naming ElasticsearchVersion crd:
- Name format: `{Original Elasticsearch version}-{modification tag}`

We modify original Elasticsearch docker image to support additional features like Search Guard plugin integration, custom configuration etc. and re-tag the image with v1, v2 etc. modification tag. An image with higher modification tag will have more feature than the images with lower modification tag. Hence, it is recommended to use ElasticsearchVersion crd with highest modification tag to take advantage of the latest features.

### spec.version

`spec.version` is a required field that specifies the original version of Elasticsearch database that has been used to build the docker image specified in `spec.db.image` field.

### spec.deprecated

`spec.deprecated` is an optional field that specifies whether the docker images specified here is supported by the current KubeDB operator. For example, we have modified `kubedb/elasticsearch:6.2.4` docker image to support custom configuration and re-tagged as `kubedb/elasticsearch:6.2.4-v1`. Now, KubeDB `0.9.0` supports providing custom configuration which required `kubedb/elasticsearch:6.2.4-v1` docker image. So, we have marked `kubedb/elasticsearch:6.2.4` version has been marked deprecated in KubeDB `0.9.0`.

The default value of this field is `false`. If `spec.depcrecated` is set `true`, KubeDB operator will not create the database and other respective resources for this version.

### spec.db.image

`spec.db.image` is a required field that specifies the docker image which will be used to create Statfulset by KubeDB operator to create expected Elasticsearch database.

### spec.exporter.image

`spec.exporter.image` is required field that specifies the image which will be used to export Prometheus metrics.

### spec.tools.image

`spec.tools.image` is a required field that specifies the image which will be used to take backup and initialize database from snapshot.

## Next Steps

- Learn about Elasticsearch crd [here](/docs/concepts/databases/elasticsearch.md).
- Deploy your first Elasticsearch database with KubeDB by following the guide [here](/docs/guides/elasticsearch/quickstart/quickstart.md).
Loading

0 comments on commit edcc0cc

Please sign in to comment.