Bug 1368883

Summary: [DOCS] [3.3] Document the ability to inject resource limits into pods
Product: OpenShift Container Platform Reporter: Vikram Goyal <vigoyal>
Component: DocumentationAssignee: brice <bfallonf>
Status: CLOSED CURRENTRELEASE QA Contact: Qingyu Wang <nobody+qwang>
Severity: medium Docs Contact: Vikram Goyal <vigoyal>
Priority: medium    
Version: 3.3.0CC: aos-bugs, avagarwa, jokerman, mmccomas
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-09-28 03:17:33 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Vikram Goyal 2016-08-22 03:06:50 UTC
Ability to inject information about computing resource requests and limits (e.g. cpu, memory, local disk) into pods, so that image/application authors are aware of the computing environment in which the pods run.

Should probably go into the dev guide. Will need to interview SME/Dev/QE/GSS.

Eng card: https://trello.com/c/rulSWARV

Comment 1 brice 2016-08-26 04:21:32 UTC
PR created for this:

https://github.com/openshift/openshift-docs/pull/2740

Avesh, is there anything you think is missing and needs to be included? Is there anything technically inaccurate?

Thanks!

Comment 2 Avesh Agarwal 2016-08-26 18:08:20 UTC
Brice, the PR does not look complete to me. This does not have all the information as in the original PR: https://github.com/kubernetes/kubernetes.github.io/pull/591 

Or am I missing something?

Comment 3 brice 2016-08-29 01:17:20 UTC
Avesh,

Which parts of the PR do you think need to be added? What's in the PR I link above is all that I've added, so I wouldn't say that you've missed anything.

I tried to add only the parts that are relevant to the topic specifically. So, I've added what needs to be added to the pod specification (the example yaml), why the reader would want to do it (the intro paragraph), and how to verify that it's been created correctly.

Comment 4 Avesh Agarwal 2016-08-29 20:08:04 UTC
Brice,

I think the title of this bug is confusing. It says: "inject resource limits into pods", what does it mean? Setting resource limits/request for pods/containers? or Exposing this limits/requests via downward API? 

What your PR does seems to be the first. But your PR does not talk about how to expose these resource limits/reqeusts via downward API.

For example, your PR does not discuss about the keywords, limits.cpu, requests.cpu, limits.memory and requests.memory that are needed to expose the limits/requests via downward API, and then examples for these.

Comment 5 brice 2016-08-30 04:42:12 UTC
Avesh,

I think I understand you. I'm not sure if it's the docs' place to point out each keyword, etc, but I've at least put in the process and the examples.

I've put more info into the PR. Is there anything particularly obvious that I'm missing? Are any steps incorrect?

https://github.com/openshift/openshift-docs/pull/2740

Thanks.

Comment 6 openshift-github-bot 2016-09-02 03:10:12 UTC
Commit pushed to master at https://github.com/openshift/openshift-docs

https://github.com/openshift/openshift-docs/commit/7efa985a3a5c1579cbaf19e8e27df50a5ef57a0b
Merge pull request #2740 from bfallonf/bz1368883

Bug 1368883 added info on resource limits in downward API