Commit Graph

273 Commits

Author SHA1 Message Date
He Simei
1d6c0e287b fix service-account related doc 2015-08-14 08:44:21 +08:00
Brendan Burns
1055eed9b6 Add initial storage types to the Kubernetes API 2015-08-13 09:25:02 -07:00
Eric Paris
5aa495cdad Update code to use - in flag names instead of _ 2015-08-11 16:31:52 -04:00
Ben McCann
4c199b604a Fix the architecture diagram such that the arrow from the api server to the node doesn't go through/under etcd 2015-08-07 00:13:15 -07:00
Jerzy Szczepkowski
67d45821f8 Merge pull request #12216 from derekwaynecarr/limit_range_requests
LimitRange design updates to account for Requests and Limits
2015-08-07 08:18:10 +02:00
Dawn Chen
256eeeda2b Merge pull request #12291 from derekwaynecarr/resource_quota_requests
Update resource quota design to align with requests and limits
2015-08-06 16:07:42 -07:00
derekwaynecarr
e75f8be8ea Update design for LimitRange to handle requests 2015-08-06 10:58:55 -04:00
Wojciech Tyczynski
5b216d8a51 Merge pull request #12328 from pmorie/sc-typo
Fix typo in security context proposal
2015-08-06 15:27:45 +02:00
Wojciech Tyczynski
e366f2c597 Merge pull request #12206 from derekwaynecarr/move_doc
LimitRange documentation should be under admin
2015-08-06 13:43:58 +02:00
Paul Morie
7a73f3cdb8 Fix typo in security context proposal 2015-08-06 00:53:01 -04:00
Mike Danese
8326697055 rewrite all links to prs to k8s links 2015-08-05 21:11:11 -07:00
Mike Danese
fe6b15ba2f rewrite all links to issues to k8s links 2015-08-05 21:11:11 -07:00
Dawn Chen
9a29583fe0 Merge pull request #12064 from AnanyaKumar/patch-2
Update admission_control.md
2015-08-05 15:14:00 -07:00
derekwaynecarr
789450a40d Update resource quota design to align with requests and limits 2015-08-05 14:37:09 -04:00
derekwaynecarr
577f2fa0a5 LimitRange documentation should be under admin 2015-08-05 10:26:52 -04:00
Ananya Kumar
15884e14d2 Update admission_control.md 2015-08-03 23:00:48 -07:00
Ananya Kumar
bf5bcdc68f Update admission_control.md
I tested out a Limit Ranger, and it seems like the admission happens *before* Validation. Please correct me if I'm wrong though, I didn't look at the code in detail. In any case, I think it makes sense for admission to happen before validation because code in admission can change containers.

