Skip to content

Commit

Permalink
Addressing yelpsoa files reviews
Browse files Browse the repository at this point in the history
  • Loading branch information
EmanElsaban committed Oct 7, 2024
1 parent ea03020 commit 3ee2201
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
7 changes: 5 additions & 2 deletions docs/source/isolation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -157,5 +157,8 @@ Some notes on this:
Disk
"""""

Kubernetes supports disk resource isolation through the use of storage quotas. Disk resource is isolated through the use of
namespaces - PaaSTA by default apply storage resource limit for the namespace if none is specified (Note: those limits can be overridden in soaconfigs).
Kubernetes supports disk resource isolation through the use of storage quotas. Kubernetes
will periodically poll for usage, so it is possible to temporarily exceed the configured
limit. When Kubernetes sees that a container has exceeded it's limit, it will evict (i.e., kill) the offending Pod, thereby deleting the containers filesystem and reclaiming the used disk.

NOTE: this usage calculation takes into consideration node-level container logs (i.e., container logs for stdout/stderr stored on-host to power things like ``kubectl logs``) - if an application is particularly "chatty" with its output, the ``disk`` allocation in soa-configs will need to take this into account.```
2 changes: 1 addition & 1 deletion docs/source/paasta_development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Steps below outline running PaaSTA playground components with a debugger attache

.. sourcecode:: shell

(py38-linux) user@dev55-uswest1adevc:~/pg/paasta$ KUBECONFIG=./k8s_itests/kubeconfig kubectl get Pods -n paasta
(py38-linux) user@dev55-uswest1adevc:~/pg/paasta$ KUBECONFIG=./k8s_itests/kubeconfig kubectl get pods -n paasta
NAME READY STATUS RESTARTS AGE
compute-infra-test-service-autoscaling-6fdf96b485-2fkd5 1/1 Running 0 25s
compute-infra-test-service-autoscaling-6fdf96b485-44lqp 1/1 Running 0 25s
Expand Down
17 changes: 7 additions & 10 deletions docs/source/yelpsoa_configs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,20 +43,19 @@ specify the following options:

* ``cpus``: Number of CPUs an instance needs. Defaults to 1. CPUs in Kubernetes
are "shares" and represent a minimal amount of a CPU to share with a Pod
relative to the other Pods on a host.
relative to the other Pods on a host. For a more detailed read on
how this works in practice, see the docs on `isolation <isolation.html>`_.

* ``cpu_burst_add``: Maximum number of additional CPUs an instance may use while bursting; if unspecified, PaaSTA defaults to 1 for long-running services, and 0 for scheduled jobs (Tron).
For example, if a service specifies that it needs 2 CPUs normally and 1 for burst, the service may go up to 3 CPUs, if needed.

* ``mem``: Memory (in MB) an instance needs. Defaults to 4096 (4GB). In Kubernetes
memory is constrained to the specified limit, and containers will reach
out-of-memory (OOM) conditions if they attempt to exceed these limits, and
then be killed.
then be killed. For more a more detailed read on
how this works, see the docs on `isolation <isolation.html>`_

* ``disk``: Disk (in MB) an instance needs. Defaults to 1024 (1GB). Disk limits
may or may not be enforced, but services should set their ``disk`` setting
regardless to ensure the scheduler has adequate information for distributing
tasks.
* ``disk``: Disk (in MB) an instance needs. Defaults to 1024 (1GB).

* ``env``: A dictionary of environment variables that will be made available
to the container. PaaSTA additionally will inject the following variables automatically (keep in mind all environment variables are strings in a shell):
Expand Down Expand Up @@ -505,7 +504,7 @@ out of the load balancer, so it justifies having less sensitive thresholds.
This file stores configuration for periodically scheduled jobs for execution on
`Tron <https://github.com/yelp/tron>`_.

The documentation here is for the paasta-specific options. For all other
The documentation here is for the PaaSTA-specific options. For all other
settings, please see the
`canonical docs <https://tron.readthedocs.io/en/latest/jobs.html>`_.

Expand Down Expand Up @@ -598,7 +597,7 @@ The yaml where adhoc instances are defined. Top-level keys are instance names.
Each instance MAY have:

* Anything in the `Common Settings`_.
.

* ``net``

* ``cmd``
Expand All @@ -624,8 +623,6 @@ See the `kubernetes-[clustername].yaml`_ section for details for each of these p
is specified. If both are specified, an exception is thrown with an
explanation of the problem, and the program terminates.
.. _doc: deploy_groups.html

``smartstack.yaml``
-------------------

Expand Down

0 comments on commit 3ee2201

Please sign in to comment.