Added generated docs from updates to state.json documentation. Review: https://reviews.apache.org/r/43619/
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/0d53c395 Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/0d53c395 Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/0d53c395 Branch: refs/heads/master Commit: 0d53c395c83c2fd94fe6c6f73cb29dcc089cb87b Parents: c520f61 Author: Kevin Klues <[email protected]> Authored: Tue Feb 16 16:32:27 2016 -0800 Committer: Vinod Kone <[email protected]> Committed: Tue Feb 16 16:32:27 2016 -0800 ---------------------------------------------------------------------- docs/endpoints/master/state.json.md | 72 +++++++++++++++++++++++++- docs/endpoints/master/state.md | 72 +++++++++++++++++++++++++- docs/endpoints/slave/state.json.md | 88 +++++++++++++++++++++++++++++++- docs/endpoints/slave/state.md | 88 +++++++++++++++++++++++++++++++- 4 files changed, 316 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mesos/blob/0d53c395/docs/endpoints/master/state.json.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/master/state.json.md b/docs/endpoints/master/state.json.md index e13993e..dad5627 100644 --- a/docs/endpoints/master/state.json.md +++ b/docs/endpoints/master/state.json.md @@ -8,4 +8,74 @@ Information about state of master. ### DESCRIPTION ### This endpoint shows information about the frameworks, tasks, -executors and slaves running in the cluster as a JSON object. \ No newline at end of file +executors and slaves running in the cluster as a JSON object. + +Example (**Note**: this is not exhaustive): + +``` +{ + "version" : "0.28.0", + "git_sha" : "9d5889b5a265849886a533965f4aefefd1fbd103", + "git_branch" : "refs/heads/master", + "git_tag" : "0.28.0", + "build_date" : "2016-02-15 10:00:28", + "build_time" : 1455559228, + "build_user" : "mesos-user", + "start_time" : 1455643643.42422, + "elected_time" : 1455643643.43457, + "id" : "b5eac2c5-609b-4ca1-a352-61941702fc9e", + "pid" : "[email protected]:5050", + "hostname" : "localhost", + "activated_slaves" : 0, + "deactivated_slaves" : 0, + "cluster" : "test-cluster", + "leader" : "[email protected]:5050", + "log_dir" : "/var/log", + "external_log_file" : "mesos.log", + "flags" : { + "framework_sorter" : "drf", + "authenticate" : "false", + "logbufsecs" : "0", + "initialize_driver_logging" : "true", + "work_dir" : "/var/lib/mesos", + "http_authenticators" : "basic", + "authorizers" : "local", + "slave_reregister_timeout" : "10mins", + "logging_level" : "INFO", + "help" : "false", + "root_submissions" : "true", + "ip" : "127.0.0.1", + "user_sorter" : "drf", + "version" : "false", + "max_slave_ping_timeouts" : "5", + "slave_ping_timeout" : "15secs", + "registry_store_timeout" : "20secs", + "max_completed_frameworks" : "50", + "quiet" : "false", + "allocator" : "HierarchicalDRF", + "hostname_lookup" : "true", + "authenticators" : "crammd5", + "max_completed_tasks_per_framework" : "1000", + "registry" : "replicated_log", + "registry_strict" : "false", + "log_auto_initialize" : "true", + "authenticate_slaves" : "false", + "registry_fetch_timeout" : "1mins", + "allocation_interval" : "1secs", + "authenticate_http" : "false", + "port" : "5050", + "zk_session_timeout" : "10secs", + "recovery_slave_removal_limit" : "100%", + "webui_dir" : "/path/to/mesos/build/../src/webui", + "cluster" : "mycluster", + "leader" : "[email protected]:5050", + "log_dir" : "/var/log", + "external_log_file" : "mesos.log" + }, + "slaves" : [], + "frameworks" : [], + "completed_frameworks" : [], + "orphan_tasks" : [], + "unregistered_frameworks" : [] +} +``` \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/0d53c395/docs/endpoints/master/state.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/master/state.md b/docs/endpoints/master/state.md index 7571d31..7fdd5f7 100644 --- a/docs/endpoints/master/state.md +++ b/docs/endpoints/master/state.md @@ -8,4 +8,74 @@ Information about state of master. ### DESCRIPTION ### This endpoint shows information about the frameworks, tasks, -executors and slaves running in the cluster as a JSON object. \ No newline at end of file +executors and slaves running in the cluster as a JSON object. + +Example (**Note**: this is not exhaustive): + +``` +{ + "version" : "0.28.0", + "git_sha" : "9d5889b5a265849886a533965f4aefefd1fbd103", + "git_branch" : "refs/heads/master", + "git_tag" : "0.28.0", + "build_date" : "2016-02-15 10:00:28", + "build_time" : 1455559228, + "build_user" : "mesos-user", + "start_time" : 1455643643.42422, + "elected_time" : 1455643643.43457, + "id" : "b5eac2c5-609b-4ca1-a352-61941702fc9e", + "pid" : "[email protected]:5050", + "hostname" : "localhost", + "activated_slaves" : 0, + "deactivated_slaves" : 0, + "cluster" : "test-cluster", + "leader" : "[email protected]:5050", + "log_dir" : "/var/log", + "external_log_file" : "mesos.log", + "flags" : { + "framework_sorter" : "drf", + "authenticate" : "false", + "logbufsecs" : "0", + "initialize_driver_logging" : "true", + "work_dir" : "/var/lib/mesos", + "http_authenticators" : "basic", + "authorizers" : "local", + "slave_reregister_timeout" : "10mins", + "logging_level" : "INFO", + "help" : "false", + "root_submissions" : "true", + "ip" : "127.0.0.1", + "user_sorter" : "drf", + "version" : "false", + "max_slave_ping_timeouts" : "5", + "slave_ping_timeout" : "15secs", + "registry_store_timeout" : "20secs", + "max_completed_frameworks" : "50", + "quiet" : "false", + "allocator" : "HierarchicalDRF", + "hostname_lookup" : "true", + "authenticators" : "crammd5", + "max_completed_tasks_per_framework" : "1000", + "registry" : "replicated_log", + "registry_strict" : "false", + "log_auto_initialize" : "true", + "authenticate_slaves" : "false", + "registry_fetch_timeout" : "1mins", + "allocation_interval" : "1secs", + "authenticate_http" : "false", + "port" : "5050", + "zk_session_timeout" : "10secs", + "recovery_slave_removal_limit" : "100%", + "webui_dir" : "/path/to/mesos/build/../src/webui", + "cluster" : "mycluster", + "leader" : "[email protected]:5050", + "log_dir" : "/var/log", + "external_log_file" : "mesos.log" + }, + "slaves" : [], + "frameworks" : [], + "completed_frameworks" : [], + "orphan_tasks" : [], + "unregistered_frameworks" : [] +} +``` \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/0d53c395/docs/endpoints/slave/state.json.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/slave/state.json.md b/docs/endpoints/slave/state.json.md index 10f7a74..0a31159 100644 --- a/docs/endpoints/slave/state.json.md +++ b/docs/endpoints/slave/state.json.md @@ -8,4 +8,90 @@ Information about state of the Slave. ### DESCRIPTION ### This endpoint shows information about the frameworks, executors -and the slave's master as a JSON object. \ No newline at end of file +and the slave's master as a JSON object. + +Example (**Note**: this is not exhaustive): + +``` +{ + "version" : "0.28.0", + "git_sha" : "9d5889b5a265849886a533965f4aefefd1fbd103", + "git_branch" : "refs/heads/master", + "git_tag" : "0.28.0", + "build_date" : "2016-02-15 10:00:28" + "build_time" : 1455559228, + "build_user" : "mesos-user", + "start_time" : 1455647422.88396, + "id" : "e2c38084-f6ea-496f-bce3-b6e07cea5e01-S0", + "pid" : "slave(1)@127.0.1.1:5051", + "hostname" : "localhost", + "resources" : { + "ports" : "[31000-32000]", + "mem" : 127816, + "disk" : 804211, + "cpus" : 32 + }, + "attributes" : {}, + "master_hostname" : "localhost", + "log_dir" : "/var/log", + "external_log_file" : "mesos.log", + "frameworks" : [], + "completed_frameworks" : [], + "flags" : { + "gc_disk_headroom" : "0.1", + "isolation" : "posix/cpu,posix/mem", + "containerizers" : "mesos", + "docker_socket" : "/var/run/docker.sock", + "gc_delay" : "1weeks", + "docker_remove_delay" : "6hrs", + "port" : "5051", + "systemd_runtime_directory" : "/run/systemd/system", + "initialize_driver_logging" : "true", + "cgroups_root" : "mesos", + "fetcher_cache_size" : "2GB", + "cgroups_hierarchy" : "/sys/fs/cgroup", + "qos_correction_interval_min" : "0ns", + "cgroups_cpu_enable_pids_and_tids_count" : "false", + "sandbox_directory" : "/mnt/mesos/sandbox", + "docker" : "docker", + "help" : "false", + "docker_stop_timeout" : "0ns", + "master" : "127.0.0.1:5050", + "logbufsecs" : "0", + "docker_registry" : "https://registry-1.docker.io";, + "frameworks_home" : "", + "cgroups_enable_cfs" : "false", + "perf_interval" : "1mins", + "docker_kill_orphans" : "true", + "switch_user" : "true", + "logging_level" : "INFO", + "hadoop_home" : "", + "strict" : "true", + "executor_registration_timeout" : "1mins", + "recovery_timeout" : "15mins", + "revocable_cpu_low_priority" : "true", + "docker_store_dir" : "/tmp/mesos/store/docker", + "image_provisioner_backend" : "copy", + "authenticatee" : "crammd5", + "quiet" : "false", + "executor_shutdown_grace_period" : "5secs", + "fetcher_cache_dir" : "/tmp/mesos/fetch", + "default_role" : "*", + "work_dir" : "/tmp/mesos", + "launcher_dir" : "/path/to/mesos/build/src", + "registration_backoff_factor" : "1secs", + "docker_auth_server" : "https://auth.docker.io";, + "oversubscribed_resources_interval" : "15secs", + "enforce_container_disk_quota" : "false", + "container_disk_watch_interval" : "15secs", + "disk_watch_interval" : "1mins", + "docker_puller_timeout" : "60", + "cgroups_limit_swap" : "false", + "hostname_lookup" : "true", + "perf_duration" : "10secs", + "appc_store_dir" : "/tmp/mesos/store/appc", + "recover" : "reconnect", + "version" : "false" + }, +} +``` \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mesos/blob/0d53c395/docs/endpoints/slave/state.md ---------------------------------------------------------------------- diff --git a/docs/endpoints/slave/state.md b/docs/endpoints/slave/state.md index 40df6a8..1077f69 100644 --- a/docs/endpoints/slave/state.md +++ b/docs/endpoints/slave/state.md @@ -8,4 +8,90 @@ Information about state of the Slave. ### DESCRIPTION ### This endpoint shows information about the frameworks, executors -and the slave's master as a JSON object. \ No newline at end of file +and the slave's master as a JSON object. + +Example (**Note**: this is not exhaustive): + +``` +{ + "version" : "0.28.0", + "git_sha" : "9d5889b5a265849886a533965f4aefefd1fbd103", + "git_branch" : "refs/heads/master", + "git_tag" : "0.28.0", + "build_date" : "2016-02-15 10:00:28" + "build_time" : 1455559228, + "build_user" : "mesos-user", + "start_time" : 1455647422.88396, + "id" : "e2c38084-f6ea-496f-bce3-b6e07cea5e01-S0", + "pid" : "slave(1)@127.0.1.1:5051", + "hostname" : "localhost", + "resources" : { + "ports" : "[31000-32000]", + "mem" : 127816, + "disk" : 804211, + "cpus" : 32 + }, + "attributes" : {}, + "master_hostname" : "localhost", + "log_dir" : "/var/log", + "external_log_file" : "mesos.log", + "frameworks" : [], + "completed_frameworks" : [], + "flags" : { + "gc_disk_headroom" : "0.1", + "isolation" : "posix/cpu,posix/mem", + "containerizers" : "mesos", + "docker_socket" : "/var/run/docker.sock", + "gc_delay" : "1weeks", + "docker_remove_delay" : "6hrs", + "port" : "5051", + "systemd_runtime_directory" : "/run/systemd/system", + "initialize_driver_logging" : "true", + "cgroups_root" : "mesos", + "fetcher_cache_size" : "2GB", + "cgroups_hierarchy" : "/sys/fs/cgroup", + "qos_correction_interval_min" : "0ns", + "cgroups_cpu_enable_pids_and_tids_count" : "false", + "sandbox_directory" : "/mnt/mesos/sandbox", + "docker" : "docker", + "help" : "false", + "docker_stop_timeout" : "0ns", + "master" : "127.0.0.1:5050", + "logbufsecs" : "0", + "docker_registry" : "https://registry-1.docker.io";, + "frameworks_home" : "", + "cgroups_enable_cfs" : "false", + "perf_interval" : "1mins", + "docker_kill_orphans" : "true", + "switch_user" : "true", + "logging_level" : "INFO", + "hadoop_home" : "", + "strict" : "true", + "executor_registration_timeout" : "1mins", + "recovery_timeout" : "15mins", + "revocable_cpu_low_priority" : "true", + "docker_store_dir" : "/tmp/mesos/store/docker", + "image_provisioner_backend" : "copy", + "authenticatee" : "crammd5", + "quiet" : "false", + "executor_shutdown_grace_period" : "5secs", + "fetcher_cache_dir" : "/tmp/mesos/fetch", + "default_role" : "*", + "work_dir" : "/tmp/mesos", + "launcher_dir" : "/path/to/mesos/build/src", + "registration_backoff_factor" : "1secs", + "docker_auth_server" : "https://auth.docker.io";, + "oversubscribed_resources_interval" : "15secs", + "enforce_container_disk_quota" : "false", + "container_disk_watch_interval" : "15secs", + "disk_watch_interval" : "1mins", + "docker_puller_timeout" : "60", + "cgroups_limit_swap" : "false", + "hostname_lookup" : "true", + "perf_duration" : "10secs", + "appc_store_dir" : "/tmp/mesos/store/appc", + "recover" : "reconnect", + "version" : "false" + }, +} +``` \ No newline at end of file
