Compare commits
158 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 524cfedbfe | |||
| 3bd5670939 | |||
| e16ad4e7a0 | |||
| 4fb1b686d1 | |||
| b8d006391d | |||
| 11a2cd9a20 | |||
| 444943bc44 | |||
| cd9183197f | |||
| 6b4729694a | |||
| 51b2149717 | |||
| 7d1f79fa34 | |||
| ccc568c97e | |||
| c85c3fe893 | |||
| bcf55ec9d2 | |||
| a56a8ef2d1 | |||
| 7dcc87ce97 | |||
| 1b1d0701c0 | |||
| 6017180400 | |||
| 7077e41d03 | |||
| 258fc90f5a | |||
| 538dd33ff2 | |||
| 53f460ad9e | |||
| 6da76a3a3a | |||
| 0ab8fd0567 | |||
| 7aa48830c8 | |||
| 2f56f12a7d | |||
| 561f07eb44 | |||
| 53bd0588bd | |||
| 1b06ec8e27 | |||
| 7a81d39bb2 | |||
| c83fdb64cf | |||
| b8d00ae1d0 | |||
| 4ba6e9b088 | |||
| 3ce57d9667 | |||
| 128a779fff | |||
| 79a1173ec8 | |||
| 1474b944ca | |||
| ac78c99a4b | |||
| 975685a3b5 | |||
| 1ff7648009 | |||
| 4d407c1d12 | |||
| 9e6d670b12 | |||
| 3e32a946d5 | |||
| bc805bd7ee | |||
| 6c5ce5bfb6 | |||
| 4ad495b9a5 | |||
| 147f04ca76 | |||
| 271bd0f163 | |||
| 7fa809ce25 | |||
| 6b70c56b25 | |||
| ff6d28472f | |||
| 170c0e7866 | |||
| 532c60d3c3 | |||
| daac519af8 | |||
| 6ff373e1d9 | |||
| f379efa3b4 | |||
| e396274119 | |||
| 25cc5f9556 | |||
| 250522ab83 | |||
| b3b62eba3e | |||
| 29a7b6df2e | |||
| 96a4aa7a3e | |||
| 5325153ee2 | |||
| cc41d370d7 | |||
| b052e4e803 | |||
| 2bd62e674b | |||
| c3947d5ba5 | |||
| 755b52134e | |||
| 9f37676700 | |||
| a10da9cf47 | |||
| 8ec205f057 | |||
| bccd6515f3 | |||
| bda3250c1b | |||
| f93a513d88 | |||
| af7c064877 | |||
| 366cc81601 | |||
| 66cba99aca | |||
| 40e12296d6 | |||
| d32bf973ef | |||
| b3cf89cd75 | |||
| 675765f64f | |||
| 9f590be6ce | |||
| 91fc94fa64 | |||
| 711c56cc4e | |||
| b147fb02ea | |||
| 6bceca53b0 | |||
| 286f2cbd9e | |||
| be8d67ab5e | |||
| f4ce844fcb | |||
| d3019fb14a | |||
| 5c331b74d6 | |||
| a60b2d3045 | |||
| afc78e5b7f | |||
| 5b9b63454b | |||
| ed363f786c | |||
| b173596ab9 | |||
| 27c000f74e | |||
| 90d95e7ab2 | |||
| 3810cb23cb | |||
| a30edd4c00 | |||
| 2a7a878d0e | |||
| 178a2d0f26 | |||
| c330471483 | |||
| 91fc3b9f11 | |||
| 9c0a1b7732 | |||
| 6dcb9d4490 | |||
| 053c79464c | |||
| 83509afbd2 | |||
| 7751e73961 | |||
| a1dfece593 | |||
| 2cf12d2cd8 | |||
| 733de0e819 | |||
| 7c19f53cb2 | |||
| a601ca7c9e | |||
| 2d96ffb696 | |||
| 2090fa2009 | |||
| f42118acf8 | |||
| cf863b3c2d | |||
| 9412bef9fe | |||
| 4807ff07cd | |||
| a26f481492 | |||
| dbfc28aab5 | |||
| 7c999e38b1 | |||
| fc7c06c1e5 | |||
| 7b692cdb29 | |||
| 0fba3ae29a | |||
| 62f4bc8a55 | |||
| 5edcbfd1f1 | |||
| 32de7d72f0 | |||
| 895a6074e2 | |||
| 9403dc361f | |||
| 6c68762cef | |||
| f5cddc78dd | |||
| 5b4ef96268 | |||
| 35dc007365 | |||
| 1798434784 | |||
| db171119ac | |||
| b6ed75c95d | |||
| c29168c78c | |||
| 8ade9bfc88 | |||
| aeb25d0f68 | |||
| da40cc8386 | |||
| 1025476fd5 | |||
| b2eebbbc8c | |||
| 4032cd08d7 | |||
| 0f1d4ce86e | |||
| 08e6c4c699 | |||
| 36413301d1 | |||
| 18559533a3 | |||
| 6eac0e81bd | |||
| d6012632b4 | |||
| e8b4d65bbc | |||
| 3a01832d84 | |||
| dfbc33b8fb | |||
| e475da8481 | |||
| 9979f1d821 | |||
| c377b46e20 | |||
| bf530cac1c |
@@ -1 +0,0 @@
|
||||
**
|
||||
@@ -1,5 +1,4 @@
|
||||
<!-- Thanks for filing an issue! Before submitting, please fill in the following information. -->
|
||||
<!-- See https://kubernetes.io/docs/contribute/start/ for guidance on writing an actionable issue description. -->
|
||||
|
||||
<!--Required Information-->
|
||||
|
||||
@@ -15,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,13 +1,11 @@
|
||||
>^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
> For 1.9 Features: set Milestone to `1.9` and Base Branch to `release-1.9`
|
||||
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
> NOTE: Please check the “Allow edits from maintainers” box (see image below) to
|
||||
> [allow reviewers to fix problems](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) on your patch and speed up the review process.
|
||||
>
|
||||
> Please delete this note before submitting the pull request.
|
||||
>
|
||||
> For 1.13 Features: set Milestone to 1.13 and Base Branch to dev-1.13
|
||||
>
|
||||
> Help editing and submitting pull requests:
|
||||
> https://kubernetes.io/docs/contribute/start/#improve-existing-content.
|
||||
>
|
||||
> Help choosing which branch to use:
|
||||
> https://kubernetes.io/docs/contribute/start#choose-which-git-branch-to-use.
|
||||
>^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
>
|
||||
> NOTE: After opening the PR, please *un-check and re-check* the "Allow edits from maintainers" box. This is a temporary workaround to address a known issue with GitHub.
|
||||
|
||||

