Compare commits
37 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 42e97ac889 | |||
| 25d0d3edb4 | |||
| 2753f80465 | |||
| 587920e622 | |||
| c6b909de18 | |||
| 98d5d8ede6 | |||
| 5137ba582a | |||
| 6dac39de5b | |||
| 5e9ea589d5 | |||
| 210f7ba24b | |||
| 310b3980db | |||
| 685396fb8d | |||
| c00c946d13 | |||
| dda7d83b7f | |||
| e441af2e27 | |||
| f2b71cc84d | |||
| 51d779fe41 | |||
| edd9e6c565 | |||
| bc25964394 | |||
| c9eb0737cb | |||
| 857c1bfe86 | |||
| a6af64c989 | |||
| e4a301ea68 | |||
| 2c7fb7c3e9 | |||
| e2d46b3d76 | |||
| 1510c31f16 | |||
| 0d0cc45c7d | |||
| 3b4700d2ce | |||
| ce9cfacb7f | |||
| 38e819845a | |||
| 90dcb039db | |||
| a73e5d5139 | |||
| 38c50e11e0 | |||
| 9f95738233 | |||
| 153e91d370 | |||
| 7cf77d926e | |||
| 533786c368 |
@@ -14,7 +14,7 @@
|
||||
|
||||
|
||||
**Page to Update:**
|
||||
https://kubernetes.io/...
|
||||
http://kubernetes.io/...
|
||||
|
||||
<!--Optional Information (remove the comment tags around information you would like to include)-->
|
||||
<!--Kubernetes Version:-->
|
||||
|
||||
@@ -1,8 +1,7 @@
|
||||
>^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
> For 1.10 Features: set Milestone to 1.10 and Base Branch to release-1.10
|
||||
>^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
> NOTE: After opening the PR, please *un-check and re-check* the ["Allow edits from maintainers"](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) box so that maintainers can work on your patch and speed up the review process. This is a temporary workaround to address a known issue with GitHub.>
|
||||
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
> For 1.7 Features: set Milestone to `1.7` and Base Branch to `release-1.7`
|
||||
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
>
|
||||
> NOTE: Please check the “Allow edits from maintainers” box below to allow
|
||||
> reviewers fix problems on your patch and speed up the review process.
|
||||
> Please delete this note before submitting the pull request.
|
||||
|
||||

