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'
* document version changes of critical pod
* document system priority class name version requirement
* Update guaranteed-scheduling-critical-addon-pods.md
Minor updates:
- Add a full stop.
- Removed the 'Start the tutorial›' section. The sections are already linked from 1 to 6 and this section doe not add any value after point 6.
* Link to 'Add image pull secret to service account'
This page does not mention the fact that image pull secrets can be specified through a service account. So adding link to the section which gives details about 'adding image pull secret to service account'.
* Correcting link url
Correcting link url
* Corrects procedure to get tab completion on Mac
Tab completion only requires the installation of bash-completion and sourcing the bash_completion script.
Installing bash-completion@2 doesn't work and source <(kubectl completion bash) is no longer necessary in the .bash_profile.
* Removed reference to other methods that don't work
* Update install-kubectl.md
The current content was not following the style guide and lacked information on what the user was doing under the quick start section. Added more information and tested the section out. Further reorganized the content.
Correct typos
Updated the content.
Updated the content
Fixed syntax error.
Update the unordered list formatting
Fix formatting issues
Formatting update
Format the content
Format the content
Format content
Format ordered content
Format unordered list
Clean up and reorganize minikube.md
Updated the content
Updated the content as per the comments received.
Fixed an error
Fixes the note shortcode
Fixes error in shortcode
Clean up and reorganize minikube.md
* Use note shortcode in kops glossary entry
This brings the entry closer to Kubernetes' style guide for
documentation.
* Reword kops glossary entry
- Write “Terraform” with a capital T (it's a proper noun)
- Adjust grammar
The link https://github.com/kubernetes/minikube#other-ways-to-install doesn't exist anymore.
So either we remove the link to it or we fix the minikube README and add a new section for alternative ways to install minikube.
What do you think?
* Link upgrade to skewed version page
It provides the order of upgrade and shows which versions are supported.
Solves (at least partially ) #14420
* Update cluster-management.md
* Update cluster-management.md
* document pod downwardAPI fieldRef & resourceRef values of en version
* document pod downwardAPI fieldRef & resourceRef values of zh version
* typo correction
* Correcting minikube quickstart steps
In minikube quickstart section , it was difficult to differentiate between command and its output. Also, There was no details given for each steps and its expected output. This PR fixes these issues.
* Correcting number formatting
Correcting number formatting
* Correcting numbering
Correcting numbering
* Update content/en/docs/setup/minikube.md
Co-Authored-By: Franklin Yu <franklinyu@hotmail.com>
* Update content/en/docs/setup/minikube.md
Co-Authored-By: Franklin Yu <franklinyu@hotmail.com>
* Update content/en/docs/setup/minikube.md
Co-Authored-By: Franklin Yu <franklinyu@hotmail.com>
* Corrected formatting
Corrected formatting
* Correcting number sequence
Correcting number sequence
* Updated Linux Academy courses
* Apply suggestions from code review
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Fix link syntax
* Update overview.md
Both local and pod port number are same i.e. 6379 which causes confusion to first time reader. This can be easily avoided by using two different port number.
* Correcting order of display for daemon set tasks
Correcting order of display for daemon set tasks
* Correcting display order of daemon set task
Correcting display order of daemon set task
here apt installs both kubelet and kubectl but just holds kubelet. I think kubectl should alse be held by apt-mark.
```
# replace x in 1.14.x-00 with the latest patch version
apt-mark unhold kubelet && \
apt-get update && apt-get install -y kubelet=1.14.x-00 kubectl=1.14.x-00 && \
apt-mark hold kubelet
```
Add meeting guidelines, graphic
Update embedded image
Use raw HTML for image link
Edit path
Indent list items
minor edits
Add line breaks for indentation
Add bolding
Add section for meetings
Feedback from jimangel
* Use glossary references where appropriate
* Link from Pod overview to detailed Pod concept
* Assume that privileged containers are stable
* Improve wording
* Write Pod in upper case
As Pod is an API object, write it in upper case.
This patch swaps all uses with extensions/v1beta1 with the new
networking.k8s.io/v1beta1 apiVersion for the Ingress resource.
Signed-off-by: Christopher M. Luciano <cmluciano@us.ibm.com>
* Define SLO acronym
Save people from having to search for the translation of SLO to Service-Level Objectives.
* replace SLO with direct PodDisruptionBudget reference
The orders of kind and metadata were inconsistent, and that made the
doc unreadable.
This fixes the orders in consistent way under pods/init-containers.md.
* updated self-hosting documentation
* removed more referances
* updated wording
* updated self-hosting warning to be more clear about the effects of pivot has on your cluster
* Update content/en/docs/setup/independent/self-hosting.md
Co-Authored-By: Klaven <mcounts@suse.com>
*minikube ssh* logs into the cluster as user 'docker'. The user 'docker' (uid=1000) does not have write permissions in /mnt to create a new directory and/or the example's HTML file. Use sudo(8) to create the directory as well as the HTML file nginx will ultimately serve.
* Fix broken link in service-accounts-admin.md
a213182b10
added a linke to [projected volume] that maybe got renamed.
* Update service-accounts-admin.md
Added steps to find out if virtualization in installed on the users OS.
Minor improvement
Capitalized Windows
Removed the shell from the command.
Update install-minikube.md
by kubectl apply.
The docs imply that lists whose elements are all primitives
are replaced by the applied config instead of being updated.
This PR states that explicitly for clarity.
* Add files via upload
KubeCon Barcelona 2019 Diversity Lunch & Hack Blog Post
* Update 2019-04-25-kubecon-diversity-lunch-and-hack.md
* Update and rename 2019-04-25-kubecon-diversity-lunch-and-hack.md to 2019-05-02-kubecon-diversity-lunch-and-hack.md
* adding Elastic Stack for logging and monitoring
* added section on deploying Elasticsearch and Kibana
* more detail
* more detail
* First draft
* Using tutorial template.
* more goodness
* Describe autodiscover
* added verification steps
* Added cluster role binding
* Use Redis metrics and logs
* cleanup
* add cleanup
* unused
* Added language tags
* Added glossary_tooltip
* Added link
* Placed alternative steps in tabs
* shorten heading
* uppercase for Kubernetes objects
* cleanup secret
* grammar
* updated title and linked from the guestbook tutorial
* added reviewer. Thanks Tim!
* Removed default username/password
* typo, verbosity, more info.
`CPUCFSQuotaPeriod` Feature Gate is set from the flag name `CustomCPUCFSQuotaPeriod` per [`kube_features.go#163`](https://github.com/kubernetes/kubernetes/blob/master/pkg/features/kube_features.go#L163)
This PR updates the docs to suit.
In some respects it would be tidier to remove `Custom` prefix from `kube_features.go` so that the Feature Gate naming maps 1:1.
Happy to close this PR and do PR to remove 'Custom' prefix instead.
Added a step under the sections that guide the user to install the binary using curl on the OS. This is the same format maintained by the other section on this page.