Skip to content

timothy-spencer/cf-elk

Repository files navigation

ELK for cloud.gov

This repository contains minimal ELK stack for testing deployment to cloud.gov, in particular, and other instances of Cloud Foundry ("CF") in general.

For cloud.gov, follow the quickstart guide for a guided tour, or follow the USAGE below.

Usage

  1. Follow the Cloud Foundry command-line (CLI) setup instructions.
  2. Log into your Cloud Foundry account. (For example, if you use cloud.gov, follow the "Set up the command line" instructions to log in.)
  3. Clone or download this repository, and cd into the directory cf-elk.
  4. run the deploy script with ./deploy.sh. It should:
    1. Clone the kibana repo with a specific version that we tested out.
    2. Copy in config that updates the node version to the latest (as of this writing) version that is compatible with kibana.
    3. Copies in a special startup script that we use to configure kibana at runtime to use the ES service we created above.
    4. Create an elasticsearch service for you.
    5. Deploys kibana with cf push
    6. Configures and launches the elk-logstash docker instance
    7. Sets up the internal service that can be used to drain logs into.
    8. Loads some sample data into ES. This may take a while.
  5. Get the username/password/URL that you will need to use to log into kibana from the end of the output of the script.
  6. Go to the URL. You may need to wait a bit here for kibana to fully launch.
  7. You may now set a default index (probably @timestamp) and start searching! Be aware that the data is kind of old, so you might need to set the search scope to be the last 5 years rather than the last 15 minutes.
  8. There is a logstash instance living on the elk-logstash app URL. You should be able to configure filebeat to send logs to it like so:
output.logstash:
  hosts: ["elk-logstash-<whatever>.app.cloud.gov:443"]
  ssl: true

See also

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

About

An implementation of an ELK stack in Cloud Foundry

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published