By the way I think it's pretty hard to find flows like this in the code, so it's useful if we add links to code in the design docs (for prospective developers) :)
2015-07-30 20:02:06 -07:00
Eric Paris
024208e39f Fix trailing whitespace in all docs 2015-07-30 20:41:30 -04:00
Eric Paris
8886a9940d Rewrite how the munger works
The basic idea is that in the main mungedocs we run the entirefile and
create an annotated set of lines about that file. All mungers then act
on a struct mungeLines instead of on a bytes array. Making use of the
metadata where appropriete. Helper functions exist to make updating a
'macro block' extremely easy.
2015-07-30 20:41:30 -04:00
Vish Kannan
1194001116 Merge pull request #11708 from bgrant0607/docfix
Update post-1.0 release versioning proposal.
2015-07-23 10:02:15 -07:00
Brian Grant
cba5433f43 Change to semantic versioning. 2015-07-23 00:42:03 +00:00
Janet Kuo
a2971fb2ab Fix doc typos 2015-07-22 17:19:07 -07:00
Brian Grant
f171cc0912 Update post-1.0 release versioning proposal. 2015-07-22 20:20:31 +00:00
Alex Robinson
acd1bed70e Fix capitalization of Kubernetes in the documentation. 2015-07-20 14:39:36 -07:00
Tim Hockin
995a7aef29 Collected markedown fixes around syntax. 2015-07-20 09:51:22 -07:00
David Oppenheimer
50e95a031b Absolutize links that leave the docs/ tree to go anywhere other than
to examples/ or back to docs/
2015-07-20 00:25:07 -07:00
Brian Grant
8cfd3d669e Merge pull request #11551 from a-robinson/docs
Improve syntax highlighting for design and devel docs
2015-07-19 08:45:54 -07:00
Alex Robinson
68d6e3a8ae Replace `` with when emphasizing something inline in docs/ 2015-07-19 09:05:17 +00:00
Alex Robinson
4c308f0703 Improve design docs syntax highlighting. 2015-07-19 08:46:02 +00:00
Tim Hockin
33f1862830 Run gendocs 2015-07-17 15:35:43 -07:00
Daniel Smith
f7873d2a1f apply changes 2015-07-17 11:04:46 -07:00
Tim Hockin
542e13d2d3 Better scary message 2015-07-17 09:28:49 -07:00
Janet Kuo
b0c68c4b81 Ensure all docs and examples in user guide are reachable 2015-07-16 23:12:47 -07:00
Brian Grant
786b59427d Merge pull request #11400 from lavalamp/munger
Add absolute path link checking to munger
2015-07-16 22:50:14 -07:00
Daniel Smith
98eeadb66e (mostly) auto fixed links 2015-07-16 16:28:18 -07:00
David Oppenheimer
c57c877670 Take availability.md doc and
- extract the portion related to multi-cluster operation into a new multi-cluster.md doc
- merge the remainder (that was basically high-level troubleshooting advice) into cluster-troubleshooting.md
2015-07-16 14:39:03 -07:00
Eric Tune
65a372b9ca Merge pull request #11318 from mikedanese/kubectl-example-fix
point kubectl -f examples to correct paths
2015-07-15 12:55:53 -07:00
Mike Danese
b80fe60042 point kubectl -f examples to correct paths 2015-07-15 10:51:45 -07:00
David Oppenheimer
d31e13048c Move diagrams out of top-level docs/ directory and merge
docs/devel/developer-guide.md into docs/devel/README.md
2015-07-14 23:56:51 -07:00
David Oppenheimer
8d5eb03c7b Move some docs from docs/ top-level into docs/{admin/,devel/,user-guide/}. 2015-07-14 22:07:44 -07:00
Tim Hockin
39b86908a1 Run gendocs 2015-07-14 17:28:47 -07:00
Tim Hockin
79f9cd7c83 Run gendocs 2015-07-14 15:28:59 -07:00
Eric Tune
6b38719593 Merge pull request #11195 from erictune/move_versioning
Move versioning doc.
2015-07-14 13:01:20 -07:00
Mike Danese
3eff8fce41 automated link fixes 2015-07-14 10:51:10 -07:00
Eric Tune
e463723f03 Move versioning.md to design/ -- not user-focused. 2015-07-14 09:57:42 -07:00
Daniel Smith
b1555956e9 standardize on - instead of _ in file names 2015-07-13 18:32:00 -07:00
Daniel Smith
2c333e4bc2 move admin related docs into docs/admin 2015-07-13 18:24:11 -07:00
Daniel Smith
821e08fded Apply mungedocs changes 2015-07-13 17:48:40 -07:00
Tim Hockin
8bb5c5060c Merge pull request #10843 from jiangyaoguo/change-get-minions-in-docs
change "get minions" to "get nodes"  in docs
2015-07-13 13:27:56 -07:00
Eric Tune
f353592cde Remove colon from end of doc heading. 2015-07-13 12:07:26 -07:00
Tim Hockin
fffc64e733 Run gendocs and munges 2015-07-13 11:27:48 -07:00
Tim Hockin
03aa143328 Merge pull request #11145 from marekbiskup/kubectl-rolling-update-doc-fix
kubectl-rolling-update-doc-fix
2015-07-13 09:47:19 -07:00
Ed Costello
2b941634d8 Copy edits to remove doubled words 2015-07-13 10:11:55 -04:00
Marek Biskup
d1f2541755 kubectl-rolling-update-doc-fix 2015-07-13 15:09:26 +02:00
Ed Costello
98e9f1eeae Copy edits for typos 2015-07-12 22:03:06 -04:00
Akshay Aurora
789e50439b Fix formatting in networking.md 2015-07-12 03:49:01 +05:30
Daniel Smith
9ef38c124c manual fixes 2015-07-10 10:54:47 -07:00
Daniel Smith
c03a788c67 Auto-fixed docs 2015-07-10 10:54:47 -07:00
jiangyaoguo
102c56ddc4 change get minions cmd in docs 2015-07-10 10:40:52 +08:00
Victor Marmol
fff24af86e Merge pull request #10859 from davidopp/clean
Move scheduler overview from docs/design/ to docs/devel/
2015-07-08 14:03:23 -07:00
Victor Marmol
c268352547 Merge pull request #10949 from JanetKuo/update-kubectl-get-docs-all
Update kubectl output in doc
2015-07-08 13:55:46 -07:00
Victor Marmol
2ee06ed171 Merge pull request #10950 from pmorie/hostpath
Change remaining instances of hostDir in docs to hostPath
2015-07-08 13:49:23 -07:00
Paul Morie
5b4adf8469 Change remaining instances of hostDir in docs to hostPath 2015-07-08 16:26:20 -04:00
Janet Kuo
a761a0fb72 Update kubectl output in doc 2015-07-08 13:22:54 -07:00
Tim Hockin
0a23c0666d Make docs links be relative so we can version them 2015-07-07 15:22:17 -07:00
David Oppenheimer
a85d0d3bd1 Move scheduler overview from docs/design/ to docs/devel/ 2015-07-07 14:16:26 -07:00
Yu-Ju Hong
da25b1224f Merge pull request #10786 from thockin/docs-networking
De-dup, cleanup, overhaul networking docs
2015-07-07 10:45:49 -07:00
Tim Hockin
2210220dbf De-dup,overhaul networking docs 2015-07-06 17:28:12 -07:00
Yu-Ju Hong
de710713aa Merge pull request #10573 from erictune/resources
Add user-oriented compute resource doc.
2015-07-06 16:12:38 -07:00
Eric Tune
fd325982c3 Add user-oriented compute resource doc.
Adds docs/compute_resources.md with user-oriented
explanation of compute resources.
Reveals detail gradually and includes examples
and troubleshooting.  Examples are tested.

