when copying/pasting the command to install the Kubernetes on Mac OS using zsh, the command results in the following error,
`The specified key does not exist.`. This is usually because of the `\` that zsh automatically inserts into the command. The best practice is to use double-quotes and this is also the standard method according to https://google.github.io/styleguide/shell.xml?showone=Quoting#Quoting
* Fix incorrect advice about creating a secret
The existing command does not use code style as required by the style
guide and it is incorrect as rendered. Also, there's an easier way to do
this.
* Add reviewer suggested improvement for secret escaping
Adding sftim's suggestion phrasing explanation of escaping shell special characters.
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Make secret escaping instructions consistent
`kubectl config view -o jsonpath='{.users[].name}' ` in the doc doesn't get the list of users as described in the comment actually.
To get the list of users, the json path should be `'{.users[].name}' `
Enhance to emphasize that triagers should add a priority to each
issue.
Add Learn about Prow section
Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
Add references to the Content guide where the Style guide was
mentioned.
Update the Contribute page (_index.md)
Make Style and Content linkable everywhere
Changed bullet list to numbered list in Content Guide to make referring
to sections easier.
Reverted change to bullet list - beyond scope of this PR
Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
The `*.profile` file referenced do not need to be provided in a separate
file. Making them separate files is preventing hugo from correctly
building the site.
This PR separates the graduated/deprecated feature gates into a separate
table. When updating the table contents by browsing the source code, we
also found some missing items which are added in this PR as well.
* Update DaemonSet deletion documentation
The "Updating a DaemonSet" section referred to pre-1.6 behavior, where
rolling updates of DaemonSets were not supported and thus orphaned pods
from deleted DaemonSets would not be replaced by a new DaemonSet.
Describe the new behavior, where orphaned pods can be adopted by a new
DaemonSet and may be replaced depending on the update strategy in use.
* Tweak language around Pod replacement after DaemonSet deletion
* Update note about DaemonSet rolling updates
No need to call out the version in which rolling updates for DaemonSets
were introduced given how long they've been supported.
* Fix title of audit task
The content the title refers to indicates an intent of describing how
to configure auditing for multiple apiservers rather than multiple
clusters.
* Update content/en/docs/tasks/debug-application-cluster/audit.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
Add shortcode, partial, and css so we can display an accouncement
site-wide.
Create a shortcode for use in content/en/ _index.html so
announcement is displayed on website landing page.
Create a partial for use in layouts/docs/baseof.html so
announcement is displaye on every page in '<url>/docs/home'
directory.
Add two values to config.toml: announcement (boolean) for toggling
display of announcement; announcement_message, which is the actual
message.
Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
* initial commit for IPv4/IPv6 dual stack docs
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Apply suggestions from code review
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Remove warning, Add What's next section
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Add Service section
Add Provising a dual stack Kubernetes cluster section
Add Ecosystem tooling section
Update prerequisites
Update flags
Update supported features
Move validation to task
Add Service validation
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Apply suggestions from code review
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Remove ecosystem tooling
Remove provisioning tools
Add backtics to ipFamily values
Update loadbalancer section
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Fix feature gate link typo
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Update to dual-stack
Add default use-case to Service validation
Add note to default Service behaviour
Add default Service example
Update egress routing description
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Update api-server to the API server
Fix small typo based on feedback
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Add for_k8s_version feature state
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Update service IP address verbiage to be more concise
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Move to tasks/network
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Move dual-stack under services-networking
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Remove dual-stack from glossary
Add codenew blocks
Split command from output
Renamed pod name
Created subheading to validate node and pod addressing
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Apply suggestions from code review
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Verbiage update based on review
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Apply suggestions from code review
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* storage: CSI inline volumes in beta
* storage: remove historic information for CSI inline volumes
As pointed out during review, this information is better captured in
the feature gates reference page.
* Added documentation to support Topology Manager feature in Kubelet.
* Added new document outlining feature
* Updated feature-gates.md to include feature gate for feature
* Update kubelet.md to include kubelet flags for feature
* Added Topology Manager reference to relevant pages
Co-authored-by: Tim Bannister <tim@scalefactory.com>
* Update Topology Manager Policies section
- Gardener is a fully managed service, including day-1 and day-2 operations
- Gardener supports OpenStack (and Packet Cloud), which is often the foundation for on-premise installations
See e.g. adopters like https://bnerd.com which are offering a Gardener-based fully managed Kubernetes service in their own OpenStack DCs. More information at https://github.com/gardener/gardener/blob/master/ADOPTERS.md.
* Add comprehensive CRD versioning flow to documentation
* Break down CRD versioning upgrade processes into steps, apply review feedback
* Reference doc section about custom resource storage migration in workflow documentation
* Add step to find any clients still on old version during CRD version migration
* Fix indentation in list in conversion end-to-end flow doc
* Fix spacing before lists in docs about conversion webhooks
* Fix two typos
Also, I've snuck in a trivial update for the ShareProcessNamespace
feature gate, adding an "Until" version which had been omitted.
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
Create a concepts page, link to it from scheduler concept page,
update feature gates reference and describe briefly in the
runtime-class page.
Signed-off-by: Eric Ernst <eric.ernst@intel.com>
* added step on pulling down sig-windows-tools to windows guide.
* First draft of KubeCluster.ps1 Windows setup instructions
* Update content/en/docs/setup/production-environment/windows/user-guide-windows-nodes.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Update content/en/docs/setup/production-environment/windows/user-guide-windows-nodes.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Update content/en/docs/setup/production-environment/windows/user-guide-windows-nodes.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Update content/en/docs/setup/production-environment/windows/user-guide-windows-nodes.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Update content/en/docs/setup/production-environment/windows/user-guide-windows-nodes.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Update content/en/docs/setup/production-environment/windows/user-guide-windows-nodes.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Update content/en/docs/setup/production-environment/windows/user-guide-windows-nodes.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Update content/en/docs/setup/production-environment/windows/user-guide-windows-nodes.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Update content/en/docs/setup/production-environment/windows/user-guide-windows-nodes.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* added pre-reqs for overlay and moved troubleshooting section
* cosmetic changes and updated kubecluster.ps1 .gifs
* updated deployment steps and networking fix-ups in the Windows user guide
* Documenting how to use EvenPodsSpread feature
* address comments
* address comments
* address sftim's comments
* move to folder workloads/pods
* address comments
* move yamls to examples folder and reference back in the document
* Link from scheduling to topology spread constraints
- minor fix for control-plane-flags
- cleanup tables from "kubeadm maturity" in create-cluster
- update install guide for container linux guide in install-kubeadm
- minor fixes in self-hosting
This patch turns the glossary entry for "workloads" into "workload" in
order to be consistent with other terms in the glossary. In addition,
the definition is modified to match what the overlay tip for the
"Workload" tag at the top of the glossary page says, which is
"Applications running on Kubernetes".
A workload is *not* a core object itself. Rather, it is a general
concept. Various other core objects describe different types of
workloads, and the glossary definition is appropriately modified to make
that clear.
Fixes Issue #14107
- Sample CRD will not work due to apiextensions.k8s.io/v1beta1 setting preserveUnknownFields to true by default. Set to `false`.
- Provide required `type: object` at `openAPIV3Schema` root for both versions to avoid `schema.openAPIV3Schema.type: Required value: must not be empty at the root` error.
* Add link references which were removed with #16011
Signed-off-by: David Schneider <schneider@puzzle.ch>
* Move link references into correct capture block
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.
Jim Angel
Tim Bannister
J M
Dimitri Mitropoulos
CloudYuga Technologies
aimeeu
Naoki Oketani
lys0716
Tomasz Jakubik
David Benque
Pengcheng Chen
manyatripathi
Trey Tacon
Melony QIN
Mesaque Silva
bells17
Benjamin Fuller
Ismail Alidzhikov
Syed Awais Ali
Artem V. Navrotskiy
Deepika Pandhi
mohamed chiheb ben jemaa
Toni Tauro
Himanshu Pandey
Rafael Fernández López
Lee Verberne
Sascha Grunert
wgj
Saed Alavinia
Andrej Marolt
Mans Matulewicz
diguage
Raghuram Devarakonda
Michal Srb
savitharaghunathan
Fabrizio Pandini
Paris
widearea101
Nikhita Raghunath
Marian Steinbach
Qiming
conwaychriscosmo
Karen Bradshaw
Ed Randall
Josh Woodcock
Eric Briand
Tim Schaller
John Howard
bjpaul
Seth
M00nF1sh
Alena Varkockova
Song Shukun
Duffie Cooley
simplytunde
Taylor Dolezal
Jordan Liggitt
David Eads
Mark Janssen
Jingyi Hu
Cheng Pan
k1eran
houjun
Josh Gavant
Adam Wolfe Gordon
Maru Newby
Gyuho Lee
Praveen Sastry
joshmsamuels
Kubernetes Prow Robot
Antoine Pelisse
Rob Scott
Haowei Cai (Roy)
Lachlan Evenson
Patrick Ohly
Louise Daly
Vedran Lerenc
Jeff Wenzbauer
Joe Betz
Lee Verberne
Eric Ernst
David Schott
Deep Debroy
Wei Huang
sudeshsh
Lubomir I. Ivanov
John Griffith
Matthias Bertschy
Dr. Stefan Schimanski
Hemant Kumar
Zihong Zheng
Tim Allclair (St. Clair)
RA489
Kaitlyn Barnard
John Reese
Jay Pipes
inductor
Matt Dorn
Clayton Coleman
Sebastian Florek
Draven
Xing Yang
Carlos Sanchez
David Schneider
Edwin
Benjamin Elder
Piyush Kumar
Leo Di Donato
oneoneonepig
Stephan
Yoon
Anders Eknert
Kevin Wiesmüller
Wojciech Tyczynski
Justin Biggs
Claudiu Belu
praveen-kg
Quan Tian
Marek Counts
Angel
Jakub Warczarek
Burke Azbill
boxboatjeremy
Kane York
Soto Sugita
Arnaud M
Max Kaminskiy
Vincent Gramer
Oz N Tiram
Jared
ponypaver
Bill Mulligan
Alvaro Aleman
Iva Koevska
Xiang Dai
Zane Bitter
Gabriele Cimato
Kohei Toyoda
Andreas Lindhé
Johannes Liebermann
codyc
Victor Ude
lyveng
Manish Bansal
Tahmid Shakil
Ori Tzoran
Patrick East
Rita Zhang
Eduardo Roldan
James
Jesse Hu
Kobayashi Daisuke
Michael Vorburger ⛑️
Alex Punnen
janitha09
Derek
Andrew Lytvynov
Conlan Cesar
Strajan Sebastian Ioan
Shivesh Abhishek
Edu Patrocinio