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.

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

[DevOps] adding readme for how to deploy elasticstack using helm charts #565

Merged
merged 4 commits into from
Apr 23, 2020

Conversation

fxdgear
Copy link
Contributor

@fxdgear fxdgear commented Apr 22, 2020

Link to issue

Changelog entry

  • README on how to use helm to install elastic stack into an elastic-stack namespace in a k8s cluster.

Additional info

This has been deployed already for testing into the test-es namespace on preprod. This namespace can be deleted at anytime.

I'd suggest a review of the available overrides for each helmchart to ensure that the right settings are getting set that meet the needs for this project.

The default settings have been applied to each service in the Elastic Stack so far and that means:

  • metricbeat is pulling metric data from all pods in all namespaces
  • filebeat is pulling all logs from all pods in all namespaces
  • kibana is running without an ingress, which means you need to configure port forwarding to access kibana
  • elasticsearch has no default username/password (also there is no ingress so you must have port forwarding enabled to access elasticsearch).
  • AMP server is configured to connect to elasticsearch, but no data is being shipped to APM server yet. This is something that the CHIME app would need to be updated to support.

Pull Request Checklist

For Reviewer

  • Submitted under the correct tag
  • Runs without error or warning
  • Documentation revised / included
  • Unit tests included
  • Issues referenced
  • Does not create new bugs / issues

@MooseQuest
Copy link
Collaborator

For APM an issue has been opened to track #566

Copy link
Collaborator

@MooseQuest MooseQuest left a comment

Choose a reason for hiding this comment

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

This looks good to me. This is enough of a readme to get started.

Copy link
Contributor

@lottspot lottspot left a comment

Choose a reason for hiding this comment

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

I think it's more appropriate if we file this information under docs/. Maybe docs/helm or something like that.

@lottspot
Copy link
Contributor

lottspot commented Apr 22, 2020

Er... make that docs/operations/helm

@fxdgear
Copy link
Contributor Author

fxdgear commented Apr 22, 2020

I think it's more appropriate if we file this information under docs/. Maybe docs/helm or something like that.

Moving to Docs makes sense.

I was hoping that this README would live next to the customized values yaml files.

BUT maybe this does make more sense in the docs directory and a more terse readme can live here, and reference the docs directory.

@lottspot
Copy link
Contributor

lottspot commented Apr 22, 2020

@fxdgear We have generally been keeping documentation in docs/operations/ and operational files under k8s/

@lottspot lottspot added documentation Improvements or additions to documentation k8s infra Requires work on ops-facing workloads which support k8s app labels Apr 22, 2020
@fxdgear
Copy link
Contributor Author

fxdgear commented Apr 23, 2020

@lottspot PTAL. I've updated the locations of files as well as updated the README to reference the new locations.

Copy link
Contributor

@lottspot lottspot left a comment

Choose a reason for hiding this comment

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

Looks good!

@lottspot lottspot merged commit 8a8c569 into CodeForPhilly:develop Apr 23, 2020
@fxdgear fxdgear deleted the nick/elastic-stack-helm branch April 23, 2020 19:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation k8s infra Requires work on ops-facing workloads which support k8s app
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants