Repository: mesos Updated Branches: refs/heads/master b9651f654 -> 16fe3472d
Updated endpoints help. Auto-generated by running support/generate-endpoint-help.py. Project: http://git-wip-us.apache.org/repos/asf/mesos/repo Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/16fe3472 Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/16fe3472 Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/16fe3472 Branch: refs/heads/master Commit: 16fe3472de3e6831dd9ffdbfee56af57af2e1a17 Parents: 7b35cd9 Author: Vinod Kone <vinodk...@gmail.com> Authored: Fri Jul 22 11:57:07 2016 -0700 Committer: Vinod Kone <vinodk...@gmail.com> Committed: Fri Jul 22 11:58:17 2016 -0700 ---------------------------------------------------------------------- docs/endpoints/files/browse.json.md | 2 +- docs/endpoints/files/browse.md | 2 +- docs/endpoints/files/debug.json.md | 6 +----- docs/endpoints/files/debug.md | 6 +----- docs/endpoints/files/download.json.md | 2 +- docs/endpoints/files/download.md | 2 +- docs/endpoints/files/read.json.md | 2 +- docs/endpoints/files/read.md | 2 +- docs/endpoints/master/api/v1.md | 9 +-------- docs/endpoints/master/api/v1/scheduler.md | 7 +------ docs/endpoints/master/create-volumes.md | 8 +------- docs/endpoints/master/destroy-volumes.md | 8 +------- docs/endpoints/master/flags.md | 2 +- docs/endpoints/master/frameworks.md | 6 +----- docs/endpoints/master/reserve.md | 8 +------- docs/endpoints/master/state-summary.md | 10 +--------- docs/endpoints/master/state.json.md | 14 +++----------- docs/endpoints/master/state.md | 14 +++----------- docs/endpoints/master/tasks.json.md | 10 +--------- docs/endpoints/master/tasks.md | 10 +--------- docs/endpoints/master/teardown.md | 8 +------- docs/endpoints/master/unreserve.md | 8 +------- docs/endpoints/slave/api/v1.md | 3 +-- docs/endpoints/slave/flags.md | 2 +- docs/endpoints/slave/state.json.md | 10 +--------- docs/endpoints/slave/state.md | 10 +--------- 26 files changed, 30 insertions(+), 141 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/files/browse.json.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/files/browse.json.md b/docs/endpoints/files/browse.json.md index 6b21e50..55ee41b 100644 --- a/docs/endpoints/files/browse.json.md +++ b/docs/endpoints/files/browse.json.md @@ -24,7 +24,7 @@ This endpoint requires authentication iff HTTP authentication is enabled. ### AUTHORIZATION ### -Browsing files requires that the request principal is +Browsing files requires that the request principal is authorized to do so for the target virtual file path. Authorizers may categorize different virtual paths into http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/files/browse.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/files/browse.md b/docs/endpoints/files/browse.md index 0fa204a..de8632e 100644 --- a/docs/endpoints/files/browse.md +++ b/docs/endpoints/files/browse.md @@ -24,7 +24,7 @@ This endpoint requires authentication iff HTTP authentication is enabled. ### AUTHORIZATION ### -Browsing files requires that the request principal is +Browsing files requires that the request principal is authorized to do so for the target virtual file path. Authorizers may categorize different virtual paths into http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/files/debug.json.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/files/debug.json.md b/docs/endpoints/files/debug.json.md index 2806a58..a4dc0de 100644 --- a/docs/endpoints/files/debug.json.md +++ b/docs/endpoints/files/debug.json.md @@ -17,8 +17,4 @@ JSON object. ### AUTHENTICATION ### This endpoint requires authentication iff HTTP authentication is -enabled. - -### AUTHORIZATION ### -The request principal should be authorized to query this endpoint. -See the authorization documentation for details. \ No newline at end of file +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/files/debug.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/files/debug.md b/docs/endpoints/files/debug.md index 3338066..9361ffe 100644 --- a/docs/endpoints/files/debug.md +++ b/docs/endpoints/files/debug.md @@ -17,8 +17,4 @@ JSON object. ### AUTHENTICATION ### This endpoint requires authentication iff HTTP authentication is -enabled. - -### AUTHORIZATION ### -The request principal should be authorized to query this endpoint. -See the authorization documentation for details. \ No newline at end of file +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/files/download.json.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/files/download.json.md b/docs/endpoints/files/download.json.md index 31d442a..88dd72c 100644 --- a/docs/endpoints/files/download.json.md +++ b/docs/endpoints/files/download.json.md @@ -24,7 +24,7 @@ This endpoint requires authentication iff HTTP authentication is enabled. ### AUTHORIZATION ### -Downloading files requires that the request principal is +Downloading files requires that the request principal is authorized to do so for the target virtual file path. Authorizers may categorize different virtual paths into http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/files/download.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/files/download.md b/docs/endpoints/files/download.md index 202d015..3a38760 100644 --- a/docs/endpoints/files/download.md +++ b/docs/endpoints/files/download.md @@ -24,7 +24,7 @@ This endpoint requires authentication iff HTTP authentication is enabled. ### AUTHORIZATION ### -Downloading files requires that the request principal is +Downloading files requires that the request principal is authorized to do so for the target virtual file path. Authorizers may categorize different virtual paths into http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/files/read.json.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/files/read.json.md b/docs/endpoints/files/read.json.md index 64f348e..6697ab1 100644 --- a/docs/endpoints/files/read.json.md +++ b/docs/endpoints/files/read.json.md @@ -25,7 +25,7 @@ This endpoint requires authentication iff HTTP authentication is enabled. ### AUTHORIZATION ### -Reading files requires that the request principal is +Reading files requires that the request principal is authorized to do so for the target virtual file path. Authorizers may categorize different virtual paths into http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/files/read.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/files/read.md b/docs/endpoints/files/read.md index ef95c80..21ea6d8 100644 --- a/docs/endpoints/files/read.md +++ b/docs/endpoints/files/read.md @@ -25,7 +25,7 @@ This endpoint requires authentication iff HTTP authentication is enabled. ### AUTHORIZATION ### -Reading files requires that the request principal is +Reading files requires that the request principal is authorized to do so for the target virtual file path. Authorizers may categorize different virtual paths into http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/master/api/v1.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/master/api/v1.md b/docs/endpoints/master/api/v1.md index 45aebd8..19c6142 100644 --- a/docs/endpoints/master/api/v1.md +++ b/docs/endpoints/master/api/v1.md @@ -21,11 +21,4 @@ found. ### AUTHENTICATION ### This endpoint requires authentication iff HTTP authentication is -enabled. - -### AUTHORIZATION ### -The information returned by this endpoint for certain calls -might be filtered based on the user accessing it. -For example a user might only see the subset of frameworks, -tasks, and executors they are allowed to view. -See the authorization documentation for details. \ No newline at end of file +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/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 4c6caf5..39cd457 100644 --- a/docs/endpoints/master/api/v1/scheduler.md +++ b/docs/endpoints/master/api/v1/scheduler.md @@ -21,9 +21,4 @@ found. ### AUTHENTICATION ### This endpoint requires authentication iff HTTP authentication is -enabled. - -### AUTHORIZATION ### -The returned frameworks information might be filtered based on the -users authorization. -See the authorization documentation for details. \ No newline at end of file +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/master/create-volumes.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/master/create-volumes.md b/docs/endpoints/master/create-volumes.md index 83f85ac..f6ec938 100644 --- a/docs/endpoints/master/create-volumes.md +++ b/docs/endpoints/master/create-volumes.md @@ -29,10 +29,4 @@ the volumes to be created. ### AUTHENTICATION ### This endpoint requires authentication iff HTTP authentication is -enabled. - -### AUTHORIZATION ### -Using this endpoint to create persistent volumes requires that -the current principal is authorized to create volumes for the -specific role. -See the authorization documentation for details. \ No newline at end of file +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/master/destroy-volumes.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/master/destroy-volumes.md b/docs/endpoints/master/destroy-volumes.md index 778f797..054e816 100644 --- a/docs/endpoints/master/destroy-volumes.md +++ b/docs/endpoints/master/destroy-volumes.md @@ -29,10 +29,4 @@ the volumes to be destroyed. ### AUTHENTICATION ### This endpoint requires authentication iff HTTP authentication is -enabled. - -### AUTHORIZATION ### -Using this endpoint to destroy persistent volumes requires that -the current principal is authorized to destroy volumes created -by the principal who created the volume. -See the authorization documentation for details. \ No newline at end of file +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/master/flags.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/master/flags.md b/docs/endpoints/master/flags.md index 6b3de41..850b6f8 100644 --- a/docs/endpoints/master/flags.md +++ b/docs/endpoints/master/flags.md @@ -17,5 +17,5 @@ enabled. ### AUTHORIZATION ### Querying this endpoint requires that the current principal -is authorized to view all flags. +is authorized to query the path. See the authorization documentation for details. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/master/frameworks.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/master/frameworks.md b/docs/endpoints/master/frameworks.md index afb583e..1aed723 100644 --- a/docs/endpoints/master/frameworks.md +++ b/docs/endpoints/master/frameworks.md @@ -21,8 +21,4 @@ found. ### AUTHENTICATION ### This endpoint requires authentication iff HTTP authentication is -enabled. - -### AUTHORIZATION ### -This endpoint might be filtered based on the user accessing it. -See the authorization documentation for details. \ No newline at end of file +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/master/reserve.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/master/reserve.md b/docs/endpoints/master/reserve.md index 71cc1a9..9bb04ed 100644 --- a/docs/endpoints/master/reserve.md +++ b/docs/endpoints/master/reserve.md @@ -29,10 +29,4 @@ the resources to be reserved. ### AUTHENTICATION ### This endpoint requires authentication iff HTTP authentication is -enabled. - -### AUTHORIZATION ### -Using this endpoint to reserve resources requires that the -current principal is authorized to reserve resources for the -specific role. -See the authorization documentation for details. \ No newline at end of file +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/master/state-summary.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/master/state-summary.md b/docs/endpoints/master/state-summary.md index 2986d05..4eb517e 100644 --- a/docs/endpoints/master/state-summary.md +++ b/docs/endpoints/master/state-summary.md @@ -20,16 +20,8 @@ Returns 503 SERVICE_UNAVAILABLE if the leading master cannot be found. This endpoint gives a summary of the state of all tasks and registered frameworks in the cluster as a JSON object. -The information shown might be filtered based on the user -accessing the endpoint. ### AUTHENTICATION ### This endpoint requires authentication iff HTTP authentication is -enabled. - -### AUTHORIZATION ### -This endpoint might be filtered based on the user accessing it. -For example a user might only see the subset of frameworks -they are allowed to view. -See the authorization documentation for details. \ No newline at end of file +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/master/state.json.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/master/state.json.md b/docs/endpoints/master/state.json.md index 8466f7d..c5852bd 100644 --- a/docs/endpoints/master/state.json.md +++ b/docs/endpoints/master/state.json.md @@ -19,8 +19,6 @@ Returns 503 SERVICE_UNAVAILABLE if the leading master cannot be found. This endpoint shows information about the frameworks, tasks, executors and agents running in the cluster as a JSON object. -The information shown might be filtered based on the user -accessing the endpoint. Example (**Note**: this is not exhaustive): @@ -52,7 +50,7 @@ Example (**Note**: this is not exhaustive): "work_dir" : "/var/lib/mesos", "http_authenticators" : "basic", "authorizers" : "local", - "agent_reregister_timeout" : "10mins", + "slave_reregister_timeout" : "10mins", "logging_level" : "INFO", "help" : "false", "root_submissions" : "true", @@ -77,7 +75,7 @@ Example (**Note**: this is not exhaustive): "authenticate_http" : "false", "port" : "5050", "zk_session_timeout" : "10secs", - "recovery_agent_removal_limit" : "100%", + "recovery_slave_removal_limit" : "100%", "webui_dir" : "/path/to/mesos/build/../src/webui", "cluster" : "mycluster", "leader" : "master@127.0.0.1:5050", @@ -95,10 +93,4 @@ Example (**Note**: this is not exhaustive): ### AUTHENTICATION ### This endpoint requires authentication iff HTTP authentication is -enabled. - -### AUTHORIZATION ### -This endpoint might be filtered based on the user accessing it. -For example a user might only see the subset of frameworks, -tasks, and executors they are allowed to view. -See the authorization documentation for details. \ No newline at end of file +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/master/state.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/master/state.md b/docs/endpoints/master/state.md index eba9b39..8e0650f 100644 --- a/docs/endpoints/master/state.md +++ b/docs/endpoints/master/state.md @@ -19,8 +19,6 @@ Returns 503 SERVICE_UNAVAILABLE if the leading master cannot be found. This endpoint shows information about the frameworks, tasks, executors and agents running in the cluster as a JSON object. -The information shown might be filtered based on the user -accessing the endpoint. Example (**Note**: this is not exhaustive): @@ -52,7 +50,7 @@ Example (**Note**: this is not exhaustive): "work_dir" : "/var/lib/mesos", "http_authenticators" : "basic", "authorizers" : "local", - "agent_reregister_timeout" : "10mins", + "slave_reregister_timeout" : "10mins", "logging_level" : "INFO", "help" : "false", "root_submissions" : "true", @@ -77,7 +75,7 @@ Example (**Note**: this is not exhaustive): "authenticate_http" : "false", "port" : "5050", "zk_session_timeout" : "10secs", - "recovery_agent_removal_limit" : "100%", + "recovery_slave_removal_limit" : "100%", "webui_dir" : "/path/to/mesos/build/../src/webui", "cluster" : "mycluster", "leader" : "master@127.0.0.1:5050", @@ -95,10 +93,4 @@ Example (**Note**: this is not exhaustive): ### AUTHENTICATION ### This endpoint requires authentication iff HTTP authentication is -enabled. - -### AUTHORIZATION ### -This endpoint might be filtered based on the user accessing it. -For example a user might only see the subset of frameworks, -tasks, and executors they are allowed to view. -See the authorization documentation for details. \ No newline at end of file +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/master/tasks.json.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/master/tasks.json.md b/docs/endpoints/master/tasks.json.md index d276f27..5d2c0e6 100644 --- a/docs/endpoints/master/tasks.json.md +++ b/docs/endpoints/master/tasks.json.md @@ -18,8 +18,6 @@ current master is not the leader. Returns 503 SERVICE_UNAVAILABLE if the leading master cannot be found. Lists known tasks. -The information shown might be filtered based on the user -accessing the endpoint. Query parameters: @@ -30,10 +28,4 @@ Query parameters: ### AUTHENTICATION ### This endpoint requires authentication iff HTTP authentication is -enabled. - -### AUTHORIZATION ### -This endpoint might be filtered based on the user accessing it. -For example a user might only see the subset of tasks they are -allowed to view. -See the authorization documentation for details. \ No newline at end of file +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/master/tasks.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/master/tasks.md b/docs/endpoints/master/tasks.md index 64ce46c..c7df686 100644 --- a/docs/endpoints/master/tasks.md +++ b/docs/endpoints/master/tasks.md @@ -18,8 +18,6 @@ current master is not the leader. Returns 503 SERVICE_UNAVAILABLE if the leading master cannot be found. Lists known tasks. -The information shown might be filtered based on the user -accessing the endpoint. Query parameters: @@ -30,10 +28,4 @@ Query parameters: ### AUTHENTICATION ### This endpoint requires authentication iff HTTP authentication is -enabled. - -### AUTHORIZATION ### -This endpoint might be filtered based on the user accessing it. -For example a user might only see the subset of tasks they are -allowed to view. -See the authorization documentation for details. \ No newline at end of file +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/master/teardown.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/master/teardown.md b/docs/endpoints/master/teardown.md index 3ab4824..4c14f59 100644 --- a/docs/endpoints/master/teardown.md +++ b/docs/endpoints/master/teardown.md @@ -23,10 +23,4 @@ framework to tear down. ### AUTHENTICATION ### This endpoint requires authentication iff HTTP authentication is -enabled. - -### AUTHORIZATION ### -Using this endpoint to teardown frameworks requires that the -current principal is authorized to teardown frameworks created -by the principal who created the framework. -See the authorization documentation for details. \ No newline at end of file +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/master/unreserve.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/master/unreserve.md b/docs/endpoints/master/unreserve.md index f064239..5cce428 100644 --- a/docs/endpoints/master/unreserve.md +++ b/docs/endpoints/master/unreserve.md @@ -29,10 +29,4 @@ the resources to be unreserved. ### AUTHENTICATION ### This endpoint requires authentication iff HTTP authentication is -enabled. - -### AUTHORIZATION ### -Using this endpoint to unreserve resources requires that the -current principal is authorized to unreserve resources created -by the principal who reserved the resources. -See the authorization documentation for details. \ No newline at end of file +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/slave/api/v1.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/slave/api/v1.md b/docs/endpoints/slave/api/v1.md index b394f7f..c867d79 100644 --- a/docs/endpoints/slave/api/v1.md +++ b/docs/endpoints/slave/api/v1.md @@ -16,5 +16,4 @@ Returns 200 OK if the call is successful ### AUTHENTICATION ### -This endpoint requires authentication iff HTTP authentication is -enabled. \ No newline at end of file +This endpoint does not require authentication. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/slave/flags.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/slave/flags.md b/docs/endpoints/slave/flags.md index 4a8a036..3ea38c1 100644 --- a/docs/endpoints/slave/flags.md +++ b/docs/endpoints/slave/flags.md @@ -16,5 +16,5 @@ This endpoint requires authentication iff HTTP authentication is enabled. ### AUTHORIZATION ### -The request principal should be authorized to view all flags. +The request principal should be authorized to query this endpoint. See the authorization documentation for details. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/slave/state.json.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/slave/state.json.md b/docs/endpoints/slave/state.json.md index 0f82c19..ac85369 100644 --- a/docs/endpoints/slave/state.json.md +++ b/docs/endpoints/slave/state.json.md @@ -14,8 +14,6 @@ Information about state of the Agent. ### DESCRIPTION ### This endpoint shows information about the frameworks, executors and the agent's master as a JSON object. -The information shown might be filtered based on the user -accessing the endpoint. Example (**Note**: this is not exhaustive): @@ -104,10 +102,4 @@ Example (**Note**: this is not exhaustive): ### AUTHENTICATION ### This endpoint requires authentication iff HTTP authentication is -enabled. - -### AUTHORIZATION ### -This endpoint might be filtered based on the user accessing it. -For example a user might only see the subset of frameworks, -tasks, and executors they are allowed to view. -See the authorization documentation for details. \ No newline at end of file +enabled. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/16fe3472/docs/endpoints/slave/state.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/slave/state.md b/docs/endpoints/slave/state.md index b34459e..c7b61d7 100644 --- a/docs/endpoints/slave/state.md +++ b/docs/endpoints/slave/state.md @@ -14,8 +14,6 @@ Information about state of the Agent. ### DESCRIPTION ### This endpoint shows information about the frameworks, executors and the agent's master as a JSON object. -The information shown might be filtered based on the user -accessing the endpoint. Example (**Note**: this is not exhaustive): @@ -104,10 +102,4 @@ Example (**Note**: this is not exhaustive): ### AUTHENTICATION ### This endpoint requires authentication iff HTTP authentication is -enabled. - -### AUTHORIZATION ### -This endpoint might be filtered based on the user accessing it. -For example a user might only see the subset of frameworks, -tasks, and executors they are allowed to view. -See the authorization documentation for details. \ No newline at end of file +enabled. \ No newline at end of file
