Add new section for content guidelines
Add table of examples of what is and is not allowed
Add examples of links to Linux Academy courses based on discussion
during the Aug 20 SIG Docs meeting.
Remove example table and reformat based on feedback
Move content guide to its own page
Update existing pages to mention new Content Guide page
Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
In nginx ingress controller Version 0.22.0 and beyond, any substrings within the request URI that need to be passed to the rewritten path must explicitly be defined in a capture group. Please refer doc here :
* `https://kubernetes.github.io/ingress-nginx/examples/rewrite/#rewrite-target`
* `https://stackoverflow.com/a/55193468/5527839 `
Currently, what was mentioned in the docs, didnt work for me. I was using minikube version `1.2.0` which uses ingress above v0.21.0. After reading the docs provided in above two links, was able to figure out where it was lacking. Have mentioned the changes in the proposed file change.
* Fix links into Audit with Falco section
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
Co-authored-by: Lorenzo Fontana <lo@linux.com>
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
* Fix typo in audit docs
Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
Recently, the RunAsUserName feature has been added, allowing users to
run Windows containers with custom usernames, different from the image
default usernames.
Adds documentation regarding its prerequisites, feature gate, usage,
restrictions, and samples.
It's very difficult to figure out e.g. the correct quotes to use from
regular text that is subject to being converted for typographers quotes.
Use code literals instead to ensure that nothing is modified, and to
distinguish literals from accompanying text.
Signed-off-by: Zane Bitter <zbitter@redhat.com>
It switched from a naming scheme of service1/service2 to s1/s2. That can be confusing for new people, and I propose we stick to only one naming scheme.
Add hyperlink to 'communicate' in Participating in SIG Docs section.
Hyperlink points to Participating in SIG Docs discussions section further down the page.
Add info to Submit a pull request bullet 5 about putting fixes #<issue_number>
or closes #<issue_number> to the PR description so GitHub will automatically close the issue
* Improvement for kubectl patch command
This command does not work in Powershell. A specific note would help the developers to take care of the same.
* Fixed review comments
Added different tabs for bash and PowerShell.
* Removing note for PowerShell
Hugo is not able to add note along with shortcode. Hence removing note.
* Update device plugin docs for Kubernetes 1.14
& related pages
This change is mainly about feature-state shortcodes & similar.
(if there's a way to get the short version string, eg "1.14" rather
than "v1.14", then that could go in place of the hard coded value
in this commit).
* Fix code block formatting
eg code blocks incorrectly marked as:
```shell
* Use glossary shortcodes where appropriate
* Hyperlink to Prometheus
* Tidy Markdown formatting
* Change example vendor domain name
Use a name inside ".example" to highlight that this is a DNS
domain name.
* Reword device plugins documentation
* Tweak headings for device plugins
* Add "what's next" to device plugins docs
* Tweak wording for device plugins docs
* Add KubeVirt device plugins
- tested on macOS with BSD's grep and GNU's. same flags, same output.
- there are some 55 CPU flags on mac, so highlighting VMX makes it
easier to grasp
- using `egrep` on linux and `grep` on mac, not necessary
- precision: the VT-x feature is NOT an OS feature...
* Add OPA Gatekeeper blog post
* address comments
* Apply suggestions from code review
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* address more comments
* Update based on beta release
* Update publish date; reword intro
* Document the enableServiceLinks flag
There are many cases of service discovery environment variables clashing with env vars expected by programs, causing hard to debug problems. The enableServiceLinks flag added in 1.13 should be mentioned here and not only on the API reference.
* Update connect-applications-service.md
* Update content/en/docs/concepts/services-networking/connect-applications-service.md
Co-Authored-By: Qiming <tengqim@cn.ibm.com>
* rephrased the action to use active voice style
* porting some information from kubeadm-init.md to kubelet-integration.md doc
from reference/setup-tools/kubeadm/kubeadm-init.md to setup/production-environment/tools/kubeadm/kubelet-integration.md
includes edits I just proposed in #15421 and #80136
* improve wording re. systemd in kubelet-integration.md
* removing quotes and adding the in kubelet-integration.md
* Update content/en/docs/setup/production-environment/tools/kubeadm/kubelet-integration.md
Co-Authored-By: Lubomir I. Ivanov <neolit123@gmail.com>
because with busybox/0.log it fails as shown below (unless you mkdir busybox,
with the correct permission, which is an extra step we can avoid for a tutorial like this)
FATA[0000] Starting the container "3c71f8c3abfcac0f8357fa25be896062f05f88e1d9acbd7a033afeee9a54f3c4" failed: rpc error: code = Unknown desc = failed to create containerd task: failed to create container loggers: failed to create and open log file: open busybox/0.log: no such file or directory
CSR API isn't guaranteed to use the cluster CA. The CA used to sign
certs using the CSR API depends on the specific cluster stup. Admins can
use a separate CA if they choose to.
Users shouldn't rely on verifying those certs using the CA bundle
mounted with service account secrets.
The doc page is reworded to remove most mentions of cluster CA and
instead focus on API usage specifics.
* Update volumes examples that are no longer in staging
Update volumes examples that are no longer in staging
per
c16a976d98
a lot of links are now broken in the docs
* Remove /staging from ceph examples
Remove /staging from ceph examples
The content describing authorization modes used the term "authorization
modules" erroneously. This patch uses the term "mode" as is appropriate
but keeps the section link header the old "authorization-modules" in
order not to break older links.
- Mark as relevant to networking.
- Unmark as a core object. kube-proxy is not an API object.
- Fix hyperlink to reference docs.
- Include hyperlink in definition. This is used in /docs/concepts/overview/components/
- Revise wording.
* remove doc from kubeadm-init.md which is duplicated in kubelet-integration.md
This section in reference/setup-tools/kubeadm/kubeadm-init.md seems to significantly overlap with setup/production-environment/tools/kubeadm/kubelet-integration.md - looks like someone copy/pasted it at some point? The information in kubelet-integration.md looks more up to date than this (e.g. there actually is no `--allow-privileged=true` or `--network-plugin=cni` here?). Therefore lets delete the sections content, and have a short line linking to the other one.
If this is accepted, then #15421 is moot (because #15423 moves it to the new place).
* shorten link re. removed doc from kubeadm-init.md
as requested in https://github.com/kubernetes/website/pull/15424/ review
* drop https://kubernetes.io from link in kubeadm-init.md
* Revert "shorten link re. removed doc from kubeadm-init.md"
This reverts commit f128ce7dc2.
* fix bad wording
* update kubeadm-init.md based on kbhawkey review feedback
* remove duplicate sentence in kubeadm-init.md
* Adding cgroup to glossary
Adding cgroup to glossary
* Removed value from aka field
* Updating cgroups.md with cgroups changed to cgroup
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Modified cgroups to singular
* Title update and remove etc
Updated the title as mentioned in v2 docs and removed etc
* Update cgroups.md
Adding different short description
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Updated cgroups.md short description
* Changed file name and glossary title
* Changed the title to make it consistent
* Added Tencent Cloud Production Environment Solution
* Add an article on how to run kubernetes on Tencent Kubernetes Engine : content/en/docs/setup/production-environment/turnkey/tke.md
* Document modifications have been made as recommended by reviewer sftim. Please select this document when merging.
* Document optimization
* Modify the contents of the document : content/en/docs/setup/production-environment/turnkey/tke.md
* Add A What's Next section
* Add content: TKE is a Certified Kubernetes product.
* Add reviewers and other information.
* Delete a space
* Change information about reviewers
* Remove reviewers.
* pod-network to be done only on master node
added a note saying that Install a pod-network add on need to be done only on the master node
* updated where to run pod-network doc
All admission control plugins support two modes for specifying their
configuration: linking to an external file using the `path` key in the
shared admission configuration file, or directly embedding the
configuration using the `configuration` key in the shared admission
configuration file.
This commit makes the ImagePolicyWebhook documentation mention the
embedded configuration option.
* New getting started blog post
I'd like to submit a blog post for the kubernetes.io blog targeted to people just getting started with Kubernetes. I myself am still new to it but want to start writing more to share what I am learning and help others along the way. My point of view is a little different than most people who post on the kubernetes.io blog since I am an independent consultant and I also work mostly with Microsoft products - so some of my resources are from Microsoft which seems rare for some reason in most Kubernetes blog posts I find on the web.
* Added the images and changed md for path
I added the image files and changed the paths in the markdown to /static/images/blog/...
* fix path
* Added date to header
Added a date to get it on netlify preview
* made changes
* Update and rename get-started-with-kubernetes-using-python.md to 2019-07-23-get-started-with-kubernetes-using-python.md
The addition of the flag "---control-plane-endpoint" for
"kubeadm init" removes the requirement for creating a config file
for the stacked etcd setup.
The config is still required for stacked etcd setup.
When upgrading controlplane nodes, upgrading the kubelets should be done
as the last step after "kubeadm upgrade" was run on all of the control
plane nodes already.
Also apply consistency related cleanup to sections and section names.
I changed a question that had no question mark into a statement. I also changed the heading from the first person to the second person, because the topic it treats the reader as the second person everywhere else.
* Switch to "failure zone" term
Previous wording, "availability zone", is specific to certain cloud
service providers (eg AWS).
* Refer to glossary terms where appropriate
* Reword signposting to examples
* Assign stable name to anchor
* Link to standard node labels
* Fix incorrect feature state claims
* NodeRestriction admission plugin needs Kubernetes v1.11
(or later)
* Move further reading to whatsnext section
* Fix link to cluster setup
* Drop advice about older kubectl
Kubernetes v1.14+ definitely does offer a compatible kubectl
* Drop outdated comment about downloading examples
* Call an availability zone an availability zone
* Improve init containers page
- Overall rewording
- Link to “Debug init containers” in whatsnext
- Explain terms / use glossary references
- Use glossary shortcodes where appropriate
- Expand terms like QoS and cgroup that aren't in the glossary
- Only document & recommend stable syntax
- Tweak initContainer examples to use project style
- Drop vestigialreference to StatefulSet
Also: write “container” in lower case
Most of the places where this page talks about containers, it's as a
concept rather than an object in the Kubernetes API. Adjust case
accordingly.
* Reword what's next section
Ubuntu 16.04.5 LTS
apt-mark unhold kubeadm && apt-get update && apt-get install -y kubeadm=1.14.x-00 && apt-mark hold kubeadm gives the below error
The following packages have unmet dependencies:
kubelet : Depends: kubernetes-cni (= 0.6.0) but 0.7.5-00 is to be installed
E: Error, pkgProblemResolver::Resolve generated breaks, this may be caused by held packages.
Unholding the kubelet with kubeadm fixes the problem.
* Add scheduler concept page
* Rename scheduling overview
* Fix non-ASCII colon symbols
* Reword scheduler concept page
* Move scheduler performance tuning into scheduling
* Signpost from overview to kube-scheduler, etc
* Add whatsnext section to scheduler concept
* Restructure scheduling concept
Now there's a concept page for scheduling, some of the details
in the performance tuning page can have a better home.
* Omit link to (unwritten) scheduling extensions page
* Drop deprecated / superseded filtering rules
This change is required since the 3.8 manifest moves to using
apps/v1 instead of extensions/v1beta1 for types like DaemonSet
and Deployment.
See PR 70672 of k/k.
* Update api reference contrib doc
See issue #14111
* updates to api ref contrib guide
* further updates to api ref contrib
* more updates api ref contrib
lose apt-mark unhold kubectl when apt-get install kubectl. If not unhold kubectl, it would return the error follows:
``` shell
root@ecs-k8s-master:~# apt-mark unhold kubelet && apt-get update && apt-get install -y kubelet=1.15.0-00 kubectl=1.15.0-00 && apt-mark hold kubelet
kubelet was already not hold.
Hit:1 https://download.docker.com/linux/ubuntu xenial InRelease
Hit:2 https://mirrors.tuna.tsinghua.edu.cn/ubuntu xenial InRelease
Hit:3 https://mirrors.tuna.tsinghua.edu.cn/ubuntu xenial-updates InRelease
Get:4 https://mirrors.tuna.tsinghua.edu.cn/ubuntu xenial-backports InRelease [107 kB]
Hit:4 https://mirrors.tuna.tsinghua.edu.cn/ubuntu xenial-backports InRelease
Hit:5 https://mirrors.tuna.tsinghua.edu.cn/ubuntu xenial-security InRelease
Hit:6 https://packages.cloud.google.com/apt kubernetes-xenial InRelease
Reading package lists... Done
Reading package lists... Done
Building dependency tree
Reading state information... Done
The following packages were automatically installed and are no longer required:
linux-headers-4.4.0-145 linux-headers-4.4.0-145-generic linux-image-4.4.0-145-generic linux-modules-4.4.0-145-generic
Use 'apt autoremove' to remove them.
The following held packages will be changed:
kubectl
The following packages will be upgraded:
kubectl kubelet
2 upgraded, 0 newly installed, 0 to remove and 9 not upgraded.
E: Held packages were changed and -y was used without --allow-change-held-packages.
```
1. Replace net.ipv4.route.min_pmtu with net.core.somaxconn in the
example of using unsafe sysctls in containers, since the former is not
accessible within container namespace at all.
2. Not all net.* sysctls are namespaced. Explain the correct way to
identify the namespaced networking sysctls.
* fix path of game.properties file
It has been dowloaded to configure-pod-container/configmap/game.properties
* fix typo: kustomization instead of kusotmization
Due to a couple missing newlines and missing closing fixed-width quote
delimiter, the bulleted list of extensions to core constructs was being
incorrectly displayed.
* Update and organize the content on Deployments
fix formatting issues
Format a note
Formats the content
Format content
Fix formatting issues
Format content
Format content
Update and organize the content on Deployments
* Update the content as per the comments
* Update as per the comments
* Update as per the comments
- Ignore 'xtrabackup_slave_info' if it is an empty file.
- Remove the tailing semicolon in 'xtrabackup_slave_info'.
- Stop script when 'CHANGE MASTER' is failed, then rename 'change_master_to.sql.in' only when changing master is successful.
Init Containers were specified using custom annotations in k8s 1.5. In
k8s 1.6, these annotations were replaced with the
`Pod.Spec.initContainers` collection and the old annotations were
deprecated in 1.6 and no longer supported in 1.8. There's no reason to
clutter the docs with the old annotation syntax.
* This URL is a better link directly to the feature
Signed-off-by: Jorge O. Castro <jorgec@vmware.com>
* Convert links to relative links, clean up a conversion comment
Signed-off-by: Jorge O. Castro <jorgec@vmware.com>
* Initial blog post draft for kubeadm v1.15
* More edits, and add pictures
* Incorporate changes from review and add hugo metadata
Signed-off-by: Jorge O. Castro <jorgec@vmware.com>
* Update logo and some final edits
Signed-off-by: Jorge O. Castro <jorgec@vmware.com>
* Some minor fixes, fix the logo and author attribution
* Fix list formatting
* Fix an other list formatting issue
* Update 2019-06-24-kubeadm-ha-v115.md
Removed ambiguous word 'temporarily', as namespace set using that method, is not temporary. It is permanent for a current resource and there is no concept of a temporary namespace in K8s.
Also, for consisteny '--namespace' flag added after the actual command.
* Updates HAProxy Ingress Controller information to point to new controller supported by haproxytech
* Update content/en/docs/concepts/services-networking/ingress-controllers.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Added listing for AWS VPC CNI
Added listing for AWS VPC CNI under "How to implement the Kubernetes networking model".
* Added AWS VPC CNI
* Added AWS VPC CNI to Installing a pod network add-on
* Updated tabs to alphabetical order
* Fix formatting in 2019-06-20-Future-of-CRDs-Structural-Schemas.md
Hugo seems to be incompatible with the Github markdown formatting.
* Fix doc link
* Defaulting is alpha
* Adding what's new section to namespace concepts
To learn more about namespaces and give better navigation this section is added.
* Update namespaces.md
There's been a number of questions around the difference between the external.metrics.k8s.io and custom.metrics.k8s.io in #sig-autoscaling referring back to the HPA docs recently. Added links out to the design proposals for each and the relevant sections of the existing walkthrough docs.
We don't need to be the dispatch for all vulns, now that other projects are starting to have their own processes. But we don't want to discourage reports about stuff that isn't directly in k/k either.
Saying that we usually disclose vuln reports in 7 days is just not true. But, I think it's still good to aim for 7 days when we aren't blocked on and coordinating release of patches.
* Updated IP Address for /etc/hosts
Tested on Minikube for macOS.
When using Minikube, the IP address listed in `kubectl get ingress` is the internal Minikube IP address and is not available on the web browser.
Added advice to the user that when using Minikube, add the Minikube IP address to the Hosts file instead of the IP address displayed in `kubectl get ingress`.
* Update ingress-minikube.md
* Adding alternative command to create namespace
As this is first place user look to find details to create a namespace, added an alternative command to create a namespace. Also, this is mostly used way to create namepsace instead of YAML.
* Correcting Formatting
Correcting formatting for changes
* Update namespaces.md
* Updates the What is Kubernetes page
* Adds content to the what is kubernetes used for section.
* Updates the ordered list.
* Formats the content.
* Update the content as per the comments
* Fix a broken link
* Highlight feature state for Ingress concept
* Fix command output marked as shell script
* Write "load balancer" as two words
* Clarify prerequisites for Ingress
* Tidy & reword
* Add link to Ingress Controllers topic
(further reading)
* Use a glossary tooltip for Secret
(readers may not have encountered that concept yet)
* Update term definitions in Ingress concept
- Adopt wording from glossary
(NB: glossary_definition shortcode didn't seem suitable)
- Replace terms with glossary_tooltip where appropriate
* [WIP] added accessibility guidelines to the style guide
Adopted the accessibility level A and AA guidelines to Markdown elements:
https://www.w3.org/WAI/WCAG21/quickref/?versions=2.0¤tsidebar=%23col_overview&levels=aaa
We still need to define attributes for the front matter. See, https://github.com/kubernetes/website/issues/14286
I am yet to draft the guidelines for images and alt text.
* fixed the note
Update style-guide.md
Incorporated the changes suggested
Incorporated the changes suggested.
fixed the formatting issues in the table
fixed the spaces in the links section
fixed a space issue
fixed format issues in the link
added a11y guidelines to code section
removed a spacing issue
front matter guidelines best fit the using template section
Update content/en/docs/contribute/style/style-guide.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
Update content/en/docs/contribute/style/style-guide.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
Update content/en/docs/contribute/style/style-guide.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
incorporated the changes
incorporated the changes
Update content/en/docs/contribute/style/style-guide.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
title section for front matter guideline
updated the html characters
Update content/en/docs/contribute/style/style-guide.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
Update style-guide.md
* Add Ref to shared process namespaces
The article talking about ways container can talk to each other should include shared process namespace as a method
* Drop note on kube version in reference
* Put minikube install steps in per-OS tabs
* Work around nested <li> formatting issue
Using Markdown unordered lists inside tabs doesn't seem to work. These
changes are my work-around for that.
* Reword "laptop" to personal computer
Some computers aren't laptops
* Drop trailing whitespace
* Drop warning about removing other Mac hypervisors
* Move examples ahead of commands that use them
In support of https://github.com/kubernetes/website/issues/12740
The aim is to adopt a consistent style around providing downloadable
examples for use with kubectl, etc.
* Tweak wording for stateful app pod example
* Adopt formatting conventions for code blocks
* Move ReplicationController sample YAML to examples
In aid of https://github.com/kubernetes/website/issues/12740
* Move PodDisruptionBudget sample YAML to examples
In aid of https://github.com/kubernetes/website/issues/12740
* Update test schema for new examples
* Use Unicode ellipsis in example
Aim here is to make the elision more obvious
* Add comment about where to run probe
Add comment about where to run probe
Signed-off-by: Xiang Dai <764524258@qq.com>
* Update language
Signed-off-by: Xiang Dai <764524258@qq.com>
* Update language
Signed-off-by: Xiang Dai <764524258@qq.com>
* Update language
Signed-off-by: Xiang Dai <764524258@qq.com>
* fix grammar nits
Signed-off-by: Xiang Dai <764524258@qq.com>
* Add recommendation to use kms provider
Add a warning to encrypting secrets documentation that if using a provider with secrets encryption, kms provider is preferred as it materially changes the threat model.
* Update encrypt-data.md
* Update encrypt-data.md
Updated to include kms provider is Beta sice 1.12
* Update encrypt-data.md
* feat: add job application has some error and restartPolicy is not Nerver pod will be delete note
* feat: optimize delete pods related suggestion
* Update jobs-run-to-completion.md
* clarify Conditions section in arch/nodes.md
The field name is `conditions` (plural), so have the section name match
the field name. In addition, updates the JSON output of an individual
Condition to match all the fields returned in k8s 1.14+.
* add information about Allocatable to nodes.md
Since k8s 1.6, a Node object returns information about both the node's
capacity as well as the allocatable resources on the node. The latter is
a representation of the resources that are available for normal pods to
consume.
This patch adds information about capacity vs. allocatable to the
documentation about nodes and provides a link to where the reader can
find more information about reserving compute resources.
* Correction: sysctl entries aren't annotations
First, thank you for your work on this documentation. It means so much to so many users. I found that the sysctl documentation linked here explains that sysctl pod security policy entries are in the spec field, not done via annotation. This corrects it, using as much of the original language as possible from the linked sysctl documentation.
* Update pod-security-policy.md
* Adding example to show labels in POD yaml
This page talk about labels and its usage. Also it talk about syntax for specifying labels. But it does not show how we can have labels in resource manifest. So with this PR i am adding example which shows that how we can have labels in pod manifest.
* Changes to resolve review comments
Changes to resolve review comments
* Adding annotation example
Adding example to show how annotation looks like in manifest. This will help users to understand where exactly we can use the annotations whose details are already given on this page. Annotation `imageregistry: https://hub.docker.com/` used intentionally to make it more relevant as earlier section talk about registry address annotation.
* Resolving review comments
Resolving review comments
This patch promotes re-use of the existing kube-proxy glossary
definition by referencing it from overview/components.md. Similarly, we
move the definition of Container Runtime into a new glossary definition
so that other pages may refer to it.
* Update images.md
* Update content/en/docs/concepts/containers/images.md
That works fine and thank you.
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
**your.private.registry.example.com** is a better choice of domain name for a non-existing sample domain name than calling it **yourprivateregistry.com**
refer #14283
* Reword glossary entry for Service
New wording should be more suitable for inclusion via a
glossary_definition shortcode.
* Improve What's Next section for Service concept
* Rename Services concept to singular
This matches other concept documentation, eg Deployment.
* Use documentation IP address range
1.2.3.4 is outside the blocks reserved for documentation.
* Reword Service concept description
Services direct traffic to Pods, not containers
* Write IPVS in uppercase
Using `rm -Rf ~/.minikube` is not necessary in modern (v1.x) versions of minikube, and is highly discouraged as may can leave dangling VM's running, which minikube will fail to recover from.
Example issue: https://github.com/kubernetes/minikube/issues/4377
* Improve Pivotal row in Production Setup table.
- Provider column should contain company name
- Change check marks to product links to match other rows
Co-authored-by: Danny Berger <dberger@pivotal.io>
* Spell out PKS abbreviation.
Co-authored-by: Danny Berger <dberger@pivotal.io>
* Tweak glossary definition for Node
The services (eg kubelet) that run on a Node are not the kind of
Service that the Kubernetes API knows about. Reword accordingly.
Also, highlight that Docker is one container runtime and that
there are others.
* Adopt suggestions from https://github.com/kubernetes/website/pull/14523
Co-Authored-By: Rael Garcia <me@rael.io>
without specifying registry details for `image` value, You will get following error if you are using a private registry even when your private images are hosted in docker.hub and you have valid credentials configured for the same.
Failed to pull image "xxx/xxx-app:0.0.1": rpc error: code = Unknown desc = Error response from daemon: pull access denied for xxx/xxx-app, repository does not exist or may require 'docker login'