Skip to content

Commit

Permalink
Update README.md (#110)
Browse files Browse the repository at this point in the history
* Update README.md

Fixed text that described the sample yaml as not having container resource requests, which it does.

* Update README.md

Removing language stating that the referenced yaml doesnt include cpu/memory requests

* Reverting a change from the previous commit

Accidentally removed too many instances of the word 'requests'
  • Loading branch information
rosskusler authored Dec 16, 2020
1 parent 095c753 commit 86d6dfa
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ Consider the following sample pod specification file `pod.yaml`. This file has t
1. The container in this pod is not running as a read only file system, which could allow it to write to the root filesystem.

**Production readiness:**
1. The container's CPU requests and limits are not set, which could allow it to consume excessive CPU.
1. The container's memory requests and limits are not set, which could allow it to consume excessive memory
1. The container's CPU limits are not set, which could allow it to consume excessive CPU.
1. The container's memory limits are not set, which could allow it to consume excessive memory

```yaml
apiVersion: v1
Expand Down
8 changes: 4 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,10 +148,10 @@ To build KubeLinter from source:
> allowing it to write to the root filesystem.
>
> **Production readiness issue**
> - The configuration doesn't specify the container's CPU requests and
> limits, allowing it to consume excessive CPU.
> - The configuration doesn't specify the container's memory requests and
> limits, allowing it to consume excessive memory.
> - The configuration doesn't specify the container's CPU limits,
> allowing it to consume excessive CPU.
> - The configuration doesn't specify the container's memory limits,
> allowing it to consume excessive memory.

1. To lint this file with KubeLinter, run the following command:
```bash
Expand Down

0 comments on commit 86d6dfa

Please sign in to comment.