Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Elasticsearch documentation #172

Merged
merged 15 commits into from
Feb 24, 2018
Merged

Update Elasticsearch documentation #172

merged 15 commits into from
Feb 24, 2018

Conversation

mirshahriar
Copy link
Contributor

@mirshahriar mirshahriar commented Feb 20, 2018 •
edited
Loading

User Guide

  • search-guard
    • create_certificate: for Search Guard TLS on Transport & HTTP layer
    • use_certificate: while accessing Elasticsearch server
    • configuration: for Search Guard
  • clustering
    • topology : Use dedicated node for Elasticsearch cluster role
  • initialization
    • snapshot_source: Initialize a Elasticsearch database with existing snapshot data
  • monitoring
    • using_builtin_prometheus: Monitor Elasticsearch database using builtin Prometheus
    • using_coreos_prometheus_operator: Monitor Elasticsearch using CoreOS Prometheus
  • private-registry
    • using-private-registry: Use non-public docker image
  • snapshot
    • instant_backup: Take instant backup of a Elasticsearch database
    • scheduled_backup: KubeDB supports taking periodic backups
  • quickstart: Use KubeDB to run a Elasticsearch database
  • README

the-redback
the-redback suggested changes Feb 22, 2018
View reviewed changes
docs/guides/elasticsearch/initialization/snapshot_source.md Outdated

* Populate database with some data. Follow [this](https://github.com/kubedb/cli/blob/master/docs/guides/elasticsearch/snapshot/instant_backup.md#populate-database).
* Create storage Secret.<br>In this tutorial, we need a storage Secret for backup process
```console
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One blank line before each codeblock

docs/guides/elasticsearch/initialization/snapshot_source.md Outdated
--from-file=./GOOGLE_SERVICE_ACCOUNT_JSON_KEY
secret "gcs-secret" created
```
* Take an instant backup, if not available. Follow [this](https://github.com/kubedb/cli/blob/master/docs/guides/elasticsearch/snapshot/instant_backup.md#instant-backup).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One blank line after each codeblock

docs/guides/elasticsearch/clustering/topology.md Outdated
KubeDB Elasticsearch supports multi-node database cluster.

### Before You Begin
At first, you need to have a Kubernetes cluster, and the kubectl command-line tool must be configured to communicate with your cluster.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One blank before and after each heading.

docs/guides/elasticsearch/initialization/snapshot_source.md Outdated

KubeDB supports Elasticsearch database initialization.

### Before You Begin
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2nd level heading for before you begin. ##

@the-redback the-redback mentioned this pull request Feb 22, 2018
Merged
@tamalsaha tamalsaha closed this Feb 24, 2018
@tamalsaha tamalsaha reopened this Feb 24, 2018
@tamalsaha tamalsaha merged commit cb4d001 into master Feb 24, 2018
@tamalsaha tamalsaha deleted the elasticsearch-docs branch February 24, 2018 20:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@the-redback the-redback the-redback requested changes

@tamalsaha tamalsaha Awaiting requested review from tamalsaha

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mirshahriar @the-redback @tamalsaha