Moves design-focused docs/resources.md to docs/design/resources.md.
Updates links to that.
2015-07-06 14:57:30 -07:00
David Oppenheimer
f692adc67d Initial design doc for scheduler. 2015-07-01 13:58:56 -07:00
Salvatore Dario Minonne
5b109eef49 Adding IANA_SVC_NAME definition to docs/design/identifiers.md 2015-06-26 09:44:28 +02:00
Satnam Singh
2d1c3c31b2 Merge pull request #9864 from marekbiskup/docs-edit-dash
remove double dash
2015-06-18 14:40:28 -07:00
Satnam Singh
424d09fb97 Merge pull request #9907 from RichieEscarez/9404_controller
Changed "controller" to "replication controller"
2015-06-18 14:33:49 -07:00
Saad Ali
968156e892 Merge pull request #9098 from benmccann/vault-keywhiz-docs
Document how a secrets server like Vault or Keywhiz might fit into Kubernetes
2015-06-17 18:06:11 -07:00
RichieEscarez
eb44b3c830 Qualified all references to "controller" so that references to "replication controller" are clear. fixes #9404
Also ran hacks/run-gendocs.sh
2015-06-17 08:48:59 -07:00
Marek Biskup
7b403edd6f double dash replaced by html mdash 2015-06-17 12:36:27 +02:00
Ed Costello
05714d416b Copy edits for spelling errors and typos
Signed-off-by: Ed Costello <epc@epcostello.com>
2015-06-12 18:47:28 -04:00
Brendan Burns
9e198a6ed9 Purge cluster/kubectl.sh from nearly all docs.
Mark cluster/kubectl.sh as deprecated.
2015-06-09 13:35:52 -07:00
Kris Rousey
6e83eb2636 Updating docs/ to v1 2015-06-05 14:09:49 -07:00
Scott Konzem
1cff55f874 Fix misspellings in documentation 2015-06-05 11:35:17 -04:00
Eric Tune
7fee4de41d Explain that file-based pods cannot use secrets. 2015-06-02 11:17:42 -07:00
Ben McCann
d7efc88b7d Document how a secrets server like Vault or Keywhiz might fit into Kubernetes 2015-06-01 20:10:45 -07:00
Paul Morie
2ad30966fa Corrections to examples in expansion docs 2015-05-29 01:00:36 -04:00
Tim Hockin
4318ca5a8b Rename 'portal IP' to 'cluster IP' most everywhere
This covers obvious transforms, but not --portal_net, $PORTAL_NET and
similar.
2015-05-28 16:10:44 -07:00
Paul Morie
8b338860aa Make kubelet expand var refs in cmd, args, env 2015-05-27 00:13:57 -04:00
Dawn Chen
17715c7b39 Merge pull request #8627 from caesarxuchao/secrets-design-docs
update docs/design/secrets.md to v1beta3
2015-05-22 14:51:29 -07:00
Chao Xu
b1cf9fbc5c update docs/design/secrets.md to v1beta3 2015-05-21 11:05:25 -07:00
Chao Xu
bda5e4376e in docs, update "minions" to "nodes" 2015-05-21 09:59:40 -07:00
Chao Xu
5b8b5a0844 in docs, update replicationController to replicationcontroller 2015-05-20 17:31:15 -07:00
Tim Hockin
cb49843ccb Merge pull request #8140 from vishh/namespace
Update Namespace names to follow DNS label format
2015-05-19 11:25:32 -07:00
Vishnu Kannan
d10af89493 Updating namespaces to be DNS labels instead of DNS names. 2015-05-19 11:09:09 -07:00
Paul Morie
e84092f870 Add variable expansion and design doc 2015-05-18 15:59:55 -04:00
Jeff Lowdermilk
553f9f822b Add ga-beacon analytics to gendocs scripts
hack/run-gendocs.sh puts ga-beacon analytics link into all md files,
hack/verify-gendocs.sh verifies presence of link.
2015-05-15 18:56:38 -07:00
Paul Morie
3988e0e069 Merge pull request #7987 from pweil-/security-context-doc
Update Security Context Documentation
2015-05-11 10:07:41 -04:00
Paul Weil
05e8915b37 bring doc up to date with actual api types 2015-05-08 16:38:28 -04:00
Weiwei Jiang
d59f3aeef1 Fix wrong link for security context 2015-05-07 16:10:50 +08:00
Brian Grant
32b4b1cdd7 Merge pull request #7575 from brendandburns/kubectl
Rolling Updates: Add support for --rollback.
2015-05-06 11:35:57 -07:00
Brendan Burns
c9e33e197d Add support for --rollback. 2015-05-06 10:21:35 -07:00
Paul Morie
a6b06f4932 Fix link to service accounts doc in security context doc 2015-05-06 10:04:39 -04:00
Saad Ali
66e0985715 Fix event doc link 2015-05-05 18:11:58 -07:00
Brendan Burns
37eedef348 Add a central simple getting started guide with kubernetes guide.
Point several getting started guides at this doc.
2015-05-01 20:20:15 -07:00
markturansky
242567460d PersistentVolumeClaimBinder implementation 2015-04-27 12:05:11 -04:00
Tim Hockin
12e4e8f304 Make docs links go through docs.k8s.io 2015-04-23 16:36:27 -07:00
David Oppenheimer
54f20151f4 Merge pull request #6713 from brendandburns/docs
Suggest a simple rolling update.
2015-04-23 11:52:30 -07:00
Brendan Burns
7e0f6f859f Suggest a simple rolling update. 2015-04-22 10:22:47 -07:00
caesarxuchao
61818cfcbe fix the link to services.md 2015-04-21 21:24:53 -07:00
Robert Bailey
26edb7581e Remove old design file (that has been fully implemented). 2015-04-20 21:33:03 -07:00
Daniel Smith
288effa7c1 Merge pull request #6933 from bgrant0607/docfix
Update docs. Add design principles.
2015-04-16 16:55:10 -07:00
Brian Grant
f1cea092df Update docs. Add design principles. Fixes #6133. Fixes #4182.
# *** ERROR: *** docs are out of sync between cli and markdown
# run hack/run-gendocs.sh > docs/kubectl.md to regenerate

