Feature/Design HWSC CLI App

faraonc commented 5 years ago

Description

As a software engineer, I need to be able to manage services and resources.

I suggest you read all the brief tutorials starting from https://www.elastic.co/guide/en/elasticsearch/reference/7.0/getting-started.html

I am referring about the guide in the picture I posted. The image does not include all of the tutorials. You MIGHT have to read some of them. Screen Shot 2019-05-15 at 1 04 34 AM

Requirements

Scalability

Design HWSC CLI app in a way that it can be used as a library if it is not being using as a CLI app. An example would be https://github.com/golang-migrate/migrate#use-in-your-go-project. In this way, we can use it in with other services.

Features

hwsc CLI app should be able to perform the following:

help

A help command to show a summary of commands and options that are available.

manage ElasticSearch

making an index given a name and json file with the provided mapping https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html#_example_mapping
READ the following carefully:
- https://www.elastic.co/guide/en/elasticsearch/reference/current/indices.html
- https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html**
json file mapping needs to be versionized and stored a folder called templates

NOTE about updating field mappings


Updating field mappings
In general, the mapping for existing fields cannot be updated. There are some exceptions to this rule. For instance:

new properties can be added to Object datatype fields.
new multi-fields can be added to existing fields.
the ignore_above parameter can be updated.
checking the status of elastic search e.g. disk space, nodes, shards, CPU, RAM

Story Points

8

Definition of Done

[x] command to check ES cluster health (keep it in my mind that this CLI is not just strictly for ES... maybe a command like hwsc es health)
[x] a helpful guide e.g. hwsc help? or hwsc help es health or hwsc es help health (this depends on the CLI library https://github.com/spf13/cobra we are using)
[x] good CLI messages
[ ] ~unit test~ separate task