You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by bm...@apache.org on 2016/02/08 17:22:32 UTC
[1/3] mesos git commit: Added script to generate docs from endpoint
help strings.
Repository: mesos
Updated Branches:
refs/heads/master af0bb8969 -> b36edb082
Added script to generate docs from endpoint help strings.
Invoke this script from anywhere within the mesos source tree
(including in the build directory) to autogenerate documentation for
all endpoint strings and install them into the docs/endpoint folder.
In a subsequent commit we commit all of these autogenerated files back
to the source repo and add a link in home.md to find them.
Review: https://reviews.apache.org/r/43220/
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/024bdd47
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/024bdd47
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/024bdd47
Branch: refs/heads/master
Commit: 024bdd470795592bfbf091045d7ba05ab873fd62
Parents: af0bb89
Author: Kevin Klues <kl...@gmail.com>
Authored: Mon Feb 8 09:11:06 2016 +0100
Committer: Benjamin Mahler <be...@gmail.com>
Committed: Mon Feb 8 17:10:33 2016 +0100
----------------------------------------------------------------------
support/generate-endpoint-help.py | 334 +++++++++++++++++++++++++++++++++
1 file changed, 334 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/024bdd47/support/generate-endpoint-help.py
----------------------------------------------------------------------
diff --git a/support/generate-endpoint-help.py b/support/generate-endpoint-help.py
new file mode 100755
index 0000000..2833384
--- /dev/null
+++ b/support/generate-endpoint-help.py
@@ -0,0 +1,334 @@
+#!/usr/bin/env python
+
+'''
+Autogenerate documentation for all process endpoints spawned by a
+Mesos master and slave.
+'''
+
+import argparse
+import atexit
+import errno
+import json
+import os
+import posixpath
+import re
+import shlex
+import shutil
+import subprocess
+import sys
+import time
+import urllib2
+
+
+# The host ip and master and agent ports.
+HOST_IP = "127.0.0.1"
+MASTER_PORT = 5050
+AGENT_PORT = 5051
+
+# The master and agent programs to launch.
+# We considered making the parameters to these commands something that
+# a user could specify on the command line, but ultimately chose to
+# hard code them. Different parameters may cause different endpoints
+# to become available, and we should modify this script to ensure that
+# we cover all of them instead of leaving that up to the user.
+MASTER_COMMAND = [
+ 'mesos-master.sh',
+ '--ip=%s' % (HOST_IP),
+ '--registry=in_memory'
+]
+
+AGENT_COMMAND = [
+ 'mesos-slave.sh',
+ '--master=%s:%s' % (HOST_IP, MASTER_PORT)
+]
+
+
+# A header to add onto all generated markdown files.
+MARKDOWN_HEADER = (
+'<!--- This is an automatically generated file. DO NOT EDIT! --->\n'
+)
+
+
+# A global timeout as well as a retry interval when hitting any http
+# endpoints on the master or agent (in seconds).
+RECEIVE_TIMEOUT = 10
+RETRY_INTERVAL = 0.10
+
+# A dictionary of the command line options passed in.
+options = {}
+
+# A pointer to the current subprocess for the master or agent.
+# This is useful for tracking the master or agent subprocesses so
+# that we can kill them if the script exits prematurely.
+current_subprocess = None
+
+
+# A pointer to the top level directory of the mesos project.
+try:
+ git_top_dir = subprocess.check_output(['git', 'rev-parse', '--show-cdup']).strip()
+ with open(os.path.join(git_top_dir, 'CHANGELOG'), 'r') as f:
+ if 'mesos' not in f.readline().lower():
+ raise
+except:
+ print >> sys.stderr, 'You must run this command from within the Mesos source repository!'
+ sys.exit(1)
+
+
+def parse_options():
+ """Parses command line options and populates the dictionary."""
+ parser = argparse.ArgumentParser(
+ formatter_class = argparse.RawTextHelpFormatter,
+ description = 'Generate markdown files from all installed HTTP '
+ 'endpoints on a Mesos master and agent process.')
+
+ parser.add_argument(
+ '-c', '--command-path',
+ metavar = 'COMMAND_PATH',
+ default = os.path.join(git_top_dir, "build/bin"),
+ help = 'Path to the Mesos master and agent commands.\n'
+ '(default: %(default)s)')
+
+ parser.add_argument(
+ '-o', '--output-path',
+ metavar = 'OUTPUT_PATH',
+ default = os.path.join(git_top_dir, "docs/endpoints"),
+ help = 'Path to the top level directory where all\n'
+ 'generated markdown files will be placed.\n'
+ '(default: %(default)s)')
+
+ args = parser.parse_args()
+
+ options['command_path'] = args.command_path
+ options['output_path'] = args.output_path
+
+
+def get_url_until_success(url):
+ """Continuously tries to open a url until it succeeds or times out."""
+ time_spent = 0
+ while (time_spent < RECEIVE_TIMEOUT):
+ try:
+ helps = urllib2.urlopen(url)
+ break
+ except:
+ time.sleep(RETRY_INTERVAL)
+ time_spent += RETRY_INTERVAL
+
+ if (time_spent >= RECEIVE_TIMEOUT):
+ print >> sys.stderr, 'Timeout attempting to hit url: %s' % (url)
+ sys.exit(1)
+
+ return helps.read()
+
+
+def get_help(ip, port):
+ """Grabs the help strings for all endpoints at http://ip:port as a JSON object."""
+ url = 'http://%s:%d/help?format=json' % (ip, port)
+ return json.loads(get_url_until_success(url))
+
+
+def generalize_endpoint_id(id):
+ """Generalizes the id of the form e.g. process(id) to slave(id)."""
+ return re.sub('\([0-9]+\)', '(id)', id)
+
+
+def normalize_endpoint_id(id):
+ """Normalizes the id of the form e.g. process(id) to process."""
+ return re.sub('\([0-9]+\)', '', id)
+
+
+def get_endpoint_path(id, name):
+ """Generates the canonical endpoint path, given id and name.
+
+ Examples: ('process', '/') -> '/process'
+ ('process(id)', '/') -> '/process(id)'
+ ('process', '/endpoint') -> '/process/endpoint'
+ """
+ new_id = generalize_endpoint_id(id)
+ new_name = name[1:] # Strip the leading slash
+ if new_name:
+ return posixpath.join('/', new_id, new_name)
+ else:
+ return posixpath.join('/', new_id)
+
+
+def get_relative_md_path(id, name):
+ """Generates the relative path of the generated .md file from id and name.
+
+ This path is relative to the options['output_path'] directory.
+
+ Examples: master/health.md
+ master/maintenance/schedule.md
+ registrar/registry.md
+ version.md
+ """
+ new_id = normalize_endpoint_id(id)
+ new_name = name[1:] # Strip the leading slash
+ if new_name:
+ return os.path.join(new_id, new_name + '.md')
+ else:
+ return os.path.join(new_id + '.md')
+
+
+def write_markdown(path, output):
+ """Writes 'output' to the file at 'path'."""
+ print 'generating: %s' % (path)
+
+ dirname = os.path.dirname(path)
+ if not os.path.exists(dirname):
+ os.makedirs(dirname)
+
+ outfile = open(path, 'w+')
+
+ # Add our header and remove all '\n's at the end of the output if
+ # there are any.
+ output = MARKDOWN_HEADER + '\n' + output.rstrip()
+
+ outfile.write(output)
+ outfile.close()
+
+
+def dump_index_markdown(master_help, agent_help):
+ """Dumps an index for linking to the master and agent help files.
+
+ This file is dumped into a directory rooted at
+ options['output_path'].
+ """
+
+ # The output template for the HTTP endpoints index.
+ # We use a helper function below to insert text into the '%s' format
+ # strings contained in the "Master Endpoints" and "Agent Endpoints"
+ # sections of this template.
+ output = (
+"""
+# HTTP Endpoints #
+
+Below is a list of HTTP endpoints available for a given Mesos process.
+
+Depending on your configuration, some subset of these endpoints will
+be available on your Mesos master or agent. Additionally, a `/help`
+endpoint will be available that displays help similar to what you see
+below.
+
+** NOTE: ** The documentation for these endpoints is auto-generated
+from strings stored in the Mesos source code. See
+support/generate-endpoint-help.py.
+
+## Master Endpoints ##
+
+Below is a set of endpoints available on a Mesos master. These
+endpoints are reachable at the address http://ip:port/endpoint.
+
+For example, http://master.com:5050/files/browse
+
+%s
+
+## Agent Endpoints ##
+
+Below is a set of endpoints available on a Mesos agent. These
+endpoints are reachable at the address http://ip:port/endpoint.
+
+For example, http://agent.com:5051/files/browse
+
+%s
+"""
+ )
+
+ def generate_links(help):
+ """Iterates over the input JSON and creates a list of links to
+ to the markdown files generated by this script. These links
+ are grouped per process, with the process's name serving as a
+ header for each group. All links are relative to
+ options['output_path'].
+
+ For example:
+ ### profiler ###
+ * [/profiler/start] (profiler/start.md)
+ * [/profiler/stop] (profiler/stop.md)
+
+ ### version ###
+ * [/version] (version.md)
+ """
+ output = ""
+ for process in help['processes']:
+ id = process['id']
+ output += '### %s ###\n' % (generalize_endpoint_id(id))
+ for endpoint in process['endpoints']:
+ name = endpoint['name']
+ output += '* [%s](%s)\n' % (get_endpoint_path(id, name),
+ get_relative_md_path(id, name))
+ output += '\n'
+
+ # Remove any trailing newlines
+ return output.rstrip()
+
+ output = output % (generate_links(master_help),
+ generate_links(agent_help))
+
+ path = os.path.join(options['output_path'], 'index.md')
+ write_markdown(path, output)
+
+
+def dump_markdown(help):
+ """Dumps JSON encoded help strings into markdown files.
+
+ These files are dumped into a directory rooted at
+ options['output_path'].
+ """
+ for process in help['processes']:
+ id = process['id']
+ for endpoint in process['endpoints']:
+ name = endpoint['name']
+ text = endpoint['text']
+
+ relative_path = get_relative_md_path(id, name)
+ path = os.path.join(options['output_path'], relative_path)
+ write_markdown(path, text)
+
+
+def start_master():
+ """Starts the Mesos master using the specified command.
+
+ This method returns the Popen object used to start it so it can
+ be killed later on.
+ """
+ cmd = os.path.join('.', options['command_path'], MASTER_COMMAND[0])
+ master = subprocess.Popen([cmd] + MASTER_COMMAND[1:])
+
+ # Wait for the master to become responsive
+ get_url_until_success("http://%s:%d/health" % (HOST_IP, MASTER_PORT))
+ return master
+
+
+def start_agent():
+ """Starts the Mesos agent using the specified command.
+
+ This method returns the Popen object used to start it so it can
+ be killed later on.
+ """
+ cmd = os.path.join('.', options['command_path'], AGENT_COMMAND[0])
+ agent = subprocess.Popen([cmd] + AGENT_COMMAND[1:])
+
+ # Wait for the agent to become responsive.
+ get_url_until_success('http://%s:%d/health' % (HOST_IP, AGENT_PORT))
+ return agent
+
+
+if __name__ == '__main__':
+ parse_options()
+
+ atexit.register(lambda: current_subprocess.kill())
+
+ current_subprocess = start_master()
+ master_help = get_help(HOST_IP, MASTER_PORT)
+ current_subprocess.kill()
+
+ current_subprocess = start_agent()
+ agent_help = get_help(HOST_IP, AGENT_PORT)
+ current_subprocess.kill()
+
+ shutil.rmtree(options['output_path'], ignore_errors=True)
+ os.makedirs(options['output_path'])
+
+ dump_index_markdown(master_help, agent_help)
+ dump_markdown(master_help)
+ dump_markdown(agent_help)
[3/3] mesos git commit: Updated generated endpoint documentation.
Posted by bm...@apache.org.
Updated generated endpoint documentation.
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/b36edb08
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/b36edb08
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/b36edb08
Branch: refs/heads/master
Commit: b36edb08257e9a4fab1dfde641406e55f0f81478
Parents: d264244
Author: Benjamin Mahler <be...@gmail.com>
Authored: Mon Feb 8 17:22:11 2016 +0100
Committer: Benjamin Mahler <be...@gmail.com>
Committed: Mon Feb 8 17:22:11 2016 +0100
----------------------------------------------------------------------
docs/endpoints/files/browse.json.md | 1 +
docs/endpoints/files/browse.md | 1 +
docs/endpoints/files/debug.json.md | 1 +
docs/endpoints/files/debug.md | 1 +
docs/endpoints/files/download.json.md | 1 +
docs/endpoints/files/download.md | 1 +
docs/endpoints/files/read.json.md | 1 +
docs/endpoints/files/read.md | 1 +
docs/endpoints/index.md | 4 +++-
docs/endpoints/logging/toggle.md | 3 ++-
docs/endpoints/master/api/v1/scheduler.md | 1 +
docs/endpoints/master/create-volumes.md | 1 +
docs/endpoints/master/destroy-volumes.md | 1 +
docs/endpoints/master/flags.md | 1 +
docs/endpoints/master/frameworks.md | 1 +
docs/endpoints/master/health.md | 1 +
docs/endpoints/master/machine/down.md | 1 +
docs/endpoints/master/machine/up.md | 1 +
docs/endpoints/master/maintenance/schedule.md | 1 +
docs/endpoints/master/maintenance/status.md | 1 +
docs/endpoints/master/observe.md | 1 +
docs/endpoints/master/quota.md | 1 +
docs/endpoints/master/redirect.md | 1 +
docs/endpoints/master/reserve.md | 1 +
docs/endpoints/master/roles.json.md | 1 +
docs/endpoints/master/roles.md | 1 +
docs/endpoints/master/slaves.md | 1 +
docs/endpoints/master/state-summary.md | 1 +
docs/endpoints/master/state.json.md | 1 +
docs/endpoints/master/state.md | 1 +
docs/endpoints/master/tasks.json.md | 1 +
docs/endpoints/master/tasks.md | 1 +
docs/endpoints/master/teardown.md | 1 +
docs/endpoints/master/unreserve.md | 1 +
docs/endpoints/metrics/snapshot.md | 1 +
docs/endpoints/monitor/statistics.json.md | 1 +
docs/endpoints/monitor/statistics.md | 1 +
docs/endpoints/profiler/start.md | 1 +
docs/endpoints/profiler/stop.md | 1 +
docs/endpoints/registrar/registry.md | 1 +
docs/endpoints/slave/api/v1/executor.md | 1 +
docs/endpoints/slave/flags.md | 1 +
docs/endpoints/slave/health.md | 1 +
docs/endpoints/slave/state.json.md | 1 +
docs/endpoints/slave/state.md | 1 +
docs/endpoints/system/stats.json.md | 1 +
docs/endpoints/version.md | 1 +
47 files changed, 50 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/files/browse.json.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/files/browse.json.md b/docs/endpoints/files/browse.json.md
index 1e14d3e..7c70493 100644
--- a/docs/endpoints/files/browse.json.md
+++ b/docs/endpoints/files/browse.json.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /files/browse.json
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/files/browse.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/files/browse.md b/docs/endpoints/files/browse.md
index f249fe3..5aa685a 100644
--- a/docs/endpoints/files/browse.md
+++ b/docs/endpoints/files/browse.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /files/browse
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/files/debug.json.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/files/debug.json.md b/docs/endpoints/files/debug.json.md
index d4eff9a..3e41fec 100644
--- a/docs/endpoints/files/debug.json.md
+++ b/docs/endpoints/files/debug.json.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /files/debug.json
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/files/debug.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/files/debug.md b/docs/endpoints/files/debug.md
index b303583..f3ff381 100644
--- a/docs/endpoints/files/debug.md
+++ b/docs/endpoints/files/debug.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /files/debug
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/files/download.json.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/files/download.json.md b/docs/endpoints/files/download.json.md
index a801c64..77c6b97 100644
--- a/docs/endpoints/files/download.json.md
+++ b/docs/endpoints/files/download.json.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /files/download.json
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/files/download.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/files/download.md b/docs/endpoints/files/download.md
index f669708..2b8b3f5 100644
--- a/docs/endpoints/files/download.md
+++ b/docs/endpoints/files/download.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /files/download
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/files/read.json.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/files/read.json.md b/docs/endpoints/files/read.json.md
index 9382937..f86f227 100644
--- a/docs/endpoints/files/read.json.md
+++ b/docs/endpoints/files/read.json.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /files/read.json
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/files/read.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/files/read.md b/docs/endpoints/files/read.md
index c5ba6bd..31dd90c 100644
--- a/docs/endpoints/files/read.md
+++ b/docs/endpoints/files/read.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /files/read
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/index.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/index.md b/docs/endpoints/index.md
index 48eef37..69d2157 100644
--- a/docs/endpoints/index.md
+++ b/docs/endpoints/index.md
@@ -1,5 +1,6 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
# HTTP Endpoints #
Below is a list of HTTP endpoints available for a given Mesos process.
@@ -10,7 +11,8 @@ endpoint will be available that displays help similar to what you see
below.
** NOTE: ** The documentation for these endpoints is auto-generated
-from strings stored in the Mesos source code.
+from strings stored in the Mesos source code. See
+support/generate-endpoint-help.py.
## Master Endpoints ##
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/logging/toggle.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/logging/toggle.md b/docs/endpoints/logging/toggle.md
index c051788..baa4d1b 100644
--- a/docs/endpoints/logging/toggle.md
+++ b/docs/endpoints/logging/toggle.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /logging/toggle
@@ -8,7 +9,7 @@ Sets the logging verbosity level for a specified duration.
### DESCRIPTION ###
The libprocess library uses [glog][glog] for logging. The library
only uses verbose logging which means nothing will be output unless
-the verbosity level is set (by default it's 0, libprocess useslevels 1, 2, and 3).
+the verbosity level is set (by default it's 0, libprocess uses levels 1, 2, and 3).
**NOTE:** If your application uses glog this will also affect
your verbose logging.
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/api/v1/scheduler.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/api/v1/scheduler.md b/docs/endpoints/master/api/v1/scheduler.md
index 72186e4..6faa1c2 100644
--- a/docs/endpoints/master/api/v1/scheduler.md
+++ b/docs/endpoints/master/api/v1/scheduler.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/api/v1/scheduler
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/create-volumes.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/create-volumes.md b/docs/endpoints/master/create-volumes.md
index 779662d..f167452 100644
--- a/docs/endpoints/master/create-volumes.md
+++ b/docs/endpoints/master/create-volumes.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/create-volumes
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/destroy-volumes.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/destroy-volumes.md b/docs/endpoints/master/destroy-volumes.md
index 104dd75..a9a12ad 100644
--- a/docs/endpoints/master/destroy-volumes.md
+++ b/docs/endpoints/master/destroy-volumes.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/destroy-volumes
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/flags.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/flags.md b/docs/endpoints/master/flags.md
index 0f066b8..b63b6e2 100644
--- a/docs/endpoints/master/flags.md
+++ b/docs/endpoints/master/flags.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/flags
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/frameworks.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/frameworks.md b/docs/endpoints/master/frameworks.md
index bce7c29..bc21f1e 100644
--- a/docs/endpoints/master/frameworks.md
+++ b/docs/endpoints/master/frameworks.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/frameworks
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/health.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/health.md b/docs/endpoints/master/health.md
index c4f436f..39af4f9 100644
--- a/docs/endpoints/master/health.md
+++ b/docs/endpoints/master/health.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/health
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/machine/down.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/machine/down.md b/docs/endpoints/master/machine/down.md
index 3c9e9d8..82cce61 100644
--- a/docs/endpoints/master/machine/down.md
+++ b/docs/endpoints/master/machine/down.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/machine/down
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/machine/up.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/machine/up.md b/docs/endpoints/master/machine/up.md
index 005655c..5bfd95e 100644
--- a/docs/endpoints/master/machine/up.md
+++ b/docs/endpoints/master/machine/up.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/machine/up
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/maintenance/schedule.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/maintenance/schedule.md b/docs/endpoints/master/maintenance/schedule.md
index 882019f..e91ee81 100644
--- a/docs/endpoints/master/maintenance/schedule.md
+++ b/docs/endpoints/master/maintenance/schedule.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/maintenance/schedule
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/maintenance/status.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/maintenance/status.md b/docs/endpoints/master/maintenance/status.md
index edb2a18..17e3eef 100644
--- a/docs/endpoints/master/maintenance/status.md
+++ b/docs/endpoints/master/maintenance/status.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/maintenance/status
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/observe.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/observe.md b/docs/endpoints/master/observe.md
index c474c49..acdc18c 100644
--- a/docs/endpoints/master/observe.md
+++ b/docs/endpoints/master/observe.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/observe
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/quota.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/quota.md b/docs/endpoints/master/quota.md
index 0084a4c..26c7bb1 100644
--- a/docs/endpoints/master/quota.md
+++ b/docs/endpoints/master/quota.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/quota
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/redirect.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/redirect.md b/docs/endpoints/master/redirect.md
index 3e91d32..4a230e4 100644
--- a/docs/endpoints/master/redirect.md
+++ b/docs/endpoints/master/redirect.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/redirect
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/reserve.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/reserve.md b/docs/endpoints/master/reserve.md
index ed16f73..6d4dee4 100644
--- a/docs/endpoints/master/reserve.md
+++ b/docs/endpoints/master/reserve.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/reserve
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/roles.json.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/roles.json.md b/docs/endpoints/master/roles.json.md
index fd6503b..d67779c 100644
--- a/docs/endpoints/master/roles.json.md
+++ b/docs/endpoints/master/roles.json.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/roles.json
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/roles.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/roles.md b/docs/endpoints/master/roles.md
index ae37562..976a9b7 100644
--- a/docs/endpoints/master/roles.md
+++ b/docs/endpoints/master/roles.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/roles
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/slaves.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/slaves.md b/docs/endpoints/master/slaves.md
index 7ca6f72..0be05d7 100644
--- a/docs/endpoints/master/slaves.md
+++ b/docs/endpoints/master/slaves.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/slaves
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/state-summary.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/state-summary.md b/docs/endpoints/master/state-summary.md
index 03aa655..a6d79f0 100644
--- a/docs/endpoints/master/state-summary.md
+++ b/docs/endpoints/master/state-summary.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/state-summary
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/state.json.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/state.json.md b/docs/endpoints/master/state.json.md
index 164a0ba..e13993e 100644
--- a/docs/endpoints/master/state.json.md
+++ b/docs/endpoints/master/state.json.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/state.json
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/state.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/state.md b/docs/endpoints/master/state.md
index e9225da..7571d31 100644
--- a/docs/endpoints/master/state.md
+++ b/docs/endpoints/master/state.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/state
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/tasks.json.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/tasks.json.md b/docs/endpoints/master/tasks.json.md
index 3db0426..cb1856f 100644
--- a/docs/endpoints/master/tasks.json.md
+++ b/docs/endpoints/master/tasks.json.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/tasks.json
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/tasks.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/tasks.md b/docs/endpoints/master/tasks.md
index 8654bf7..e8dbf93 100644
--- a/docs/endpoints/master/tasks.md
+++ b/docs/endpoints/master/tasks.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/tasks
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/teardown.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/teardown.md b/docs/endpoints/master/teardown.md
index 151d55f..9cd8639 100644
--- a/docs/endpoints/master/teardown.md
+++ b/docs/endpoints/master/teardown.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/teardown
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/master/unreserve.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/master/unreserve.md b/docs/endpoints/master/unreserve.md
index 9a4925e..81c72d3 100644
--- a/docs/endpoints/master/unreserve.md
+++ b/docs/endpoints/master/unreserve.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /master/unreserve
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/metrics/snapshot.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/metrics/snapshot.md b/docs/endpoints/metrics/snapshot.md
index 62f5f0f..ab37ab4 100644
--- a/docs/endpoints/metrics/snapshot.md
+++ b/docs/endpoints/metrics/snapshot.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /metrics/snapshot
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/monitor/statistics.json.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/monitor/statistics.json.md b/docs/endpoints/monitor/statistics.json.md
index 06d5e73..5ce4fc6 100644
--- a/docs/endpoints/monitor/statistics.json.md
+++ b/docs/endpoints/monitor/statistics.json.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /monitor/statistics.json
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/monitor/statistics.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/monitor/statistics.md b/docs/endpoints/monitor/statistics.md
index c5cade3..602104b 100644
--- a/docs/endpoints/monitor/statistics.md
+++ b/docs/endpoints/monitor/statistics.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /monitor/statistics
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/profiler/start.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/profiler/start.md b/docs/endpoints/profiler/start.md
index 3d97be8..244fd6f 100644
--- a/docs/endpoints/profiler/start.md
+++ b/docs/endpoints/profiler/start.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /profiler/start
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/profiler/stop.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/profiler/stop.md b/docs/endpoints/profiler/stop.md
index bc490af..6b9738a 100644
--- a/docs/endpoints/profiler/stop.md
+++ b/docs/endpoints/profiler/stop.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /profiler/stop
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/registrar/registry.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/registrar/registry.md b/docs/endpoints/registrar/registry.md
index 3a262b1..12b11fe 100644
--- a/docs/endpoints/registrar/registry.md
+++ b/docs/endpoints/registrar/registry.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /registrar(1)/registry
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/slave/api/v1/executor.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/slave/api/v1/executor.md b/docs/endpoints/slave/api/v1/executor.md
index a9318e4..e92df49 100644
--- a/docs/endpoints/slave/api/v1/executor.md
+++ b/docs/endpoints/slave/api/v1/executor.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /slave(1)/api/v1/executor
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/slave/flags.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/slave/flags.md b/docs/endpoints/slave/flags.md
index 7e459b3..8abbc72 100644
--- a/docs/endpoints/slave/flags.md
+++ b/docs/endpoints/slave/flags.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /slave(1)/flags
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/slave/health.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/slave/health.md b/docs/endpoints/slave/health.md
index 51045e9..265dcfa 100644
--- a/docs/endpoints/slave/health.md
+++ b/docs/endpoints/slave/health.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /slave(1)/health
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/slave/state.json.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/slave/state.json.md b/docs/endpoints/slave/state.json.md
index 338c8ab..10f7a74 100644
--- a/docs/endpoints/slave/state.json.md
+++ b/docs/endpoints/slave/state.json.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /slave(1)/state.json
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/slave/state.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/slave/state.md b/docs/endpoints/slave/state.md
index 8e6da6f..40df6a8 100644
--- a/docs/endpoints/slave/state.md
+++ b/docs/endpoints/slave/state.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /slave(1)/state
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/system/stats.json.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/system/stats.json.md b/docs/endpoints/system/stats.json.md
index e1994c0..a5fb58f 100644
--- a/docs/endpoints/system/stats.json.md
+++ b/docs/endpoints/system/stats.json.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /system/stats.json
http://git-wip-us.apache.org/repos/asf/mesos/blob/b36edb08/docs/endpoints/version.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/version.md b/docs/endpoints/version.md
index 1166479..07a9f6c 100644
--- a/docs/endpoints/version.md
+++ b/docs/endpoints/version.md
@@ -1,4 +1,5 @@
<!--- This is an automatically generated file. DO NOT EDIT! --->
+
### USAGE ###
> /version
[2/3] mesos git commit: Updated endpoints/index.md.
Posted by bm...@apache.org.
Updated endpoints/index.md.
The index was updated to reflect updates to the
generate-endpoints-help.py script used to generate it.
Review: https://reviews.apache.org/r/43324/
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/d264244f
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/d264244f
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/d264244f
Branch: refs/heads/master
Commit: d264244f8db5772affcd9e6acdbd0e5952fe1498
Parents: 024bdd4
Author: Kevin Klues <kl...@gmail.com>
Authored: Mon Feb 8 17:21:10 2016 +0100
Committer: Benjamin Mahler <be...@gmail.com>
Committed: Mon Feb 8 17:21:10 2016 +0100
----------------------------------------------------------------------
docs/endpoints/index.md | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/d264244f/docs/endpoints/index.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/index.md b/docs/endpoints/index.md
index f702ff5..48eef37 100644
--- a/docs/endpoints/index.md
+++ b/docs/endpoints/index.md
@@ -3,20 +3,21 @@
# HTTP Endpoints #
Below is a list of HTTP endpoints available for a given Mesos process.
-The documentation for these endpoints is auto-generated from strings
-stored in the Mesos source code.
Depending on your configuration, some subset of these endpoints will
-be available on your Mesos master or agent. Additionally, a '/help'
+be available on your Mesos master or agent. Additionally, a `/help`
endpoint will be available that displays help similar to what you see
below.
+** NOTE: ** The documentation for these endpoints is auto-generated
+from strings stored in the Mesos source code.
+
## Master Endpoints ##
Below is a set of endpoints available on a Mesos master. These
endpoints are reachable at the address http://ip:port/endpoint.
-For example, http://master.mesosphere.com:5050/files/browse
+For example, http://master.com:5050/files/browse
### files ###
* [/files/browse](files/browse.md)
@@ -78,7 +79,7 @@ For example, http://master.mesosphere.com:5050/files/browse
Below is a set of endpoints available on a Mesos agent. These
endpoints are reachable at the address http://ip:port/endpoint.
-For example, http://agent.mesosphere.com:5051/files/browse
+For example, http://agent.com:5051/files/browse
### files ###
* [/files/browse](files/browse.md)