|
||||
|
||||
+13
-8
@@ -1,24 +1,29 @@
|
||||
language: go
|
||||
go:
|
||||
- 1.8.3
|
||||
- 1.8.1
|
||||
|
||||
# Don't want default ./... here:
|
||||
install:
|
||||
- export PATH=$GOPATH/bin:$PATH
|
||||
- mkdir -p $HOME/gopath/src/k8s.io
|
||||
- mv $TRAVIS_BUILD_DIR $HOME/gopath/src/k8s.io/website
|
||||
- cd $HOME/gopath/src/k8s.io/website
|
||||
- mv $TRAVIS_BUILD_DIR $HOME/gopath/src/k8s.io/kubernetes.github.io
|
||||
|
||||
# (1) Fetch dependencies for us to run the tests in test/examples_test.go
|
||||
- pushd $GOPATH/src/k8s.io && git clone https://github.com/kubernetes/kubernetes && popd
|
||||
- pushd $GOPATH/src/k8s.io/kubernetes && git checkout release-1.9 && popd
|
||||
- go get -t -v k8s.io/kubernetes.github.io/test
|
||||
|
||||
# (2) Simplified deduplication of dependencies.
|
||||
# Simplified deduplication of dependencies.
|
||||
- cp -L -R $GOPATH/src/k8s.io/kubernetes/vendor/ $GOPATH/src/
|
||||
- rm -r $GOPATH/src/k8s.io/kubernetes/vendor/
|
||||
|
||||
- go get -t -v k8s.io/website/test
|
||||
# (2) Fetch md-check along with all its dependencies.
|
||||
- git clone --depth=50 --branch=master https://github.com/kubernetes/md-check $HOME/gopath/src/k8s.io/md-check
|
||||
- go get -t -v k8s.io/md-check
|
||||
|
||||
# (3) Fetch mungedocs
|
||||
- go get -v k8s.io/kubernetes/cmd/mungedocs
|
||||
|
||||
script:
|
||||
- go test -v k8s.io/website/test
|
||||
- go test -v k8s.io/kubernetes.github.io/test
|
||||
- $GOPATH/bin/md-check --root-dir=$HOME/gopath/src/k8s.io/kubernetes.github.io
|
||||
- ./verify-docs-format.sh
|
||||
- $GOPATH/bin/mungedocs --verbose --verify --upstream=origin --root-dir=$HOME/gopath/src/k8s.io/kubernetes.github.io/docs/ --repo-root=$HOME/gopath/src/k8s.io/kubernetes.github.io --skip-munges=remove-whitespace,blank-lines-surround-preformatted,header-lines,sync-examples,analytics,analytics,kubectl-dash-f,table-of-contents,md-links,kubectl-dash-f
|
||||
|
||||
+5
-5
@@ -9,7 +9,7 @@ These are just guidelines, not rules. Use your best judgment, and feel free to p
|
||||
|
||||
### Code of Conduct
|
||||
|
||||
Kubernetes follows the [Cloud Native Computing Foundation (CNCF) Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to Sarah Novotny [sarahnovotny@google.com](mailto:sarahnovotny@google.com) and/or Dan Kohn [dan@linuxfoundation.org](mailto:dan@linuxfoundation.org).
|
||||
Kubernetes follows the [Cloud Native Computing Foundation (CNCF) Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to Sarah Novotny [sarahnovotny@google.com](mailto:sarahnovotny@google.com) and/or Dan Kohn [dan@linuxfoundation.org](mailto:dan@linuxfoundation.org).
|
||||
|
||||
### Documentation and Site Decisions
|
||||
|
||||
@@ -17,7 +17,7 @@ The [Kubernetes SIG Docs Discussion Group](https://groups.google.com/forum/#!for
|
||||
|
||||
### Style Guides and Templates
|
||||
|
||||
Before submitting a pull request to create new content, please review the [Kubernetes.io style guide](http://kubernetes.io/docs/home/contribute/style-guide/) and follow the [instructions for using page templates](http://kubernetes.io/docs/home/contribute/page-templates/).
|
||||
Before submitting a pull request to create new content, please review the [Kubernetes.io style guide](http://kubernetes.io/docs/home/contribute/style-guide/) and follow the [instructions for using page templates](http://kubernetes.io/docs/home/contribute/page-templates/).
|
||||
|
||||
|
||||
## Contributing to Documentation
|
||||
@@ -26,10 +26,10 @@ Before submitting a pull request to create new content, please review the [Kuber
|
||||
|
||||
Kubernetes.io uses github issues to track documentation issues and requests. If you see a documentation issue, submit an issue using the following steps:
|
||||
|
||||
1. Check the [kubernetes.io issues list](https://github.com/kubernetes/website/issues) as you might find out the issue is a duplicate.
|
||||
2. Use the [included template for every new issue](https://github.com/kubernetes/website/issues/new). When you create a bug report, include as many details as possible and include suggested fixes to the issue.
|
||||
1. Check the [kubernetes.io issues list](https://github.com/kubernetes/kubernetes.github.io/issues) as you might find out the issue is a duplicate.
|
||||
2. Use the [included template for every new issue](https://github.com/kubernetes/kubernetes.github.io/issues/new). When you create a bug report, include as many details as possible and include suggested fixes to the issue.
|
||||
|
||||
Note that code issues should be filed against the main kubernetes repository, while documentation issues should go in the kubernetes.io repository.
|
||||
Note that code issues should be filed against the main kubernetes repository, while documentation issues should go in the kubernetes.io repository.
|
||||
|
||||
### Submitting Documentation Pull Requests
|
||||
|
||||
|
||||
@@ -1,53 +1,4 @@
|
||||
source "https://rubygems.org"
|
||||
|
||||
# gem "github-pages", group: :jekyll_plugins
|
||||
|
||||
gem "jekyll", "3.6.0"
|
||||
|
||||
group :github_pages_compatible do
|
||||
gem "json", "~> 1.7", ">= 1.7.7"
|
||||
gem "coffee-script", "~> 2.4"
|
||||
gem "coffee-script-source", "~> 1.12"
|
||||
gem "ethon", "~> 0.10"
|
||||
gem "execjs", "~> 2.7"
|
||||
gem "minima", "~> 2.0"
|
||||
gem "terminal-table", "~> 1.4"
|
||||
gem "unicode-display_width", "~> 1.1"
|
||||
end
|
||||
|
||||
group :jekyll_plugins do
|
||||
gem "jekyll-feed", "~> 0.6"
|
||||
gem "jekyll-sitemap"
|
||||
gem "jekyll-gist"
|
||||
gem "jekyll-paginate", "1.1.0"
|
||||
gem "jekyll-seo-tag"
|
||||
gem "jekyll-avatar", "~> 0.4"
|
||||
gem "jekyll-coffeescript", "~> 1.0"
|
||||
gem "jekyll-default-layout", "~> 0.1"
|
||||
gem "jekyll-github-metadata", "~> 2.2"
|
||||
gem "jekyll-optional-front-matter", "~> 0.1"
|
||||
gem "jekyll-readme-index", "0.0.3"
|
||||
gem "jekyll-redirect-from", "~> 0.13"
|
||||
gem "jekyll-relative-links", "~> 0.2"
|
||||
gem "jekyll-swiss", "~> 0.4"
|
||||
gem "jekyll-theme-architect", "0.0.3"
|
||||
gem "jekyll-theme-cayman", "0.0.3"
|
||||
gem "jekyll-theme-dinky", "0.0.3"
|
||||
gem "jekyll-theme-hacker", "0.0.3"
|
||||
gem "jekyll-theme-leap-day", "0.0.3"
|
||||
gem "jekyll-theme-merlot", "0.0.3"
|
||||
gem "jekyll-theme-midnight", "0.0.3"
|
||||
gem "jekyll-theme-minimal", "0.0.3"
|
||||
gem "jekyll-theme-modernist", "0.0.3"
|
||||
gem "jekyll-theme-primer", "~> 0.1"
|
||||
gem "jekyll-theme-slate", "0.0.3"
|
||||
gem "jekyll-theme-tactile", "0.0.3"
|
||||
gem "jekyll-theme-time-machine", "0.0.3"
|
||||
gem "jekyll-titles-from-headings", "~> 0.1"
|
||||
end
|
||||
|
||||
gem "github-pages", group: :jekyll_plugins
|
||||
gem "jekyll-include-cache", "~> 0.1"
|
||||
|
||||
gem "kramdown", "~> 1.11"
|
||||
gem "rouge", "~> 2.0"
|
||||
gem "pry"
|
||||
|
||||
+122
-95
@@ -1,61 +1,123 @@
|
||||
GEM
|
||||
remote: https://rubygems.org/
|
||||
specs:
|
||||
addressable (2.5.2)
|
||||
public_suffix (>= 2.0.2, < 4.0)
|
||||
coderay (1.1.2)
|
||||
activesupport (4.2.7)
|
||||
i18n (~> 0.7)
|
||||
json (~> 1.7, >= 1.7.7)
|
||||
minitest (~> 5.1)
|
||||
thread_safe (~> 0.3, >= 0.3.4)
|
||||
tzinfo (~> 1.1)
|
||||
addressable (2.5.0)
|
||||
public_suffix (~> 2.0, >= 2.0.2)
|
||||
coffee-script (2.4.1)
|
||||
coffee-script-source
|
||||
execjs
|
||||
coffee-script-source (1.12.2)
|
||||
colorator (1.1.0)
|
||||
ethon (0.11.0)
|
||||
ethon (0.10.1)
|
||||
ffi (>= 1.3.0)
|
||||
execjs (2.7.0)
|
||||
faraday (0.13.1)
|
||||
faraday (0.10.0)
|
||||
multipart-post (>= 1.2, < 3)
|
||||
ffi (1.9.18)
|
||||
ffi (1.9.14)
|
||||
forwardable-extended (2.6.0)
|
||||
jekyll (3.6.0)
|
||||
gemoji (2.1.0)
|
||||
github-pages (112)
|
||||
activesupport (= 4.2.7)
|
||||
github-pages-health-check (= 1.3.0)
|
||||
jekyll (= 3.3.1)
|
||||
jekyll-avatar (= 0.4.2)
|
||||
jekyll-coffeescript (= 1.0.1)
|
||||
jekyll-default-layout (= 0.1.4)
|
||||
jekyll-feed (= 0.8.0)
|
||||
jekyll-gist (= 1.4.0)
|
||||
jekyll-github-metadata (= 2.2.0)
|
||||
jekyll-mentions (= 1.2.0)
|
||||
jekyll-optional-front-matter (= 0.1.2)
|
||||
jekyll-paginate (= 1.1.0)
|
||||
jekyll-readme-index (= 0.0.3)
|
||||
jekyll-redirect-from (= 0.11.0)
|
||||
jekyll-relative-links (= 0.2.1)
|
||||
jekyll-sass-converter (= 1.3.0)
|
||||
jekyll-seo-tag (= 2.1.0)
|
||||
jekyll-sitemap (= 0.12.0)
|
||||
jekyll-swiss (= 0.4.0)
|
||||
jekyll-theme-architect (= 0.0.3)
|
||||
jekyll-theme-cayman (= 0.0.3)
|
||||
jekyll-theme-dinky (= 0.0.3)
|
||||
jekyll-theme-hacker (= 0.0.3)
|
||||
jekyll-theme-leap-day (= 0.0.3)
|
||||
jekyll-theme-merlot (= 0.0.3)
|
||||
jekyll-theme-midnight (= 0.0.3)
|
||||
jekyll-theme-minimal (= 0.0.3)
|
||||
jekyll-theme-modernist (= 0.0.3)
|
||||
jekyll-theme-primer (= 0.1.5)
|
||||
jekyll-theme-slate (= 0.0.3)
|
||||
jekyll-theme-tactile (= 0.0.3)
|
||||
jekyll-theme-time-machine (= 0.0.3)
|
||||
jekyll-titles-from-headings (= 0.1.3)
|
||||
jemoji (= 0.7.0)
|
||||
kramdown (= 1.11.1)
|
||||
liquid (= 3.0.6)
|
||||
listen (= 3.0.6)
|
||||
mercenary (~> 0.3)
|
||||
minima (= 2.0.0)
|
||||
rouge (= 1.11.1)
|
||||
terminal-table (~> 1.4)
|
||||
github-pages-health-check (1.3.0)
|
||||
addressable (~> 2.3)
|
||||
net-dns (~> 0.8)
|
||||
octokit (~> 4.0)
|
||||
public_suffix (~> 2.0)
|
||||
typhoeus (~> 0.7)
|
||||
html-pipeline (2.4.2)
|
||||
activesupport (>= 2)
|
||||
nokogiri (>= 1.4)
|
||||
i18n (0.7.0)
|
||||
jekyll (3.3.1)
|
||||
addressable (~> 2.4)
|
||||
colorator (~> 1.0)
|
||||
jekyll-sass-converter (~> 1.0)
|
||||
jekyll-watch (~> 1.1)
|
||||
kramdown (~> 1.14)
|
||||
liquid (~> 4.0)
|
||||
kramdown (~> 1.3)
|
||||
liquid (~> 3.0)
|
||||
mercenary (~> 0.3.3)
|
||||
pathutil (~> 0.9)
|
||||
rouge (>= 1.7, < 3)
|
||||
rouge (~> 1.7)
|
||||
safe_yaml (~> 1.0)
|
||||
jekyll-avatar (0.5.0)
|
||||
jekyll-avatar (0.4.2)
|
||||
jekyll (~> 3.0)
|
||||
jekyll-coffeescript (1.0.1)
|
||||
coffee-script (~> 2.2)
|
||||
jekyll-default-layout (0.1.4)
|
||||
jekyll (~> 3.0)
|
||||
jekyll-feed (0.9.2)
|
||||
jekyll-feed (0.8.0)
|
||||
jekyll (~> 3.3)
|
||||
jekyll-gist (1.4.1)
|
||||
jekyll-gist (1.4.0)
|
||||
octokit (~> 4.2)
|
||||
jekyll-github-metadata (2.9.3)
|
||||
jekyll-github-metadata (2.2.0)
|
||||
jekyll (~> 3.1)
|
||||
octokit (~> 4.0, != 4.4.0)
|
||||
jekyll-include-cache (0.1.0)
|
||||
jekyll (~> 3.3)
|
||||
jekyll-optional-front-matter (0.3.0)
|
||||
jekyll-mentions (1.2.0)
|
||||
activesupport (~> 4.0)
|
||||
html-pipeline (~> 2.3)
|
||||
jekyll (~> 3.0)
|
||||
jekyll-optional-front-matter (0.1.2)
|
||||
jekyll (~> 3.0)
|
||||
jekyll-paginate (1.1.0)
|
||||
jekyll-readme-index (0.0.3)
|
||||
jekyll (~> 3.0)
|
||||
jekyll-redirect-from (0.13.0)
|
||||
jekyll-redirect-from (0.11.0)
|
||||
jekyll (>= 2.0)
|
||||
jekyll-relative-links (0.2.1)
|
||||
jekyll (~> 3.3)
|
||||
jekyll-relative-links (0.5.1)
|
||||
jekyll-sass-converter (1.3.0)
|
||||
sass (~> 3.2)
|
||||
jekyll-seo-tag (2.1.0)
|
||||
jekyll (~> 3.3)
|
||||
jekyll-sass-converter (1.5.0)
|
||||
sass (~> 3.4)
|
||||
jekyll-seo-tag (2.3.0)
|
||||
jekyll (~> 3.3)
|
||||
jekyll-sitemap (1.1.1)
|
||||
jekyll-sitemap (0.12.0)
|
||||
jekyll (~> 3.3)
|
||||
jekyll-swiss (0.4.0)
|
||||
jekyll-theme-architect (0.0.3)
|
||||
@@ -76,101 +138,66 @@ GEM
|
||||
jekyll (~> 3.3)
|
||||
jekyll-theme-modernist (0.0.3)
|
||||
jekyll (~> 3.3)
|
||||
jekyll-theme-primer (0.5.2)
|
||||
jekyll (~> 3.5)
|
||||
jekyll-github-metadata (~> 2.9)
|
||||
jekyll-seo-tag (~> 2.2)
|
||||
jekyll-theme-primer (0.1.5)
|
||||
jekyll (~> 3.3)
|
||||
jekyll-theme-slate (0.0.3)
|
||||
jekyll (~> 3.3)
|
||||
jekyll-theme-tactile (0.0.3)
|
||||
jekyll (~> 3.3)
|
||||
jekyll-theme-time-machine (0.0.3)
|
||||
jekyll (~> 3.3)
|
||||
jekyll-titles-from-headings (0.5.0)
|
||||
jekyll-titles-from-headings (0.1.3)
|
||||
jekyll (~> 3.3)
|
||||
jekyll-watch (1.5.0)
|
||||
listen (~> 3.0, < 3.1)
|
||||
json (1.8.6)
|
||||
kramdown (1.15.0)
|
||||
liquid (4.0.0)
|
||||
listen (3.0.8)
|
||||
rb-fsevent (~> 0.9, >= 0.9.4)
|
||||
rb-inotify (~> 0.9, >= 0.9.7)
|
||||
jemoji (0.7.0)
|
||||
activesupport (~> 4.0)
|
||||
gemoji (~> 2.0)
|
||||
html-pipeline (~> 2.2)
|
||||
jekyll (>= 3.0)
|
||||
json (1.8.3)
|
||||
kramdown (1.11.1)
|
||||
liquid (3.0.6)
|
||||
listen (3.0.6)
|
||||
rb-fsevent (>= 0.9.3)
|
||||
rb-inotify (>= 0.9.7)
|
||||
mercenary (0.3.6)
|
||||
method_source (0.9.0)
|
||||
minima (2.1.1)
|
||||
jekyll (~> 3.3)
|
||||
mini_portile2 (2.1.0)
|
||||
minima (2.0.0)
|
||||
minitest (5.10.1)
|
||||
multipart-post (2.0.0)
|
||||
octokit (4.7.0)
|
||||
net-dns (0.8.0)
|
||||
nokogiri (1.6.8.1)
|
||||
mini_portile2 (~> 2.1.0)
|
||||
octokit (4.6.2)
|
||||
sawyer (~> 0.8.0, >= 0.5.3)
|
||||
pathutil (0.16.0)
|
||||
pathutil (0.14.0)
|
||||
forwardable-extended (~> 2.6)
|
||||
pry (0.11.2)
|
||||
coderay (~> 1.1.0)
|
||||
method_source (~> 0.9.0)
|
||||
public_suffix (3.0.0)
|
||||
rb-fsevent (0.10.2)
|
||||
rb-inotify (0.9.10)
|
||||
ffi (>= 0.5.0, < 2)
|
||||
rouge (2.2.1)
|
||||
public_suffix (2.0.4)
|
||||
rb-fsevent (0.9.8)
|
||||
rb-inotify (0.9.7)
|
||||
ffi (>= 0.5.0)
|
||||
rouge (1.11.1)
|
||||
safe_yaml (1.0.4)
|
||||
sass (3.5.3)
|
||||
sass-listen (~> 4.0.0)
|
||||
sass-listen (4.0.0)
|
||||
rb-fsevent (~> 0.9, >= 0.9.4)
|
||||
rb-inotify (~> 0.9, >= 0.9.7)
|
||||
sass (3.4.23)
|
||||
sawyer (0.8.1)
|
||||
addressable (>= 2.3.5, < 2.6)
|
||||
faraday (~> 0.8, < 1.0)
|
||||
terminal-table (1.8.0)
|
||||
unicode-display_width (~> 1.1, >= 1.1.1)
|
||||
unicode-display_width (1.3.0)
|
||||
terminal-table (1.7.3)
|
||||
unicode-display_width (~> 1.1.1)
|
||||
thread_safe (0.3.5)
|
||||
typhoeus (0.8.0)
|
||||
ethon (>= 0.8.0)
|
||||
tzinfo (1.2.2)
|
||||
thread_safe (~> 0.1)
|
||||
unicode-display_width (1.1.2)
|
||||
|
||||
PLATFORMS
|
||||
ruby
|
||||
|
||||
DEPENDENCIES
|
||||
coffee-script (~> 2.4)
|
||||
coffee-script-source (~> 1.12)
|
||||
ethon (~> 0.10)
|
||||
execjs (~> 2.7)
|
||||
jekyll (= 3.6.0)
|
||||
jekyll-avatar (~> 0.4)
|
||||
jekyll-coffeescript (~> 1.0)
|
||||
jekyll-default-layout (~> 0.1)
|
||||
jekyll-feed (~> 0.6)
|
||||
jekyll-gist
|
||||
jekyll-github-metadata (~> 2.2)
|
||||
github-pages
|
||||
jekyll-include-cache (~> 0.1)
|
||||
jekyll-optional-front-matter (~> 0.1)
|
||||
jekyll-paginate (= 1.1.0)
|
||||
jekyll-readme-index (= 0.0.3)
|
||||
jekyll-redirect-from (~> 0.13)
|
||||
jekyll-relative-links (~> 0.2)
|
||||
jekyll-seo-tag
|
||||
jekyll-sitemap
|
||||
jekyll-swiss (~> 0.4)
|
||||
jekyll-theme-architect (= 0.0.3)
|
||||
jekyll-theme-cayman (= 0.0.3)
|
||||
jekyll-theme-dinky (= 0.0.3)
|
||||
jekyll-theme-hacker (= 0.0.3)
|
||||
jekyll-theme-leap-day (= 0.0.3)
|
||||
jekyll-theme-merlot (= 0.0.3)
|
||||
jekyll-theme-midnight (= 0.0.3)
|
||||
jekyll-theme-minimal (= 0.0.3)
|
||||
jekyll-theme-modernist (= 0.0.3)
|
||||
jekyll-theme-primer (~> 0.1)
|
||||
jekyll-theme-slate (= 0.0.3)
|
||||
jekyll-theme-tactile (= 0.0.3)
|
||||
jekyll-theme-time-machine (= 0.0.3)
|
||||
jekyll-titles-from-headings (~> 0.1)
|
||||
json (~> 1.7, >= 1.7.7)
|
||||
kramdown (~> 1.11)
|
||||
minima (~> 2.0)
|
||||
pry
|
||||
rouge (~> 2.0)
|
||||
terminal-table (~> 1.4)
|
||||
unicode-display_width (~> 1.1)
|
||||
|
||||
BUNDLED WITH
|
||||
1.15.4
|
||||
1.13.6
|
||||
|
||||
@@ -6,13 +6,10 @@ help: ## Show this help.
|
||||
all: build ## Build site with production settings and put deliverables in _site.
|
||||
|
||||
build: ## Build site with production settings and put deliverables in _site.
|
||||
bundle exec jekyll build
|
||||
jekyll build
|
||||
|
||||
build-preview: ## Build site with drafts and future posts enabled.
|
||||
bundle exec jekyll build --drafts --future
|
||||
jekyll build --drafts --future
|
||||
|
||||
serve: ## Boot the development server.
|
||||
bundle exec jekyll serve
|
||||
|
||||
stage: ## Run the Jekyll staging container.
|
||||
docker run -ti --rm -v "${PWD}":/k8sdocs -p 4000:4000 gcr.io/google-samples/k8sdocs:1.1
|
||||
jekyll serve
|
||||
|
||||
@@ -1,21 +1,6 @@
|
||||
# Reviewers can /lgtm /approve but not sufficient for auto-merge without an
|
||||
# approver
|
||||
reviewers:
|
||||
- rajakavitha1
|
||||
- stewart-yu
|
||||
- xiangpengzhao
|
||||
- zhangxiaoyu-zidif
|
||||
|
||||
# Approvers have all the ability of reviewers but their /approve makes
|
||||
# auto-merge happen if a /lgtm exists, or vice versa, or they can do both
|
||||
# No need for approvers to also be listed as reviewers
|
||||
approvers:
|
||||
- bradamant3
|
||||
- bradtopol
|
||||
- chenopis
|
||||
- kbarnard10
|
||||
- mistyhacks
|
||||
- steveperry-53
|
||||
- tengqm
|
||||
- zacharysarah
|
||||
- zparnold
|
||||
assignees:
|
||||
- smarterclayton
|
||||
- janetkuo
|
||||
- pwittrock
|
||||
- kelseyhightower
|
||||
- jaredbhatti
|
||||
|
||||
-205
@@ -1,205 +0,0 @@
|
||||
aliases:
|
||||
sig-api-machinery: #Team: API Server; GH: sig-api-machinery-pr-reviews; e.g. Annotations, Labels
|
||||
- lavalamp
|
||||
- sttts
|
||||
- liggitt
|
||||
- smarterclayton
|
||||
- deads2k
|
||||
sig-apps: #Team: Workloads; GH: sig-apps-pr-reviews; e.g. ConfigMaps, CronJobs, CustomResourceDefinitions, DaemonSets, Deployments, Jobs, Secrets, StatefulSets
|
||||
- enisoc
|
||||
- erictune
|
||||
- foxish
|
||||
- janetkuo
|
||||
- kow3ns
|
||||
- lukaszo
|
||||
- mfojtik
|
||||
- smarterclayton
|
||||
- soltysh
|
||||
- tnozicka
|
||||
sig-architecture: #GH: sig-architecture-pr-reviews
|
||||
- smarterclayton
|
||||
- bgrant0607
|
||||
sig-auth: #GH: sig-auth-pr-reviews
|
||||
- php-coder
|
||||
- liggitt
|
||||
- mikedanese
|
||||
- ericchiang
|
||||
- mattmoyer
|
||||
- enj
|
||||
- deads2k
|
||||
- davidopp
|
||||
sig-autoscaling: #GH: sig-autoscaling-pr-reviews
|
||||
- DirectXMan12
|
||||
- bskiba
|
||||
- aleksandra-malinowska
|
||||
- MaciekPytel
|
||||
- davidopp
|
||||
- mwielgus
|
||||
sig-aws: #Amazon AWS
|
||||
- justinsb
|
||||
- kris-nova
|
||||
- chrislovecnm
|
||||
- mfburnett
|
||||
sig-azure: #Microsoft Azure
|
||||
- slack
|
||||
- colemickens
|
||||
- jdumars
|
||||
sig-big-data: #GH: sig-big-data-pr-reviews
|
||||
- foxish
|
||||
sig-cli: #Team: CLI; GH: sig-cli-pr-reviews; e.g. kubectl
|
||||
- adohe
|
||||
- deads2k
|
||||
- derekwaynecarr
|
||||
- dims
|
||||
- dshulyak
|
||||
- eparis
|
||||
- ericchiang
|
||||
- ghodss
|
||||
- mengqiy
|
||||
- rootfs
|
||||
- shiywang
|
||||
- smarterclayton
|
||||
- soltysh
|
||||
- sttts
|
||||
sig-cluster-lifecycle: #GH: sig-cluster-lifecycle-pr-reviews
|
||||
- jbeda
|
||||
- timothysc
|
||||
- lukemarsden
|
||||
- pipejakob
|
||||
- dmmcquay
|
||||
- mattmoyer
|
||||
- luxas
|
||||
- roberthbailey
|
||||
- medinatiger
|
||||
sig-cluster-ops:
|
||||
- zehicle
|
||||
- jdumars
|
||||
sig-contribex: #aka Contributor Experience; GH: sig-contributor-experience-pr-reviews
|
||||
- rmmh
|
||||
- cblecker
|
||||
- apelisse
|
||||
- grodrigues3
|
||||
- spxtr
|
||||
sig-contributor-experience: #GH: sig-contributor-experience-pr-reviews
|
||||
- rmmh
|
||||
- cblecker
|
||||
- apelisse
|
||||
- grodrigues3
|
||||
- spxtr
|
||||
sig-docs: #Team: documentation; GH: sig-docs-pr-reviews
|
||||
- bradamant3
|
||||
- steveperry-53
|
||||
- zacharysarah
|
||||
- bradtopol
|
||||
- heckj
|
||||
sig-federation: #Team: Federation; e.g. Federated Clusters
|
||||
- csbell
|
||||
sig-gcp: #Google Cloud Platform; GH: sig-gcp-pr-reviews
|
||||
- abgworrall
|
||||
sig-instrumentation: #GH: sig-instrumentation-pr-reviews; e.g. metrics, logging, events
|
||||
- DirectXMan12
|
||||
- x13n
|
||||
- kawych
|
||||
- crassirostris
|
||||
- brancz
|
||||
- fabxc
|
||||
- loburm
|
||||
- piosz
|
||||
- fgrzadkowski
|
||||
sig-multicluster: #GH: sig-multicluster-pr-reviews; e.g. resiliency against availability zone outages; hybrid clouds; spanning multiple cloud providers; migration to public clouds
|
||||
- madhusudancs
|
||||
- marun
|
||||
- jianhuiz
|
||||
- shashidharatd
|
||||
- nikhiljindal
|
||||
- quinton-hoole
|
||||
- mwielgus
|
||||
- csbell
|
||||
sig-network: #Team: Network; GH: sig-network-pr-reviews; e.g. Ingress, Network Policies, Services
|
||||
- bowei
|
||||
- caseydavenport
|
||||
- danwinship
|
||||
- dcbw
|
||||
- dnardo
|
||||
- freehan
|
||||
- mrhohn
|
||||
- nicksardo
|
||||
- thockin
|
||||
sig-node: #Team: Node; GH: sig-node-pr-reviews; e.g. Containers, Docker, Images, OS images, Pods, Registries
|
||||
- Random-Liu
|
||||
- dashpole
|
||||
- dchen1107
|
||||
- derekwaynecarr
|
||||
- dims
|
||||
- feiskyer
|
||||
- mtaufen
|
||||
- ncdc
|
||||
- pmorie
|
||||
- resouer
|
||||
- sjpotter
|
||||
- tallclair
|
||||
- tmrts
|
||||
- vishh
|
||||
- yifan-gu
|
||||
- yujuhong
|
||||
sig-onprem: #On-premises; GH: sig-onprem-pr-reviews
|
||||
- zen
|
||||
- idvoretskyi
|
||||
- pigmej
|
||||
- feiskyer
|
||||
- nebril
|
||||
sig-openstack: #GH: sig-openstack-pr-reviews
|
||||
- hogepodge
|
||||
- dklyle
|
||||
- rjmorse
|
||||
sig-pm: #aka Product Management
|
||||
- apsinha
|
||||
- idvoretskyi
|
||||
- calebamiles
|
||||
sig-product-management:
|
||||
- apsinha
|
||||
- idvoretskyi
|
||||
- calebamiles
|
||||
sig-release: #GH: sig-release-pr-reviews
|
||||
- calebamiles
|
||||
- enisoc
|
||||
- pwittrock
|
||||
sig-rktnetes:
|
||||
- calebamiles
|
||||
sig-scalability: #GH: sig-scalability-pr-reviews
|
||||
- jbeda
|
||||
- spiffxp
|
||||
- lavalamp
|
||||
- countspongebob
|
||||
sig-scheduling: #Team: Sharing; GH: sig-scheduling-pr-reviews; e.g. Scheduler
|
||||
- bsalamat
|
||||
- davidopp
|
||||
- jayunit100
|
||||
- k82cn
|
||||
- resouer
|
||||
- timothysc
|
||||
- wojtek-t
|
||||
sig-service-catalog: #GH: sig-service-catalog-pr-reviews; e.g. Service Broker
|
||||
- pmorie
|
||||
- jessfraz
|
||||
- pwittrock
|
||||
- droot
|
||||
- seans3
|
||||
sig-storage: #Team: Storage; GH: sig-storage-pr-reviews; e.g. Volumes
|
||||
- childsb
|
||||
- jsafrane
|
||||
- rootfs
|
||||
- saad-ali
|
||||
- matchstick
|
||||
- msau42
|
||||
sig-testing: #GH: sig-testing-pr-reviews
|
||||
- fejta
|
||||
- ixdy
|
||||
- rmmh
|
||||
- spiffxp
|
||||
- spxtr
|
||||
sig-ui: #User Interface
|
||||
- danielromlein
|
||||
- floreks
|
||||
sig-windows:
|
||||
- michmike
|
||||
@@ -4,14 +4,11 @@ Welcome! We are very pleased you want to contribute to the Kubernetes documentat
|
||||
|
||||
You can click the **Fork** button in the upper-right area of the screen to create a copy of this repository in your GitHub account called a *fork*. Make any changes you want in your fork, and when you are ready to send those changes to us, go to your fork and create a new pull request to let us know about it.
|
||||
|
||||
Once your pull request is created, a Kubernetes reviewer will take responsibility for providing clear, actionable feedback. As the owner of the pull request, **it is your responsibility to modify your pull request to address the feedback that has been provided to you by the Kubernetes reviewer.** Also note that you may end up having more than one Kubernetes reviewer provide you feedback or you may end up getting feedback from a Kubernetes reviewer that is different than the one originally assigned to provide you feedback. Furthermore, in some cases, one of your reviewers might ask for a technical review from a [Kubernetes tech reviewer](https://github.com/kubernetes/website/wiki/Tech-reviewers) when needed. Reviewers will do their best to provide feedback in a timely fashion but response time can vary based on circumstances.
|
||||
|
||||
For more information about contributing to the Kubernetes documentation, see:
|
||||
|
||||
* [Contributing to the Kubernetes Documentation](http://kubernetes.io/editdocs/)
|
||||
* [Creating a Documentation Pull Request](http://kubernetes.io/docs/home/contribute/create-pull-request/)
|
||||
* [Writing a New Topic](http://kubernetes.io/docs/home/contribute/write-new-topic/)
|
||||
* [Review Issues](http://kubernetes.io/docs/home/contribute/review-issues/)
|
||||
* [Staging Your Documentation Changes](http://kubernetes.io/docs/home/contribute/stage-documentation-changes/)
|
||||
* [Using Page Templates](http://kubernetes.io/docs/home/contribute/page-templates/)
|
||||
* [Documentation Style Guide](http://kubernetes.io/docs/home/contribute/style-guide/)
|
||||
|
||||
+5
-37
@@ -13,45 +13,15 @@ incremental: true
|
||||
safe: false
|
||||
lsi: false
|
||||
|
||||
latest: "v1.9"
|
||||
defaults:
|
||||
-
|
||||
scope:
|
||||
path: ""
|
||||
values:
|
||||
fullversion: "v1.9.0"
|
||||
version: "v1.9"
|
||||
fullversion: "v1.6.3"
|
||||
version: "v1.6"
|
||||
githubbranch: "master"
|
||||
docsbranch: "master"
|
||||
versions:
|
||||
- fullversion: "v1.13.0"
|
||||
version: "v1.13"
|
||||
githubbranch: "v1.13.0"
|
||||
docsbranch: "release-1.13"
|
||||
url: https://kubernetes.io/docs/
|
||||
- fullversion: "v1.12.0"
|
||||
version: "v1.12"
|
||||
githubbranch: "v1.12.0"
|
||||
docsbranch: "release-1.12"
|
||||
url: https://v1-12.docs.kubernetes.io
|
||||
- fullversion: "v1.11.0"
|
||||
version: "v1.11"
|
||||
githubbranch: "v1.11.0"
|
||||
docsbranch: "release-1.11"
|
||||
url: https://v1-11.docs.kubernetes.io
|
||||
- fullversion: "v1.10.0"
|
||||
version: "v1.10"
|
||||
githubbranch: "v1.10.0"
|
||||
docsbranch: "release-1.10"
|
||||
url: https://v1-10.docs.kubernetes.io
|
||||
- fullversion: "v1.9.0"
|
||||
version: "v1.9"
|
||||
githubbranch: "v1.9.0"
|
||||
docsbranch: "release-1.9"
|
||||
url: https://v1-9.docs.kubernetes.io
|
||||
deprecated: true
|
||||
currentUrl: https://kubernetes.io/docs/home/
|
||||
nextUrl: http://kubernetes-io-vnext-staging.netlify.com/
|
||||
-
|
||||
scope:
|
||||
path: "docs"
|
||||
@@ -61,15 +31,14 @@ defaults:
|
||||
|
||||
permalink: pretty
|
||||
|
||||
plugins:
|
||||
gems:
|
||||
- jekyll-redirect-from
|
||||
- jekyll-feed
|
||||
- jekyll-sitemap
|
||||
- jekyll-seo-tag
|
||||
- jekyll-include-cache
|
||||
# disabled gems
|
||||
# - jekyll-redirect-from
|
||||
|
||||
include: [_redirects,_headers]
|
||||
include: [_headers]
|
||||
|
||||
# SEO
|
||||
logo: /images/favicon.png
|
||||
@@ -89,4 +58,3 @@ tocs:
|
||||
- reference
|
||||
- samples
|
||||
- search
|
||||
- imported
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
id: architecture
|
||||
name: Architecture
|
||||
description: The inner components of Kubernetes.
|
||||
@@ -1,3 +0,0 @@
|
||||
id: community
|
||||
name: Community
|
||||
description: Related to Kubernetes open-source development.
|
||||
@@ -1,3 +0,0 @@
|
||||
id: core-object
|
||||
name: Core Object
|
||||
description: A resource type that Kubernetes supports by default.
|
||||
@@ -1,3 +0,0 @@
|
||||
id: extension
|
||||
name: Extension
|
||||
description: Supported customizations of Kubernetes.
|
||||
@@ -1,3 +0,0 @@
|
||||
id: fundamental
|
||||
name: Fundamental
|
||||
description: Relevant for a first-time user of Kubernetes.
|
||||
@@ -1,3 +0,0 @@
|
||||
id: networking
|
||||
name: Networking
|
||||
description: How Kubernetes components talk to each other (and to programs outside the cluster).
|
||||
@@ -1,3 +0,0 @@
|
||||
id: operation
|
||||
name: Operation
|
||||
description: Starting and maintaining Kubernetes.
|
||||
@@ -1,3 +0,0 @@
|
||||
id: security
|
||||
name: Security
|
||||
description: Keeping Kubernetes applications safe and secure.
|
||||
@@ -1,3 +0,0 @@
|
||||
id: storage
|
||||
name: Storage
|
||||
description: How Kubernetes applications handle persistent data.
|
||||
@@ -1,3 +0,0 @@
|
||||
id: tool
|
||||
name: Tool
|
||||
description: Software that makes Kubernetes easier or better to use.
|
||||
@@ -1,3 +0,0 @@
|
||||
id: user-type
|
||||
name: User Type
|
||||
description: Represents a common type of Kubernetes user.
|
||||
@@ -1,3 +0,0 @@
|
||||
id: workload
|
||||
name: Workload
|
||||
description: Applications running on Kubernetes.
|
||||
+6
-43
@@ -1,15 +1,12 @@
|
||||
bigheader: "Concepts"
|
||||
abstract: "Detailed explanations of Kubernetes system concepts and abstractions."
|
||||
landing_page: /docs/concepts/index/
|
||||
toc:
|
||||
- docs/concepts/index.md
|
||||
|
||||
- title: Overview
|
||||
landing_page: /docs/concepts/overview/what-is-kubernetes/
|
||||
section:
|
||||
- docs/concepts/overview/what-is-kubernetes.md
|
||||
- docs/concepts/overview/components.md
|
||||
- docs/concepts/overview/kubernetes-api.md
|
||||
- title: Working with Kubernetes Objects
|
||||
section:
|
||||
- docs/concepts/overview/working-with-objects/kubernetes-objects.md
|
||||
@@ -17,43 +14,20 @@ toc:
|
||||
- docs/concepts/overview/working-with-objects/namespaces.md
|
||||
- docs/concepts/overview/working-with-objects/labels.md
|
||||
- docs/concepts/overview/working-with-objects/annotations.md
|
||||
- title: Object Management Using kubectl
|
||||
section:
|
||||
- docs/concepts/overview/object-management-kubectl/overview.md
|
||||
- docs/concepts/overview/object-management-kubectl/imperative-command.md
|
||||
- docs/concepts/overview/object-management-kubectl/imperative-config.md
|
||||
- docs/concepts/overview/object-management-kubectl/declarative-config.md
|
||||
- docs/concepts/overview/kubernetes-api.md
|
||||
|
||||
- title: Kubernetes Architecture
|
||||
landing_page: /docs/concepts/architecture/nodes/
|
||||
section:
|
||||
- docs/concepts/architecture/nodes.md
|
||||
- docs/concepts/architecture/master-node-communication.md
|
||||
- docs/concepts/architecture/cloud-controller.md
|
||||
|
||||
- title: Extending Kubernetes
|
||||
landing_page: /docs/concepts/api-extension/custom-resources/
|
||||
section:
|
||||
- docs/concepts/overview/extending.md
|
||||
- title: Extending the Kubernetes API
|
||||
section:
|
||||
- docs/concepts/api-extension/apiserver-aggregation.md
|
||||
- docs/concepts/api-extension/custom-resources.md
|
||||
- title: Compute, Storage, and Networking Extensions
|
||||
section:
|
||||
- docs/concepts/cluster-administration/network-plugins.md
|
||||
- docs/concepts/cluster-administration/device-plugins.md
|
||||
- docs/concepts/service-catalog/index.md
|
||||
|
||||
- title: Containers
|
||||
landing_page: /docs/concepts/containers/images/
|
||||
section:
|
||||
- docs/concepts/containers/images.md
|
||||
- docs/concepts/containers/container-environment-variables.md
|
||||
- docs/concepts/containers/container-lifecycle-hooks.md
|
||||
|
||||
- title: Workloads
|
||||
landing_page: /docs/concepts/workloads/pods/pod-overview/
|
||||
section:
|
||||
- title: Pods
|
||||
section:
|
||||
@@ -61,54 +35,43 @@ toc:
|
||||
- docs/concepts/workloads/pods/pod.md
|
||||
- docs/concepts/workloads/pods/pod-lifecycle.md
|
||||
- docs/concepts/workloads/pods/init-containers.md
|
||||
- docs/concepts/workloads/pods/podpreset.md
|
||||
- docs/concepts/workloads/pods/disruptions.md
|
||||
- title: Controllers
|
||||
section:
|
||||
- docs/concepts/workloads/controllers/replicaset.md
|
||||
- docs/concepts/workloads/controllers/replicationcontroller.md
|
||||
- docs/concepts/workloads/controllers/deployment.md
|
||||
- docs/concepts/workloads/controllers/statefulset.md
|
||||
- docs/concepts/workloads/controllers/petset.md
|
||||
- docs/concepts/workloads/controllers/daemonset.md
|
||||
- docs/concepts/workloads/controllers/garbage-collection.md
|
||||
- docs/concepts/workloads/controllers/jobs-run-to-completion.md
|
||||
- docs/concepts/workloads/controllers/cron-jobs.md
|
||||
|
||||
- title: Configuration
|
||||
landing_page: /docs/concepts/configuration/overview/
|
||||
section:
|
||||
- docs/concepts/configuration/overview.md
|
||||
- docs/concepts/configuration/manage-compute-resources-container.md
|
||||
- docs/concepts/configuration/assign-pod-node.md
|
||||
- docs/concepts/configuration/taint-and-toleration.md
|
||||
- docs/concepts/configuration/secret.md
|
||||
- docs/concepts/configuration/organize-cluster-access-kubeconfig.md
|
||||
- docs/concepts/configuration/pod-priority-preemption.md
|
||||
|
||||
- title: Services, Load Balancing, and Networking
|
||||
landing_page: /docs/concepts/services-networking/service/
|
||||
section:
|
||||
- docs/concepts/services-networking/service.md
|
||||
- docs/concepts/services-networking/dns-pod-service.md
|
||||
- docs/concepts/services-networking/connect-applications-service.md
|
||||
- docs/concepts/services-networking/ingress.md
|
||||
- docs/concepts/services-networking/network-policies.md
|
||||
- docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases.md
|
||||
|
||||
- title: Storage
|
||||
landing_page: /docs/concepts/storage/volumes/
|
||||
section:
|
||||
- docs/concepts/storage/volumes.md
|
||||
- docs/concepts/storage/persistent-volumes.md
|
||||
- docs/concepts/storage/storage-classes.md
|
||||
- docs/concepts/storage/dynamic-provisioning.md
|
||||
- title: Dynamic Provisioning
|
||||
path: http://blog.kubernetes.io/2016/10/dynamic-provisioning-and-storage-in-kubernetes.html
|
||||
|
||||
- title: Cluster Administration
|
||||
landing_page: /docs/concepts/cluster-administration/cluster-administration-overview/
|
||||
section:
|
||||
- docs/concepts/cluster-administration/cluster-administration-overview.md
|
||||
- docs/concepts/cluster-administration/certificates.md
|
||||
- docs/concepts/cluster-administration/cloud-providers.md
|
||||
- docs/concepts/cluster-administration/manage-deployment.md
|
||||
- docs/concepts/cluster-administration/networking.md
|
||||
- docs/concepts/cluster-administration/network-plugins.md
|
||||
@@ -119,9 +82,9 @@ toc:
|
||||
- docs/concepts/cluster-administration/authenticate-across-clusters-kubeconfig.md
|
||||
- docs/concepts/cluster-administration/master-node-communication.md
|
||||
- docs/concepts/cluster-administration/proxies.md
|
||||
- docs/concepts/cluster-administration/controller-metrics.md
|
||||
- docs/concepts/cluster-administration/device-plugins.md
|
||||
- title: Policies
|
||||
section:
|
||||
- docs/concepts/policy/resource-quotas.md
|
||||
- docs/concepts/policy/pod-security-policy.md
|
||||
|
||||
|
||||
|
||||
+9
-14
@@ -1,28 +1,23 @@
|
||||
bigheader: "About"
|
||||
bigheader: "Documentation Home"
|
||||
abstract: "Documentation for using and learning about Kubernetes."
|
||||
toc:
|
||||
- docs/home/index.md
|
||||
|
||||
- title: Supported Doc Versions
|
||||
path: /docs/home/supported-doc-versions/
|
||||
- docs/home/index.md
|
||||
|
||||
- title: Release Notes
|
||||
path: https://git.k8s.io/kubernetes/CHANGELOG.md
|
||||
- title: Release Roadmap
|
||||
path: https://github.com/kubernetes/kubernetes/milestones/
|
||||
|
||||
- docs/tasks/debug-application-cluster/troubleshooting.md
|
||||
|
||||
- title: Contributing to the Kubernetes Docs
|
||||
landing_page: /editdocs/
|
||||
section:
|
||||
- editdocs.md
|
||||
- docs/home/contribute/participating.md
|
||||
- docs/home/contribute/create-pull-request.md
|
||||
- docs/home/contribute/write-new-topic.md
|
||||
- docs/home/contribute/stage-documentation-changes.md
|
||||
- docs/home/contribute/page-templates.md
|
||||
- docs/home/contribute/review-issues.md
|
||||
- docs/home/contribute/style-guide.md
|
||||
- docs/home/contribute/includes.md
|
||||
- docs/home/contribute/localization.md
|
||||
|
||||
- title: Updating Automatically Generated Reference Pages
|
||||
section:
|
||||
- docs/home/contribute/generated-reference/kubernetes-components.md
|
||||
- docs/home/contribute/generated-reference/kubectl.md
|
||||
- docs/home/contribute/generated-reference/kubernetes-api.md
|
||||
- docs/home/contribute/generated-reference/federation-api.md
|
||||
|
||||
@@ -8,4 +8,3 @@ tocs:
|
||||
- reference
|
||||
- samples
|
||||
- support
|
||||
- imported
|
||||
|
||||
@@ -1,27 +0,0 @@
|
||||
id: _example
|
||||
name: Example K8s Term
|
||||
full-link: /docs/link-to-long-dedicated-docs-page
|
||||
aka:
|
||||
- Slang K8s Term
|
||||
- Misnomer
|
||||
- Formerly Known as Prince
|
||||
related:
|
||||
- id-of-less-fancy-k8s-term
|
||||
- id-of-tangential-term
|
||||
- id-of-commonly-used-with-term
|
||||
tags:
|
||||
- Some Tag
|
||||
short-description: >
|
||||
Required.
|
||||
Markdown allowed (e.g. for cross-linking).
|
||||
One or two lines that provide a minimum definition.
|
||||
Do not repeat the term.
|
||||
Prefer fragments.
|
||||
End with a period.
|
||||
long-description: >
|
||||
Optional.
|
||||
Markdown allowed.
|
||||
Longer additional text to appear after (in conjunction with) short description.
|
||||
Provide where the short description is not sufficient as the intro paragraph to a topic.
|
||||
Write complete but concise sentences.
|
||||
**See /_includes/templates/glossary/README.md for the official style guide.**
|
||||
@@ -1,9 +0,0 @@
|
||||
id: annotation
|
||||
name: Annotation
|
||||
full-link: /docs/concepts/overview/working-with-objects/annotations
|
||||
tags:
|
||||
- fundamental
|
||||
short-description: >
|
||||
A key-value pair that is used to attach arbitrary non-identifying metadata to objects.
|
||||
long-description: >
|
||||
The metadata in an annotation can be small or large, structured or unstructured, and can include characters not permitted by labels. Clients such as tools and libraries can retrieve this metadata.
|
||||
@@ -1,11 +0,0 @@
|
||||
id: application-architect
|
||||
name: Application Architect
|
||||
related:
|
||||
- application-developer
|
||||
tags:
|
||||
- user-type
|
||||
short-description: >
|
||||
A person responsible for the high-level design of an application.
|
||||
long-description: >
|
||||
An architect ensures that an app's implementation allows it to interact with its surrounding components in a scalable, maintainable way.
|
||||
Surrounding components include databases, logging infrastructure, and other microservices.
|
||||
@@ -1,11 +0,0 @@
|
||||
id: application-developer
|
||||
name: Application Developer
|
||||
related:
|
||||
- application-architect
|
||||
tags:
|
||||
- user-type
|
||||
short-description: >
|
||||
A person who writes an application that runs in a Kubernetes cluster.
|
||||
long-description: >
|
||||
An application developer focuses on one part of an application.
|
||||
The scale of their focus may vary significantly in size.
|
||||
@@ -1,10 +0,0 @@
|
||||
id: approver
|
||||
name: Approver
|
||||
tags:
|
||||
- community
|
||||
short-description: >
|
||||
A person who can review and approve Kubernetes code contributions.
|
||||
long-description: >
|
||||
While code review is focused on code quality and correctness, approval is focused on the holistic acceptance of a contribution.
|
||||
Holistic acceptance includes backwards/forwards compatibility, adhering to API and flag conventions, subtle performance and correctness issues, interactions with other parts of the system, and others.
|
||||
Approver status is scoped to a part of the codebase.
|
||||
@@ -1,11 +0,0 @@
|
||||
id: certificate
|
||||
name: Certificate
|
||||
full-link: /docs/tasks/tls/managing-tls-in-a-cluster/
|
||||
tags:
|
||||
- security
|
||||
short-description: >
|
||||
A cryptographically secure file used to validate access to the Kubernetes cluster.
|
||||
long-description: >
|
||||
Certificates enable applications within a Kubernetes
|
||||
cluster to access the Kubernetes API securely. Certificates validate that
|
||||
clients are allowed to access the API.
|
||||
@@ -1,9 +0,0 @@
|
||||
id: cla
|
||||
name: CLA (Contributor License Agreement)
|
||||
full-link: https://github.com/kubernetes/community/blob/master/CLA.md
|
||||
tags:
|
||||
- community
|
||||
short-description: >
|
||||
Terms under which a {% glossary_tooltip text="contributor" term_id="contributor" %} grants a license to an open source project for their contributions.
|
||||
long-description: >
|
||||
CLAs help resolve legal disputes involving contributed material and intellectual property (IP).
|
||||
@@ -1,13 +0,0 @@
|
||||
id: cloud-controller-manager
|
||||
name: Cloud Controller Manager
|
||||
full-link: https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/
|
||||
tags:
|
||||
- core-object
|
||||
- architecture
|
||||
- operation
|
||||
short-description: >
|
||||
Cloud Controller Manager is an alpha feature in 1.8. In upcoming releases it will be the preferred way to integrate Kubernetes with any cloud.
|
||||
long-description: >
|
||||
Kubernetes v1.6 contains a new binary called cloud-controller-manager. cloud-controller-manager is a daemon that embeds cloud-specific control loops.
|
||||
These cloud-specific control loops were originally in the kube-controller-manager. Since cloud providers develop and release at a different pace compared to the Kubernetes
|
||||
project, abstracting the provider-specific code to the cloud-controller-manager binary allows cloud vendors to evolve independently from the core Kubernetes code.
|
||||
@@ -1,10 +0,0 @@
|
||||
id: cloud-provider
|
||||
name: Cloud Provider
|
||||
full-link: /docs/concepts/cluster-administration/cloud-providers
|
||||
tags:
|
||||
- community
|
||||
short-description: >
|
||||
Cloud provider is a company that offers cloud computing platform that can run Kubernetes clusters.
|
||||
long-description: >
|
||||
Cloud providers or sometime called Cloud Service Provider (CSPs) provides cloud computing platforms. They may offer services such as Infrastructure as a Service (IaaS) or Platform as a Service (PaaS). Cloud providers host the Kubernetes cluster and also provide services that interact with the cluster, such as Load Balancers, Storage Classes etc.
|
||||
|
||||
@@ -1,11 +0,0 @@
|
||||
id: cluster-architect
|
||||
name: Cluster Architect
|
||||
related:
|
||||
- cluster
|
||||
- cluster-operator
|
||||
tags:
|
||||
- user-type
|
||||
short-description: >
|
||||
A person who designs infrastructure that involves one or more Kubernetes clusters.
|
||||
long-description: >
|
||||
Cluster architects are concerned with best practices for distributed systems, for example: high availability and security.
|
||||
@@ -1,15 +0,0 @@
|
||||
id: cluster-operator
|
||||
name: Cluster Operator
|
||||
aka:
|
||||
- Cluster Administrator
|
||||
related:
|
||||
- cluster
|
||||
- cluster-architect
|
||||
tags:
|
||||
- user-type
|
||||
short-description: >
|
||||
A person who configures, controls, and monitors clusters.
|
||||
long-description: |
|
||||
Their primary responsibility is keeping a cluster up and running, which may involve periodic maintenance activities or upgrades.<br>
|
||||
|
||||
**NOTE:** Cluster operators are different from the [Operator pattern](https://coreos.com/operators) that extends the Kubernetes API.
|
||||
@@ -1,9 +0,0 @@
|
||||
id: cluster
|
||||
name: Cluster
|
||||
tags:
|
||||
- fundamental
|
||||
- operation
|
||||
short-description: >
|
||||
A set of machines, called nodes, that run containerized applications managed by Kubernetes.
|
||||
long-description: >
|
||||
A cluster has several worker nodes and at least one master node.
|
||||
@@ -1,12 +0,0 @@
|
||||
id: code-contributor
|
||||
name: Code Contributor
|
||||
full-link: /docs/imported/community/devel/
|
||||
aka:
|
||||
- Community Developer
|
||||
tags:
|
||||
- community
|
||||
- user-type
|
||||
short-description: >
|
||||
A person who develops and contributes code to the Kubernetes open source codebase.
|
||||
long-description: >
|
||||
They are also an active {% glossary_tooltip text="community member" term_id="member" %} who participates in one or more {% glossary_tooltip text="Special Interest Groups (SIGs)" term_id="sig" %}.
|
||||
@@ -1,13 +0,0 @@
|
||||
id: configmap
|
||||
name: ConfigMap
|
||||
full-link: /docs/tasks/configure-pod-container/configure-pod-configmap/
|
||||
related:
|
||||
- pod
|
||||
- secret
|
||||
tags:
|
||||
- core-object
|
||||
short-description: >
|
||||
An API object used to store non-confidential data in key-value pairs. Can be consumed as environment variables, command-line arguments, or config files in a {% glossary_tooltip text="volume" term_id="volume" %}.
|
||||
long-description: >
|
||||
Allows you to decouple environment-specific configuration from your {% glossary_tooltip text="container images" term_id="container" %}, so that your applications are easily portable.
|
||||
When storing confidential data use a [Secret](https://kubernetes.io/docs/concepts/configuration/secret/).
|
||||
@@ -1,9 +0,0 @@
|
||||
id: container-env-variables
|
||||
name: Container Environment Variables
|
||||
full-link: /docs/concepts/containers/container-environment-variables.md
|
||||
tags:
|
||||
- fundamental
|
||||
short-description: >
|
||||
Container environment variables are name/value pairs that provide useful information into containers running in a Pod.
|
||||
long-description: >
|
||||
Container environment variables provide information that is required by the running containerized applications along with information about important resources to the [Containers] {% glossary_tooltip text="Containers" term_id="container" %}. For example, file system, information about the container itself and other cluster resources such as service endpoints, etc.
|
||||
@@ -1,10 +0,0 @@
|
||||
id: container
|
||||
name: Container
|
||||
full-link: /docs/concepts/overview/what-is-kubernetes/#why-containers
|
||||
tags:
|
||||
- fundamental
|
||||
- workload
|
||||
short-description: >
|
||||
A lightweight and portable executable image that contains software and all of its dependencies.
|
||||
long-description: >
|
||||
Containers decouple applications from underlying host infrastructure to make deployment easier in different cloud or OS environments, and for easier scaling.
|
||||
@@ -1,8 +0,0 @@
|
||||
id: contributor
|
||||
name: Contributor
|
||||
tags:
|
||||
- community
|
||||
short-description: >
|
||||
Someone who donates code, documentation, or their time to help the Kubernetes project or community.
|
||||
long-description: >
|
||||
Contributions include pull requests (PRs), issues, feedback, {% glossary_tooltip text="special interest groups (SIG)" term_id="sig" %} participation, or organizing community events.
|
||||
@@ -1,12 +0,0 @@
|
||||
id: controller
|
||||
name: Controller
|
||||
full-link: /docs/admin/kube-controller-manager/
|
||||
related:
|
||||
- controller-manager
|
||||
tags:
|
||||
- architecture
|
||||
- fundamental
|
||||
short-description: >
|
||||
A control loop that watches the shared state of the cluster through the {% glossary_tooltip text="apiserver" term_id="kube-apiserver" %} and makes changes attempting to move the current state towards the desired state.
|
||||
long-description: >
|
||||
Examples of controllers that ship with Kubernetes today are the replication controller, endpoints controller, namespace controller, and serviceaccounts controller.
|
||||
@@ -1,10 +0,0 @@
|
||||
id: cronjob
|
||||
name: CronJob
|
||||
full-link: /docs/concepts/workloads/controllers/cron-jobs/
|
||||
tags:
|
||||
- core-object
|
||||
- workload
|
||||
short-description: >
|
||||
Manages a [Job](/docs/concepts/workloads/controllers/jobs-run-to-completion/) that runs on a periodic schedule.
|
||||
long-description: >
|
||||
Similar to a line in a *crontab* file, a Cronjob object specifies a schedule using the [Cron](https://en.wikipedia.org/wiki/Cron) format.
|
||||
@@ -1,14 +0,0 @@
|
||||
id: CustomResourceDefinition
|
||||
name: CustomResourceDefinition
|
||||
aka:
|
||||
- CRD
|
||||
- Formerly Known as ThirdPartyResources (TPR)
|
||||
tags:
|
||||
- fundamental
|
||||
- operation
|
||||
- extension
|
||||
full-link: docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/
|
||||
short-description: >
|
||||
Custom code that defines a resource to add to your Kubernetes API server without building a complete custom server.
|
||||
long-description: >
|
||||
Custom Resource Definitions let you extend the Kubernetes API for your environment if the publicly supported API resources can't meet your needs.
|
||||
@@ -1,11 +0,0 @@
|
||||
id: daemonset
|
||||
name: DaemonSet
|
||||
full-link: /docs/concepts/workloads/controllers/daemonset
|
||||
tags:
|
||||
- fundamental
|
||||
- core-object
|
||||
- workload
|
||||
short-description: >
|
||||
Ensures a copy of a {% glossary_tooltip text="Pod" term_id="pod" %} is running across a set of nodes in a {% glossary_tooltip text="cluster" term_id="cluster" %}.
|
||||
long-description: >
|
||||
Used to deploy system daemons such as log collectors and monitoring agents that typically must run on every {% glossary_tooltip term_id="node" %}.
|
||||
@@ -1,11 +0,0 @@
|
||||
id: deployment
|
||||
name: Deployment
|
||||
full-link: /docs/concepts/workloads/controllers/deployment/
|
||||
tags:
|
||||
- fundamental
|
||||
- core-object
|
||||
- workload
|
||||
short-description: >
|
||||
An API object that manages a replicated application.
|
||||
long-description: >
|
||||
Each replica is represented by a {% glossary_tooltip term_id="pod" %}, and the Pods are distributed among the nodes of a cluster.
|
||||
@@ -1,11 +0,0 @@
|
||||
id: developer
|
||||
name: Developer (disambiguation)
|
||||
aka:
|
||||
- Kubernetes Developer
|
||||
tags:
|
||||
- community
|
||||
- user-type
|
||||
short-description: >
|
||||
May refer to: {% glossary_tooltip text="Application Developer" term_id="application-developer" %}, {% glossary_tooltip text="Code Contributor" term_id="code-contributor" %}, or {% glossary_tooltip text="Platform Developer" term_id="platform-developer" %}.
|
||||
long-description: >
|
||||
This overloaded term may have different meanings depending on the context
|
||||
@@ -1,9 +0,0 @@
|
||||
id: docker
|
||||
name: docker
|
||||
full-link: /docs/reference/kubectl/docker-cli-to-kubectl/
|
||||
tags:
|
||||
- fundamental
|
||||
short-description: >
|
||||
Docker is a software technology providing operating-system-level virtualization also known as containers.
|
||||
long-description: >
|
||||
Docker uses the resource isolation features of the Linux kernel such as cgroups and kernel namespaces, and a union-capable file system such as OverlayFS and others to allow independent "containers" to run within a single Linux instance, avoiding the overhead of starting and maintaining virtual machines (VMs).
|
||||
@@ -1,11 +0,0 @@
|
||||
id: downstream
|
||||
name: Downstream (disambiguation)
|
||||
related:
|
||||
- upstream
|
||||
tags:
|
||||
- community
|
||||
short-description: >
|
||||
May refer to: code in the Kubernetes ecosystem that depends upon the core Kubernetes codebase or a forked repo.
|
||||
long-description: |
|
||||
* In the **Kubernetes Community**: Conversations often use *downstream* to mean the ecosystem, code, or third-party tools that rely on the core Kubernetes codebase. For example, a new feature in Kubernetes may be adopted by applications *downstream* to improve their functionality.
|
||||
* In **GitHub** or **git**: The convention is to refer to a forked repo as *downstream*, whereas the source repo is considered *upstream*.
|
||||
@@ -1,11 +0,0 @@
|
||||
id: dynamicvolumeprovisioning
|
||||
name: Dynamic Volume Provisioning
|
||||
full-link: /docs/concepts/storage/dynamic-provisioning
|
||||
tags:
|
||||
- core-object
|
||||
- storage
|
||||
short-description: >
|
||||
Allows users to request automatic creation of storage {% glossary_tooltip text="Volumes" term_id="volume" %}.
|
||||
long-description: >
|
||||
Dynamic provisioning eliminates the need for cluster administrators to pre-provision storage. Instead, it automatically provisions storage by user request.
|
||||
Dynamic volume provisioning is based on an API object, {% glossary_tooltip text="StorageClass" term_id="storage-class" %}, referring to a {% glossary_tooltip text="Volume Plugin" term_id="volume-plugin" %} that provisions a {% glossary_tooltip text="Volume" term_id="volume" %} and the set of parameters to pass to the Volume Plugin.
|
||||
@@ -1,11 +0,0 @@
|
||||
id: etcd
|
||||
name: etcd
|
||||
full-link: /docs/tasks/administer-cluster/configure-upgrade-etcd/
|
||||
tags:
|
||||
- architecture
|
||||
- storage
|
||||
short-description: >
|
||||
Consistent and highly-available key value store used as Kubernetes' backing store for all cluster data.
|
||||
long-description: >
|
||||
Always have a backup plan for etcd's data for your Kubernetes cluster.
|
||||
For in-depth information on etcd, see [etcd documentation](https://github.com/coreos/etcd/blob/master/Documentation/docs.md).
|
||||
@@ -1,10 +0,0 @@
|
||||
id: helm-chart
|
||||
name: Helm Chart
|
||||
full-link: https://github.com/kubernetes/helm/blob/master/docs/charts.md
|
||||
tags:
|
||||
- tool
|
||||
short-description: >
|
||||
A package of pre-configured Kubernetes resources that can be managed with the Helm tool.
|
||||
long-description: |
|
||||
Charts provide a reproducible way of creating and sharing Kubernetes applications.
|
||||
A single chart can be used to deploy something simple, like a memcached Pod, or something complex, like a full web app stack with HTTP servers, databases, caches, and so on.
|
||||
@@ -1,17 +0,0 @@
|
||||
id: horizontal-pod-autoscaler
|
||||
name: Horizontal Pod Autoscaler
|
||||
full-link: /docs/tasks/run-application/horizontal-pod-autoscale/
|
||||
aka:
|
||||
- HPA
|
||||
related:
|
||||
- pod
|
||||
- replication-controller
|
||||
- deployment
|
||||
tags:
|
||||
- operation
|
||||
short-description: >
|
||||
An API resource that automatically scales the number of pod replicas based on targeted CPU
|
||||
utilization or custom metric targets.
|
||||
long-description: >
|
||||
HPA is typically used with {% glossary_tooltip text="Replication Controllers" term_id="replication-controller" %}, {% glossary_tooltip text="Deployments" term_id="deployment" %}, or Replica Sets.
|
||||
It cannot be applied to objects that cannot be scaled, for example {% glossary_tooltip text="DaemonSets" term_id="daemonset" %}.
|
||||
@@ -1,9 +0,0 @@
|
||||
id: image
|
||||
name: Image
|
||||
tags:
|
||||
- fundamental
|
||||
short-description: >
|
||||
Stored instance of a container that holds a set of software needed to run an application.
|
||||
long-description: >
|
||||
A way of packaging software that allows it to be stored in a container registry, pulled to a local system, and run as an application. Meta data is included in the image that can indicate what executable to run, who built it, and other information.
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
id: ingress
|
||||
name: Ingress
|
||||
full-link: /docs/concepts/services-networking/ingress/
|
||||
aka:
|
||||
- Ingress controller
|
||||
tags:
|
||||
- networking
|
||||
- architecture
|
||||
- extension
|
||||
short-description: >
|
||||
An API object that manages external access to the services in a cluster, typically HTTP.
|
||||
long-description: >
|
||||
Ingress can provide load balancing, SSL termination and name-based virtual hosting.
|
||||
@@ -1,8 +0,0 @@
|
||||
id: init-container
|
||||
name: Init Container
|
||||
tags:
|
||||
- fundamental
|
||||
short-description: >
|
||||
One or more initialization containers that must run to completion before any app containers run.
|
||||
long-description: >
|
||||
Initialization (init) containers are like regular app containers, with one difference: init containers must run to completion before any app containers can start. Init containers run in series: each init container must run to completion before the next init container begins.
|
||||
@@ -1,13 +0,0 @@
|
||||
id: istio
|
||||
name: Istio
|
||||
full-link: https://istio.io/docs/concepts/what-is-istio/overview.html
|
||||
tags:
|
||||
- networking
|
||||
- architecture
|
||||
- extension
|
||||
short-description: >
|
||||
An open platform (not Kubernetes-specific) that provides a uniform way to integrate microservices, manage traffic flow, enforce policies, and aggregate telemetry data.
|
||||
long-description: >
|
||||
Adding Istio does not require changing application code.
|
||||
It is a layer of infrastructure between a service and the network, which when combined with service deployments, is commonly referred to as a service mesh.
|
||||
Istio's control plane abstracts away the underlying cluster management platform, which may be Kubernetes, Mesosphere, etc.
|
||||
@@ -1,11 +0,0 @@
|
||||
id: job
|
||||
name: Job
|
||||
full-link: /docs/concepts/workloads/controllers/jobs-run-to-completion
|
||||
tags:
|
||||
- fundamental
|
||||
- core-object
|
||||
- workload
|
||||
short-description: >
|
||||
A finite or batch task that runs to completion.
|
||||
long-description: >
|
||||
Creates one or more {% glossary_tooltip term_id="pod" %} objects and ensures that a specified number of them successfully terminate. As Pods successfully complete, the Job tracks the successful completions.
|
||||
@@ -1,19 +0,0 @@
|
||||
id: kops
|
||||
name: Kops
|
||||
full-link: /docs/getting-started-guides/kops/
|
||||
tags:
|
||||
- tool
|
||||
- operation
|
||||
short-description: >
|
||||
A CLI tool that helps you create, destroy, upgrade and maintain production-grade, highly available, Kubernetes clusters. *NOTE: Officially supports AWS only, with GCE and VMware vSphere in alpha*.
|
||||
long-description: |
|
||||
`kops` provisions your cluster with:
|
||||
|
||||
* Fully automated installation
|
||||
* DNS-based cluster identification
|
||||
* Self-healing: everything runs in Auto-Scaling Groups
|
||||
* Limited OS support (Debian preferred, Ubuntu 16.04 supported, early support for CentOS & RHEL)
|
||||
* High availability (HA) support
|
||||
* The ability to directly provision, or generate terraform manifests
|
||||
|
||||
You can also build your own cluster using {% glossary_tooltip term_id="kubeadm" %} as a building block. `kops` builds on the kubeadm work.
|
||||
@@ -1,12 +0,0 @@
|
||||
id: kube-apiserver
|
||||
name: kube-apiserver
|
||||
full-link: /docs/reference/generated/kube-apiserver/
|
||||
aka:
|
||||
- apiserver
|
||||
tags:
|
||||
- architecture
|
||||
- fundamental
|
||||
short-description: >
|
||||
Component on the master that exposes the Kubernetes API. It is the front-end for the Kubernetes control plane.
|
||||
long-description: >
|
||||
It is designed to scale horizontally -- that is, it scales by deploying more instances. See [Building High-Availability Clusters](/docs/admin/high-availability/).
|
||||
@@ -1,14 +0,0 @@
|
||||
id: kube-controller-manager
|
||||
name: kube-controller-manager
|
||||
full-link: /docs/reference/generated/kube-controller-manager/
|
||||
aka:
|
||||
- controller-manager
|
||||
related:
|
||||
- controller
|
||||
tags:
|
||||
- architecture
|
||||
- fundamental
|
||||
short-description: >
|
||||
Component on the master that runs {% glossary_tooltip text="controllers" term_id="controller" %}.
|
||||
long-description: >
|
||||
Logically, each {% glossary_tooltip text="controller" term_id="controller" %} is a separate process, but to reduce complexity, they are all compiled into a single binary and run in a single process.
|
||||
@@ -1,10 +0,0 @@
|
||||
id: kube proxy
|
||||
name: kube-proxy
|
||||
full-link: /docs/reference/generated/kube-proxy
|
||||
tags:
|
||||
- fundamental
|
||||
- core-object
|
||||
short-description: >
|
||||
`kube-proxy` is a network proxy that runs on each node in the cluster.
|
||||
long-description: >
|
||||
`kube-proxy` is responsible for request forwarding. `kube-proxy` allows TCP and UDP stream forwarding or round robin TCP and UDP forwarding across a set of backend functions.
|
||||
@@ -1,13 +0,0 @@
|
||||
id: kube-scheduler
|
||||
name: kube-scheduler
|
||||
full-link: /docs/reference/generated/kube-scheduler/
|
||||
aka:
|
||||
- scheduler
|
||||
tags:
|
||||
- architecture
|
||||
short-description: >
|
||||
Component on the master that watches newly created pods that have no node assigned, and selects a node for them to run on.
|
||||
long-description: >
|
||||
Factors taken into account for scheduling decisions include individual and collective resource requirements,
|
||||
hardware/software/policy constraints, affinity and anti-affinity specifications, data locality, inter-workload interference
|
||||
and deadlines.
|
||||
@@ -1,10 +0,0 @@
|
||||
id: kubeadm
|
||||
name: Kubeadm
|
||||
full-link: /docs/admin/kubeadm/
|
||||
tags:
|
||||
- tool
|
||||
- operation
|
||||
short-description: >
|
||||
A tool for quickly installing Kubernetes and setting up a secure cluster.
|
||||
long-description: >
|
||||
You can use kubeadm to install both the control plane and the worker node components.
|
||||
@@ -1,10 +0,0 @@
|
||||
id: kubectl
|
||||
name: Kubectl
|
||||
full-link: /docs/user-guide/kubectl-overview/
|
||||
tags:
|
||||
- tool
|
||||
- fundamental
|
||||
short-description: >
|
||||
A command line tool for communicating with a {% glossary_tooltip text="Kubernetes API" term_id="kubernetes-api" %} server.
|
||||
long-description: >
|
||||
You can use kubectl to create, inspect, update, and delete Kubernetes objects.
|
||||
@@ -1,10 +0,0 @@
|
||||
id: kubelet
|
||||
name: Kubelet
|
||||
full-link: /docs/reference/generated/kubelet
|
||||
tags:
|
||||
- fundamental
|
||||
- core-object
|
||||
short-description: >
|
||||
An agent that runs on each node in the cluster. It makes sure that containers are running in a pod.
|
||||
long-description: >
|
||||
The kubelet takes a set of PodSpecs that are provided through various mechanisms and ensures that the containers described in those PodSpecs are running and healthy. The kubelet doesn’t manage containers which were not created by Kubernetes.
|
||||
@@ -1,13 +0,0 @@
|
||||
id: kubernetes-api
|
||||
name: Kubernetes API
|
||||
full-link: /docs/concepts/overview/kubernetes-api/
|
||||
tags:
|
||||
- fundamental
|
||||
- architecture
|
||||
short-description: >
|
||||
The application that serves Kubernetes functionality through a RESTful interface and stores the state of the cluster.
|
||||
long-description: >
|
||||
Kubernetes resources and "records of intent" are all stored as API objects, and modified via RESTful calls to the API.
|
||||
The API allows configuration to be managed in a declarative way.
|
||||
Users can interact with the Kubernetes API directly, or via tools like `kubectl`.
|
||||
The core Kubernetes API is flexible and can also be extended to support custom resources.
|
||||
@@ -1,10 +0,0 @@
|
||||
id: label
|
||||
name: Label
|
||||
full-link: /docs/concepts/overview/working-with-objects/labels
|
||||
tags:
|
||||
- fundamental
|
||||
short-description: >
|
||||
Tags objects with identifying attributes that are meaningful and relevant to users.
|
||||
long-description: >
|
||||
Labels are key/value pairs that are attached to objects such as {% glossary_tooltip text="Pods" term_id="pod" %}.
|
||||
They are used to organize and to select subsets of objects.
|
||||
@@ -1,8 +0,0 @@
|
||||
id: maintainer
|
||||
name: Maintainer
|
||||
tags:
|
||||
- community
|
||||
short-description: >
|
||||
A highly experienced {% glossary_tooltip text="contributor" term_id="contributor" %}, active in multiple areas of Kubernetes, who has cross-area ownership and write access to a project's GitHub repository.
|
||||
long-description: >
|
||||
Maintainers work holistically across the project to maintain its health and success and have made substantial contributions, both through code development and broader organizational efforts.
|
||||
@@ -1,9 +0,0 @@
|
||||
id: managed-service
|
||||
name: Managed Service
|
||||
tags:
|
||||
- extension
|
||||
short-description: >
|
||||
A software offering maintained by a third-party provider.
|
||||
long-description: >
|
||||
Some examples of Managed Services are AWS EC2, Azure SQL Database, and GCP Pub/Sub, but they can be any software offering that can be used by an application.
|
||||
[Service Catalog](/docs/concepts/service-catalog/) provides a way to list, provision, and bind with Managed Services offered by {% glossary_tooltip text="Service Brokers" term_id="service-broker" %}.
|
||||
@@ -1,10 +0,0 @@
|
||||
id: member
|
||||
name: Member
|
||||
tags:
|
||||
- community
|
||||
short-description: >
|
||||
A continuously active {% glossary_tooltip text="contributor" term_id="contributor" %} in the K8s community.
|
||||
long-description: >
|
||||
Members can have issues and PRs assigned to them and participate in {% glossary_tooltip text="special interest groups (SIGs)" term_id="sig" %} through GitHub teams.
|
||||
Pre-submit tests are automatically run for members' PRs.
|
||||
A member is expected to remain an active contributor to the community.
|
||||
@@ -1,10 +0,0 @@
|
||||
id: minikube
|
||||
name: Minikube
|
||||
full-link: /docs/getting-started-guides/minikube/
|
||||
tags:
|
||||
- fundamental
|
||||
- tool
|
||||
short-description: >
|
||||
A tool for running Kubernetes locally.
|
||||
long-description: >
|
||||
Minikube runs a single-node cluster inside a VM on your computer.
|
||||
@@ -1,10 +0,0 @@
|
||||
id: name
|
||||
name: Name
|
||||
full-link: /docs/concepts/overview/working-with-objects/names
|
||||
tags:
|
||||
- fundamental
|
||||
short-description: >
|
||||
A client-provided string that refers to an object in a resource URL, such as `/api/v1/pods/some-name`.
|
||||
long-description: >
|
||||
Only one object of a given kind can have a given name at a time.
|
||||
However, if you delete the object, you can make a new object with the same name.
|
||||
@@ -1,10 +0,0 @@
|
||||
id: namespace
|
||||
name: Namespace
|
||||
full-link: /docs/concepts/overview/working-with-objects/namespaces
|
||||
tags:
|
||||
- fundamental
|
||||
short-description: >
|
||||
An abstraction used by Kubernetes to support multiple virtual clusters on the same physical {% glossary_tooltip text="cluster" term_id="cluster" %}.
|
||||
long-description: >
|
||||
Namespaces are used to organize objects in a cluster and provide a way to divide cluster resources.
|
||||
Names of resources need to be unique within a namespace, but not across namespaces.
|
||||
@@ -1,13 +0,0 @@
|
||||
id: network-policy
|
||||
name: Network Policy
|
||||
full-link: /docs/concepts/services-networking/network-policies/
|
||||
aka:
|
||||
- NetworkPolicy
|
||||
tags:
|
||||
- networking
|
||||
- architecture
|
||||
- extension
|
||||
short-description: >
|
||||
A specification of how groups of Pods are allowed to communicate with each other and with other network endpoints.
|
||||
long-description: >
|
||||
Network Policies help you declaratively configure which Pods are allowed to connect to each other, which namespaces are allowed to communicate, and more specifically which port numbers to enforce each policy on. `NetworkPolicy` resources use labels to select Pods and define rules which specify what traffic is allowed to the selected Pods. Network Policies are implemented by a supported network plugin provided by a network provider. Be aware that creating a network resource without a controller to implement it will have no effect.
|
||||
@@ -1,13 +0,0 @@
|
||||
id: node
|
||||
name: Node
|
||||
full-link: /docs/concepts/architecture/nodes/
|
||||
aka:
|
||||
- Minion
|
||||
related:
|
||||
- deployment
|
||||
tags:
|
||||
- fundamental
|
||||
short-description: >
|
||||
A node is a worker machine in Kubernetes.
|
||||
long-description: >
|
||||
A worker machine may be a VM or physical machine, depending on the cluster. It has the {% glossary_tooltip text="Services" term_id="service" %} necessary to run {% glossary_tooltip text="Pods" term_id="pod" %} and is managed by the master components. The {% glossary_tooltip text="Services" term_id="service" %} on a node include Docker, kubelet and kube-proxy.
|
||||
@@ -1,15 +0,0 @@
|
||||
id: persistent-volume-claim
|
||||
name: Persistent Volume Claim
|
||||
full-link: /docs/concepts/storage/persistent-volumes/
|
||||
related:
|
||||
- persistent-volume
|
||||
- statefulset
|
||||
- deployment
|
||||
- pod
|
||||
tags:
|
||||
- core-object
|
||||
- storage
|
||||
short-description: >
|
||||
Claims storage resources defined in a PersistentVolume so that it can be mounted as a volume in a container.
|
||||
long-description: |
|
||||
Specifies the amount of storage, how the storage will be accessed (read-only, read-write and/or exclusive) and how it is reclaimed (retained, recycled or deleted). Details of the storage itself are in the PersistentVolume specification.
|
||||
@@ -1,17 +0,0 @@
|
||||
id: persistent-volume
|
||||
name: Persistent Volume
|
||||
full-link: /docs/concepts/storage/persistent-volumes/
|
||||
related:
|
||||
- statefulset
|
||||
- deployment
|
||||
- persistent-volume-claim
|
||||
- pod
|
||||
tags:
|
||||
- core-object
|
||||
- storage
|
||||
short-description: >
|
||||
An API object that represents a piece of storage in the cluster. Available as a general, pluggable resource that persists beyond the lifecycle of any individual {% glossary_tooltip text="Pod" term_id="pod" %}.
|
||||
long-description: |
|
||||
PersistentVolumes (PVs) provide an API that abstracts details of how storage is provided from how it is consumed.
|
||||
PVs are used directly in scenarios where storage can be created ahead of time (static provisioning).
|
||||
For scenarios that require on-demand storage (dynamic provisioning), PersistentVolumeClaims (PVCs) are used instead.
|
||||
@@ -1,11 +0,0 @@
|
||||
id: platform-developer
|
||||
name: Platform Developer
|
||||
aka:
|
||||
- Kubernetes Developer
|
||||
- Extension Developer
|
||||
tags:
|
||||
- user-type
|
||||
short-description: >
|
||||
A person who customizes the Kubernetes platform to fit the needs of their project.
|
||||
long-description: >
|
||||
A platform developer may, for example, use [Custom Resources](/docs/concepts/api-extension/custom-resources/) or [Extend the Kubernetes API with the aggregation layer](/docs/concepts/api-extension/apiserver-aggregation/) to add functionality to their instance of Kubernetes, specifically for their application. Some Platform Developers are also {% glossary_tooltip text="contributors" term_id="contributor" %} and develop extensions which are contributed to the Kubernetes community. Others develop closed-source commercial or site-specific extensions.
|
||||
@@ -1,19 +0,0 @@
|
||||
id: pod-security-policy
|
||||
name: Pod Security Policy
|
||||
full-link: /docs/concepts/policy/pod-security-policy/
|
||||
related:
|
||||
- pod
|
||||
- container
|
||||
- sidecar
|
||||
- deployment
|
||||
- statefulset
|
||||
- security
|
||||
tags:
|
||||
- core-object
|
||||
- fundamental
|
||||
short-description: >
|
||||
Enables fine-grained authorization of {% glossary_tooltip term_id="pod" %} creation and updates.
|
||||
long-description: >
|
||||
A cluster-level resource that controls security sensitive aspects of the Pod specification.
|
||||
The `PodSecurityPolicy` objects define a set of conditions that a Pod must run with in order to be accepted into the system, as well as defaults for the related fields.
|
||||
Pod Security Policy control is implemented as an optional admission controller.
|
||||
@@ -1,17 +0,0 @@
|
||||
id: pod
|
||||
name: Pod
|
||||
full-link: /docs/concepts/workloads/pods/pod-overview/
|
||||
related:
|
||||
- container
|
||||
- sidecar
|
||||
- deployment
|
||||
- statefulset
|
||||
tags:
|
||||
- core-object
|
||||
- fundamental
|
||||
short-description: >
|
||||
The smallest and simplest Kubernetes object. A Pod represents a set of running {% glossary_tooltip text="containers" term_id="container" %} on your cluster.
|
||||
long-description: >
|
||||
A Pod is typically set up to run a single primary container.
|
||||
It can also run optional sidecar containers that add supplementary features like logging.
|
||||
Pods are commonly managed by a {% glossary_tooltip term_id="deployment" %}.
|
||||
@@ -1,12 +0,0 @@
|
||||
id: podpreset
|
||||
name: PodPreset
|
||||
tags:
|
||||
- operation
|
||||
short-description: >
|
||||
An API object that injects information such as secrets, volume mounts,
|
||||
and environment variables into pods at creation time.
|
||||
long-description: >
|
||||
This object chooses the pods to inject information into using
|
||||
standard selectors. This allows the podspec definitions to be
|
||||
nonspecific, decoupling the podspec from environment specific
|
||||
configuration.
|
||||
@@ -1,10 +0,0 @@
|
||||
id: rbac
|
||||
name: RBAC (Role-Based Access Control)
|
||||
full-link: /docs/admin/authorization/rbac/
|
||||
tags:
|
||||
- security
|
||||
- fundamental
|
||||
short-description: >
|
||||
Manages authorization decisions, allowing admins to dynamically configure access policies through the {% glossary_tooltip text="Kubernetes API" term_id="kubernetes-api" %}.
|
||||
long-description: >
|
||||
RBAC utilizes *roles*, which contain permission rules, and *role bindings*, which grant the permissions defined in a role to a set of users.
|
||||
@@ -1,14 +0,0 @@
|
||||
id: replica-set
|
||||
name: ReplicaSet
|
||||
full-link: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/
|
||||
related:
|
||||
- replication-controller
|
||||
tags:
|
||||
- fundamental
|
||||
- core-object
|
||||
- workload
|
||||
short-description: >
|
||||
ReplicaSet is the next-generation Replication Controller.
|
||||
long-description: >
|
||||
ReplicaSet, like ReplicationController, ensures that a specified number of pods replicas are running at one time.
|
||||
ReplicaSet supports the new set-based selector requirements as described in the labels user guide, whereas a Replication Controller only supports equality-based selector requirements.
|
||||
@@ -1,10 +0,0 @@
|
||||
id: replication-controller
|
||||
name: Replication Controller
|
||||
tags:
|
||||
- workload
|
||||
- core-object
|
||||
short-description: >
|
||||
Kubernetes service that ensures a specific number of instances of a pod are always running.
|
||||
long-description: >
|
||||
Will automatically add or remove running instances of a pod, based on a set value for that pod. Allows the pod to return to the defined number of instances if pods are deleted or if too many are started by mistake.
|
||||
|
||||
@@ -1,11 +0,0 @@
|
||||
id: resource-quota
|
||||
name: Resource Quotas
|
||||
full-link: /docs/concepts/policy/resource-quotas/
|
||||
tags:
|
||||
- fundamental
|
||||
- operation
|
||||
- architecture
|
||||
short-description: >
|
||||
Provides constraints that limit aggregate resource consumption per {% glossary_tooltip term_id="namespace" %}.
|
||||
long-description: >
|
||||
Limits the quantity of objects that can be created in a namespace by type, as well as the total amount of compute resources that may be consumed by resources in that project.
|
||||
@@ -1,8 +0,0 @@
|
||||
id: reviewer
|
||||
name: Reviewer
|
||||
tags:
|
||||
- community
|
||||
short-description: >
|
||||
A person who reviews code for quality and correctness on some part of the project.
|
||||
long-description: >
|
||||
Reviewers are knowledgeable about both the codebase and software engineering principles. Reviewer status is scoped to a part of the codebase.
|
||||
@@ -1,15 +0,0 @@
|
||||
id: secret
|
||||
name: Secret
|
||||
full-link: /docs/concepts/configuration/secret/
|
||||
related:
|
||||
- pods
|
||||
- volume
|
||||
tags:
|
||||
- core-object
|
||||
- security
|
||||
short-description: >
|
||||
Stores sensitive information, such as passwords, OAuth tokens, and ssh keys.
|
||||
long-description: >
|
||||
Allows for more control over how sensitive information is used and reduces the risk of accidental exposure, including [encryption](https://kubernetes.io/docs/tasks/administer-cluster/encrypt-data/#ensure-all-secrets-are-encrypted) at rest.
|
||||
A {% glossary_tooltip text="Pod" term_id="pod" %} references the secret as a file in a volume mount or by the kubelet pulling images for a pod.
|
||||
Secrets are great for confidential data and [ConfigMaps](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/) for non-confidential data.
|
||||
@@ -1,9 +0,0 @@
|
||||
id: security-context
|
||||
name: Security Context
|
||||
full-link: /docs/tasks/configure-pod-container/security-context/
|
||||
tags:
|
||||
- security
|
||||
short-description: >
|
||||
The securityContext field defines privilege and access control settings for a Pod or Container, including the runtime UID and GID.
|
||||
long-description: >
|
||||
The securityContext field in a {% glossary_tooltip term_id="pod" %} (applying to all containers) or container is used to set the user (runAsUser) and group (fsGroup), capabilities, privilege settings, and security policies (SELinux/AppArmor/Seccomp) that container processes use.
|
||||
@@ -1,13 +0,0 @@
|
||||
id: selector
|
||||
name: Selector
|
||||
full-link: /docs/concepts/overview/working-with-objects/labels/
|
||||
related:
|
||||
- label
|
||||
tags:
|
||||
- fundamental
|
||||
short-description: >
|
||||
Allows users to filter a list of resources based on labels.
|
||||
long-description: >
|
||||
Selectors are applied when querying lists of resources to filter
|
||||
them by {% glossary_tooltip text="Labels" term_id="label"
|
||||
%}.
|
||||
@@ -1,10 +0,0 @@
|
||||
id: service-account
|
||||
name: Service Account
|
||||
full-link: /docs/tasks/configure-pod-container/configure-service-account/
|
||||
tags:
|
||||
- fundamental
|
||||
- core-object
|
||||
short-description: >
|
||||
Provides an identity for processes that run in a {% glossary_tooltip text="Pod" term_id="pod" %}.
|
||||
long-description: >
|
||||
When processes inside Pods access the cluster, they are authenticated by the API server as a particular service account, for example, `default`. When you create a Pod, if you do not specify a service account, it is automatically assigned the default service account in the same namespace {% glossary_tooltip text="Namespace" term_id="namespace" %}.
|
||||
@@ -1,9 +0,0 @@
|
||||
id: service-broker
|
||||
name: Service Broker
|
||||
tags:
|
||||
- extension
|
||||
short-description: >
|
||||
An endpoint for a set of {% glossary_tooltip text="Managed Services" term_id="managed-service" %} offered and maintained by a third-party.
|
||||
long-description: >
|
||||
{% glossary_tooltip text="Service Brokers" term_id="service-broker" %} implement the [Open Service Broker API spec](https://github.com/openservicebrokerapi/servicebroker/blob/v2.13/spec.md) and provide a standard interface for applications to use their Managed Services.
|
||||
[Service Catalog](/docs/concepts/service-catalog/) provides a way to list, provision, and bind with Managed Services offered by Service Brokers.
|
||||
@@ -1,8 +0,0 @@
|
||||
id: service-catalog
|
||||
name: Service Catalog
|
||||
tags:
|
||||
- extension
|
||||
short-description: >
|
||||
An extension API that enables applications running in Kubernetes clusters to easily use external managed software offerings, such as a datastore service offered by a cloud provider.
|
||||
long-description: >
|
||||
It provides a way to list, provision, and bind with external {% glossary_tooltip text="Managed Services" term_id="managed-service" %} from {% glossary_tooltip text="Service Brokers" term_id="service-broker" %} without needing detailed knowledge about how those services are created or managed.
|
||||
@@ -1,10 +0,0 @@
|
||||
id: service
|
||||
name: Service
|
||||
full-link: /docs/concepts/services-networking/service/
|
||||
tags:
|
||||
- fundamental
|
||||
- core-object
|
||||
short-description: >
|
||||
An API object that describes how to access applications, such as a set of {% glossary_tooltip text="Pods" term_id="pod" %}, and can describe ports and load-balancers.
|
||||
long-description: >
|
||||
The access point can be internal or external to the cluster.
|
||||
@@ -1,12 +0,0 @@
|
||||
id: sig
|
||||
name: SIG (special interest group)
|
||||
full-link: https://github.com/kubernetes/community/blob/master/sig-list.md#master-sig-list
|
||||
tags:
|
||||
- community
|
||||
short-description: >
|
||||
{% glossary_tooltip text="Community members" term_id="member" %} who collectively manage an ongoing piece or aspect of the larger Kubernetes open source project.
|
||||
long-description: |
|
||||
Members within a SIG have a shared interest in advancing a specific area, such as architecture, API machinery, or documentation.
|
||||
SIGs must follow the [SIG Governance](https://github.com/kubernetes/community/blob/master/sig-governance.md) guidelines but can have their own contribution policy and channels of communication.
|
||||
|
||||
For more information, see the [kubernetes/community](https://github.com/kubernetes/community) repo and the current list of [SIGs and Working Groups](https://github.com/kubernetes/community/blob/master/sig-list.md).
|
||||
@@ -1,17 +0,0 @@
|
||||
id: statefulset
|
||||
name: StatefulSet
|
||||
full-link: /docs/concepts/workloads/controllers/statefulset/
|
||||
related:
|
||||
- deployment
|
||||
- pod
|
||||
tags:
|
||||
- fundamental
|
||||
- core-object
|
||||
- workload
|
||||
- storage
|
||||
short-description: >
|
||||
Manages the deployment and scaling of a set of {% glossary_tooltip text="Pods" term_id="pod" %}, *and provides guarantees about the ordering and uniqueness* of these Pods.
|
||||
long-description: |
|
||||
Like a {% glossary_tooltip term_id="deployment" %}, a StatefulSet manages Pods that are based on an identical container spec. Unlike a Deployment, a StatefulSet maintains a sticky identity for each of their Pods. These pods are created from the same spec, but are not interchangeable: each has a persistent identifier that it maintains across any rescheduling.
|
||||
|
||||
A StatefulSet operates under the same pattern as any other Controller. You define your desired state in a StatefulSet *object*, and the StatefulSet *controller* makes any necessary updates to get there from the current state.
|
||||
@@ -1,11 +0,0 @@
|
||||
id: storageclass
|
||||
name: Storage Class
|
||||
full-link: /docs/concepts/storage/storage-classes
|
||||
tags:
|
||||
- core-object
|
||||
- storage
|
||||
short-description: >
|
||||
A StorageClass provides a way for administrators to describe different available storage types.
|
||||
long-description: >
|
||||
StorageClasses can map to quality-of-service levels, backup policies, or to arbitrary policies determined by cluster administrators.
|
||||
Each StorageClass contains the fields `provisioner`, `parameters`, and `reclaimPolicy`, which are used when a {% glossary_tooltip text="Persistent Volume" term_id="persistent-volume" %} belonging to the class needs to be dynamically provisioned. Users can request a particular class using the name of a StorageClass object.
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user