You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by vi...@apache.org on 2016/02/26 23:17:20 UTC
mesos git commit: Added links to the operator endpoint doc pages.
Repository: mesos
Updated Branches:
refs/heads/master d1d3f4bbc -> 85bf4df15
Added links to the operator endpoint doc pages.
Review: https://reviews.apache.org/r/44101/
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/85bf4df1
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/85bf4df1
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/85bf4df1
Branch: refs/heads/master
Commit: 85bf4df154875e2e3c7723d72b86c1336827cc69
Parents: d1d3f4b
Author: Neil Conway <ne...@gmail.com>
Authored: Fri Feb 26 14:16:56 2016 -0800
Committer: Vinod Kone <vi...@gmail.com>
Committed: Fri Feb 26 14:16:56 2016 -0800
----------------------------------------------------------------------
docs/logging.md | 4 ++--
docs/mesos-containerizer.md | 2 +-
docs/network-monitoring.md | 8 ++++----
docs/networking-for-mesos-managed-containers.md | 2 +-
docs/persistent-volume.md | 17 ++++++++++-------
docs/quota.md | 6 +++---
docs/reservation.md | 10 ++++++----
docs/roles.md | 6 +++---
docs/sandbox.md | 2 +-
9 files changed, 31 insertions(+), 26 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/85bf4df1/docs/logging.md
----------------------------------------------------------------------
diff --git a/docs/logging.md b/docs/logging.md
index 50a95ba..6162290 100644
--- a/docs/logging.md
+++ b/docs/logging.md
@@ -24,8 +24,8 @@ library, see the [configuration documentation](configuration.md).
Google logging options that are not explicitly mentioned there can be
configured via environment variables.
-Both Master and Agent also expose an HTTP endpoint which temporarily toggles
-verbose logging:
+Both Master and Agent also expose a [/logging/toggle](endpoints/logging/toggle.md)
+HTTP endpoint which temporarily toggles verbose logging:
```
POST <ip:port>/logging/toggle?level=[1|2|3]&duration=VALUE
http://git-wip-us.apache.org/repos/asf/mesos/blob/85bf4df1/docs/mesos-containerizer.md
----------------------------------------------------------------------
diff --git a/docs/mesos-containerizer.md b/docs/mesos-containerizer.md
index a8ef4e7..998de80 100644
--- a/docs/mesos-containerizer.md
+++ b/docs/mesos-containerizer.md
@@ -76,7 +76,7 @@ specify `--enforce_container_disk_quota` when starting the slave.
The Posix Disk isolator reports disk usage for each sandbox by
periodically running the `du` command. The disk usage can be retrieved
-from the resource statistics endpoint (`/monitor/statistics.json`).
+from the resource statistics endpoint ([/monitor/statistics](endpoints/monitor/statistics.md)).
The interval between two `du`s can be controlled by the slave flag
`--container_disk_watch_interval`. For example,
http://git-wip-us.apache.org/repos/asf/mesos/blob/85bf4df1/docs/network-monitoring.md
----------------------------------------------------------------------
diff --git a/docs/network-monitoring.md b/docs/network-monitoring.md
index 57b859e..706cd19 100644
--- a/docs/network-monitoring.md
+++ b/docs/network-monitoring.md
@@ -8,7 +8,7 @@ Mesos on Linux provides support for per-container network monitoring and
isolation. The network isolation prevents a single container from exhausting the
available network ports, consuming an unfair share of the network bandwidth or
significantly delaying packet transmission for others. Network statistics for
-each active container are published through the `/monitor/statistics.json`
+each active container are published through the [/monitor/statistics](endpoints/monitor/statistics.md)
endpoint on the slave. The network isolation is transparent for the majority of
tasks running on a slave (those that bind to port 0 and let the kernel allocate
their port).
@@ -176,7 +176,7 @@ enabled would thus be:
## Monitoring container network statistics
Mesos exposes statistics from the Linux network stack for each container network
-on the `/monitor/statistics.json` slave endpoint.
+on the [/monitor/statistics](endpoints/monitor/statistics.md) slave endpoint.
From the network interface inside the container, we report the following
counters (since container creation) under the `statistics` key:
@@ -284,9 +284,9 @@ for each of these elements includes:
</tr>
</table>
-[1] `backlog` is only reported on the bloat_reduction interface
+[1] `backlog` is only reported on the bloat_reduction interface.
-[2] `overlimits` are only reported on the bw_limit interface
+[2] `overlimits` are only reported on the bw_limit interface.
[3] Currently always reported as 0 by the underlying Traffic Control element.
http://git-wip-us.apache.org/repos/asf/mesos/blob/85bf4df1/docs/networking-for-mesos-managed-containers.md
----------------------------------------------------------------------
diff --git a/docs/networking-for-mesos-managed-containers.md b/docs/networking-for-mesos-managed-containers.md
index f2fbea5..029e003 100644
--- a/docs/networking-for-mesos-managed-containers.md
+++ b/docs/networking-for-mesos-managed-containers.md
@@ -93,7 +93,7 @@ isolation using new data structures in the TaskInfo message.
6. NIM then "decorates" the TaskStatus with the IP information.
* The IP address(es) from TaskStatus are made available at Master's
- state endpoint.
+ [/state](endpoints/master/state.md) endpoint.
* The TaskStatus is also forwarded to the framework to inform it of the IP
addresses.
* When a task is killed or lost, NIM communicates with IPAM client to release
http://git-wip-us.apache.org/repos/asf/mesos/blob/85bf4df1/docs/persistent-volume.md
----------------------------------------------------------------------
diff --git a/docs/persistent-volume.md b/docs/persistent-volume.md
index f772405..bfcad48 100644
--- a/docs/persistent-volume.md
+++ b/docs/persistent-volume.md
@@ -258,10 +258,12 @@ by operators and administrative tools.
To use this endpoint, the operator should first ensure that a reservation for
the necessary resources has been made on the appropriate slave (e.g., by using
-the `/reserve` HTTP endpoint or by configuring a static reservation).
+the [/reserve](endpoints/master/reserve.md) HTTP endpoint or by configuring a
+static reservation).
To create a 512MB persistent volume for the `ads` role on a dynamically reserved
-disk resource, we can send a request like so:
+disk resource, we can send an HTTP POST request to the master's
+[/create-volumes](endpoints/master/create-volumes.md) endpoint like so:
```
curl -i \
@@ -309,11 +311,12 @@ the reserved resources are located. That asynchronous message may not be
delivered or creating the volumes at the slave might fail, in which case no
volumes will be created. To determine if a create operation has succeeded, the
user can examine the state of the appropriate Mesos slave (e.g., via the slave's
-`/state` HTTP endpoint).
+[/state](endpoints/slave/state.md) HTTP endpoint).
#### `/destroy-volumes`
-To destroy the volume created above, we can send an HTTP POST like so:
+To destroy the volume created above, we can send an HTTP POST to the master's
+[/destroy-volumes](endpoints/master/destroy-volumes.md) endpoint like so:
```
curl -i \
@@ -361,7 +364,7 @@ the persistent volumes are located. That asynchronous message may not be
delivered or destroying the volumes at the slave might fail, in which case no
volumes will be destroyed. To determine if a destroy operation has succeeded,
the user can examine the state of the appropriate Mesos slave (e.g., via the
-slave's `/state` HTTP endpoint).
+slave's [/state](endpoints/slave/state.md) HTTP endpoint).
### Programming with Persistent Volumes
@@ -419,7 +422,7 @@ volumes:
succeed, the result will be a single reservation of 4 CPUs. To handle this
situation, applications should be prepared for resource offers that contain
more resources than expected. Some applications may also want to detect this
- situation and unreserve an additional reserved resources that will not be
+ situation and unreserve any additional reserved resources that will not be
required.
* It often makes sense to structure application logic as a "state machine",
@@ -441,7 +444,7 @@ volumes:
succeeded: as discussed above, frameworks need to wait for an offer that
contains the "expected" reserved resources to determine when a reservation
request has succeeded. Determining what a framework should "expect" to find in
- an offer is more difficult when multiple frameworks can be making reservations
+ an offer is more difficult when multiple frameworks can make reservations
for the same role concurrently. In general, whenever multiple frameworks are
allowed to register in the same role, the operator should ensure that those
frameworks are configured to collaborate with one another when using
http://git-wip-us.apache.org/repos/asf/mesos/blob/85bf4df1/docs/quota.md
----------------------------------------------------------------------
diff --git a/docs/quota.md b/docs/quota.md
index 48dcd2a..4f09d73 100644
--- a/docs/quota.md
+++ b/docs/quota.md
@@ -61,9 +61,9 @@ introducing preemption for running tasks.
# Operator HTTP Endpoint
-The master `/quota` HTTP endpoint enables operators to configure quotas. The
-endpoint currently offers a REST-like interface and supports the
-following operations:
+The master [/quota](endpoints/master/quota.md) HTTP endpoint enables operators
+to configure quotas. The endpoint currently offers a REST-like interface and
+supports the following operations:
* [Setting](#setRequest) a new quota with POST.
* [Removing](#removeRequest) an existing quota with DELETE.
http://git-wip-us.apache.org/repos/asf/mesos/blob/85bf4df1/docs/reservation.md
----------------------------------------------------------------------
diff --git a/docs/reservation.md b/docs/reservation.md
index cbf0a08..9714f09 100644
--- a/docs/reservation.md
+++ b/docs/reservation.md
@@ -258,7 +258,8 @@ slave that hosts the desired resources; the request will fail if sufficient
unreserved resources cannot be found on the slave). In this case, the principal
included in the request will be the principal of an authorized operator rather
than the principal of a framework registered under the `ads` role. We send an
-HTTP POST request to the `/reserve` HTTP endpoint like so:
+HTTP POST request to the master's [/reserve](endpoints/master/reserve.md)
+endpoint like so:
$ curl -i \
-u <operator_principal>:<password> \
@@ -300,12 +301,13 @@ reservation request is then forwarded asynchronously to the Mesos slave where
the resources are located. That asynchronous message may not be delivered, in
which case no resources will be reserved. To determine if a reserve operation
has succeeded, the user can examine the state of the appropriate Mesos slave
-(e.g., via the slave's `/state` HTTP endpoint).
+(e.g., via the slave's [/state](endpoints/slave/state.md) HTTP endpoint).
#### `/unreserve` (since 0.25.0)
Suppose we want to unreserve the resources that we dynamically reserved above.
-We can send an HTTP POST request to the `/unreserve` HTTP endpoint like so:
+We can send an HTTP POST request to the master's
+[/unreserve](endpoints/master/unreserve.md) endpoint like so:
$ curl -i \
-u <operator_principal>:<password> \
@@ -353,4 +355,4 @@ master. The request is then forwarded asynchronously to the Mesos slave where
the resources are located. That asynchronous message may not be delivered, in
which case no resources will be unreserved. To determine if an unreserve
operation has succeeded, the user can examine the state of the appropriate Mesos
-slave (e.g., via the slave's `/state` HTTP endpoint).
+slave (e.g., via the slave's [/state](endpoints/slave/state.md) HTTP endpoint).
http://git-wip-us.apache.org/repos/asf/mesos/blob/85bf4df1/docs/roles.md
----------------------------------------------------------------------
diff --git a/docs/roles.md b/docs/roles.md
index 84e5b7e..d121934 100644
--- a/docs/roles.md
+++ b/docs/roles.md
@@ -98,9 +98,9 @@ agent node are initially assigned to the `*` role (this can be changed via the
The `*` role behaves differently from non-default roles. For example, dynamic
reservations can be used to reassign resources from the `*` role to a specific
role, but not from one specific role to another specific role (without first
-unreserving the resource, e.g., using the `/unreserve` operator HTTP
-endpoint). Similarly, persistent volumes cannot be created on unreserved
-resources.
+unreserving the resource, e.g., using the [/unreserve](endpoints/master/unreserve.md)
+operator HTTP endpoint). Similarly, persistent volumes cannot be created on
+unreserved resources.
## Invalid role
http://git-wip-us.apache.org/repos/asf/mesos/blob/85bf4df1/docs/sandbox.md
----------------------------------------------------------------------
diff --git a/docs/sandbox.md b/docs/sandbox.md
index 276e112..1c3fc59 100644
--- a/docs/sandbox.md
+++ b/docs/sandbox.md
@@ -139,7 +139,7 @@ endpoint running on the agent.
## Sandbox size
The maximum size of the sandbox is dependent on the containerization of the
-executor and isolators :
+executor and isolators:
* Mesos containerizer - For backwards compatibility, the Mesos containerizer
does not enforce a container's disk quota by default. However, if the