Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
po3rin committed Nov 6, 2020
1 parent ad4e5e4 commit f2e4cfe
Showing 1 changed file with 19 additions and 13 deletions.
32 changes: 19 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,6 @@ eskeeper synchronizes index and alias with configuration files while ensuring id
- [x] update
- [ ] delete

## :mag_right: Stages

eskeeper process is divided into four stages.

```bash
validation config stage # validation config format
pre-check stage # check creating process and mapping
sync stage # sync index and alias with config
post-check stage # check index and alias has created or update
```

## :four_leaf_clover: Quick Start

Expand Down Expand Up @@ -93,6 +80,25 @@ eskeeper -u user -p pass -e=http://localhost:9200,http://localhost9300 < testdat
ESKEEPER_ES_USER=user ESKEEPER_ES_PASS=pass ESKEEPER_ES_URLS=http://localhost:9200 eskeeper < testdata/es.yaml
```

## :mag_right: Stages

eskeeper process is divided into four stages.

#### validation config stage
* Validates config yaml format

#### pre-check stage

* Check if mapping file is valid format
* Check if there is an index for alias

#### sync stage
* Sync indices and aliases with config

#### post-check stage
* Check if indices & aliases has been created


## :triangular_flag_on_post: Contributing

Did you find something technically wrong, something to fix, or something? Please give me Issue or Pull Request !!

0 comments on commit f2e4cfe

Please sign in to comment.