* fix version selector in v1.10
- add `version-1.11` in `v1.10` version selector
Signed-off-by: harshvkarn <harshvkarn54@gmail.com>
* remove v1.6 support from version selector
- `v1.6` is deprecated, so remove `v1.6` from version selector
Signed-off-by: harshvkarn <harshvkarn54@gmail.com>
* fix docsbranch for 1.11
Changes that will help upcoming consolidation work:
- Add variable `githubWebsiteRaw` to config.toml to facilitate building
links to raw YAML files
- Revise `codenew` shortcode to generate links to raw YAML files instead
of github.com file view;
- Rename `artifacts` directory to `examples` to better reflect its usage;
Accompanied changes as show cases:
- Moved `deployment.yaml`, `deployment-update.yaml` and
`deployment-scale.yaml` to the new `examples/application` subdirectory;
- Removed duplicate instances of the above YAML files in other
directories;
- Update example_test.go to test the relocated YAML files and removed
testing for files that no longer needed.
* Update Windows documentation for OVN/OVS CNI plugin
This patch adds reference to the Ansible playbooks which help
to deploy a kubernetes cluster in a fully automated way.
Signed-off-by: Alin Balutoiu <abalutoiu@cloudbasesolutions.com>
* Minor tweaks
* Trivial commit/undo to trigger Netlify
Added an extra whitespace line at EOF
This page adds instructions on how to use the kubeadm config
to pass flags to control plane components.
The provided examples are pretty basic. Later this can be expanded with
actual user stories.
This is an attempt to consolidate YAML files so that:
- They can remain untouched when we moving the documents around;
- Contributors do not have to change the test cases each time a
documentation is moved;
- We can encourage referencing the existing YAMLs from different
concept or task pages when possible.
After deploying the PV and PVC via the YAML file, run `kubectl describe pvc mysql-pv-claim` should show `mysql-pv-volume` as the `Volume`, instead of `mysql-pv`.
This heading is missing in the 1.10 documentations which makes it hard to find the needed information because the anchor `setting up a master load balancer` points to nowhere. This was working in the 1.19 documentation and it was really useful.
I noticed that the three last headers were missing from the index, so I inspected the markdown and realized that they had only one hashtag (#) as compared to two (##) as all the other headers had.
I simply made those three topics follow the same pattern I observed the other did.
# Issue
The command of jobs does not run correctly if its job already finished.
Some readers may confuse that they can't succeed to run a command to follow this tutorial.
So, we should add `--show-all` option to show pods that may be completed.
# The log to show that we need to add an --show-all option
```
$ kubectl get jobs
NAME DESIRED SUCCESSFUL AGE
busybox 1 0 27d
hello-1529501040 1 1 2m
hello-1529501100 1 1 1m
hello-1529501160 1 1 43s
$ kubectl get pods --selector=job-name=hello-1529501160
No resources found, use --show-all to see completed objects.
$ kubectl get pods --show-all --selector=job-name=hello-1529501160
NAME READY STATUS RESTARTS AGE
hello-1529501160-dckjv 0/1 Completed 0 1m
```
Those links are dead, pointing at what I assume in the previous place for the Kubelet TLS bootstrapping documentation.
Update them with the new location!
* Update etcd config description of kubeadm HA doc
- Fix url from http to https
- Add etcd-listen-ip description
* Edit for clarity and list markup
* More minor edits
* Add Dockerfile and make commands
* add background run option
* Expand on OSS attribution in new Dockerfile
* Begin adding README instructions for Docker
* Add new stage command
implementation-details.md is outdated for k8s 1.11.
Add feature state that this page applies to k8s 1.10.
The page should be updated for k8s 1.11 in a later stage
in the release cycle.
commenting out the div that holds the current calendar until we can fix some issues we are having with zoom project wide per steering committee email to k-dev mailing list.
`base64` generates 76-character chunks of text, delimited by a space character. the `=+/` characters are removed, so on the (uniformly random) offchance that 44 characters are removed, the last `dd` will read a whitespace, and the token will include a whitespace, which "usually" isn't defined as an "alphanumeric character." Removing the space character as well, would mean that 142 of the characters would have to be a `=+/[:space:]`, before the token becomes shorter.
* [docs] Fix syntax formatting in HA-setup doc.
Attempts to fix an unformatted code block; whatever markdown parser is being used seems to have gotten tripped up, and as a result the inline `yaml` in the script is interpreted as bullet points... it looks [pretty yucky](http://jstu.art/sAjc). I'm wondering if this is something specific to the Hugo toolchain? Because GH itself recognizes the block as valid, even with the `none` syntax type.
If this doesn't trigger a CI build preview, I can test locally to verify.
* [css] Don't display ul/li bullets on UI 'tabs-nav' components.
* [docs] Revert HA docs changes.
This reverts commit f5cf5c7e4f0468d077e48347bf678a95c791982e.
Cannot copy any apiserver* keys and certs, as they are generated on startup. If not, it results in an error from kubeadm
```
certificate apiserver is not signed by corresponding CA
```
Also, if the kubernetes.list does not exist you will not be able to edit it, so adding touch and then add the line will prevent errors with installing via apt-get.
It is confusing to capitalize "container" because it isn't really a primitive or API object. Furthermore, this guideline doesn't appear to be closely followed.
* Overall cleanup for kubeadm setup guide.
* Add sonobuoy verification next step
* Partial copyedits
Hit a place where we also have formatting issues, plus a TODO (removed bc these changes go live as soon as merged). More work to do, but this should help the bottleneck for now.
* Address comments from reviewers
* Copy edits, fiddly bits, and clearer warnings
Incorporated feedback from @mistyhacks, fixed many nits, reorganized some **Note:** content more sensibly.
* Revised title per feedback
* replace pearson case study with new one
*this is already on the index page from awhile ago so I didn't add it to the top before NYT as a result
* add images
* Add a note regarding escaping characters
Updated docs with a note regarding escaping characters, it's important because it won't work well otherwise.
* Update secret.md
* No escape required for --from-file
Feedback from @mengqiy
Added information to install cfssl and cfssljson on all etc nodes as they are required to generate clients certificates
Change <podname> to <name> in static pod yaml description for etcd deployment
Additionaly the first bash script in "Run kubeadm init on master0" section doesn't render correctly on kubernetes.io site (https://kubernetes.io/docs/setup/independent/high-availability/) but I don't see any pb with markdown.
* Issue #8493 - Missing instructions in "Creating HA clusters with kubeadm":
- change to kubeadm-init.yaml: configure `advertiseAddress` to the VIP
- added section with instructions for configuring `kubelet`, `kube-controller-manager` and `kube-scheduler` to use the VIP
* Issue #8493 - Missing instructions in "Creating HA clusters with kubeadm": Change use the 'controlPlaneEndpoint' setting in kubeadm-init.yaml, hence no configuration file patching afterwards is necessary anymore.
* Issue #8493 - added private IP to apiServerCertSANs as proposed by @detiber
These pages did not use any template and the displayed toc started
with two bullet points.
Fixes:
* Use the concept template everywhere and add capture markers.
* Rework content-organization.md to move the references to a "whatsnext"
section.
* Fix in localization.md a misparsed list.
* fixing date format
* Update 2018-06-01-dynamic-ingress-kubernetes.md
* Rename 2018-06-01-dynamic-ingress-kubernetes.md to 2018-06-07-dynamic-ingress-kubernetes.md
* Add kbarnard10 as sole reviewer for auto assignment
* Add acontini as sole reviewer for case studies auto assignment
Un-comment out the reviewer declaration
Un-comment out the reviewer declaration
* Getting started gce deadlink
1.
modify for kubernetes/website link
2.
remove unnecessary .md link
* modify link from github.com to kubernetes.io
* revert blogs modification
* revert blog post for meta char
Fix some hugo transition issues:
* Use `file` as code syntax following our style guide and fixing
bug #8868
* Reformat Note so that it's not displayed as text.
Closes: #8868
In _index doc the Kubectl CLI about overview link
was add in "[Overview of kubectl]", So remove not
need "[kubectl]" link.
Signed-off-by: Yuanbin.Chen <cybing4@gmail.com>
* Fix errors in configure-multiple-schedulers.md
- Failed to push docker image
- Errors found in my-scheduler logs
```
...
E0515 06:36:28.180428 1 reflector.go:205] k8s.io/kubernetes/vendor/k8s.io/client-go/informers/factory.go:130: Failed to list *v1beta1.ReplicaSet: replicasets.extensions is forbidden: User "system:serviceaccount:kube-system:default" cannot list replicasets.extensions at the cluster scope
```
* Replace double quote with backticks for code strings
* Use `system:kube-scheduler` instead of `cluster-admin`
* Create dedicated service account for `my-scheduler`
* Update high-availability.md
[fix]command should leading
* Repair code inside list items, remove "like so"
* Modify one code block, change 1-step procedures to not be procedures
This commit adds details on how to create Windows services from
kubelet and kube-proxy.
Signed-off-by: Alin Balutoiu <abalutoiu@cloudbasesolutions.com>
* Add link: add changelog-1.10 and changelog-1.11
* Delete download page's catalog: hugo's markdown render engine can generate catalog through the TOC
* Format the release list
* Delete the release note
In recent versions of Kubernetes, selector field in DeploymentSpec is required and it'll not be filled with values from pod template. simple_deployment.yaml was already corrected and selector was added, here in this commit the content of the docs corrected to match this change.
I do not have a desire of titles but I am trying this to make the hours
I spent on the project worth them. I feel very bad when I have full
confidence about a PR and I have reviewed it but I cannot approve it.
* Clarify that beta annotations can not be removed
Removing annotations caused a major outage with nodes that lagged the
master. We used annotations as would-be fields, though we don't any
more. Now we just add fields. That makes them part of the API version.
These annotations are effectively part of the API version, too.
It stinks because I love to delete code, but I think it's just part of
the debt-accrual process and yet another reason we need to be judicious
in adding fields.
* Change 6 month deprecations to 9 months
This covers maximum version skew. For example a master might be at
1.10, while nodes are at 1.8. We must not break compat within that
window.
* Update service-access-application-cluster.md
Fix code snippet formatting and indentation in ordered list (#8698)
* Fixes code formatting using code fences
Here's a pass with code fences. It seems to work well, and I indented the code fences in the source for readability, even though it wasn't needed for proper indentation in the rendered output.
I wasn't able to use code fences and get the text "The response to a successful request is a hello message:" on its own line. I can achieve that using indentation, but for consistency's sake I used the code fences and placed the text with the paragraph above it.
* Adds `shell` to the code fences
* Fix etcd installation command in kubeadm tutorial
Shells interpolate variables before running commands, so setting the
ETCD_VERSION variable must be separated from the command that
interpolates it. Otherwise an empty string will be interpolated.
The rm command isn't necessary - the output from curl is piped directly
to tar.
* Update stated default etcd version for K8s 1.10
1.10 is the most recent version of K8s and the default etcd server
version for it is 3.1.12
* Fix non-US English typo
Style guide states US English should be used
* Add configure link description
I added a configure link description. Just having a link
on a page with no introductory context seemed awkward.
Signed-off-by: Brad Topol <btopol@us.ibm.com>
* removing unnecessary header
* updated text to be active voice
A tab shortcode was using angle brackets even though the
contents were markdown. This caused a formatting issue.
This switches the tab to use the `%`-delimiter to properly
render the markdown.
* Restore gate jobs
Most gate jobs have been disabled recently so we are risking introduce
many defects when migrating to Hugo. This PR fixes the gate job to get
it running again.
* add comment for fix
* comment out, delete later
* comment out completely
* include package
This commit adds a missing closing capture and puts "## Install kubectl" inside the relevant capture.
Note that the missing close was also missing before Hugo-migration, so the section ordering is still not the same as the Jekyll version of the site. But I think it is more corret.
Note that content outside the capture template blocks, is included as defined is this template:
https://github.com/kubernetes/website/blob/master/layouts/partials/templates/task.html#L8
See #8277
* Fix url to etcd binary
etcd should be 3.12 for kubernetes 1.10, also fix the URL (probably was broken after migration to Hugo)
* Make Curl command safer
You really only need that variable to be set for the specific command, so no need to export it.
Also, when using Bash variables in a string, you should enclose them in curly braces to delineate them from the rest of the string. This helps prevent problems where Bash can't tell where the name of the variable ends and the next part of the string begins.
The page was wrongly formatted:
* Two lists were shown as paragraphs, add empty lines so that they are
parsed as lists.
* The list of members, reviewers was not intended properly, so that the
single items are intended but not their description. Indent
everything.
* Fix URL to owners.md file, the old one gives a 404.
* Fix code blocks in set-up-cluster-federation-kubefed
Two of the code blocks don't render correctly in the [docs page](https://kubernetes.io/docs/tasks/federation/set-up-cluster-federation-kubefed/) (see *Adding a cluster to a federation* section) even though they render correctly in the GitHub preview. Hopefully this PR will fix it.
Plus fixed a few instances where the code blocks in set-up-cluster-federation-kubefed.md don't indicate the code block's language.
* Fix spacing
- Use environment variables when redirecting to "/etc/etcd.env".
- Add more placeholder values for flags in "etcd.service" -> "ExecStart"
Fixeskubernetes/kubeadm#797
* Update kubeadm-init.md
Fix broken kubeadm token link
* Fix more broken links in kubeadm-init.md
Broken links are fixed including kubeadm-join, kubeadm-upgrade, and kubeadm-reset
Currently, the link just points to a description of
what Kubernetes objects are and does not
explicitly state what a declarative API is. It is
not immediately clear to the reader what the term
means.
This commit tries to explain it explicitly so that
the link adds to the meaning and it is clearer to
the reader.
ThirdPartyResources (TPRs) were removed in v1.8. It is misleading
to still show the docs for TPRs for > v1.8. If one needs to read
docs for TPRs, they can switch to the v1.8 version of the docs
website.
However, the docs of migration of TPRs to CRDs are still not
removed because one can also migrate from v1.7 (when CRDs were
introduced) to v1.7+.
First, fix https:// address.
Secondly, previous formatting would display on the page as one line
altogether, which couldn't be pasted into a terminal correctly.
The TOC looked like:
3. Deployments
1.1 Deployment Management
4. Services
1.1 Service Management
The problem is that the headings went from "##" to "####", use "###" for
second level heading to cleanup TOC.
fix some hugo issues:
* Add missing empty line for list.
* Indent items correctly to avoid overlong line shown as code.
* Fix broken table
Closes: #8457
Before running `kubeadm init` users should be informed that the command might change depending on the network plugins they choose. It is better to provide it before presenting with `kubeadm init` so that they don't have to tear the cluster apart once they figure out they needed some extra parameters while running the command
* Container Linux doc fixes
portions of the URLs were missing their bash substitutions and the variable exports don't apply to the following commands without using 'export'
* Adjustments from PR
export is not needed, used proper bash expansion
* typos
* Typo fix: formated->formatted and proper noun in capital
formated->formatted
Pod and Container are proper noun, in this doc, someplace are in capital, some are in lowercase. It's better to keep consistency.
* Update volumes.md
1) Remove missing links about kube-apiserver, kube-controller-manager
and kube-scheduler. Link to the high-availability page, which
isn't exactly a full replacement.
2) Add section about kube-proxy parameters.
Hugo does not support the way the image's max-width was specified before.
This fix will constrain images to always be 50% rather than max out
at 50%, but it is the best we can easily do for now.
Signed-off-by: Misty Stanley-Jones <mistyhacks@google.com>
* Add links to the F5 BIG-IP Controller for Kubernetes to the Ingress controllers section of the ingress doc
* Address review comments from @zacharysarah
* Fix concepts/api-extension/custom-resources.md
All tables were wrongly formatted, add proper second line so that hugo
formats them nicely again.
Add missing empty line before lists so that they get displayed as lists.
Closes: #8392
* Fix one more table
Fix another wrong table heading in custom-resources.md as noticed
during review.
Reading over the .md file, I fixed the following problems:
* Replace links to old location with new location.
* Fix missing shell quotation marks and shell annotations
* Fix wrong indent so that lists are shown correctly.
* Fix broken table, the "|" needs to be quoted to be rendered.
The way we previously did it in Jekyll doesn't work
with Black Friday. There are a few workarounds, but
the easiest way to fix it is to just change those
links to HTML email.
* [Issue #8336] Added a # symbol to What's next
Looking to see if the Table of contents will render properly if all the headers are H4 (####)
* use h2 instead of h4
* More readable fix for issue #7957
Replaces HTML entity-escaped text with Markdown-escaped text where necessary.
* Fixing the markdown discrepancy
Rendering consistently is for chumps
* Supersedes #8288 with a post-Hugo location
* Adjusted time for earlier publishing
* Dropped blog post into http/
* Another time adjustment
* Update front matter
* Testing a location change
* Adding a top-level heading
* More tweaks
Ajusted the sequence of tab "node allow-post-csrs" and "node allow-auto-approve" to conform to the actual sequence of kubeadm alpha phase bootstrap-token.
The term "`MutatingAdmissionWebhooks`" has no special meaning in the
docs. It is misleading because readers may think of it as the name of a
resource or field, or the name of the corresponding admission
controller. However, the name of the admission controller is in
singular. This PR proposes a change to avoid such misunderstandings.
* Update service.md
Update from ReplicationController and rolling-update to ReplcaSet and Deployment rollout
* Update service.md
Remove reference to deployment
Since we now generate the kubectl doc for each release, it is no longer necessary to use the old redirects. Cleaning up the references throughout the documents.
* Added IPv6 info to kube-proxy arguments
* Added IPv6 related printouts for kubectl commands
* revert kube-proxy.md
* revert
* revert to ba7c300
* revert to 08af95d
* Update zookeeper.md
As part of a docs sprint in Melbourne I made a very initial pass at trying to tidy this up a little, I would like to have done much much more, but it's a start…
* Updates from feedback
* Format markdown
* FInal tidy
* Update style-guide.md
Added kubectl and Minikube to the Kubernetes.io word list. Please review.
* Update style-guide.md
Added Persistent Volumes and Salt to the Kubernetes.io word list. Please review.
* Update style-guide.md
removed PersistentVolumes and Salt from the list
So far we have been running tests against the master branch of
kubernetes/kubernetes. This is creating quite some problems because the
master branch is always moving. We are actually checking the YAML files
against a version between 1.10 and 1.11.
This PR is attempting to fix the problem by checking out the
'release-1.10' branch before running the tests. We are supposed to
change the branch to be used when release-1.11 is out. With this PR
(hopefully it works), we will only need to fix the gate every time a new
release is out.
The current title "CoreOS on AWS or GCE" is misleading because the page
actually contains information about many ways to run Kubernetes. When
the page is referenced from the navigation panel, the title becomes very
confusing.
Closes: #711
* Typo fix in implementation-details.md
does not exists->does not exist
does not contains->does not contain
* Update 2017-04-00-Rbac-Support-In-Kubernetes.md
an an->an
* Update 2017-04-00-Rbac-Support-In-Kubernetes.md
* Update a note indicating current state of federation V1
* change horizontal line to <br>
* edit note
* capitalize Kubernetes
* <br> unnecessary w/ note callout
* Clarify that node anti-affinity can be achieved using node taints
The current text may have pre-dated the node taints feature, so it says that no such concept exists, when it actually does now.
* add "to"
Replace double-quote with single-quote for terminal commands.
Although the strings in the examples work fine, users who with randomly generated passwords may have character strings that cause strange behaviors with double-quotes. Using single-quotes prevents this.
Example of a command that causes odd behaviors with double-quotes:
echo -n "RandPasswordr3!$#$3aR" | base64
This example has a series of special characters that some terminals try to interpret and replace with other text.
add this to --runimte-config will cause such error:
```
error: unknown api groups eventratelimit.admission.k8s.io
```
I have test that this feature works fine without any confiuration
to --runtime-config.
The 'user-guide' subdirectory is almost empty now after the contents
are migrated to either concepts or tasks. This PR removes the contents
left over in this path.
* Use Terminated instead of Failed
Containers that terminate successfully (exit code 0) can also be restarted and it's the default behaviour is restartPolicy is not specified.
* Use Exited instead of Failed
In the upstream code base, there are cases where the field description
string contain substrings like '*', 'pods/*', '*/scale' and '*/*'.
When generating reference docs out of these Go comments, the Node.js
module used was incorrectly passing the asterisks as '<em>', i.e. a
mark for emphasize. This behavior has rendered the output documentation
very misleading. For example, in the definition for RuleWithOperations,
users can specify '*' as a wildcard for matching all apiGroups, all
resources. However, the generated docs is showing that an empty string
'' is used to match all apiGroups or resources. This is a serious bug
fixed by this PR.
Doc generator patch is included in PR to
kubernetes-incubator/reference-docs.
* Initial Kubefed AWS Route53 on-prem documentation
* Add flag requirement for kubefed init
* conform to style guidelines
* fix controller-manager wording
* move cut-off section from CoreDNS support
Since the default annotation prefix has been changed to "nginx.ingress.kubernetes.io" in nginx ingress controller, the examples in ingress doc should be updated.
* Document new OpenAPI endpoint
Document new OpenAPI endpoint and deprecation announcement for old endpoints.
* Remove out-of-date swagger spec information
Deprecation announcement is in line 29
* Update default behavior for endpoint HTTP headers
First-time kubeadm user here: The v1.10.0 docs indicate that config file use is experimental, but judging from the comments on https://github.com/kubernetes/kubernetes/pull/59288 it looks like new features are beginning to be supported only in the config file. controlPlaneEndpoint is super useful for us and while I suspect the kubeadm init docs will ultimately be re-written to emphasize the config file options rather than flags (with appropriate examples and descriptions as the flags have now), it would've saved us some time today if we'd seen controlPlaneEndpoint in the config file example.
* Add draft for blog migration post
* Small revisions
* Most important commit ever
* Feedback from kbarnard10
- Turn URLs into hyperlinks
- Remove one line
* Feedback from sarahkconway
- Specify that blog reviews are more transparent/streamlined
* Feedback from kbarnard10, part 2
Added "how to submit a blog post"
Revised "confidentiality"
* Feedback from kbarnard10, part 3
* Renamed file for date accuracy
* Changed date back, added email link
In previous commit, we have enabled showing the full group names for API
resources. However, in doing that, we broken links inside the reference
doc and links pointing to the api reference. This PR fixes this problem
using the revised doc generator.
* Add contrib guidelines for blog posts
* Add form guidelines
* Add TOC entry
* Renamed file
* Feedback from @heckj and @bradtopol
* Revised submission guidelines to include form
podtolerationrestriction does not encompass all the use cases of
podnodeselector, in a case where not all nodes are tainted, then
podtolerationrestriction can not ensure pods are scheduled on the
specific set of nodes.
Based on the discussion on kubernetes/kubernetes#40870, we'd better
clearly document that the endpoint IPs used by a service without
selectors cannot be virtual ones.
* Updated for adherence to style guide and the links to: /docs/user-guide/kubectl
Can someone please confirm what the "Coming soon" path to extend the API with custom resources is?
* Incorporated the changes suggested @heckj @zacharysarah
Could one of you please confirm What "Coming soon: " in line 82 stands for? Is there a name or definition or reference?
* Update api-overview.md
* Update api-overview.md
* fixed a typo
* Update api-overview.md
* hosting fonts locally
resolves#7955
- issues with using hosted fonts: excessive page load times due to
periodic firewall impact
* move jquery from google CDN to jquery site
* getting the CSS too, just in case
* WIP
* fixing layouts and assets
updating Gemfile.lock with bundle install (rvm use ruby-2.2.9)
Updated links in header and footer
switch to paginate v2 gem
comment sidebar logic
fixing css regression
retry paginate
updated local ruby version
reverting to original pagination gem
remove text, make heading roboto, next/prev as buttons
* reintoduce dir tree changes
format checking new posts
shrink fab-icons down to 33px
* reintoduce dir tree changes
format checking new posts
shrink fab-icons down to 33px
* next/prev buttons on posts and index
* Change "latest" to v1.10
* rename .md to match old blog and added explict permalinks for urls
* replacing a link to old blog
* fix image regression with {: .big-img} tag
* adding blog post
* formatting updates
* more formatting updates
* fixing numbering
* more number fixes
* list updates again
* changes based on Michelle's comment
* formatting update
* updated bullet points
* formatting fixes
* indentation fixes
* WIP
* fixing layouts and assets
updating Gemfile.lock with bundle install (rvm use ruby-2.2.9)
Updated links in header and footer
switch to paginate v2 gem
comment sidebar logic
fixing css regression
retry paginate
updated local ruby version
reverting to original pagination gem
remove text, make heading roboto, next/prev as buttons
* reintoduce dir tree changes
format checking new posts
shrink fab-icons down to 33px
* reintoduce dir tree changes
format checking new posts
shrink fab-icons down to 33px
* next/prev buttons on posts and index
* Change "latest" to v1.10
* rename .md to match old blog and added explict permalinks for urls
* replacing a link to old blog
"short-definition" is not correct.
In the YAML files like data/glossary/minikube.yaml,_data/glossary/application-architect.yaml,data/glossary/cla.yaml ..., "short-description" are used, not "short-definition".
Tested in minikube by replacing the zookeeper image with the pause container and the scheduler was able to schedule all 3 pods on the minikube node. Changing it to zk, made the pods zk-1 and zk-2 pending with scheduling failure as expected.
* imaged.md kubernetes version changed
"This was tested with a private docker repository as of 26 June with Kubernetes version This was tested with a private docker repository as of 26 June with Kubernetes version v0.19.3. It should also work for a private registry such as quay.io, but that has not been tested.
v0.19.3 changed to v1.9.3
* Update images.md
* Update images.md
We have been using redirections in many pages when referencing the API
docs generated. Since the relocation of the generated files, this is
becoming difficult to maintain. This PR redirects all such links to the
generated artifacts so we can easily detect missing links if any.
closes: #7874
* Add link for IBM Cloud Private-CE on Linux Containers project
IBM Cloud Private-CE (Community Edition) on Linux Containers is a Terraform/Packer/BASH based IaC to create a seven node (1 Boot, 1 Master, 1 Management, 1 Proxy and 3 Workers) LXD cluster on Linux Host. Supported versions are: ICP 2.1.0.1 + Kubernetes 1.8.3 and ICP 2.1.0.2 + Kubernetes 1.9.1
Goal of this project was to create a Terraform based solution that can be easily configured to meet user needs for development purposes. This IaC script can be applied to Local or Cloud based Linux Host (Ubuntu). Additionally, environment specific TFVARS can allow simpler integration with DevOps pipeline.
Detailed information can be found at https://github.com/HSBawa/icp-ce-on-linux-containers.
* Update verbiage to expand IaC
* 1.10 update (#7151)
* Fix partition value expected behaviour explanation (#7123)
Fixes issue #7057
* Correct "On-Premise" to "On-Premises"
* Updates the Calico installation page (#7094)
* All files for Haufe Groups case study (#7051)
* Fix typo (#7127)
* fix typo of device-plugins.md (#7106)
* fix broken links (#7136)
* Updated configure-service-account (#7147)
Error from server resolved by escaping kubectl patch serviceaccount default -p '{"imagePullSecrets": [{"name": "myregistrykey"}]}' JSON string by '\'
* Remove docs related to 'require-kubeconfig' (#7138)
With kubernetes/kubernetes#58367 merged, v1.10 will not use the
"require-kubeconfig" flag. The flag has become a no-op solely to ensure
existing deployments won't break.
* Added Verification Scenario for a Pod that Uses a PVC in Terminating State (#7164)
The below PR:
https://github.com/kubernetes/kubernetes/pull/55873
modified scheduler in such a way that scheduling of a pod that uses a PVC in Terminating state fails.
That's why verification of such scenario was added to documentation.
* fix LimitPodHardAntiAffinityTopology name (#7221)
* Document the removal of the KubeletConfigFile feature gate (#7140)
With kubernetes/kubernetes#58978 merged, the said feature gate is
removed. This PR removes texts related to the gate and revises the
Feature Gates reference to reflect this change.
* deprecate three admission controller (#7363)
* Document the removal of Accelerators feature gate (#7389)
The `Accelerators` feature gate will be removed in 1.11. 1.10 will be
its last mile.
References: kubernetes/kubernetes#57384
* Update local storage docs for beta (#7473)
* Document that HugePages feature gate is Beta (#7387)
The `HugePages` feature gate has graduated to Beta in v1.10. This PR
documents this fact.
* Add HyperVContainer feature gates (#7502)
* Remove the beta reference from Taints and Tolerations doc (#7493)
* Kms provider doc (#7479)
* Kms provider doc
* issue# 7399, Create KMS-provider.md and update encrypt-data.md
* address review comments
* Document that Device Plugin feature is Beta (1.10) (#7512)
* Add docs for CRD features for 1.10 (#7439)
* Add docs for CRD features for 1.10
* Add CustomResourcesSubresources to list of feature gates
* Add latest changes to custom resources doc
* Add crds as abbreviated alias (#7437)
* Bring PVC Protection Feature to Beta (#7165)
* Bring PVC Protection Feature to Beta
The PR: https://github.com/kubernetes/kubernetes/pull/59052
brought PVC Protection feature to beta.
That's why the documentation is updated accordingly.
* The PVC Protection feature was renamed to Storage Protection. That's why the documentation is updated.
* promote PodNodeSelector to stable; document detailed behavior (#7134)
* promote PodNodeSelector to stable; document detailed behavior
* respond to feedback
* Update CPU manager feature enabling (#7390)
With `CPUManager` feature graduating to beta. No explicit enabling is
required starting v1.10.
References: kubernetes/kubernetes#55977
* Adding block volumeMode documentation for local volumes. (#7531)
Code review comments.
Changed property to field.
Address tech review comment.
* remove description kubectl --show-all (#7574)
--show-all has been deprecated and set to true by default.
https://github.com/kubernetes/kubernetes/pull/60210
* fix description about contribute style guide (#7592)
* fix description about KUBECONFIG (#7589)
s/envrionment/environment
* fix description about cni (#7588)
s/simultanously/simultaneously/
* fix description about MutatingAdmissionWebhook and ValidatingAdmissionWebhook (#7587)
* fix description about persistent volume binding (#7590)
s/slighty/slightly/
* Doc change for configurable pod resolv.conf Beta (#7611)
* fix description about out of resource handling (#7597)
s/threshhold/threshold
* fix description about zookeeper (#7598)
s/achive/achieve
* fix description about kubeadm (#7594)
s/compatability/compatibility/
* fix description about kubeadm (#7593)
* fix description about kubeadm implementation details (#7595)
* fix description about api concepts (#7596)
* Storage Protection was renamed to Storage Object in Use Protection (#7576)
* Storage Protection was renamed to Storage Object in Use Protection
The K8s PR: https://github.com/kubernetes/kubernetes/pull/59901
renamed Storage Protection to Storage Object in Use Protection.
That's why the same is also renamed in the documentation.
* Moved Storage Object in Use Protection admission plugin description down according to alphabetic order.
* Use PSP from policy API group. (#7562)
* update kubeletconfig docs for v1.10, beta (#7561)
* Update port-forwarding docs (#7575)
* add pv protection description (#7620)
* fix description about client library (#7634)
* Add docs on configuring NodePort IP (#7631)
* Document that LocalStorageCapacityIsolation is beta (#7635)
A follow-up to the kubernetes/kubernetes#60159 change which has promoted
the `LocalStorageCapacityIsolation` feature gate to Beta.
* Update CoreDNS docs for beta (#7638)
* Update CoreDNS docs for beta
* Review comments
* Fix typo (#7640)
* Update feature gates move to beta (#7662)
* Added the inability to use colon ':' character as environment variable names and described workaround (#7657)
* merge master to 1.10, with fixes (#7682)
* Flag names changed (s/admission-control/enable-admission-plugins); disable-admissions-plugin entry added; removed reference to admission controller/plugins requiring set order (for v1.10), redundant example enabling specific plugin, and redundant version-specific info (#7449)
* Documentation for MountPropagation beta (#7655)
* Remove job's scale-related operations (#7684)
* authentication: document client-go exec plugins (#7648)
* authentication: document client-go exec plugins
* Update authentication.md
* Update local ephemeral storage feature to beta (#7685)
Update local ephemeral storage feature to beta
* Update docs for windows container resources (#7653)
* add server-side print docs (#7671)
* Create a task describing Pod process namespace sharing (#7489)
* Add external metrics to HPA docs (#7664)
* Add external metrics to HPA docs
* Update horizontal-pod-autoscale-walkthrough.md
* Apply review comments to HPA walkthrough
* remove description about "scale jobs" (#7712)
* CSI Docs for K8s v1.10 (#7698)
* Add a warning about increased memory consumption for audit logging feature. (#7725)
Signed-off-by: Mik Vyatskov <vmik@google.com>
* Update Audit Logging documentation for 1.10 (#7679)
Signed-off-by: Mik Vyatskov <vmik@google.com>
* Fix stage names in audit logging documentation (#7746)
Signed-off-by: Mik Vyatskov <vmik@google.com>
* Feature gate update for release 1.10 (#7742)
* State in the docs that the value of default Node labels are not reliable. (#7794)
* Kill the reference to --admission-control option (#7755)
The `--admission-control` option has been replaced by two new options in
v1.10. This PR kills the last appearance of the old option in the doc.
* Pvcprotection toc (#7807)
* Refreshing installation instructions (#7495)
* Refreshing installation instructions
Added conjure-up. Updated displays and juju versions to current versions.
* Updated anchors
* Fixed image value version typo (#7768)
Was inconsistent with other values
* Update flocker reference to the github repo (#7784)
* Fix typo in federation document (#7779)
* an user -> a user (#7778)
* Events are namespaced (#7767)
* fix 'monitoring' link lose efficacy problem' (#7764)
* docs/concepts/policy/pod-security-policy.md: minor fix. (#7659)
* Update downward-api-volume-expose-pod-information.md (#7771)
* Update downward-api-volume-expose-pod-information.md
The pod spec puts the downward api files into /etc/podinfo, not directly in /etc. Updated docs to reflect this fact.
* Update downward-api-volume-expose-pod-information.md
One more spot needed fixing.
* Update downward-api-volume-expose-pod-information.md
Yet another fix, in the container example.
* Add Amadeus Case Study (#7783)
* Add Amadeus Case Study
* add Amadeus logo
* Fixed Cyrillic с in 'kube-proxy-cm' (#7787)
There was a typo (wrong character) in kube-proxy-cm.yaml - Cyrillic с (UTF-8 0x0441) was used instead of Latin c.
* install-kubectl: choose one installation method (#7705)
The previous text layout suggested that all installations had to be done, one after another.
* Update install-kubeadm.md (#7781)
Add note to kubeadm install instruction to help install in other arch i.e. aarch64, ppc64le etc.
* repair failure link (#7788)
* repair failure link
* repair failure link
* do change as required
* Update k8s201.md (#7777)
* Update k8s201.md
Change instructions to download yams files directly from the website (as used in other pages.)
Added instructions to delete labeled pod to avoid warnings in the subsequent deployment step.
* Update k8s201.md
Added example of using the exposed host from the a node running Kubernetes. (This works on AWS with Weave; not able to test it on other variations...)
* Gramatical fix to kompose introduction (#7792)
The original wording didn't through very well. As much of the original sentence has been preserved as possible, primarily to ensure the kompose web address is see both in text and as a href link.
* update amadeus.html (#7800)
* Fix a missing word in endpoint reconciler section (#7804)
* add toc entry for pvcprotection downgrade issue doc
* Pvcprotection toc (#7809)
* Refreshing installation instructions (#7495)
* Refreshing installation instructions
Added conjure-up. Updated displays and juju versions to current versions.
* Updated anchors
* Fixed image value version typo (#7768)
Was inconsistent with other values
* Update flocker reference to the github repo (#7784)
* Fix typo in federation document (#7779)
* an user -> a user (#7778)
* Events are namespaced (#7767)
* fix 'monitoring' link lose efficacy problem' (#7764)
* docs/concepts/policy/pod-security-policy.md: minor fix. (#7659)
* Update downward-api-volume-expose-pod-information.md (#7771)
* Update downward-api-volume-expose-pod-information.md
The pod spec puts the downward api files into /etc/podinfo, not directly in /etc. Updated docs to reflect this fact.
* Update downward-api-volume-expose-pod-information.md
One more spot needed fixing.
* Update downward-api-volume-expose-pod-information.md
Yet another fix, in the container example.
* Add Amadeus Case Study (#7783)
* Add Amadeus Case Study
* add Amadeus logo
* Fixed Cyrillic с in 'kube-proxy-cm' (#7787)
There was a typo (wrong character) in kube-proxy-cm.yaml - Cyrillic с (UTF-8 0x0441) was used instead of Latin c.
* install-kubectl: choose one installation method (#7705)
The previous text layout suggested that all installations had to be done, one after another.
* Update install-kubeadm.md (#7781)
Add note to kubeadm install instruction to help install in other arch i.e. aarch64, ppc64le etc.
* repair failure link (#7788)
* repair failure link
* repair failure link
* do change as required
* Update k8s201.md (#7777)
* Update k8s201.md
Change instructions to download yams files directly from the website (as used in other pages.)
Added instructions to delete labeled pod to avoid warnings in the subsequent deployment step.
* Update k8s201.md
Added example of using the exposed host from the a node running Kubernetes. (This works on AWS with Weave; not able to test it on other variations...)
* Gramatical fix to kompose introduction (#7792)
The original wording didn't through very well. As much of the original sentence has been preserved as possible, primarily to ensure the kompose web address is see both in text and as a href link.
* update amadeus.html (#7800)
* Fix a missing word in endpoint reconciler section (#7804)
* add toc entry for pvcprotection downgrade issue doc
* revert TOC change
* Release 1.10 (#7818)
* Refreshing installation instructions (#7495)
* Refreshing installation instructions
Added conjure-up. Updated displays and juju versions to current versions.
* Updated anchors
* Fixed image value version typo (#7768)
Was inconsistent with other values
* Update flocker reference to the github repo (#7784)
* Fix typo in federation document (#7779)
* an user -> a user (#7778)
* Events are namespaced (#7767)
* fix 'monitoring' link lose efficacy problem' (#7764)
* docs/concepts/policy/pod-security-policy.md: minor fix. (#7659)
* Update downward-api-volume-expose-pod-information.md (#7771)
* Update downward-api-volume-expose-pod-information.md
The pod spec puts the downward api files into /etc/podinfo, not directly in /etc. Updated docs to reflect this fact.
* Update downward-api-volume-expose-pod-information.md
One more spot needed fixing.
* Update downward-api-volume-expose-pod-information.md
Yet another fix, in the container example.
* Add Amadeus Case Study (#7783)
* Add Amadeus Case Study
* add Amadeus logo
* Fixed Cyrillic с in 'kube-proxy-cm' (#7787)
There was a typo (wrong character) in kube-proxy-cm.yaml - Cyrillic с (UTF-8 0x0441) was used instead of Latin c.
* install-kubectl: choose one installation method (#7705)
The previous text layout suggested that all installations had to be done, one after another.
* Update install-kubeadm.md (#7781)
Add note to kubeadm install instruction to help install in other arch i.e. aarch64, ppc64le etc.
* repair failure link (#7788)
* repair failure link
* repair failure link
* do change as required
* Update k8s201.md (#7777)
* Update k8s201.md
Change instructions to download yams files directly from the website (as used in other pages.)
Added instructions to delete labeled pod to avoid warnings in the subsequent deployment step.
* Update k8s201.md
Added example of using the exposed host from the a node running Kubernetes. (This works on AWS with Weave; not able to test it on other variations...)
* Gramatical fix to kompose introduction (#7792)
The original wording didn't through very well. As much of the original sentence has been preserved as possible, primarily to ensure the kompose web address is see both in text and as a href link.
* update amadeus.html (#7800)
* Fix a missing word in endpoint reconciler section (#7804)
* Partners page updates (#7802)
* Partners page updates
* Update to ZTE link
* Make using sysctls a task instead of a concept (#6808)
Closes: #4505
* add a note when mount a configmap to pod (#7745)
* adjust a note format (#7812)
* Update docker-cli-to-kubectl.md (#7748)
* Update docker-cli-to-kubectl.md
Edited the document for adherence to the style guide and word usage.
* Update docker-cli-to-kubectl.md
* Incorporated the changes suggested.
* Mount propagation update to include docker config (#7854)
* update overridden config for 1.10 (#7847)
* update overridden config for 1.10
* fix config file per comments
* Update Extended Resource doc wrt cluster-level resources (#7759)
* Update service.md
`securityGroupName` is the required value when creating LoadBalancer type service in Azure.
I got the following error without `securityGroupName` value.
> Observed a panic: "invalid memory address or nil pointer dereference" (runtime error: invalid memory address or nil pointer dereference)
* Update service.md
- Original example (with <myservicename> replaced with my-svc) will result in the following error:
error: at least one tcp port specifier must be provided
- Use the same example in this section seems ideal
If you created the resource (on your local minikube) as instructed using:
kubectl create -f https://k8s.io/docs/concepts/cluster-administration/nginx-app.yaml
then, you probably want to delete it from your minikube, in that case, the correct command is the one proposed in this PR.
* Update docker-cli-to-kubectl.md
Edited the document for adherence to the style guide and word usage.
* Update docker-cli-to-kubectl.md
* Incorporated the changes suggested.
The original wording didn't through very well. As much of the original sentence has been preserved as possible, primarily to ensure the kompose web address is see both in text and as a href link.
* Update k8s201.md
Change instructions to download yams files directly from the website (as used in other pages.)
Added instructions to delete labeled pod to avoid warnings in the subsequent deployment step.
* Update k8s201.md
Added example of using the exposed host from the a node running Kubernetes. (This works on AWS with Weave; not able to test it on other variations...)
* Update downward-api-volume-expose-pod-information.md
The pod spec puts the downward api files into /etc/podinfo, not directly in /etc. Updated docs to reflect this fact.
* Update downward-api-volume-expose-pod-information.md
One more spot needed fixing.
* Update downward-api-volume-expose-pod-information.md
Yet another fix, in the container example.
* Correct spelling mistake
The whole file only appeared once
* Correct spell
Correct the word "resource" spell.
* Is "kube/.config" should be ".kube/config"
It seems that the file is ".kube/config"
* Correct spelling mistake
The whole file only appeared once
* Correct spell
Correct the word "resource" spell.
* Is "kube/.config" should be ".kube/config"
It seems that the file is ".kube/config"
* behaviour to behavior
* Guide for upgrading kubeadm HA clusters.
* kubeadm HA upgrade guide: text changes from code review.
* Guide for upgrading kubeadm HA clusters: proposed changes after second round of code review.
Pod is the object to be scheduled, So "pod to schedule onto a node " and "pod to schedule on" are not suitable in the doc. "pod to be scheduled onto a node" is better.
Made updates for files, related to IPv6. Note: The release notes
cover 1.9. When 1.10 release notes are added, the comment about
the /66 restriction for IPv6 can be removed.
* fixed the interacting with cluster section for the ubuntu installation
* made changes as per request from zacharysarah
* added rancher stub
* added rancher documentation
* fixed missing capture tag
* added ingress example, fixed languages as per changes in the PR
* fixed page index as per pr
* fixed rancher readme
* Add a note on availability of tcp_syncookies syctl
Sysctl `net.ipv4.tcp_syncookies` is not availalbe on 4.4 kernel
as it's not namespaced yet.
* updating to use {: .note} notation
per https://kubernetes.io/docs/home/contribute/style-guide/#note
This list on the sidebar isn't very useful:
- it's not an exhaustive list
- it's not an up-to-date list either
- design docs are not documentation (they're already stale)
- we already link to the full list from https://kubernetes.io/docs/reference/
home page
Also removing the 'docs/admin/ovs-networking.md' document as per
the pull request comments, it's no longer necessary.
Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
A common source of beffudlement when using local hypervisors or cloud
providers with peculiar interface setups, IP adressing, or network
policies for which kubelet cannot guess the right IP to use.
`awk` is being used so that the example works in CoreOS Container Linux
too.
Requested in kubernetes/kubeadm#203.
* Please explain N/A's meaning
Because N/A's meaning probably is Not Available/ Not applicable or Name and Address
* all "N/A" change to "Not Available"
all "N/A" change to "Not Available"
* "Available" change to "Applicable"
all "Available" change to "Applicable"
- Moved details of recent releases (1.8 and onward) to the top
- added missing "with" in "compatible with the Kubernetes Container Runtime Interface (CRI)"
* Updating troubleshooting
Changed debug method over to CDK Field Agent and replaced old logging suggestion with the logging page.
* Rewording to hopefully clarify
Please let me know if this still isn't clear. It's a deceptively dense word soup and I wonder if I need to just expand on it some to remove assumptions.
* Updating privileged container information
We now use privileged containers by default on GPU-enabled nodes.
* Changes for consistency
Replaced worker with node.
* Pull out build instructions
* General clarifications and remove reference to merged kube-proxy PR
* Updates to sample yaml files, and clarification on host OS version (2016/latest vs 1709 tags)
* Reordering for clarity
* Add tag for Server 1709
* Addressing feedback
* Address feedback
* Fixed cross-node preemption example
The constraint between P and Q should be pod affinity rather than anti-affinity in order to the example to be correct.
Fixes#7149
* Fixed example to emphasize Zone namespace in pod anti-affinity
The default sort in liquid is ASCIIbetical, but there is a built in
sort_natural that allows you to sort things in human sensible
ways. This updates the glossary list to use sort_natural instead.
Fixes issue #7491
Because API data volumes like downwardAPI are expected to be fully
managed by Kubernetes and are now mounted read-only, this causes
problems with other files in /etc like /etc/resolv.conf that Docker
tries to add to the volume. Our examples should show such volumes
being mounted to a dedicated subdirectory for the volume.
The term_id for Label is singular, but the file is plural. All the
rest of the terms in the glossary prefer singular for the glossary
reference. Harmonizing the label entry is helpful for consistency.
Update all in tree tooltip references at the same time.
* Update Service Catalog docs to meet style guidelines
* Address stevepe's comments
* Remove full-links to cluster operator and application developer in glossary
- In the provided configuration file for `kubeadm init` the value for
`apiserver-count` needs to be put in quotes.
- In addition to /etc/kubernetes/pki/ca.* also /etc/kubernetes/pki/sa.*
need to be copied to the additional masters. See [this
comment](https://github.com/kubernetes/kubeadm/issues/546#issuecomment-350241024) by
@petergardfjall for details.
If we are getting releases from the stable channel, I think the plan output would say stable instead of experimental. At least, that is what I see in this video, around 40:15 mins in: https://www.youtube.com/watch?v=x9doB5eJWgQ&feature=youtu.be
* Update Create an External Load Balancer Doc
The `Create an External Load Balancer` readme has a `Finding your IP address` section which describes steps that do not work when running the service in Minikube. @jimmidyson describes how to find your ip address while running in Minikube here: https://github.com/kubernetes/minikube/issues/384#issuecomment-234409957. This change adds this helpful bit to the docs.
* Update create-external-load-balancer.md
* Update create-external-load-balancer.md
Add note callout formatting
* Update and revise 'Configuration Best Practices'
* Tidy up, clarify, and reword some confusing sections
* Update names of Kubernetes objects per Style Guide
* Update references to ReplicationControllers to ReplicaSets/Deployments
* Update and add some new cross-references
* Remove some out-of-date text
* Explain why you should create a Service before its backend or client workloads
* Reword advice about labels
* Capitalize k8s object names
* Clarify reference titles
* Explain but deprecate the :latest tag on images
* Mention both kubectl apply and kubectl create
* Address @abiogenesis-now comments
* strawman structure
* updates from PR review/feedback
* consolidate usage of SIG Docs and how to volunteer into a single location
* adding into ToC
* updates for Zach
* re-organizing and adding back approver lgtm comment
* Add files via upload
Custom Resource Definition, that replaces Third Party Resources.
* Update customresourcedefinition.yaml
Minor formating error
* Update customresourcedefinition.yaml
missing id key
* Update customresourcedefinition.yaml
deleted aka key
* Update customresourcedefinition.yaml
Made a minor edit to "name" and "id" and added "aka" section, but should require a "related" section. The related section may have the Custom Resource term, but there is currently no glossary term for Custom Resource.
* Replace old zkOk.sh livenessProbe by zookeeper-ready
Fixes one part of the issue #7287
* Update probe script content with the zookeeper-ready
Fixes the part with shows/explains the probe script at issue #7287
* Fix the path to delete liveness probe
Issue #7287
* Replace zkOk.sh readinessProbe by zookeeper-ready
Fixes "Testing for Readiness" section in issue #7287
* Add instructions to remove docker images; fixes#6874
On cleanup of Minikube, adds instructions to optionally remove Docker images created in tutorial setup
* update wording of instructions to include flag
Updates the wording to explicitly match the shell command and flags used.
If we are getting releases from the stable channel, I think the plan output would say stable instead of experimental. At least, that is what I see in this video, around 40:15 mins in: https://www.youtube.com/watch?v=x9doB5eJWgQ&feature=youtu.be
* Update on install-kubectl.md
Added more info on the reason people may get "the connection to the server was refused error". It will help newbies understand the kubectl is a client that connects to a cluster. Hence, a Kubernetes cluster such as a minikube tool will be needed to verify that kubectl is functioning correctly.
* updating wording to remove redundancy
* Updates to Component Overview
* Changed VMs to machines -- it can be both VM or physical machine.
* Separated Addons from Master section, since it depends on an addon if it's components are executed on Master or Node.
* Fix ID of Kubelet glossary
* Removed fluentd and supervisord
These are not necessary to mention here in the overview.
* fluentd is one of Cluster-level Logging solutions briefly described in Addons Section
* supervisord is not required to be run on the Node
* Requested change - remove Addons manager reference
* After review updates
* Updated the Addons page reference
* Update security-context.md
The old link to `PodSecurityContext` was 404. Found another one by starting from a `Pod` in the API Reference. Hope it is the appropriate one.
* Fix broken link to SecurityContext
resolves#7289
specifically, if the individuals listed in these leaf-node OWNERS
files issue an `/lgtm` comment on documents, it will no longer be taken
as an approver lgtm override that will merge the documents. This
preserves them in being chosen for reviews to the documents, and still
supports them using `/lgtm` to indicate technical accuracy.
* Use EOF instead of EOL in HA guide
This is for consistency with the rest of the docs.
* Change indentation from 4 to 3 spaces
The number of spaces in indentation is expected to be divisible by 3.
By having 4 spaces, an extra space was added to the beginning of all
shell code sections, causing issues for heredoc interpretation on
copy/paste.
Fixes one part of the issue #7056 about patch command failing to update.
In this case it changes the image URL to another different than the used
previously to create the StatefulSet.
* Update the workloads API versions to 1.9 for rest of the docs
* Remove comments per CR feedback
* Add a comment to be clear about which versions will work with the example
* removed link to self
* removed reference to deprecated documentation
* revised confusing statement, added more recent link to Kelsey Hightower Kubecon2017 talk
This PR adds a link to the cluster autoscaler project documentation
which can help answer some questions related to the scaler internals.
Closes: #1408
* Add an API concepts document and describe terminology and API chunking
Create a new API reference page that covers some high level topics
- terminology, paths, verbs, watching resources, chunking, and content
type negotation.
* Update api-concepts.md
Adding review feedback
The sample yaml contains base64 encoded strings that were generated with
trailing returns. This is inconsistent to the result from the command in
which a user passes the key and value from command line. This PR removes
the trailing "Cg==" characters for consistency.
Closes: #7065
Indented code block after normal paragraph is not rendered well. So changed the paragraphs to ordered list in consistency with other parts of this document.
Updated with respect to Storage/Storage Classes _"A StorageClass provides a way for administrators to describe the “classes” of storage *they* offer."_
The "Configure a Pod to Use a PersistentVolume for Storage"-task specifies that the content should be located on "/mnt/data" and not "/tmp/data", however this is not reflected in the yaml.
Many people have refrained from reading the whole document and started using /tmp as a de-facto standard directory to store data. Needless to say, using /tmp for persistent data is a bad idea and for the sake of the people only reading the first page, it should be changed to /mnt
I'm updating this after having read https://github.com/spiffxp/community/blob/0b27ee08362b4bb3cb467145705aae9fa0450bea/contributors/devel/owners.md, and it seems that what we have listed as "reviewers" is more appropriate for "approvers" - and there's probably folks who should be on the set of reviewers that we don't have listed there...
PetSet is a *very* old term that dates back to v1.4. We should not
continue evangelize such a concept where there is no trace in code base
today.
Closes: #6484
* Updated 404 link to kubeadm ref
* Update ref link to Federation API
* Fix broken links
* Manual fixes to autogenerated links
* Revert "Manual fixes to autogenerated links"
This reverts commit 94dba97a08da323b97350f4bb74385352e3f8f13.
* Import docs from other repos
* imported test docs
* fix README copy
* Add ToC YAML and index page for imported docs.
* modify update-imported-docs.sh
* Add `imported` to global ToCs
* Add nav to imported section
* remove unnecessary scope for docs/imported
* update script w/ comments and directory root fixes
* use genCmd variable
* display output of generation command
* Update instructions
* Add Community to /docs/imported/index.md
* fix travis errors
* update README.md and fix community docs issues
* simplify code, add comment
* make sure the binary is used instead of `go run`
* add automated handling for links from imported files
Put the expression "quantum entanglement" in quotes to signal to non-native readers that its use is as a turn of phrase and has no special jargonic meaning in this context.
For specifying mount propagation, changes to flags on apiserver and
kubelet are required. This PR fixes the problem.
For more comprehensive list of feature gate settings, please refer to
kubernetes/website#6364.
Closes: #5766
Update extension api-server to include missing steps for auth delegation cluster role binding and extension-apiserver-authentication-reader role binding.
Had a lot of trouble finding the exact way to "un-do" the tainting example provided here. Even the great folks on Slack couldn't provide the correct command to achieve this, even though it seems so trivial now that I know it. :-)
I think "Configuring DNS Service" reads like "you don't have DNS, let's install
it and configure it". This is more like you already have a DNS service, let's
tweak a few things.
Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
Apparently someone managed to squeeze stuff in between network policy topics.
Bringing them next to each other for coherency.
Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
The code for these providers has already been removed, but the
documentation has not been kept up to date. This page should
undergo a more thorough re-write, but this serves as a useful
stopgap.
Update double quotes format in yaml to avoid issue on copy/paste action :-)
I lost 1 hour before seeing the issue of double quotes format in my yaml file through the logs
=> kubectl logs --namespace=kube-system $(kubectl get pods --namespace=kube-system -l k8s-app=kube-dns -o name) -c kubedns
The current link to the flannel plugin is confusing. There are more
detailed description on using flannel on the github project site.
We should avoid linking to the specific yaml file. This PR changes the
link to the general markdown file.
Closes: #3835
Closes: #2896
According to the report, the google/cadvisor#1422 has been closed.
However, the related issue has been fixed in google/cadvisor#1489 and
merged a long time ago. We can safely remove the known issue now.
In the previous version it read as if you could
specify the `propagationPolicy` on the Object itself,
which isn't possible.
Change the documentation to make it clear that the
`propagationPolicy` is set on the `deleteOptions`
argument when invoking a Object deletion function.
This PR attempts to:
* Generally clean up the bootstrapping token doc.
* Separate the authentication and signing features. Help users that
only want to enable the authenticator without the signer.
* Adds a warning about ConfigMap signing being susceptible to MITM
if the same token is reused.
Currently we have two diferent doc pages to configure pod using ConfigMaps.
There are redundency between these two docs and also it creates some
confusion using the doc. Merging these two docs into single page and removing
redundency etc.
Checks an additional variable named versionedurl for the version name,
and uses the value as the url to reference. If the versionedurl doesn't
contain an entry for the version the current path is used.
e.g.
versionedurl:
v1.8: /docs/home
v1.7: /docs/old-path-to-doc
Make the 'trademark usage page' a hyperlink, thus removing the display of the raw URL (and condensing the footer from three lines to two.)
I assume there is some legalese reason why this has to be on Every Page, but other Collaborative Projects don't have it at all.
This PR is to address the concern about labels used in service diagrams.
The PR adds a note to explain the `ServiceIP` shown in the figure
instead of redrawing and pushing a new diagram.
On k8s 1.9, using --discovery-token
kubeadm join --discovery-token abcdef.1234567890abcdef --discovery-token-unsafe-skip-ca-verification 1.2.3.4:6443`
returns an error, but the node joins successfully with
kubeadm join --token abcdef.1234567890abcdef --discovery-token-unsafe-skip-ca-verification 1.2.3.4:6443`
kubectl-container example no longer exists and it has not been usable for
more than a year. it's time we scrub references to it and delete the source
as well.
* Merge branch 'master' of https://github.com/kubernetes/website into release-1.9
* 'master' of https://github.com/kubernetes/website:
[maintenance] December link fixes (#6680)
Update audit.md (#6381)
Fixed typo
concepts/policy/pod-security-policy.md: fix broken links.
Fixed a typo `illgal`
Add glossory entry for ReplicaSet
# Conflicts:
# docs/concepts/policy/pod-security-policy.md
# docs/tasks/debug-application-cluster/audit.md
* Spelling correction and sentence capitalization.
- Corrected the spelling error for storing, was put in as 'stoing'.
- Capitalized list items.
- Added '.' at end of sentences in the list items.
* Workaround for Jekyllr frontmatter
* fix typo
* Update access-cluster.md with a comment that for IPv6
the user should use [::1] for the localhost
* Trivial change to open release branch
* Undo trivial change
* add service ipvs overview
* Add instructions on how to setup kubectl
* Document conntrack dependency for kube-proxy
* Add an a
This is kind of jarring / missing an article. I'm guessing it should either be ' to a rack of bare metal servers.' or '...to racks of bare metal servers.'.
* adding example responses for common issues
- support request
- code bug report
* Trivial change to open release branch
* Undo trivial change
* Signed-off-by: Ziqi Zhao <zhaoziqi@qiniu.com> (#5366)
Fix the not-working test case yaml for /doc/concepts/storage/volumes.md
* kubectl-overview
* temp fix for broken pod and deployment links
* Update Table of Solutions for Juju
* Revise certificates documentation (#5965)
* Update review-issues.md
Some edits for clarity and condensed language.
* Update init-containers.md
Fix leading spaces in commands.
* Update kubectl-overview.md
Fix format.
* Update clc.md
Fix format.
* Update openstack-heat.md
The url no need. just highlight.
* Typo
I believe this should be "users" not "uses"
* making explicit hostname uniq requirement
* Update scheduling-hugepages.md
* Update update-daemon-set.md
* fix redirection of PersistentVolume
* Update hpa.md
* update kubectl instruction
* Use the format of kubeadm init
* fix spelling error
guarnatees to guarantees
* add matchLabels description (#6020)
* search and replace for k8s.github.io to website (#6019)
* fix scale command of object-management (#6011)
* Update replicaset.md (#6009)
* Update secret.md (#6008)
* specify password for mysql image (#5990)
* specify password for mysql image
* specify password for mysql image
* link error for run-stateless-application-deployment.md (#5985)
* link error for run-stateless-application-deployment.md
* link error for run-stateless-application-deployment.md
* Add performance implications of inter-pod affinity/anti-affinity (#5979)
* 404 monthly maintenance - October 2017 (#5977)
* Updated redirects
* More redirects
* Add conjure-up to Turnkey Cloud Solutions list (#5973)
* Add conjure-up to Turnkey Cloud Solutions list
* Changed wording slightly
* change the StatefulSet to ReplicaSet in reference (#5968)
* Clarification of failureThreshold of probes (#5963)
* Mention usage of block storage version param (#5925)
Mention usage of block storage version (bs-version) parameter to
workaround attachment issues using older K8S versions on an OpenStack
cloud with path-based endpoints.
Resolves: https://github.com/kubernetes/kubernetes.github.io/issues/5924
* Update sysctl-cluster.md (#5894)
Include guide on enabling unsafe sysctls in minikube
* Avoid Latin phrases & format note (#5889)
* Avoid Latin phrases & format note
according the Documentation Style Guide
* Update scratch.md
* Update scratch.md
* resolves jekyll rendering error (#5976)
- chinese isn't understood for keys in YAML frontmatter in jekyll, so
replaced it with the english equivalent that doesn't throw the
following error on rendering:
Error reading file src/kubernetes.github.io/cn/docs/concepts/cluster-administration/device-plugins.md: (<unknown>): could not find expected ':' while scanning a simple key at line 4 column 1
* Change VM to pod. (#6022)
* Add link to custom metrics. (#6023)
* Rephrase core group. (#6024)
* Added explanation on context to when joining (#6018)
* Update create-cluster-kubeadm.md (#5761)
Update Canal version in pod network apply commands
* Fixes issue #5620 (#5869)
* Fixes issue #5620
Signed-off-by: Brad Topol <btopol@us.ibm.com>
* Restructured so that review process is for both current and upcoming
releases. Added content describing the use of tech reviewers.
* Removed incorrect Kubernetes reviewer link.
* Fixed tech reviewer URL to now use website
* Update pod-priority-preemption.md
fix-wrong-link-to-pod-preemption
* pod-security-policy.md: add links to the page about admission plugins.
* Adding all files for BlaBlaCar case study (#5857)
* Adding all files for BlaBlaCar case study
* Update blablacar.html
* Fix changed URL for google containers
* Add /docs/reference/auto-generated directory
* correct the downwardapi redirect
* Remove links using "here"
* Rename to /docs/reference/generated directory
* add Concept template
* Change title to just Ingress
* Link mistake (#6038)
* link mistake
* link mistake
* skip title check for skip_title_check.txt
* skip title check for skip_title_check.txt
* remove doesn't exist link.
* Fix podpreset task (#5705)
* Add a simple pod manifest to pod overview (#5986)
* Split PodPreset concept out from task doc (#5984)
* Add selector spec description (#5789)
* Add selector spec description
* Fix selector field explanation
* Put orphaned topics in TOC. (#6051)
* static-pod example bad format in the final page (#6050)
* static-pod example bad format in the final page
* static-pod example bad format in the final page
* static-pod example bad format in the final page
* static-pod example bad format in the final page
* static-pod example bad format in the final page
* Fix `backoffLimit` field misplacement (#6042)
It should be placed in JobSpec according to:
https://github.com/kubernetes/kubernetes/blob/master/api/swagger-spec/batch_v1.json#L1488-L1514
* Update addons.md (#6061)
* add info about VMware NSX-T CNI plugin (#5987)
* add info about VMware NSX-T CNI plugin
Hello,
I'm VMware Networking and Security Architect and would like to include short information about our CNI plugin implementation similar to what other vendors did
Best regards
Emil Gagala
* Update networking.md
* Update networking.md
* Update networking.md
* Update: Using universal zsh configuration (#5669)
* Update install-kubectl.md
Zsh is not only oh-my-zsh, so I added universal configuration for zsh that also can be used in prezto.
* fix merge error after rebase
* Operating etcd cluster for Kubernetes bad format in the final page (#6056)
* Operating etcd cluster for Kubernetes bad format in the final page
* Update configure-upgrade-etcd.md
* Update configure-upgrade-etcd.md
* Usage note and warning tags. (#6053)
* Usage note and warning tags.
* Update configure-upgrade-etcd.md
* Update configure-upgrade-etcd.md
* Document jekyll includes snippets
* Add jekyll includes to docs home toc
- Remove extra kubernetes home in toc
* document docker cgroupdriver req (#5937)
* Update test blacklists (#6063)
* Update toc check blacklist
* Update title check blacklist
* wip
* wip
* Fix typo
* Document unconfined apparmor profile
* Revert "Document the unconfined profile for AppArmor" (#6268)
* CRD Validation: remove alpha warning, change enable instructions to (#6066)
disable
* Documented service annotation for AWS ELB SSL policy
* kubeadm: add a note about the new `--print-join-command` flag.
This is a new flag for the `kubeadm token create` command.
* Add a note to PDB page
* Improve Kubeadm reference doc (#6103)
* automatically-generated kubeadm reference doc
* user-mantained kubeadm reference doc
* Documentation for CSIPersistentVolume
* change replicaset documentation to use apps/v1 APIs
* Update service.md
ipvs alpha version -> beta version
* Updated Deployment concept docs (#6494)
* Updated Deployment concept docs
* Addressed comments
* Documentation for volume scheduling alpha feature
* Update admission control docs for webhooks
* Improve DNS documentation (#6479)
* update ds for 1.9
* Update service.md
* Update service.md
* Revert "begin updating webhook documentation" (#6575)
* Update version numbers to include 1.9 (#6518)
* Update site versions for 1.9
* Removed 1.4 docs
* Update _config.yml
* Update _config.yml
* updates for raw block devices
* rbac: docs for aggregated cluster roles (#6474)
* Added IPv6 information for Kubelet arguments (#6498)
* Added IPv6 info to kube-proxy arguments
* Added IPv6 information for argument for kubelet
* Update PVC resizing documentation (#6487)
* Updates for Windows Server version 1709 with K8s v1.8 (#6180)
* Updated for WSv1709 and K8s v1.8
* Updated picture and CNI config
* Fixed formatting on CNI Config
* Updated docs to reference Microsoft/SDN GitHub docs
* fix typo
* Workaround for Jekyllr frontmatter
* Added section on features and limitations, with example yaml files.
* Update index.md
* Added kubeadm section, few other small fixes
* Few minor grammar fixes
* Update access-cluster.md with a comment that for IPv6
the user should use [::1] for the localhost
* Addressed a number of issues brought up against the base PR
* Fixed windows-host-setup link
* Rewrite PodSecurityPolicy guide
* Update index.md
Signed-off-by: Alin Balutoiu <abalutoiu@cloudbasesolutions.com>
Signed-off-by: Alin Gabriel Serdean <aserdean@ovn.org>
* Spelling correction and sentence capitalization.
- Corrected the spelling error for storing, was put in as 'stoing'.
- Capitalized list items.
- Added '.' at end of sentences in the list items.
* Update index.md
* Update index.md
* Addressed comments and rebased
* Fixed formatting
* Fixed formatting
* Updated header link
* Updated hyperlinks
* Updated warning
* formatting
* formatting
* formatting
* Revert "Update access-cluster.md with a comment that for IPv6"
This reverts commit 31e4dbdc25.
* Revert "fix typo"
This reverts commit c05678752d.
* Revert "Workaround for Jekyllr frontmatter"
This reverts commit b84ac59624.
* Fixed grammatical issues and reverted non-related commits
* Revert "Rewrite PodSecurityPolicy guide"
This reverts commit 5d39cfeae4.
* Revert "Spelling correction and sentence capitalization."
This reverts commit 47eed4346e.
* Fixed auto-numbering
* Minor formatting updates
* CoreDNS feature documentation (#6463)
* Initial placeholder PR for CoreDNS feature documentation
* Remove from admin, add content
* Fix missing endcapture
* Add to tasks.yml
* Review feedback
* Postpone Deletion of a Persistent Volume Claim in case It Is Used by a Pod (#6415)
* Postpone Deletion of a Persistent Volume Claim in case It Is Used by a Pod
A new feature PVC Protection was added into K8s 1.9 that's why this documentation change is needed.
* Added tag at the top of each new area.
* Fix typo
* Fix: switched on in (all kubelets) -> (all K8s components).
* Added link to admission controller
* Moved PVC Protection configuration into Before you begin section.
* Added steps how to verify PVC Protection feature.
* Fixes for admission controller plugin description and for PVC Protection description in PVC lifecycle.
* Testing official rendering of enumerations (1., 2., 3., etc.)
* Re-write to address comments from review.
* Fixed definition when a PVC is in active use by a pod.
* Change auditing docs page for 1.9 release (#6427)
* Change auditing docs page for 1.9 release
Signed-off-by: Mik Vyatskov <vmik@google.com>
* Address review comments
Signed-off-by: Mik Vyatskov <vmik@google.com>
* Address review comments
Signed-off-by: Mik Vyatskov <vmik@google.com>
* Address review comments
Signed-off-by: Mik Vyatskov <vmik@google.com>
* Fix broken link
Signed-off-by: Mik Vyatskov <vmik@google.com>
* short circuit deny docs (#6536)
* line wrap
* short circuit deny
* address comments
* Add kubeadm 1.9 upgrade docs (#6485)
* kubeadm: Improve kubeadm documentation for v1.9 (#6645)
* Update admission control docs for webhooks (re-send #6368) (#6650)
* Update admission control docs for webhooks
* update in response to comments
* Revamp rkt and add CRI-O as alternative runtime (#6371)
Signed-off-by: Lorenzo Fontana <lo@linux.com>
* Documented NLB for Kubernetes 1.9 (#6260)
* Added IPV6 information to setup cluster using kubeadm (#6465)
* Added IPV6 information to setup cluster using kubeadm
* Updated kubeadm.md & create-cluster-kubeadm.md with IPv6 related information
* Added IPv6 options for kubeadm --init & automated address binding for kube-proxy based on version of IP configured for API server)
* Changes to kubeadm.md as per comments
* Modified kubeadm.md and create-cluster-kubeadm.md
* Implemented changes requested by zacharysarah
* Removed autogenerated kubeadm.md changes
* StatefulSet 1.9 updates. (#6550)
* updates sts concept and tutorials to use 1.9 apps/v1
* Update statefulset.md
* clarify pod name label
* Garbage collection updates for 1.9 (#6555)
* 1.9 gc policy update
* carify deletion
* Couple nits for dnsConfig doc (#6652)
* Add doc for AllowedFlexVolume (#6563)
* Update OpenStack Cloud Provider API support for v1.9 (#6638)
* Flex volume is GA. Remove alpha notation. (#6666)
* Update generated ref docs for Kubernetes and Federation components. (#6658)
* Update generated ref docs for Kubernetes and Federation components.
* Rename kubectl-options to kubectl.
* Add title to kubectl.
* Fix double synopsis.
* Update Federation API ref docs for 1.9. (#6636)
* Update federation API ref docs.
* Move and redirect.
* Move generated Federation docs to the generated directory.
* Fix titles.
* Type
* Fix titles
* Update auto-generated Kubernetes APi ref docs. (#6646)
* Update kubectl commands for 1.9 (#6635)
* add ExtendedResourceToleration admission controller (#6618)
* Update API reference paths for v1.9 (#6681)
* Trivial change to open release branch
* Undo trivial change
* add service ipvs overview
* Add instructions on how to setup kubectl
* Document conntrack dependency for kube-proxy
* Add an a
This is kind of jarring / missing an article. I'm guessing it should either be ' to a rack of bare metal servers.' or '...to racks of bare metal servers.'.
* adding example responses for common issues
- support request
- code bug report
* Trivial change to open release branch
* Undo trivial change
* Signed-off-by: Ziqi Zhao <zhaoziqi@qiniu.com> (#5366)
Fix the not-working test case yaml for /doc/concepts/storage/volumes.md
* kubectl-overview
* temp fix for broken pod and deployment links
* Update Table of Solutions for Juju
* Revise certificates documentation (#5965)
* Update review-issues.md
Some edits for clarity and condensed language.
* Update init-containers.md
Fix leading spaces in commands.
* Update kubectl-overview.md
Fix format.
* Update clc.md
Fix format.
* Update openstack-heat.md
The url no need. just highlight.
* Typo
I believe this should be "users" not "uses"
* making explicit hostname uniq requirement
* Update scheduling-hugepages.md
* Update update-daemon-set.md
* fix redirection of PersistentVolume
* Update hpa.md
* update kubectl instruction
* Use the format of kubeadm init
* fix spelling error
guarnatees to guarantees
* add matchLabels description (#6020)
* search and replace for k8s.github.io to website (#6019)
* fix scale command of object-management (#6011)
* Update replicaset.md (#6009)
* Update secret.md (#6008)
* specify password for mysql image (#5990)
* specify password for mysql image
* specify password for mysql image
* link error for run-stateless-application-deployment.md (#5985)
* link error for run-stateless-application-deployment.md
* link error for run-stateless-application-deployment.md
* Add performance implications of inter-pod affinity/anti-affinity (#5979)
* 404 monthly maintenance - October 2017 (#5977)
* Updated redirects
* More redirects
* Add conjure-up to Turnkey Cloud Solutions list (#5973)
* Add conjure-up to Turnkey Cloud Solutions list
* Changed wording slightly
* change the StatefulSet to ReplicaSet in reference (#5968)
* Clarification of failureThreshold of probes (#5963)
* Mention usage of block storage version param (#5925)
Mention usage of block storage version (bs-version) parameter to
workaround attachment issues using older K8S versions on an OpenStack
cloud with path-based endpoints.
Resolves: https://github.com/kubernetes/kubernetes.github.io/issues/5924
* Update sysctl-cluster.md (#5894)
Include guide on enabling unsafe sysctls in minikube
* Avoid Latin phrases & format note (#5889)
* Avoid Latin phrases & format note
according the Documentation Style Guide
* Update scratch.md
* Update scratch.md
* resolves jekyll rendering error (#5976)
- chinese isn't understood for keys in YAML frontmatter in jekyll, so
replaced it with the english equivalent that doesn't throw the
following error on rendering:
Error reading file src/kubernetes.github.io/cn/docs/concepts/cluster-administration/device-plugins.md: (<unknown>): could not find expected ':' while scanning a simple key at line 4 column 1
* Change VM to pod. (#6022)
* Add link to custom metrics. (#6023)
* Rephrase core group. (#6024)
* Added explanation on context to when joining (#6018)
* Update create-cluster-kubeadm.md (#5761)
Update Canal version in pod network apply commands
* Fixes issue #5620 (#5869)
* Fixes issue #5620
Signed-off-by: Brad Topol <btopol@us.ibm.com>
* Restructured so that review process is for both current and upcoming
releases. Added content describing the use of tech reviewers.
* Removed incorrect Kubernetes reviewer link.
* Fixed tech reviewer URL to now use website
* Update pod-priority-preemption.md
fix-wrong-link-to-pod-preemption
* pod-security-policy.md: add links to the page about admission plugins.
* Adding all files for BlaBlaCar case study (#5857)
* Adding all files for BlaBlaCar case study
* Update blablacar.html
* Fix changed URL for google containers
* Add /docs/reference/auto-generated directory
* correct the downwardapi redirect
* Remove links using "here"
* Rename to /docs/reference/generated directory
* add Concept template
* Change title to just Ingress
* Link mistake (#6038)
* link mistake
* link mistake
* skip title check for skip_title_check.txt
* skip title check for skip_title_check.txt
* remove doesn't exist link.
* Fix podpreset task (#5705)
* Add a simple pod manifest to pod overview (#5986)
* Split PodPreset concept out from task doc (#5984)
* Add selector spec description (#5789)
* Add selector spec description
* Fix selector field explanation
* Put orphaned topics in TOC. (#6051)
* static-pod example bad format in the final page (#6050)
* static-pod example bad format in the final page
* static-pod example bad format in the final page
* static-pod example bad format in the final page
* static-pod example bad format in the final page
* static-pod example bad format in the final page
* Fix `backoffLimit` field misplacement (#6042)
It should be placed in JobSpec according to:
https://github.com/kubernetes/kubernetes/blob/master/api/swagger-spec/batch_v1.json#L1488-L1514
* Update addons.md (#6061)
* add info about VMware NSX-T CNI plugin (#5987)
* add info about VMware NSX-T CNI plugin
Hello,
I'm VMware Networking and Security Architect and would like to include short information about our CNI plugin implementation similar to what other vendors did
Best regards
Emil Gagala
* Update networking.md
* Update networking.md
* Update networking.md
* Update: Using universal zsh configuration (#5669)
* Update install-kubectl.md
Zsh is not only oh-my-zsh, so I added universal configuration for zsh that also can be used in prezto.
* fix merge error after rebase
* Operating etcd cluster for Kubernetes bad format in the final page (#6056)
* Operating etcd cluster for Kubernetes bad format in the final page
* Update configure-upgrade-etcd.md
* Update configure-upgrade-etcd.md
* Usage note and warning tags. (#6053)
* Usage note and warning tags.
* Update configure-upgrade-etcd.md
* Update configure-upgrade-etcd.md
* Document jekyll includes snippets
* Add jekyll includes to docs home toc
- Remove extra kubernetes home in toc
* document docker cgroupdriver req (#5937)
* Update test blacklists (#6063)
* Update toc check blacklist
* Update title check blacklist
* wip
* wip
* Fix typo
* Document unconfined apparmor profile
* Revert "Document the unconfined profile for AppArmor" (#6268)
* CRD Validation: remove alpha warning, change enable instructions to (#6066)
disable
* Documented service annotation for AWS ELB SSL policy
* kubeadm: add a note about the new `--print-join-command` flag.
This is a new flag for the `kubeadm token create` command.
* Add a note to PDB page
* Improve Kubeadm reference doc (#6103)
* automatically-generated kubeadm reference doc
* user-mantained kubeadm reference doc
* Documentation for CSIPersistentVolume
* change replicaset documentation to use apps/v1 APIs
* Update service.md
ipvs alpha version -> beta version
* Updated Deployment concept docs (#6494)
* Updated Deployment concept docs
* Addressed comments
* Documentation for volume scheduling alpha feature
* Update admission control docs for webhooks
* Improve DNS documentation (#6479)
* update ds for 1.9
* Update service.md
* Update service.md
* Revert "begin updating webhook documentation" (#6575)
* Update version numbers to include 1.9 (#6518)
* Update site versions for 1.9
* Removed 1.4 docs
* Update _config.yml
* Update _config.yml
* updates for raw block devices
* rbac: docs for aggregated cluster roles (#6474)
* Added IPv6 information for Kubelet arguments (#6498)
* Added IPv6 info to kube-proxy arguments
* Added IPv6 information for argument for kubelet
* Update PVC resizing documentation (#6487)
* Updates for Windows Server version 1709 with K8s v1.8 (#6180)
* Updated for WSv1709 and K8s v1.8
* Updated picture and CNI config
* Fixed formatting on CNI Config
* Updated docs to reference Microsoft/SDN GitHub docs
* fix typo
* Workaround for Jekyllr frontmatter
* Added section on features and limitations, with example yaml files.
* Update index.md
* Added kubeadm section, few other small fixes
* Few minor grammar fixes
* Update access-cluster.md with a comment that for IPv6
the user should use [::1] for the localhost
* Addressed a number of issues brought up against the base PR
* Fixed windows-host-setup link
* Rewrite PodSecurityPolicy guide
* Update index.md
Signed-off-by: Alin Balutoiu <abalutoiu@cloudbasesolutions.com>
Signed-off-by: Alin Gabriel Serdean <aserdean@ovn.org>
* Spelling correction and sentence capitalization.
- Corrected the spelling error for storing, was put in as 'stoing'.
- Capitalized list items.
- Added '.' at end of sentences in the list items.
* Update index.md
* Update index.md
* Addressed comments and rebased
* Fixed formatting
* Fixed formatting
* Updated header link
* Updated hyperlinks
* Updated warning
* formatting
* formatting
* formatting
* Revert "Update access-cluster.md with a comment that for IPv6"
This reverts commit 31e4dbdc25.
* Revert "fix typo"
This reverts commit c05678752d.
* Revert "Workaround for Jekyllr frontmatter"
This reverts commit b84ac59624.
* Fixed grammatical issues and reverted non-related commits
* Revert "Rewrite PodSecurityPolicy guide"
This reverts commit 5d39cfeae4.
* Revert "Spelling correction and sentence capitalization."
This reverts commit 47eed4346e.
* Fixed auto-numbering
* Minor formatting updates
* CoreDNS feature documentation (#6463)
* Initial placeholder PR for CoreDNS feature documentation
* Remove from admin, add content
* Fix missing endcapture
* Add to tasks.yml
* Review feedback
* Postpone Deletion of a Persistent Volume Claim in case It Is Used by a Pod (#6415)
* Postpone Deletion of a Persistent Volume Claim in case It Is Used by a Pod
A new feature PVC Protection was added into K8s 1.9 that's why this documentation change is needed.
* Added tag at the top of each new area.
* Fix typo
* Fix: switched on in (all kubelets) -> (all K8s components).
* Added link to admission controller
* Moved PVC Protection configuration into Before you begin section.
* Added steps how to verify PVC Protection feature.
* Fixes for admission controller plugin description and for PVC Protection description in PVC lifecycle.
* Testing official rendering of enumerations (1., 2., 3., etc.)
* Re-write to address comments from review.
* Fixed definition when a PVC is in active use by a pod.
* Change auditing docs page for 1.9 release (#6427)
* Change auditing docs page for 1.9 release
Signed-off-by: Mik Vyatskov <vmik@google.com>
* Address review comments
Signed-off-by: Mik Vyatskov <vmik@google.com>
* Address review comments
Signed-off-by: Mik Vyatskov <vmik@google.com>
* Address review comments
Signed-off-by: Mik Vyatskov <vmik@google.com>
* Fix broken link
Signed-off-by: Mik Vyatskov <vmik@google.com>
* short circuit deny docs (#6536)
* line wrap
* short circuit deny
* address comments
* Add kubeadm 1.9 upgrade docs (#6485)
* kubeadm: Improve kubeadm documentation for v1.9 (#6645)
* Update admission control docs for webhooks (re-send #6368) (#6650)
* Update admission control docs for webhooks
* update in response to comments
* Revamp rkt and add CRI-O as alternative runtime (#6371)
Signed-off-by: Lorenzo Fontana <lo@linux.com>
* Documented NLB for Kubernetes 1.9 (#6260)
* Added IPV6 information to setup cluster using kubeadm (#6465)
* Added IPV6 information to setup cluster using kubeadm
* Updated kubeadm.md & create-cluster-kubeadm.md with IPv6 related information
* Added IPv6 options for kubeadm --init & automated address binding for kube-proxy based on version of IP configured for API server)
* Changes to kubeadm.md as per comments
* Modified kubeadm.md and create-cluster-kubeadm.md
* Implemented changes requested by zacharysarah
* Removed autogenerated kubeadm.md changes
* StatefulSet 1.9 updates. (#6550)
* updates sts concept and tutorials to use 1.9 apps/v1
* Update statefulset.md
* clarify pod name label
* Garbage collection updates for 1.9 (#6555)
* 1.9 gc policy update
* carify deletion
* Couple nits for dnsConfig doc (#6652)
* Add doc for AllowedFlexVolume (#6563)
* Update OpenStack Cloud Provider API support for v1.9 (#6638)
* Flex volume is GA. Remove alpha notation. (#6666)
* Update generated ref docs for Kubernetes and Federation components. (#6658)
* Update generated ref docs for Kubernetes and Federation components.
* Rename kubectl-options to kubectl.
* Add title to kubectl.
* Fix double synopsis.
* Update Federation API ref docs for 1.9. (#6636)
* Update federation API ref docs.
* Move and redirect.
* Move generated Federation docs to the generated directory.
* Fix titles.
* Type
* Fix titles
* Update auto-generated Kubernetes APi ref docs. (#6646)
* Update kubectl commands for 1.9 (#6635)
* add ExtendedResourceToleration admission controller (#6618)
* Update API reference paths for v1.9 (#6681)
This is inline with minikube warning message:
```
WARNING: The xhyve driver is now deprecated and support for it will be removed in a future release.
Please consider switching to the hyperkit driver, which is intended to replace the xhyve driver.
See https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#hyperkit-driver for more information.
To disable this message, run [minikube config set WantShowDriverDeprecationNotification false]
```
> 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.
> NOTE: After opening the PR, please *un-check and re-check* the ["Allow edits from maintainers"](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) box so that maintainers can work on your patch and speed up the review process. This is a temporary workaround to address a known issue with GitHub.>
>
> Please delete this note before submitting the pull request.
>
> 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.
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
If you'd like, you can build the Kubernetes docs using Docker. To get started, build the image locally:
```bash
$ make docker-image
# The underlying command:
$ docker build . \
--tag kubernetes-hugo \
--build-arg HUGO_VERSION=0.40.3
```
You can create an image for a different version of Hugo by changing the value of the `HUGO_VERSION` argument for the build. You *must* specify a version or the image will not build.
Once the `kubernetes-hugo` image has been built locally, you can build the site:
```bash
$ make docker-serve
# The underlying command:
$ docker run \
--rm \
--interactive \
--tty \
--volume $(PWD):/src \
kubernetes-hugo:latest \
hugo
```
As when building without using a Docker container, the results of the build will be published to the `public` directory (the default output directory for [Hugo](https://gohugo.io), the static site generator used to build this site).
## Thank you!
Kubernetes thrives on community participation, and we really appreciate your
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.
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.
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).
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" %}.
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/).
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.
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.
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*.
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.
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.
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.
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.
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.
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.
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.
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" %}.
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.
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.
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.
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.
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.
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.
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" %}.
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.
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.
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.
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.
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.
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" %}.
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.
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.
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.
{% 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).
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.
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*.
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).
This feature is currently in a *beta* state, meaning:
* The version names contain beta (e.g. v2beta3).
* Code is well tested. Enabling the feature is considered safe. Enabled by default.
* Support for the overall feature will not be dropped, though details may change.
* The schema and/or semantics of objects may change in incompatible ways in a subsequent beta or stable release. When this happens, we will provide instructions for migrating to the next version. This may require deleting, editing, and re-creating API objects. The editing process may require some thought. This may require downtime for applications that rely on the feature.
* Recommended for only non-business-critical uses because of potential for incompatible changes in subsequent releases. If you have multiple clusters that can be upgraded independently, you may be able to relax this restriction.
* **Please do try our beta features and give feedback on them! After they exit beta, it may not be practical for us to make more changes.**
<p>Ready to get your hands dirty? Build a simple Kubernetes cluster that runs "Hello World" for Node.js.</p>
</div>
<divclass="nav-box">
<h3><ahref="/docs/home/">Documentation</a></h3>
<p>Learn how to use Kubernetes with the use of walkthroughs, samples, and reference documentation. You can even <ahref="/editdocs/"data-auto-burger-exclude>help contribute to the docs</a>!</p>
</div>
<divclass="nav-box">
<h3><ahref="/community/">Community</a></h3>
<p>If you need help, you can connect with other Kubernetes users and the Kubernetes authors, attend community events, and watch video presentations from around the web.</p>
{% if concept %}<!-- check for this before going any further; if not present, skip to else at bottom -->
# Overview of {{concept}}s
{% if what_is %}
### What is a {{ concept }}?
{{ what_is }}
{% else %}
{% include templates/_errorthrower.md missing_block='what_is' heading='What is a (Concept)?' purpose='explains what this concept is and its purpose.' %}
{% endif %}
{% if when_to_use %}
### When to use {{ concept }}s
{{ when_to_use }}
{% else %}
{% include templates/_errorthrower.md missing_block='when_to_use' heading='When to use (Concept)' purpose='explains when to use this object.' %}
{% endif %}
{% if when_not_to_use %}
### When not to use {{ concept }}s
{{ when_not_to_use }}
{% else %}
{% include templates/_errorthrower.md missing_block='when_not_to_use' heading='When not to use (Concept)' purpose='explains when not to use this object.' %}
{% endif %}
{% if status %}
### {{ concept }} status
{{ status }}
{% else %}
{% include templates/_errorthrower.md missing_block='status' heading='Retrieving status for a (Concept)' purpose='explains how to retrieve a status description for this object.' %}
{% endif %}
{% if usage %}
#### Usage
{{ usage }}
{% else %}
{% include templates/_errorthrower.md missing_block='usage' heading='Usage' purpose='shows the most basic, common use case for this object, in the form of a code sample, command, etc, using tabs to show multiple approaches' %}
{% endif %}
<!-- continuing the "if concept" if/then: -->
{% else %}
### ERROR: You must define a "concept" variable
{: style="color:red" }
This template requires a variable called `concept` that is simply the name of the
concept for which you are giving an overview. This will be displayed in the
headings for the document.
To get rid of this message and take advantage of this template, define `concept`:
```liquid
{% raw %}{% assign concept="Replication Controller" %}{% endraw %}
```
Complete this task, then we'll walk you through preparing the rest of the document.
To write a glossary snippet, start with a copy of the template, [`/_data/glossary/_example.yml`](/_data/glossary/_example.yml). Make sure to provide (or omit) values for the following fields:
* (Required) `id`
* This field must match the name of the glossary file itself (without the `*.yml` extension). It is *not* intended to be displayed to users, and is only used programmatically.
* (Required) `name`
* The name of the term.
* (Required) `tags`
* Must be one of the tags listed in the [tags directory in the website repository](https://github.com/kubernetes/website/tree/master/_data/canonical-tags).
* (Required) `short description`
* Make sure to replace the instructional text in the template with your content.
* (Optional) `aka`
* These synonyms do not need to be glossary terms themselves (if they are deprecated), and can include spaces.
* (Optional) `related`
* These should be the `id`s (not the `names`) of related glossary terms.
* (Optional) `long description`
* If you do not provide a long description, remove the field -- that is, the complete key-value pair.
The `_example.yml` template also contains basic information about how to write your snippet. For additional guidance, continue reading this readme.
## Glossary snippet style guide
This style guide supplements the guidance provided in the glossary template. It's intended to help you think about what and how to write glossary definitions. For more general guidance on style, consult [the core docs style guide](https://kubernetes.io/docs/home/contribute/style-guide/).
### Minimum viable snippet:
Every snippet must include at least the short description. The long description is optional, but should be provided for terms that need additional clarification. For consistency with existing *Concept* definitions, *write your definitions as if the term is plural*.
**short-description** (Required): One line (or two short lines) that provides a minimum definition. Do not repeat the term. Prefer fragments. Model after tooltips. End with a period.
**long-description** (Optional): Longer additional text to appear after (in conjunction with) short description. Provide in cases where the short description is not sufficient for the intro paragraph to a topic. Write complete but concise sentences.
### Examples
```yaml
- name:Pod
- tags:
- Fundamental
- Workload
- API Object
- short-description:The smallest and simplest Kubernetes objects. Represent a set of running processes on your cluster.
- long-description:Pods most often run only a single container, and are managed by a Deployment.
```
```yaml
- name:Deployment
- tags:
- Fundamental
- Workload
- API Object
- short-description:Controllers that provide declarative updates for Pods and ReplicaSets.
- long-description:Deployments are responsible for creating and updating instances of an application.
```
### Thinking about definitions
* **Think of the short description as it would appear in a tooltip.** Is it sufficient to get the reader started? Is it short enough to be read inside a small UI element?
*Tip*: look at the API reference doc content (for example, https://kubernetes.io/docs/api-reference/v1.7/). Note, however, that this content should be used with care. The concept docs for Pod, for example, are clearer than the reference docs.
* **The long description should follow the short description to make a complete introduction to a topic.** (This is the content that appears at the top of the content, before any generated TOC.) Does it provide information that's not already clear from the short description? Does it provide information that readers should have a general sense of before they dive into the details of the topic it helps introduce?
*Tip:* the long description does not need to be long; it's intended to extend but not replace the short description. Look through current related docs for ideas. (The Deployment long description is taken from a tutorial, for example.)
{% include templates/glossary/_error.md term=term_data.name missing_block='short-description' purpose='concisely describes the key term in 1-2 lines' %}
{% endif %}
{% endif %}
{% if include.length == "all" or include.length == "long" %}
{% include templates/glossary/_error.md term=term_data.name missing_block='long-description' purpose='describes the key term in greater depth, supplementing the short-description' %}
{% include templates/_errorthrower.md missing_block='command' heading='kubectl (command)' purpose='names the kubectl command, so that the appropriate YAML file (from _data/kubectl) can be transformed into a page.' %}
{% include templates/_errorthrower.md missing_block='overview' purpose='states, in one or two sentences, the purpose of this document' %}
{% endif %}
* TOC
{: toc}
{% if prerequisites %}
## Before you begin
{{ prerequisites }}
{% else %}
{% include templates/_errorthrower.md missing_block='prerequisites' heading='Before you begin' purpose='lists action prerequisites and knowledge prerequisites' %}
{% endif %}
{% if steps %}
{{ steps }}
{% else %}
{% include templates/_errorthrower.md missing_block='steps' purpose='lists a sequence of numbered steps that accomplish the task.' %}
{% include templates/_errorthrower.md missing_block='overview' purpose='states, in one or two sentences, the purpose of this document' %}
{% endif %}
* TOC
{: toc}
{% if objectives %}
## Objectives
{{ objectives }}
{% else %}
{% include templates/_errorthrower.md missing_block='objectives' heading='Objectives' purpose='lists the objectives for this tutorial.' %}
{% endif %}
{% if prerequisites %}
## Before you begin
{{ prerequisites }}
{% else %}
{% include templates/_errorthrower.md missing_block='prerequisites' heading='Before you begin' purpose='lists action prerequisites and knowledge prerequisites' %}
{% endif %}
{% if lessoncontent %}
{{ lessoncontent }}
{% else %}
{% include templates/_errorthrower.md missing_block='lessoncontent' purpose='provides the lesson content for this tutorial.' %}
File diff suppressed because it is too large
Load Diff
Some files were not shown because too many files have changed in this diff
Show More
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Jim Angel