|
||||
|
||||
+1
-15
@@ -1,11 +1,11 @@
|
||||
**/.DS_Store
|
||||
**/desktop.ini
|
||||
.jekyll-metadata
|
||||
_site/**
|
||||
.sass-cache/**
|
||||
CNAME
|
||||
.travis.yml
|
||||
.idea/
|
||||
.vscode/
|
||||
|
||||
# Vim ignore
|
||||
# source: https://github.com/github/gitignore/blob/master/Global/Vim.gitignore
|
||||
@@ -24,17 +24,3 @@ Session.vim
|
||||
tags
|
||||
|
||||
kubernetes.github.io.iml
|
||||
|
||||
nohup.out
|
||||
|
||||
# Hugo output
|
||||
public/
|
||||
resources/
|
||||
|
||||
# User-specific editorconfig files
|
||||
.editorconfig
|
||||
|
||||
# Netlify Functions build output
|
||||
package-lock.json
|
||||
functions/
|
||||
node_modules/
|
||||
|
||||
+18
-28
@@ -1,34 +1,24 @@
|
||||
language: go
|
||||
go:
|
||||
- 1.10.2
|
||||
- 1.8.3
|
||||
|
||||
env:
|
||||
- HUGO_VERSION=0.49
|
||||
# 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
|
||||
|
||||
jobs:
|
||||
include:
|
||||
- name: "Testing examples"
|
||||
# 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
|
||||
# (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.8 && popd
|
||||
|
||||
# Make sure we are testing against the correct branch
|
||||
- pushd $GOPATH/src/k8s.io && git clone https://github.com/kubernetes/kubernetes && popd
|
||||
- pushd $GOPATH/src/k8s.io/kubernetes && git checkout release-1.11 && popd
|
||||
- cp -L -R $GOPATH/src/k8s.io/kubernetes/vendor/ $GOPATH/src/
|
||||
- rm -r $GOPATH/src/k8s.io/kubernetes/vendor/
|
||||
# (2) Simplified deduplication of dependencies.
|
||||
- cp -L -R $GOPATH/src/k8s.io/kubernetes/vendor/ $GOPATH/src/
|
||||
- rm -r $GOPATH/src/k8s.io/kubernetes/vendor/
|
||||
|
||||
# Fetch additional dependencies to run the tests in examples/examples_test.go
|
||||
- go get -t -v k8s.io/website/content/en/examples
|
||||
script:
|
||||
- go test -v k8s.io/website/content/en/examples
|
||||
- name: "Hugo build"
|
||||
install:
|
||||
- curl -L https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_${HUGO_VERSION}_linux-64bit.tar.gz | tar -xz
|
||||
- mkdir -p ${TRAVIS_HOME}/bin
|
||||
- mv hugo ${TRAVIS_HOME}/bin
|
||||
- export PATH=${TRAVIS_HOME}/bin:$PATH
|
||||
script:
|
||||
- hugo
|
||||
- go get -t -v k8s.io/website/test
|
||||
|
||||
script:
|
||||
- go test -v k8s.io/website/test
|
||||
- ./verify-docs-format.sh
|
||||
@@ -0,0 +1,11 @@
|
||||
---
|
||||
layout: docwithnav
|
||||
title: 404 Error!
|
||||
permalink: /404.html
|
||||
no_canonical: true
|
||||
sitemap: false
|
||||
---
|
||||
|
||||
<script src="/js/redirects.js"></script>
|
||||
|
||||
Sorry, this page was not found. :(
|
||||
+1
-2
@@ -9,8 +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 the
|
||||
[Kubernetes Code of Conduct Committee](https://github.com/kubernetes/community/tree/master/committee-code-of-conduct) <conduct@kubernetes.io>.
|
||||
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
|
||||
|
||||
|
||||
-33
@@ -1,33 +0,0 @@
|
||||
# Credit to Julien Guyomard (https://github.com/jguyomard). This Dockerfile
|
||||
# is essentially based on his Dockerfile at
|
||||
# https://github.com/jguyomard/docker-hugo/blob/master/Dockerfile. The only significant
|
||||
# change is that the Hugo version is now an overridable argument rather than a fixed
|
||||
# environment variable.
|
||||
|
||||
FROM alpine:latest
|
||||
|
||||
MAINTAINER Luc Perkins <lperkins@linuxfoundation.org>
|
||||
|
||||
RUN apk add --no-cache \
|
||||
curl \
|
||||
git \
|
||||
openssh-client \
|
||||
rsync \
|
||||
build-base \
|
||||
libc6-compat
|
||||
|
||||
ARG HUGO_VERSION
|
||||
|
||||
RUN mkdir -p /usr/local/src && \
|
||||
cd /usr/local/src && \
|
||||
#curl -L https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-64bit.tar.gz | tar -xz && \
|
||||
curl -L https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_${HUGO_VERSION}_linux-64bit.tar.gz | tar -xz && \
|
||||
mv hugo /usr/local/bin/hugo && \
|
||||
#curl -L https://bin.equinox.io/c/dhgbqpS8Bvy/minify-stable-linux-amd64.tgz | tar -xz && \
|
||||
#mv minify /usr/local/bin && \
|
||||
addgroup -Sg 1000 hugo && \
|
||||
adduser -Sg hugo -u 1000 -h /src hugo
|
||||
|
||||
WORKDIR /src
|
||||
|
||||
EXPOSE 1313
|
||||
@@ -0,0 +1,53 @@
|
||||
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.11"
|
||||
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 "jekyll-include-cache", "~> 0.1"
|
||||
|
||||
gem "kramdown", "~> 1.11"
|
||||
gem "rouge", "~> 2.0"
|
||||
gem "pry"
|
||||
+176
@@ -0,0 +1,176 @@
|
||||
GEM
|
||||
remote: https://rubygems.org/
|
||||
specs:
|
||||
addressable (2.5.2)
|
||||
public_suffix (>= 2.0.2, < 4.0)
|
||||
coderay (1.1.2)
|
||||
coffee-script (2.4.1)
|
||||
coffee-script-source
|
||||
execjs
|
||||
coffee-script-source (1.12.2)
|
||||
colorator (1.1.0)
|
||||
ethon (0.11.0)
|
||||
ffi (>= 1.3.0)
|
||||
execjs (2.7.0)
|
||||
faraday (0.13.1)
|
||||
multipart-post (>= 1.2, < 3)
|
||||
ffi (1.9.18)
|
||||
forwardable-extended (2.6.0)
|
||||
jekyll (3.6.0)
|
||||
addressable (~> 2.4)
|
||||
colorator (~> 1.0)
|
||||
jekyll-sass-converter (~> 1.0)
|
||||
jekyll-watch (~> 1.1)
|
||||
kramdown (~> 1.14)
|
||||
liquid (~> 4.0)
|
||||
mercenary (~> 0.3.3)
|
||||
pathutil (~> 0.9)
|
||||
rouge (>= 1.7, < 3)
|
||||
safe_yaml (~> 1.0)
|
||||
jekyll-avatar (0.5.0)
|
||||
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 (~> 3.3)
|
||||
jekyll-gist (1.4.1)
|
||||
octokit (~> 4.2)
|
||||
jekyll-github-metadata (2.9.3)
|
||||
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 (~> 3.0)
|
||||
jekyll-paginate (1.1.0)
|
||||
jekyll-readme-index (0.0.3)
|
||||
jekyll (~> 3.0)
|
||||
jekyll-redirect-from (0.12.1)
|
||||
jekyll (~> 3.3)
|
||||
jekyll-relative-links (0.5.1)
|
||||
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 (~> 3.3)
|
||||
jekyll-swiss (0.4.0)
|
||||
jekyll-theme-architect (0.0.3)
|
||||
jekyll (~> 3.3)
|
||||
jekyll-theme-cayman (0.0.3)
|
||||
jekyll (~> 3.3)
|
||||
jekyll-theme-dinky (0.0.3)
|
||||
jekyll (~> 3.3)
|
||||
jekyll-theme-hacker (0.0.3)
|
||||
jekyll (~> 3.3)
|
||||
jekyll-theme-leap-day (0.0.3)
|
||||
jekyll (~> 3.3)
|
||||
jekyll-theme-merlot (0.0.3)
|
||||
jekyll (~> 3.3)
|
||||
jekyll-theme-midnight (0.0.3)
|
||||
jekyll (~> 3.3)
|
||||
jekyll-theme-minimal (0.0.3)
|
||||
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-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 (~> 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)
|
||||
mercenary (0.3.6)
|
||||
method_source (0.9.0)
|
||||
minima (2.1.1)
|
||||
jekyll (~> 3.3)
|
||||
multipart-post (2.0.0)
|
||||
octokit (4.7.0)
|
||||
sawyer (~> 0.8.0, >= 0.5.3)
|
||||
pathutil (0.16.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)
|
||||
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)
|
||||
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)
|
||||
|
||||
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)
|
||||
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.11)
|
||||
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,48 +1,18 @@
|
||||
DOCKER = docker
|
||||
HUGO_VERSION = 0.49
|
||||
DOCKER_IMAGE = kubernetes-hugo
|
||||
DOCKER_RUN = $(DOCKER) run --rm --interactive --tty --volume $(CURDIR):/src
|
||||
NODE_BIN = node_modules/.bin
|
||||
NETLIFY_FUNC = $(NODE_BIN)/netlify-lambda
|
||||
|
||||
.PHONY: all build sass build-preview help serve
|
||||
.PHONY: all build build-preview help serve
|
||||
|
||||
help: ## Show this help.
|
||||
@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {sub("\\\\n",sprintf("\n%22c"," "), $$2);printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
|
||||
|
||||
all: build ## Build site with production settings and put deliverables in ./public
|
||||
all: build ## Build site with production settings and put deliverables in _site.
|
||||
|
||||
build: ## Build site with production settings and put deliverables in ./public
|
||||
hugo
|
||||
build: ## Build site with production settings and put deliverables in _site.
|
||||
bundle exec jekyll build
|
||||
|
||||
build-preview: ## Build site with drafts and future posts enabled
|
||||
hugo -D -F
|
||||
|
||||
functions-build:
|
||||
$(NETLIFY_FUNC) build functions-src
|
||||
|
||||
check-headers-file:
|
||||
scripts/check-headers-file.sh
|
||||
|
||||
production-build: build check-headers-file ## Build the production site and ensure that noindex headers aren't added
|
||||
|
||||
non-production-build: ## Build the non-production site, which adds noindex headers to prevent indexing
|
||||
hugo --enableGitInfo
|
||||
|
||||
sass-build:
|
||||
scripts/sass.sh build
|
||||
|
||||
sass-develop:
|
||||
scripts/sass.sh develop
|
||||
build-preview: ## Build site with drafts and future posts enabled.
|
||||
bundle exec jekyll build --drafts --future
|
||||
|
||||
serve: ## Boot the development server.
|
||||
hugo server --ignoreCache --disableFastRender
|
||||
bundle exec jekyll serve
|
||||
|
||||
docker-image:
|
||||
$(DOCKER) build . --tag $(DOCKER_IMAGE) --build-arg HUGO_VERSION=$(HUGO_VERSION)
|
||||
|
||||
docker-build:
|
||||
$(DOCKER_RUN) $(DOCKER_IMAGE) hugo
|
||||
|
||||
docker-serve:
|
||||
$(DOCKER_RUN) -p 1313:1313 $(DOCKER_IMAGE) hugo server --watch --bind 0.0.0.0
|
||||
stage: ## Run the Jekyll staging container.
|
||||
docker run -ti --rm -v "${PWD}":/k8sdocs -p 4000:4000 gcr.io/google-samples/k8sdocs:1.1
|
||||
|
||||
@@ -1,10 +1,21 @@
|
||||
# Reviewers can /lgtm /approve but not sufficient for auto-merge without an
|
||||
# approver
|
||||
reviewers:
|
||||
- sig-docs-en-reviews
|
||||
- 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:
|
||||
- sig-docs-en-owners
|
||||
- bradamant3
|
||||
- bradtopol
|
||||
- chenopis
|
||||
- kbarnard10
|
||||
- mistyhacks
|
||||
- steveperry-53
|
||||
- tengqm
|
||||
- zacharysarah
|
||||
- zparnold
|
||||
|
||||
-299
@@ -1,299 +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
|
||||
- andyzhangx
|
||||
- feiskyer
|
||||
- justaugustus
|
||||
- karataliu
|
||||
- khenidak
|
||||
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-kubeadm-approvers: # Approving changes to kubeadm documentation
|
||||
- timothysc
|
||||
- lukemarsden
|
||||
- luxas
|
||||
- roberthbailey
|
||||
- fabriziopandini
|
||||
sig-cluster-lifecycle-kubeadm-reviewers: # Reviewing kubeadm documentation
|
||||
- timothysc
|
||||
- lukemarsden
|
||||
- luxas
|
||||
- roberthbailey
|
||||
- fabriziopandini
|
||||
- kad
|
||||
- xiangpengzhao
|
||||
- stealthybox
|
||||
- liztio
|
||||
- chuckha
|
||||
- detiber
|
||||
- dixudx
|
||||
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-maintainers
|
||||
- bradamant3
|
||||
- bradtopol
|
||||
- chenopis
|
||||
- cody-clark
|
||||
- jaredbhatti
|
||||
- kbarnard10
|
||||
- mistyhacks
|
||||
- ryanmcginnis
|
||||
- steveperry-53
|
||||
- tengqm
|
||||
- tfogo
|
||||
- xiangpengzhao
|
||||
- zacharysarah
|
||||
- zhangxiaoyu-zidif
|
||||
- zparnold
|
||||
sig-docs-en-owners: #Team: Documentation; GH: sig-docs-en-owners
|
||||
- bradamant3
|
||||
- bradtopol
|
||||
- chenopis
|
||||
- cody-clark
|
||||
- jaredbhatti
|
||||
- kbarnard10
|
||||
- mistyhacks
|
||||
- ryanmcginnis
|
||||
- steveperry-53
|
||||
- stewart-yu
|
||||
- tengqm
|
||||
- tfogo
|
||||
- zacharysarah
|
||||
- zparnold
|
||||
sig-docs-en-reviews: #Team: Documentation; GH: sig-docs-pr-reviews
|
||||
- jimangel
|
||||
- rajakavitha1
|
||||
- stewart-yu
|
||||
- xiangpengzhao
|
||||
- zhangxiaoyu
|
||||
sig-docs-ja-owners: #Team: Japanese docs localization; GH: sig-docs-ja-owners
|
||||
- cstoku
|
||||
- nasa9084
|
||||
- tnir
|
||||
- zacharysarah
|
||||
sig-docs-ja-reviews: #Team: Japanese docs PR reviews; GH:sig-docs-ja-reviews
|
||||
- cstoku
|
||||
- makocchi-git
|
||||
- MasayaAoyama
|
||||
- nasa9084
|
||||
- tnir
|
||||
sig-docs-ko-owners: #Team Korean docs localization; GH: sig-docs-ko-owners
|
||||
- ClaudiaJKang
|
||||
- gochist
|
||||
- bradamant3 # Temporary for 1.13 release
|
||||
- jimangel # Temporary for 1.13 release
|
||||
- tfogo # Temporary for 1.13 release
|
||||
- zacharysarah
|
||||
sig-docs-ko-reviews: #Team Korean docs reviews; GH: sig-docs-ko-reviews
|
||||
- ClaudiaJKang
|
||||
- gochist
|
||||
- ianychoi
|
||||
sig-docs-zh-owners: #Team Chinese docs localization; GH: sig-docs-zh-owners
|
||||
- bradtopol
|
||||
- chenopis
|
||||
- chenrui333
|
||||
- dchen1107
|
||||
- haibinxie
|
||||
- hanjiayao
|
||||
- lichuqiang
|
||||
- lucperkins
|
||||
- markthink
|
||||
- SataQiu
|
||||
- tengqm
|
||||
- xiangpengzhao
|
||||
- xichengliudui
|
||||
- zacharysarah
|
||||
- zhangxiaoyu-zidif
|
||||
- bradamant3 # Temporary for 1.13 release
|
||||
- jimangel # Temporary for 1.13 release
|
||||
- tfogo # Temporary for 1.13 release
|
||||
sig-docs-zh-reviews: #Team Chinese docs reviews; GH: sig-docs-zh-reviews
|
||||
- AdamDang
|
||||
- chenrui333
|
||||
- idealhack
|
||||
- markthink
|
||||
- Mr-Linus
|
||||
- SataQiu
|
||||
- tengqm
|
||||
- xiangpengzhao
|
||||
- xichengliudui
|
||||
- zhangxiaoyu-zidif
|
||||
- pigletfly
|
||||
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
|
||||
- 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
|
||||
@@ -1,55 +1,22 @@
|
||||
# The Kubernetes documentation
|
||||
## Instructions for Contributing to the Kubernetes Documentation
|
||||
|
||||
Welcome! This repository houses all of the assets required to build the Kubernetes website and documentation. We're very pleased that you want to contribute!
|
||||
Welcome! We are very pleased you want to contribute to the Kubernetes documentation.
|
||||
|
||||
## Contributing to the docs
|
||||
|
||||
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. This copy is 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.
|
||||
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:
|
||||
|
||||
* [Start contributing](https://kubernetes.io/docs/contribute/start/)
|
||||
* [Staging Your Documentation Changes](http://kubernetes.io/docs/contribute/intermediate#view-your-changes-locally)
|
||||
* [Using Page Templates](http://kubernetes.io/docs/contribute/style/page-templates/)
|
||||
* [Documentation Style Guide](http://kubernetes.io/docs/contribute/style/style-guide/)
|
||||
* [Localizing Kubernetes Documentation](https://kubernetes.io/docs/contribute/localization/)
|
||||
|
||||
## Running the site locally using Docker
|
||||
|
||||
The recommended way to run the Kubernetes website locally is to run a specialized [Docker](https://docker.com) image that includes the [Hugo](https://gohugo.io) static site generator.
|
||||
|
||||
> If you are running on Windows, you'll need a few more tools which you can install with [Chocolatey](https://chocolatey.org). `choco install make`
|
||||
|
||||
> If you'd prefer to run the website locally without Docker, see [Running the site locally using Hugo](#running-the-site-locally-using-hugo) below.
|
||||
|
||||
If you have Docker [up and running](https://www.docker.com/get-started), build the `kubernetes-hugo` Docker image locally:
|
||||
|
||||
```bash
|
||||
make docker-image
|
||||
```
|
||||
|
||||
Once the image has been built, you can run the site locally:
|
||||
|
||||
```bash
|
||||
make docker-serve
|
||||
```
|
||||
|
||||
Open up your browser to http://localhost:1313 to view the site. As you make changes to the source files, Hugo updates the site and forces a browser refresh.
|
||||
|
||||
## Running the site locally using Hugo
|
||||
|
||||
See the [official Hugo documentation](https://gohugo.io/getting-started/installing/) for Hugo installation instructions. Make sure to install the Hugo version specified by the `HUGO_VERSION` environment variable in the [`netlify.toml`](netlify.toml#L9) file.
|
||||
|
||||
To run the site locally when you have Hugo installed:
|
||||
|
||||
```bash
|
||||
make serve
|
||||
```
|
||||
|
||||
This will start the local Hugo server on port 1313. Open up your browser to http://localhost:1313 to view the site. As you make changes to the source files, Hugo updates the site and forces a browser refresh.
|
||||
* [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/)
|
||||
|
||||
## Thank you!
|
||||
|
||||
Kubernetes thrives on community participation, and we really appreciate your contributions to our site and our documentation!
|
||||
Kubernetes thrives on community participation, and we really appreciate your
|
||||
contributions to our site and our documentation!
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
# Defined below are the security contacts for this repo.
|
||||
#
|
||||
# They are the contact point for the Product Security Team to reach out
|
||||
# to for triaging and handling of incoming issues.
|
||||
#
|
||||
# The below names agree to abide by the
|
||||
# [Embargo Policy](https://github.com/kubernetes/sig-release/blob/master/security-release-process-documentation/security-release-process.md#embargo-policy)
|
||||
# and will be removed and replaced if they violate that agreement.
|
||||
#
|
||||
# DO NOT REPORT SECURITY VULNERABILITIES DIRECTLY TO THESE NAMES, FOLLOW THE
|
||||
# INSTRUCTIONS AT https://kubernetes.io/security/
|
||||
|
||||
chenopis
|
||||
bradamant3
|
||||
zacharysarah
|
||||
+90
@@ -0,0 +1,90 @@
|
||||
name: Kubernetes
|
||||
title: Kubernetes
|
||||
url: https://kubernetes.io
|
||||
description: Production-Grade Container Orchestration
|
||||
markdown: kramdown
|
||||
kramdown:
|
||||
input: GFM
|
||||
html_to_native: true
|
||||
hard_wrap: false
|
||||
syntax_highlighter: rouge
|
||||
incremental: true
|
||||
|
||||
safe: false
|
||||
lsi: false
|
||||
|
||||
defaults:
|
||||
-
|
||||
scope:
|
||||
path: ""
|
||||
values:
|
||||
fullversion: "v1.8.4"
|
||||
version: "v1.8"
|
||||
githubbranch: "master"
|
||||
docsbranch: "master"
|
||||
versions:
|
||||
- fullversion: "v1.11.0"
|
||||
version: "v1.11"
|
||||
githubbranch: "v1.11.0"
|
||||
docsbranch: "release-1.11"
|
||||
url: https://kubernetes.io/docs/
|
||||
- fullversion: "v1.10.0"
|
||||
version: "v1.10"
|
||||
githubbranch: "v1.10.0"
|
||||
docsbranch: "release-1.10"
|
||||
url: https://v1-10.docs.kubernetes.io/docs/home/
|
||||
- fullversion: "v1.9.0"
|
||||
version: "v1.9"
|
||||
githubbranch: "v1.9.0"
|
||||
docsbranch: "release-1.9"
|
||||
url: https://v1-9.docs.kubernetes.io/docs/home/
|
||||
- fullversion: "v1.8.4"
|
||||
version: "v1.8"
|
||||
githubbranch: "v1.8.4"
|
||||
docsbranch: "release-1.8"
|
||||
url: https://v1-8.docs.kubernetes.io/docs/home/
|
||||
- fullversion: "v1.7.6"
|
||||
version: "v1.7"
|
||||
githubbranch: "v1.7.6"
|
||||
docsbranch: "release-1.7"
|
||||
url: https://v1-7.docs.kubernetes.io/docs/home/
|
||||
deprecated: true
|
||||
currentUrl: https://kubernetes.io/docs/home/
|
||||
nextUrl: http://kubernetes-io-vnext-staging.netlify.com/
|
||||
-
|
||||
scope:
|
||||
path: "docs"
|
||||
values:
|
||||
layout: docwithnav
|
||||
showedit: true
|
||||
|
||||
permalink: pretty
|
||||
|
||||
plugins:
|
||||
- jekyll-feed
|
||||
- jekyll-sitemap
|
||||
- jekyll-seo-tag
|
||||
- jekyll-include-cache
|
||||
# disabled gems
|
||||
# - jekyll-redirect-from
|
||||
|
||||
include: [_redirects,_headers]
|
||||
|
||||
# SEO
|
||||
logo: /images/favicon.png
|
||||
twitter:
|
||||
username: kubernetesio
|
||||
|
||||
# empty array for tabs
|
||||
emptyArray: []
|
||||
|
||||
# Tables of contents, stored in the _data folder, that control the sidebar nav
|
||||
tocs:
|
||||
- docs-home
|
||||
- setup
|
||||
- tasks
|
||||
- tutorials
|
||||
- concepts
|
||||
- reference
|
||||
- samples
|
||||
- search
|
||||
@@ -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,23 +14,15 @@ 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
|
||||
- docs/concepts/overview/working-with-objects/common-labels.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
|
||||
@@ -44,17 +33,16 @@ toc:
|
||||
section:
|
||||
- docs/concepts/cluster-administration/network-plugins.md
|
||||
- docs/concepts/cluster-administration/device-plugins.md
|
||||
- docs/concepts/cluster-administration/sysctl-cluster.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:
|
||||
@@ -76,7 +64,6 @@ toc:
|
||||
- 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
|
||||
@@ -87,7 +74,6 @@ toc:
|
||||
- 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
|
||||
@@ -97,7 +83,6 @@ toc:
|
||||
- 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
|
||||
@@ -105,7 +90,6 @@ toc:
|
||||
- docs/concepts/storage/dynamic-provisioning.md
|
||||
|
||||
- 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
|
||||
@@ -126,3 +110,5 @@ toc:
|
||||
section:
|
||||
- docs/concepts/policy/resource-quotas.md
|
||||
- docs/concepts/policy/pod-security-policy.md
|
||||
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
bigheader: "Documentation Home"
|
||||
abstract: "Documentation for using and learning about Kubernetes."
|
||||
toc:
|
||||
- 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
|
||||
section:
|
||||
- editdocs.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
|
||||
@@ -8,4 +8,3 @@ tocs:
|
||||
- reference
|
||||
- samples
|
||||
- support
|
||||
- imported
|
||||
@@ -0,0 +1,27 @@
|
||||
id: _example
|
||||
name: Example K8s Term
|
||||
full-link: kubernetes.io/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.**
|
||||
@@ -0,0 +1,9 @@
|
||||
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.
|
||||
@@ -0,0 +1,11 @@
|
||||
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.
|
||||
@@ -0,0 +1,11 @@
|
||||
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.
|
||||
@@ -0,0 +1,10 @@
|
||||
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.
|
||||
@@ -0,0 +1,9 @@
|
||||
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).
|
||||
@@ -0,0 +1,11 @@
|
||||
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.
|
||||
@@ -0,0 +1,15 @@
|
||||
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.
|
||||
@@ -0,0 +1,9 @@
|
||||
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.
|
||||
@@ -0,0 +1,11 @@
|
||||
id: code-contributor
|
||||
name: Code Contributor
|
||||
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" %}.
|
||||
@@ -0,0 +1,13 @@
|
||||
id: configmap
|
||||
name: ConfigMap
|
||||
full-link: /docs/tasks/configure-pod-container/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/).
|
||||
@@ -0,0 +1,10 @@
|
||||
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.
|
||||
@@ -0,0 +1,8 @@
|
||||
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.
|
||||
@@ -0,0 +1,10 @@
|
||||
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.
|
||||
@@ -0,0 +1,10 @@
|
||||
id: daemonset
|
||||
name: DaemonSet
|
||||
full-link: /docs/concepts/workloads/controllers/daemonset
|
||||
tags:
|
||||
- fundamental
|
||||
- workload
|
||||
short-description: >
|
||||
Ensures a copy of a {% glossary_tooltip term_id="pod" %} is running across a set of nodes in a {% glossary_tooltip 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" %}.
|
||||
@@ -0,0 +1,11 @@
|
||||
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.
|
||||
@@ -0,0 +1,11 @@
|
||||
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
|
||||
@@ -0,0 +1,11 @@
|
||||
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*.
|
||||
@@ -0,0 +1,10 @@
|
||||
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.
|
||||
@@ -0,0 +1,15 @@
|
||||
id: horizontal-pod-autoscaler
|
||||
name: Horizontal Pod Autoscaler
|
||||
full-link: /docs/tasks/run-application/horizontal-pod-autoscale/
|
||||
aka:
|
||||
- HPA
|
||||
related:
|
||||
- pod
|
||||
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 replication controllers, deployments or replica sets and cannot be
|
||||
applied to objects that cannot be scaled, for example DaemonSets.
|
||||
@@ -0,0 +1,9 @@
|
||||
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.
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
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.
|
||||
@@ -0,0 +1,13 @@
|
||||
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.
|
||||
@@ -0,0 +1,9 @@
|
||||
id: job
|
||||
name: Job
|
||||
full-link: /docs/concepts/workloads/controllers/jobs-run-to-completion
|
||||
tags:
|
||||
- core-object
|
||||
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.
|
||||
@@ -0,0 +1,19 @@
|
||||
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.
|
||||
@@ -0,0 +1,10 @@
|
||||
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.
|
||||
@@ -0,0 +1,10 @@
|
||||
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.
|
||||
@@ -0,0 +1,10 @@
|
||||
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.
|
||||
@@ -0,0 +1,13 @@
|
||||
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.
|
||||
@@ -0,0 +1,9 @@
|
||||
id: labels
|
||||
name: Labels
|
||||
full-link: /docs/concepts/overview/working-with-objects/labels
|
||||
tags:
|
||||
- fundamental
|
||||
short-description: >
|
||||
Used to tag 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 pods. They can be used to organize and to select subsets of objects.
|
||||
@@ -0,0 +1,8 @@
|
||||
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.
|
||||
@@ -0,0 +1,9 @@
|
||||
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" %}.
|
||||
@@ -0,0 +1,10 @@
|
||||
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.
|
||||
@@ -0,0 +1,10 @@
|
||||
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.
|
||||
@@ -0,0 +1,9 @@
|
||||
id: namespace
|
||||
name: Namespace
|
||||
full-link: /docs/concepts/overview/working-with-objects/namespaces
|
||||
tags:
|
||||
- fundamental
|
||||
short-description: >
|
||||
An abstraction used by Kubernetes to support virtual clusters on the same physical {% glossary_tooltip 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.
|
||||
@@ -0,0 +1,13 @@
|
||||
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.
|
||||
@@ -0,0 +1,13 @@
|
||||
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.
|
||||
@@ -0,0 +1,11 @@
|
||||
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.
|
||||
@@ -0,0 +1,19 @@
|
||||
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.
|
||||
@@ -0,0 +1,17 @@
|
||||
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" %}.
|
||||
@@ -0,0 +1,10 @@
|
||||
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.
|
||||
@@ -0,0 +1,13 @@
|
||||
id: replica-set
|
||||
name: ReplicaSet
|
||||
full-link: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/
|
||||
related:
|
||||
- replication-controller
|
||||
tags:
|
||||
- core-object
|
||||
- architecture
|
||||
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.
|
||||
@@ -0,0 +1,9 @@
|
||||
id: replication-controller
|
||||
name: Replication Controller
|
||||
tags:
|
||||
- fundamental
|
||||
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.
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
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.
|
||||
@@ -0,0 +1,8 @@
|
||||
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.
|
||||
@@ -0,0 +1,15 @@
|
||||
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/configmap/) for non-confidential data.
|
||||
@@ -0,0 +1,9 @@
|
||||
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.
|
||||
@@ -0,0 +1,10 @@
|
||||
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 Pod {% glossary_tooltip text="Pods" 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" %}.
|
||||
@@ -0,0 +1,9 @@
|
||||
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.
|
||||
@@ -0,0 +1,8 @@
|
||||
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: >
|
||||
Service Catalog 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.
|
||||
@@ -0,0 +1,10 @@
|
||||
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.
|
||||
@@ -0,0 +1,12 @@
|
||||
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).
|
||||
@@ -0,0 +1,18 @@
|
||||
id: statefulset
|
||||
name: StatefulSet
|
||||
full-link: /docs/concepts/workloads/controllers/statefulset/
|
||||
aka:
|
||||
- PetSet
|
||||
related:
|
||||
- deployment
|
||||
- pod
|
||||
tags:
|
||||
- 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.
|
||||
@@ -0,0 +1,11 @@
|
||||
id: upstream
|
||||
name: Upstream (disambiguation)
|
||||
related:
|
||||
- downstream
|
||||
tags:
|
||||
- community
|
||||
short-description: >
|
||||
May refer to: core Kubernetes or the source repo from which a repo was forked.
|
||||
long-description: |
|
||||
* In the **Kubernetes Community**: Conversations often use *upstream* to mean the core Kubernetes codebase, which the general ecosystem, other code, or third-party tools relies upon. For example, [community members](#term-member) may suggest that a feature is moved upstream so that it is in the core codebase instead of in a plugin or third-party tool.
|
||||
* In **GitHub** or **git**: The convention is to refer to a source repo as *upstream*, whereas the forked repo is considered *downstream*.
|
||||
@@ -0,0 +1,17 @@
|
||||
id: volume
|
||||
name: Volume
|
||||
full-link: /docs/concepts/storage/volumes/
|
||||
related:
|
||||
- pod
|
||||
- container
|
||||
- secret
|
||||
tags:
|
||||
- core-object
|
||||
- fundamental
|
||||
short-description: >
|
||||
A directory containing data, accessible to the containers in a {% glossary_tooltip text="pod" term_id="pod" %}.
|
||||
long-description: >
|
||||
A Kubernetes volume lives as long as the {% glossary_tooltip text="pod" term_id="pod" %} that encloses it.
|
||||
Consequently, a volume outlives any {% glossary_tooltip text="containers" term_id="container" %} that run within the
|
||||
{% glossary_tooltip text="pod" term_id="pod" %}, and data is preserved across
|
||||
{% glossary_tooltip text="container" term_id="container" %} restarts.
|
||||
@@ -0,0 +1,11 @@
|
||||
id: wg
|
||||
name: WG (working group)
|
||||
full-link: https://github.com/kubernetes/community/blob/master/sig-list.md#master-working-group-list
|
||||
tags:
|
||||
- community
|
||||
short-description: >
|
||||
Facilitates the discussion and/or implementation of a short-lived, narrow, or decoupled project for a committee, {% glossary_tooltip text="SIG" term_id="sig" %}, or cross-SIG effort.
|
||||
long-description: |
|
||||
Working groups are a way of organizing people to accomplish a discrete task, and are relatively easy to create and deprecate when inactive.
|
||||
|
||||
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).
|
||||
@@ -0,0 +1,104 @@
|
||||
bigheader: "Reference Documentation"
|
||||
abstract: "Design docs, concept definitions, and references for APIs and CLIs."
|
||||
toc:
|
||||
- docs/reference/index.md
|
||||
- docs/reference/glossary.md
|
||||
|
||||
- title: Using the API
|
||||
section:
|
||||
- docs/reference/api-overview.md
|
||||
- docs/reference/client-libraries.md
|
||||
- title: Accessing the API
|
||||
section:
|
||||
- docs/admin/accessing-the-api.md
|
||||
- docs/admin/authentication.md
|
||||
- docs/admin/bootstrap-tokens.md
|
||||
- docs/admin/admission-controllers.md
|
||||
- docs/admin/extensible-admission-controllers.md
|
||||
- docs/admin/service-accounts-admin.md
|
||||
- title: Authorization
|
||||
section:
|
||||
- docs/admin/authorization/index.md
|
||||
- docs/admin/authorization/abac.md
|
||||
- docs/admin/authorization/rbac.md
|
||||
- docs/admin/authorization/node.md
|
||||
- docs/admin/authorization/webhook.md
|
||||
- docs/reference/deprecation-policy.md
|
||||
- docs/reference/workloads-18-19.md
|
||||
|
||||
- title: API Reference
|
||||
section:
|
||||
- title: v1.8
|
||||
path: /docs/api-reference/v1.8/
|
||||
- docs/reference/labels-annotations-taints.md
|
||||
- title: OpenAPI and Swagger
|
||||
section:
|
||||
- title: OpenAPI Spec
|
||||
path: https://git.k8s.io/kubernetes/api/openapi-spec/
|
||||
- title: Swagger Spec
|
||||
path: https://git.k8s.io/kubernetes/api/swagger-spec/
|
||||
|
||||
- title: Federation API
|
||||
section:
|
||||
- docs/reference/federation/v1/operations.html
|
||||
- docs/reference/federation/v1/definitions.html
|
||||
- docs/reference/federation/v1beta1/operations.html
|
||||
- docs/reference/federation/v1beta1/definitions.html
|
||||
- docs/reference/federation/extensions/v1beta1/operations.html
|
||||
- docs/reference/federation/extensions/v1beta1/definitions.html
|
||||
|
||||
- title: kubectl CLI
|
||||
section:
|
||||
- docs/reference/kubectl/overview.md
|
||||
- docs/reference/generated/kubectl/kubectl-options.md
|
||||
- title: kubectl Commands
|
||||
path: /docs/reference/generated/kubectl/kubectl-commands.html
|
||||
- docs/reference/kubectl/docker-cli-to-kubectl.md
|
||||
- docs/reference/kubectl/conventions.md
|
||||
- docs/reference/kubectl/jsonpath.md
|
||||
- docs/reference/kubectl/cheatsheet.md
|
||||
|
||||
- title: Setup Tools Reference
|
||||
section:
|
||||
- docs/reference/generated/kubeadm.md
|
||||
- title: Kubefed
|
||||
section:
|
||||
- docs/reference/generated/kubefed.md
|
||||
- docs/reference/generated/kubefed_options.md
|
||||
- docs/reference/generated/kubefed_init.md
|
||||
- docs/reference/generated/kubefed_join.md
|
||||
- docs/reference/generated/kubefed_unjoin.md
|
||||
- docs/reference/generated/kubefed_version.md
|
||||
|
||||
- title: Command-line Tools Reference
|
||||
section:
|
||||
- docs/reference/generated/kubelet.md
|
||||
- docs/admin/kubelet-authentication-authorization.md
|
||||
- docs/reference/generated/kube-apiserver.md
|
||||
- docs/reference/generated/kube-controller-manager.md
|
||||
- docs/reference/generated/kube-proxy.md
|
||||
- docs/reference/generated/kube-scheduler.md
|
||||
- docs/admin/kubelet-tls-bootstrapping.md
|
||||
- docs/reference/generated/cloud-controller-manager.md
|
||||
- docs/reference/generated/federation-apiserver.md
|
||||
- docs/reference/generated/federation-controller-manager.md
|
||||
|
||||
- title: Kubernetes Design Docs
|
||||
section:
|
||||
- title: Kubernetes Architecture
|
||||
path: https://git.k8s.io/community/contributors/design-proposals/architecture/architecture.md
|
||||
- title: Kubernetes Design Overview
|
||||
path: https://github.com/kubernetes/kubernetes/tree/release-1.6/docs/design
|
||||
- title: Kubernetes Identity and Access Management
|
||||
path: https://git.k8s.io/community/contributors/design-proposals/auth/access.md
|
||||
- docs/admin/ovs-networking.md
|
||||
- title: Security Contexts
|
||||
path: https://git.k8s.io/community/contributors/design-proposals/auth/security_context.md
|
||||
- title: Security in Kubernetes
|
||||
path: https://git.k8s.io/community/contributors/design-proposals/auth/security.md
|
||||
|
||||
- title: Kubernetes Issues and Security
|
||||
section:
|
||||
- title: Kubernetes Issue Tracker on GitHub
|
||||
path: https://github.com/kubernetes/kubernetes/issues/
|
||||
- docs/reference/security.md
|
||||
+108
@@ -0,0 +1,108 @@
|
||||
bigheader: "Setup"
|
||||
abstract: "Instructions for setting up a Kubernetes cluster."
|
||||
toc:
|
||||
- docs/setup/index.md
|
||||
- docs/setup/pick-right-solution.md
|
||||
|
||||
- title: Independent Solutions
|
||||
section:
|
||||
- docs/getting-started-guides/minikube.md
|
||||
|
||||
- title: Bootstrapping Clusters with kubeadm
|
||||
section:
|
||||
- docs/setup/independent/install-kubeadm.md
|
||||
- docs/setup/independent/create-cluster-kubeadm.md
|
||||
- docs/setup/independent/troubleshooting-kubeadm.md
|
||||
|
||||
- docs/getting-started-guides/scratch.md
|
||||
- docs/getting-started-guides/alternatives.md
|
||||
|
||||
- title: Hosted Solutions
|
||||
section:
|
||||
- title: Running Kubernetes on Google Kubernetes Engine
|
||||
path: https://cloud.google.com/kubernetes-engine/docs/before-you-begin/
|
||||
- title: Running Kubernetes on Azure Container Service
|
||||
path: https://docs.microsoft.com/en-us/azure/container-service/container-service-kubernetes-walkthrough
|
||||
- title: Running Kubernetes on IBM Cloud Container Service
|
||||
path: https://console.bluemix.net/docs/containers/container_index.html
|
||||
|
||||
- title: Turn-key Cloud Solutions
|
||||
section:
|
||||
- docs/getting-started-guides/gce.md
|
||||
- docs/getting-started-guides/aws.md
|
||||
- docs/getting-started-guides/azure.md
|
||||
- docs/getting-started-guides/alibaba-cloud.md
|
||||
- docs/getting-started-guides/clc.md
|
||||
- title: Running Kubernetes on IBM Cloud
|
||||
path: https://github.com/patrocinio/kubernetes-softlayer
|
||||
- docs/getting-started-guides/stackpoint.md
|
||||
|
||||
- title: Custom Solutions
|
||||
|
||||
section:
|
||||
- title: Custom Cloud Solutions
|
||||
section:
|
||||
- docs/getting-started-guides/coreos/index.md
|
||||
- docs/getting-started-guides/ubuntu/index.md
|
||||
- docs/getting-started-guides/kops.md
|
||||
- docs/getting-started-guides/kubespray.md
|
||||
- docs/getting-started-guides/running-cloud-controller.md
|
||||
|
||||
- title: On-Premise VMs
|
||||
section:
|
||||
- docs/getting-started-guides/coreos/index.md
|
||||
- docs/getting-started-guides/cloudstack.md
|
||||
- docs/getting-started-guides/vsphere.md
|
||||
- docs/getting-started-guides/photon-controller.md
|
||||
- docs/getting-started-guides/dcos.md
|
||||
- docs/getting-started-guides/libvirt-coreos.md
|
||||
- docs/getting-started-guides/ovirt.md
|
||||
- docs/getting-started-guides/openstack-heat.md
|
||||
|
||||
- title: rkt
|
||||
section:
|
||||
- docs/getting-started-guides/rkt/index.md
|
||||
- docs/getting-started-guides/rkt/notes.md
|
||||
|
||||
- docs/getting-started-guides/mesos/index.md
|
||||
- docs/getting-started-guides/mesos-docker.md
|
||||
|
||||
- title: Bare Metal
|
||||
section:
|
||||
- docs/getting-started-guides/coreos/bare_metal_offline.md
|
||||
- docs/getting-started-guides/fedora/fedora_ansible_config.md
|
||||
- docs/getting-started-guides/fedora/fedora_manual_config.md
|
||||
- docs/getting-started-guides/fedora/flannel_multi_node_cluster.md
|
||||
- docs/getting-started-guides/centos/centos_manual_config.md
|
||||
- docs/getting-started-guides/coreos/index.md
|
||||
- docs/getting-started-guides/ubuntu/index.md
|
||||
|
||||
- title: Ubuntu
|
||||
section:
|
||||
- docs/getting-started-guides/ubuntu/index.md
|
||||
- docs/getting-started-guides/ubuntu/validation.md
|
||||
- docs/getting-started-guides/ubuntu/backups.md
|
||||
- docs/getting-started-guides/ubuntu/upgrades.md
|
||||
- docs/getting-started-guides/ubuntu/scaling.md
|
||||
- docs/getting-started-guides/ubuntu/installation.md
|
||||
- docs/getting-started-guides/ubuntu/monitoring.md
|
||||
- docs/getting-started-guides/ubuntu/networking.md
|
||||
- docs/getting-started-guides/ubuntu/security.md
|
||||
- docs/getting-started-guides/ubuntu/storage.md
|
||||
- docs/getting-started-guides/ubuntu/troubleshooting.md
|
||||
- docs/getting-started-guides/ubuntu/decommissioning.md
|
||||
- docs/getting-started-guides/ubuntu/operational-considerations.md
|
||||
- docs/getting-started-guides/ubuntu/glossary.md
|
||||
- docs/getting-started-guides/ubuntu/local.md
|
||||
- docs/getting-started-guides/ubuntu/logging.md
|
||||
|
||||
- docs/getting-started-guides/windows/index.md
|
||||
|
||||
- docs/admin/node-conformance.md
|
||||
|
||||
- docs/concepts/cluster-administration/addons.md
|
||||
- docs/admin/salt.md
|
||||
- docs/admin/cluster-large.md
|
||||
- docs/admin/multiple-zones.md
|
||||
- docs/admin/high-availability/index.md
|
||||
- docs/getting-started-guides/binary_release.md
|
||||
@@ -1,18 +1,15 @@
|
||||
bigheader: "Tasks"
|
||||
abstract: "Step-by-step instructions for performing operations with Kubernetes."
|
||||
landing_page: /docs/tasks/index/
|
||||
toc:
|
||||
- docs/tasks/index.md
|
||||
|
||||
- title: Install Tools
|
||||
landing_page: /docs/tasks/tools/install-kubectl/
|
||||
section:
|
||||
- docs/tasks/tools/install-kubectl.md
|
||||
- docs/tasks/tools/install-minikube.md
|
||||
- docs/setup/independent/install-kubeadm.md
|
||||
|
||||
- title: Configure Pods and Containers
|
||||
landing_page: /docs/tasks/configure-pod-container/configure-pod-initialization/
|
||||
section:
|
||||
- docs/tasks/configure-pod-container/assign-memory-resource.md
|
||||
- docs/tasks/configure-pod-container/assign-cpu-resource.md
|
||||
@@ -24,19 +21,18 @@ toc:
|
||||
- docs/tasks/configure-pod-container/configure-projected-volume-storage.md
|
||||
- docs/tasks/configure-pod-container/projected-volume.md
|
||||
- docs/tasks/configure-pod-container/security-context.md
|
||||
- docs/tasks/inject-data-application/environment-variable-expose-pod-information.md
|
||||
- docs/tasks/configure-pod-container/environment-variable-expose-pod-information.md
|
||||
- docs/tasks/configure-pod-container/configure-service-account.md
|
||||
- docs/tasks/configure-pod-container/pull-image-private-registry.md
|
||||
- docs/tasks/configure-pod-container/configure-liveness-readiness-probes.md
|
||||
- docs/tasks/configure-pod-container/assign-pods-nodes.md
|
||||
- docs/tasks/configure-pod-container/configure-pod-initialization.md
|
||||
- docs/tasks/configure-pod-container/attach-handler-lifecycle-event.md
|
||||
- docs/tasks/configure-pod-container/configmap.md
|
||||
- docs/tasks/configure-pod-container/configure-pod-configmap.md
|
||||
- docs/tasks/configure-pod-container/share-process-namespace.md
|
||||
- docs/tools/kompose/user-guide.md
|
||||
|
||||
- title: Inject Data Into Applications
|
||||
landing_page: /docs/tasks/inject-data-application/define-environment-variable-container/
|
||||
section:
|
||||
- docs/tasks/inject-data-application/define-command-argument-container.md
|
||||
- docs/tasks/inject-data-application/define-environment-variable-container.md
|
||||
@@ -46,7 +42,6 @@ toc:
|
||||
- docs/tasks/inject-data-application/podpreset.md
|
||||
|
||||
- title: Run Applications
|
||||
landing_page: /docs/tasks/run-application/run-stateless-application-deployment/
|
||||
section:
|
||||
- docs/tasks/run-application/run-stateless-application-deployment.md
|
||||
- docs/tasks/run-application/run-single-instance-stateful-application.md
|
||||
@@ -62,15 +57,12 @@ toc:
|
||||
- docs/tasks/run-application/configure-pdb.md
|
||||
|
||||
- title: Run Jobs
|
||||
landing_page: /docs/tasks/job/parallel-processing-expansion/
|
||||
section:
|
||||
- docs/tasks/job/automated-tasks-with-cron-jobs.md
|
||||
- docs/tasks/job/parallel-processing-expansion.md
|
||||
- docs/tasks/job/coarse-parallel-processing-work-queue/index.md
|
||||
- docs/tasks/job/fine-parallel-processing-work-queue/index.md
|
||||
|
||||
- title: Access Applications in a Cluster
|
||||
landing_page: /docs/tasks/access-application-cluster/web-ui-dashboard/
|
||||
section:
|
||||
- docs/tasks/access-application-cluster/web-ui-dashboard.md
|
||||
- docs/tasks/access-application-cluster/access-cluster.md
|
||||
@@ -87,7 +79,6 @@ toc:
|
||||
path: https://github.com/kubernetes/kubernetes/tree/release-1.5/examples/cluster-dns
|
||||
|
||||
- title: Monitor, Log, and Debug
|
||||
landing_page: /docs/tasks/debug-application-cluster/resource-usage-monitoring/
|
||||
section:
|
||||
- docs/tasks/debug-application-cluster/core-metrics-pipeline.md
|
||||
- docs/tasks/debug-application-cluster/resource-usage-monitoring.md
|
||||
@@ -110,10 +101,10 @@ toc:
|
||||
path: https://github.com/kubernetes/kubernetes/tree/release-1.5/examples/explorer
|
||||
|
||||
- title: Extend Kubernetes
|
||||
landing_page: /docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/
|
||||
section:
|
||||
- docs/tasks/access-kubernetes-api/http-proxy-access-api.md
|
||||
- docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions.md
|
||||
- docs/tasks/access-kubernetes-api/extend-api-third-party-resource.md
|
||||
- docs/tasks/access-kubernetes-api/migrate-third-party-resource.md
|
||||
- docs/tasks/access-kubernetes-api/configure-aggregation-layer.md
|
||||
- docs/tasks/access-kubernetes-api/setup-extension-api-server.md
|
||||
@@ -121,21 +112,12 @@ toc:
|
||||
- docs/tasks/service-catalog/install-service-catalog-using-sc.md
|
||||
|
||||
- title: TLS
|
||||
landing_page: /docs/tasks/tls/managing-tls-in-a-cluster/
|
||||
section:
|
||||
- docs/tasks/tls/managing-tls-in-a-cluster.md
|
||||
- docs/tasks/tls/certificate-rotation.md
|
||||
|
||||
- title: Administer a Cluster
|
||||
landing_page: /docs/tasks/administer-cluster/memory-default-namespace/
|
||||
section:
|
||||
- title: Upgrading or downgrading Kubernetes
|
||||
section:
|
||||
- docs/tasks/administer-cluster/upgrade-downgrade/upgrade-1-6.md
|
||||
- docs/tasks/administer-cluster/upgrade-downgrade/kubeadm-upgrade-1-7.md
|
||||
- docs/tasks/administer-cluster/upgrade-downgrade/kubeadm-upgrade-1-8.md
|
||||
- docs/tasks/administer-cluster/upgrade-downgrade/kubeadm-upgrade-1-9.md
|
||||
- docs/tasks/administer-cluster/upgrade-downgrade/kubeadm-upgrade-ha.md
|
||||
- title: Manage Memory, CPU, and API Resources
|
||||
section:
|
||||
- docs/tasks/administer-cluster/memory-default-namespace.md
|
||||
@@ -151,22 +133,24 @@ toc:
|
||||
- docs/tasks/administer-cluster/access-cluster-api.md
|
||||
- docs/tasks/administer-cluster/access-cluster-services.md
|
||||
- docs/tasks/administer-cluster/securing-a-cluster.md
|
||||
- docs/tasks/administer-cluster/sysctl-cluster.md
|
||||
- docs/tasks/administer-cluster/encrypt-data.md
|
||||
- docs/tasks/administer-cluster/configure-upgrade-etcd.md
|
||||
- docs/tasks/administer-cluster/static-pod.md
|
||||
- docs/tasks/administer-cluster/cluster-management.md
|
||||
- docs/tasks/administer-cluster/upgrade-1-6.md
|
||||
- docs/tasks/administer-cluster/kubeadm-upgrade-1-7.md
|
||||
- docs/tasks/administer-cluster/kubeadm-upgrade-1-8.md
|
||||
- docs/tasks/administer-cluster/namespaces.md
|
||||
- docs/tasks/administer-cluster/namespaces-walkthrough.md
|
||||
- docs/tasks/administer-cluster/dns-horizontal-autoscaling.md
|
||||
- docs/tasks/administer-cluster/coredns.md
|
||||
- docs/tasks/administer-cluster/safely-drain-node.md
|
||||
- docs/tasks/administer-cluster/cpu-memory-limit.md
|
||||
- docs/tasks/administer-cluster/out-of-resource.md
|
||||
- docs/tasks/administer-cluster/reserve-compute-resources.md
|
||||
- docs/tasks/administer-cluster/guaranteed-scheduling-critical-addon-pods.md
|
||||
- docs/tasks/administer-cluster/declare-network-policy.md
|
||||
- docs/tasks/administer-cluster/kms-provider.md
|
||||
- docs/tasks/administer-cluster/reconfigure-kubelet.md
|
||||
- docs/tasks/administer-cluster/kubelet-config-file.md
|
||||
- title: Install Network Policy Provider
|
||||
section:
|
||||
- docs/tasks/administer-cluster/calico-network-policy.md
|
||||
@@ -174,8 +158,6 @@ toc:
|
||||
- docs/tasks/administer-cluster/kube-router-network-policy.md
|
||||
- docs/tasks/administer-cluster/romana-network-policy.md
|
||||
- docs/tasks/administer-cluster/weave-network-policy.md
|
||||
- docs/tasks/administer-cluster/reconfigure-kubelet.md
|
||||
- docs/tasks/administer-cluster/kubelet-config-file.md
|
||||
- docs/tasks/administer-cluster/change-pv-reclaim-policy.md
|
||||
- docs/tasks/administer-cluster/configure-pod-disruption-budget.md
|
||||
- docs/tasks/administer-cluster/limit-storage-consumption.md
|
||||
@@ -186,12 +168,8 @@ toc:
|
||||
- docs/tasks/administer-cluster/configure-multiple-schedulers.md
|
||||
- docs/tasks/administer-cluster/ip-masq-agent.md
|
||||
- docs/tasks/administer-cluster/dns-custom-nameservers.md
|
||||
- docs/tasks/administer-cluster/dns-debugging-resolution.md
|
||||
- docs/tasks/administer-cluster/pvc-protection.md
|
||||
- docs/tasks/administer-cluster/storage-object-in-use-protection.md
|
||||
|
||||
- title: Federation - Run an App on Multiple Clusters
|
||||
landing_page: /docs/tasks/federation/set-up-cluster-federation-kubefed/
|
||||
section:
|
||||
- docs/tasks/federation/federation-service-discovery.md
|
||||
- docs/tasks/federation/set-up-cluster-federation-kubefed.md
|
||||
@@ -210,19 +188,18 @@ toc:
|
||||
- docs/tasks/administer-federation/secret.md
|
||||
|
||||
- title: Manage Cluster Daemons
|
||||
landing_page: /docs/tasks/manage-daemon/update-daemon-set/
|
||||
section:
|
||||
- docs/tasks/manage-daemon/update-daemon-set.md
|
||||
- docs/tasks/manage-daemon/rollback-daemon-set.md
|
||||
|
||||
- title: Manage GPUs
|
||||
path: /docs/tasks/manage-gpus/scheduling-gpus/
|
||||
section:
|
||||
- docs/tasks/manage-gpus/scheduling-gpus.md
|
||||
|
||||
- title: Manage HugePages
|
||||
path: /docs/tasks/manage-hugepages/scheduling-hugepages/
|
||||
section:
|
||||
- docs/tasks/manage-hugepages/scheduling-hugepages.md
|
||||
|
||||
- title: Extend kubectl with plugins
|
||||
path: /docs/tasks/extend-kubectl/kubectl-plugins/
|
||||
|
||||
- title: Troubleshooting
|
||||
path: /docs/tasks/debug-application-cluster/troubleshooting/
|
||||
section:
|
||||
- docs/tasks/extend-kubectl/kubectl-plugins.md
|
||||
@@ -1,10 +1,8 @@
|
||||
bigheader: "Tutorials"
|
||||
abstract: "Detailed walkthroughs of common Kubernetes operations and workflows."
|
||||
landing_page: /docs/tutorials/index/
|
||||
toc:
|
||||
- docs/tutorials/index.md
|
||||
- title: Kubernetes Basics
|
||||
landing_page: /docs/tutorials/kubernetes-basics/index/
|
||||
section:
|
||||
- docs/tutorials/kubernetes-basics/index.html
|
||||
- title: 1. Create a Cluster
|
||||
@@ -32,28 +30,30 @@ toc:
|
||||
- docs/tutorials/kubernetes-basics/update-intro.html
|
||||
- docs/tutorials/kubernetes-basics/update-interactive.html
|
||||
- title: Online Training Courses
|
||||
landing_page: /docs/tutorials/online-training/overview/
|
||||
section:
|
||||
- docs/tutorials/online-training/overview.md
|
||||
- title: Scalable Microservices with Kubernetes (Udacity)
|
||||
path: https://www.udacity.com/course/scalable-microservices-with-kubernetes--ud615
|
||||
- title: Introduction to Kubernetes (edX)
|
||||
path: https://www.edx.org/course/introduction-kubernetes-linuxfoundationx-lfs158x#
|
||||
- title: Hello Minikube
|
||||
path: /docs/tutorials/stateless-application/hello-minikube/
|
||||
- docs/tutorials/stateless-application/hello-minikube.md
|
||||
- docs/user-guide/walkthrough/index.md
|
||||
- docs/user-guide/walkthrough/k8s201.md
|
||||
- title: Configuration
|
||||
landing_page: /docs/tutorials/configuration/configure-redis-using-configmap/
|
||||
section:
|
||||
- docs/tutorials/configuration/configure-redis-using-configmap.md
|
||||
- title: Object Management Using kubectl
|
||||
section:
|
||||
- docs/tutorials/object-management-kubectl/object-management.md
|
||||
- docs/tutorials/object-management-kubectl/imperative-object-management-command.md
|
||||
- docs/tutorials/object-management-kubectl/imperative-object-management-configuration.md
|
||||
- docs/tutorials/object-management-kubectl/declarative-object-management-configuration.md
|
||||
- title: Stateless Applications
|
||||
landing_page: /docs/tutorials/stateless-application/guestbook/
|
||||
section:
|
||||
- docs/tasks/run-application/run-stateless-application-deployment.md
|
||||
- docs/tutorials/stateless-application/guestbook.md
|
||||
- docs/tasks/access-application-cluster/service-access-application-cluster.md
|
||||
- docs/tutorials/stateless-application/expose-external-ip-address.md
|
||||
- title: Stateful Applications
|
||||
landing_page: /docs/tutorials/stateful-application/basic-stateful-set/
|
||||
section:
|
||||
- docs/tutorials/stateful-application/basic-stateful-set.md
|
||||
- docs/tasks/run-application/run-single-instance-stateful-application.md
|
||||
@@ -62,10 +62,8 @@ toc:
|
||||
- docs/tutorials/stateful-application/cassandra.md
|
||||
- docs/tutorials/stateful-application/zookeeper.md
|
||||
- title: Clusters
|
||||
landing_page: /docs/tutorials/clusters/apparmor/
|
||||
section:
|
||||
- docs/tutorials/clusters/apparmor.md
|
||||
- title: Services
|
||||
landing_page: /docs/tutorials/services/source-ip/
|
||||
section:
|
||||
- docs/tutorials/services/source-ip.md
|
||||
@@ -0,0 +1,2 @@
|
||||
The topics in the `/docs/api-reference/` section of the Kubernetes docs
|
||||
are being moved to the [Reference](/docs/reference/) section. The content in this topic has moved to:
|
||||
@@ -0,0 +1,26 @@
|
||||
{% capture samplecode %}{% include_relative {{include.file}} %}{% endcapture %}
|
||||
{% if include.k8slink %}{% capture ghlink %}https://raw.githubusercontent.com/kubernetes/kubernetes/blob/{{page.githubbranch}}{{include.k8slink}}{% endcapture %}{% endif %}
|
||||
{% if include.ghlink %}{% capture ghlink %}https://raw.githubusercontent.com/kubernetes/website/{{page.docsbranch}}{{include.ghlink}}{% endcapture %}{% endif %}
|
||||
{% capture mysample %}
|
||||
```{{include.language}}
|
||||
{{ samplecode | raw | strip }}
|
||||
```
|
||||
{: id="{{include.file | handleize}}"}
|
||||
{% endcapture %}
|
||||
<table class="includecode">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>
|
||||
{% if ghlink %}<a href="{{ghlink}}" download="{{include.file}}">{% endif %}
|
||||
<code>{{include.file}}</code>
|
||||
{% if ghlink %}</a>{% endif %}
|
||||
<img src="/images/copycode.svg" style="max-height:24px" onclick="copyCode('{{include.file | handleize}}')" title="Copy {{include.file}} to clipboard">
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>{{ mysample | markdownify }}</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -0,0 +1,12 @@
|
||||
{% if page.deprecated %}
|
||||
<section id="deprecationWarning">
|
||||
<main>
|
||||
<div class="content deprecation-warning">
|
||||
<h3>
|
||||
Documentation for Kubernetes {{ page.version}} is no longer actively maintained. The version you are currently viewing is a static snapshot.
|
||||
For up-to-date documentation, see the <a href="{{ page.currentUrl }}">latest</a> version.
|
||||
</h3>
|
||||
</div>
|
||||
</main>
|
||||
</section>
|
||||
{% endif %}
|
||||
@@ -0,0 +1,28 @@
|
||||
<a href="#" id="feature-state-dialog-link" class="ui-state-default ui-corner-all"><span class="ui-icon ui-icon-newwin"></span>{{ dialog_title }}</a>
|
||||
<div id="feature-state-dialog" class="ui-dialog-content" title="{{ dialog_title }}">
|
||||
{{ dialog_content | markdownify }}
|
||||
</div>
|
||||
{% raw %}<script>
|
||||
$(function(){
|
||||
|
||||
$( "#feature-state-dialog" ).dialog({
|
||||
autoOpen: false,
|
||||
width: {% endraw %}{{ dialog_width | default: "600" }}{% raw %},
|
||||
buttons: [
|
||||
{
|
||||
text: "Ok",
|
||||
click: function() {
|
||||
$( this ).dialog( "close" );
|
||||
}
|
||||
}
|
||||
]
|
||||
});
|
||||
|
||||
// Link to open the dialog
|
||||
$( "#feature-state-dialog-link" ).click(function( event ) {
|
||||
$( "#feature-state-dialog" ).dialog( "open" );
|
||||
event.preventDefault();
|
||||
});
|
||||
|
||||
});
|
||||
</script>{% endraw %}
|
||||
@@ -0,0 +1,13 @@
|
||||
{% assign dialog_title = "alpha" %}
|
||||
{% capture dialog_content %}
|
||||
This feature is currently in a *alpha* state, meaning:
|
||||
|
||||
* The version names contain alpha (e.g. v1alpha1).
|
||||
* Might be buggy. Enabling the feature may expose bugs. Disabled by default.
|
||||
* Support for feature may be dropped at any time without notice.
|
||||
* The API may change in incompatible ways in a later software release without notice.
|
||||
* Recommended for use only in short-lived testing clusters, due to increased risk of bugs and lack of long-term support.
|
||||
|
||||
{% endcapture %}
|
||||
|
||||
**FEATURE STATE:** `Kubernetes {{ for_k8s_version | default: page.version }}` {% include feature-dialog.md %}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user