#
# Your commit will be aborted unless you regenerate docs.
    COMMIT_BLOCKED_ON_GENDOCS
2015-04-16 22:13:44 +00:00
Tim Hockin
c2bacd588d Stop using dockerfile/* images
As per
http://blog.docker.com/2015/03/updates-available-to-popular-repos-update-your-images/
docker has stopped answering dockerfile/redis and dockerfile/nginx.  Fix all
users in our tree.  Sadly this means a lot of published examples are now broken.
2015-04-16 12:20:43 -07:00
Prashanth B
620af16892 Merge pull request #6097 from derekwaynecarr/limit_range_default_value
Limit range supporting a default resource limits value
2015-04-02 16:04:09 -07:00
Kris Rousey
547ee5bb2a Changing the case of API to be consistent with surrounding uses. 2015-04-01 14:49:33 -07:00
derekwaynecarr
dbe4d42934 Update design doc for limit range change 2015-04-01 16:54:21 -04:00
Tamer Tas
e5f29b915d Fix typo in Secrets design document 2015-04-01 01:18:49 +03:00
Tamer Tas
6c10cf7b98 Fix typo in Secrets 2015-04-01 00:56:20 +03:00
Mark Maglana
fd29104ff5 Fix confusing use of "comprise"
The word "comprise" means "be composed of" or "contain" so
"applications comprised of multiple containers" would mean
"applications composed of of multiple containers" or "applications
contained of multiple containers" which is confusing.

I understand that this is nitpicking and that "comprise" has a new
meaning which is the opposite of its original definition just like
how "literally" now means "figuratively" to some people. However, I
believe that clarity is of utmost importance in technical
documentation which is why I'm proposing this change.
2015-03-25 14:55:34 -07:00
Brian Grant
8da8cf16b0 Merge pull request #5844 from wojtek-t/change_ns_to_namespaces
Change "/ns" to "/namespaces" in few remaining places.
2015-03-24 07:30:33 -07:00
Wojciech Tyczynski
f7191d626d Change "/ns" to "/namespaces" in few remaining places. 2015-03-24 13:05:32 +01:00
Maciej Szulik
6a2ee9ae9f Fixed markdown 2015-03-24 12:01:41 +01:00
Brian Grant
3e91fc5288 Merge pull request #5195 from derekwaynecarr/update_namespace_design
Design graceful termination of Namespaces
2015-03-20 09:00:35 -07:00
derekwaynecarr
3672d8d728 Update namespaces design 2015-03-18 11:33:02 -04:00
Wojciech Tyczynski
e6d188fca8 Remove BoundPod structure 2015-03-17 10:27:41 +01:00
Derek Carr
91131a654e Merge pull request #5186 from markturansky/pv_proposal
Persistent Storage proposal edits
2015-03-12 09:58:02 -04:00
Salvatore Dario Minonne
3e6472f5c4 updating labels.md and design/labels.md 2015-03-11 23:29:59 +01:00
markturansky
3157ffb283 Added verbiage about events 2015-03-10 10:18:24 -04:00
markturansky
bfe719d90d Edited to reflect that PVs have no namespace 2015-03-09 12:21:54 -04:00
Young
8bb4a4b439 simple typo 2015-03-08 15:38:21 +00:00
markturansky
ddb092481d Added more detail and explained workflow/lifecycle of a persistent volume using examples 2015-03-05 11:55:16 -05:00
markturansky
17dc95dd6f Persistent storage proposal 2015-03-03 15:06:18 -05:00
Paul Morie
85e890840e Fix nits in security proposal 2015-02-25 14:39:01 -05:00
Vish Kannan
561ad98901 Merge pull request #4741 from benmccann/docs-update
Docs: update links
2015-02-24 12:56:34 -08:00
Ben McCann
b73662ac95 Update links to security contexts and service accounts to point to actual docs instead of pull requests now that those proposals have been merged 2015-02-23 13:55:02 -08:00
Tim Hockin
3e7248f0f4 comments on base64-ness of secrets 2015-02-23 12:40:06 -08:00
Tim Hockin
8bdfc352ce minor fixups as I review secrets 2015-02-23 12:39:47 -08:00
Eric Tune
38a85ef81e Service account proposal.
COMMIT_BLOCKED_ON_GENDOCS
2015-02-20 12:04:39 -08:00
Victor Marmol
49e7900e1a Merge pull request #4665 from ddysher/admission-doc
Admission doc cleanup
2015-02-20 09:35:38 -08:00
Deyuan Deng
a43a039e5f Admission doc cleanup 2015-02-20 10:46:09 -05:00
Andy Goldstein
5bd0e9ab05 Add streaming command execution & port forwarding
Add streaming command execution & port forwarding via HTTP connection
upgrades (currently using SPDY).
2015-02-20 09:57:02 -05:00
Paul Morie
777b464de5 Minor addendums to secrets proposal 2015-02-19 12:02:18 -05:00
Eric Tune
e045b19bec Merge pull request #4126 from pmorie/secrets_proposal
Secrets proposal
2015-02-18 09:05:18 -08:00
Paul Morie
ea18e6698d Secrets proposal 2015-02-17 20:29:38 -05:00
Saad Ali
9d850be8d7 Update Event Compression Design Doc with LRU Cache 2015-02-17 16:36:08 -08:00
Eric Tune
97b7f7c391 Merge pull request #3910 from csrwng/security_contexts
[Proposal] Security Contexts
2015-02-17 08:42:06 -08:00
Eric Tune
64678b71f3 Merge pull request #4372 from saad-ali/event_compression_doc
Documentation for Event Compression
2015-02-14 00:11:32 -08:00
Eric Tune
e84b5b9e78 Merge pull request #4029 from smarterclayton/security_proposal
Kubernetes pod and namespace security model
2015-02-13 09:08:37 -08:00
Clayton Coleman
358d1ab304 Kubernetes pod and namespace security model
This proposed update to docs/design/security.md includes proposals
on how to ensure containers have consistent Linux security behavior
across nodes, how containers authenticate and authorize to the master
and other components, and how secret data could be distributed to
pods to allow that authentication.

References concepts from #3910, #2030, and #2297 as well as upstream issues
around the Docker vault and Docker secrets.
2015-02-12 10:37:27 -05:00
Saad Ali
b2d432005f Documentation for Event Compression 2015-02-11 18:04:30 -08:00
csrwng
2b01746104 Specify intent for container isolation and add details for id mapping 2015-02-09 14:21:40 -05:00
Alex Robinson
ad8aaaad0e Fix the broken links in the labels and access design docs. 2015-02-03 23:02:21 +00:00