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

Added README #3

Merged
merged 1 commit into from
Aug 11, 2017
Merged

Added README #3

merged 1 commit into from
Aug 11, 2017

Conversation

arshiagg
Copy link
Contributor

No description provided.

@@ -0,0 +1,14 @@
# Contiv Prometheus Integration for Kubernetes

Choose a reason for hiding this comment

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

Add a summary of what the exporter is and what it allows.

README.md Outdated
## Exporter Architecture

![Exporter Pipeline](exporter.png)

Choose a reason for hiding this comment

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

Can you split this up into sections:

  1. Prometheus setup - configuration - yaml file that is volume mounted. Add a link to the file here and describe how the different sections allow it to do pod discovery.
  2. Netplugin/Netmaster exporters - How the exporter is a web service providing a /metrics rest end point at different ports for master/netplugin
    How the pods themselves are configured with annotations to allow for the data to be fetched.
  3. Exporter implementation - Ruby code details
  4. OVS details - how there is a server started by netplugin on the port that you access and how it has traffic stats
  5. Data extraction pipeline - prometheus to exporter to netmaster/ovs pipeline

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Neelima can you please expand on what information you're looking for point 4?

Choose a reason for hiding this comment

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

For 4. Netplugin uses OpenvSwitch to program the traffic flows. Netplugin starts an ovsdb-server at port 6640. ovsdb stores information about the traffic flows and statistics.
Exporter can access the ovsdb at localhost:6640 as it is running in the same network namespace, as part of the same pod.

Copy link

@neelimamukiri neelimamukiri left a comment

Choose a reason for hiding this comment

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

LGTM. This is awesome!

@dseevr dseevr merged commit efb9602 into contiv:master Aug 11, 2017
@arshiagg arshiagg deleted the readme branch August 11, 2017 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants