helm-elasticsearch icon indicating copy to clipboard operation
helm-elasticsearch copied to clipboard

Flesh out README.md

Open clockworksoul opened this issue 6 years ago • 7 comments

The README file is depressingly sparse. I haven't had the time or energy to update it, but since it's the face of the project, and the project is starting to get some eyes, I'd like to consider this a priority.

Really, even if we just copy and modify the pires/kubernetes-elasticsearch-cluster README I think that should be fine.

I'll try to take care of this this weekend if nobody beats me to it.

clockworksoul avatar Nov 17 '17 14:11 clockworksoul

Crap, I just saw that you assigned this to yourself after I nearly finished a README.

Would you mind if I submit a PR, and we can choose our favorite?

clockworksoul avatar Nov 18 '17 20:11 clockworksoul

I pushed my work so far (a copy/modify of the pires/kubernetes-elasticsearch-cluster README) to the enbiggen-readme branch. I put it down at the Kibana section, so anything after that still refers to kubectl and the like.

If you like it, you can feel free to adopt and modify it. If your work is further along or is otherwise better, even better! 😄 In any case, I don't want to step on or reproduce your efforts. Apologies for not checking for an assignee.

clockworksoul avatar Nov 18 '17 20:11 clockworksoul

No problem, haven't started anything yet.

sagikazarmark avatar Nov 19 '17 08:11 sagikazarmark

Not sure duplicating that much content from pires is a good idea. I would rather link to the other repository in some cases.

One more thing that I would add: a table of configuration variables (as seen in many official charts)

sagikazarmark avatar Nov 19 '17 08:11 sagikazarmark

Not sure duplicating that much content from pires is a good idea. I would rather link to the other repository in some cases.

Yeah, you're probably right. I'll pare it down.

a table of configuration variables (as seen in many official charts)

Good thinking. I'll add that too.

I may get to make more progress on this today. I'd like to get it in place asap though.

clockworksoul avatar Nov 19 '17 15:11 clockworksoul

Any update on README? One question I have is if this HELM is based on deployment or Statefulset. I see Pire now supports both :) I'm interested in statefulset one because of data persistence with VolumeClaim. Can you confirm this helm currently does not persist data if loosing all data nodes?

Vince-Cercury avatar Feb 26 '18 04:02 Vince-Cercury

This chart supports both kinds as well. Check the values.yaml file.

sagikazarmark avatar Feb 26 '18 08:02 sagikazarmark