* WIP - rework update imported docs
* Rework tool/doc for updating reference docs
This PR reimplement the reference docs generator in Python and fixes
some outdated docs and data:
- Do docs import using Python because the GoLang version of tool has
some following drawbacks:
* its not convenient for handling YAML config files
* it has to be compiled to binaries to run on different platforms
* for every tiny changes you need to compile a new version and check in
- The reference docs we use in website are actually not coming directly
from `kubernetes/kubernetes`. Most of them come from the `reference-docs`
project. The configuration files are thus changed to avoid confusion.
- We have changed the location of generated docs so the default configuration
files and the docs are updated.
* Updating docs around default ImagePullPolicy
This is an attempt to clear up a bit of the wording around an image's tag and how that impacts the ImagePullPolicy.
The wording to me presently suggests *all* you need to do is use `:latest` as an image tag and that will change the `ImagePullPolicy` to latest.
This is not the case that I've observed. As it stands now, `:latest` only affect the `ImagePullPolicy` if that attribute is not present on the pod's specification.
7f23a743e8/pkg/apis/core/v1/defaults.go (L78)7f23a743e8/pkg/kubelet/images/image_manager_test.go (L63)
* Addressing feedback
- Thanks for the super valuable feedback @Bradamant3. It reads a *lot* better now!
* Fix Markdown on documentation for install-kubectl
Section modified: "Install with Powershell from PSGallery"
* Update install-kubectl.md
* Feedback from PR review with gramamtically incorect sentence and markdown rendering in install-kubectl.md
Update install-kubectl.md
Update install-kubectl.md
Update install-kubectl.md
Update install-kubectl.md
* Clean up inline markup and links
- Clean up inline markup in html headers
- Fix links on page and related page
- Clean up some wording and add links to tutorial and concepts
* Update scale-stateful-set.md
Kubelet doesn't prepend the cluster DNS server to the nodes's DNS
settings, neither for Pods with "ClusterFirst" dnsPolicy nor Pods with
"default" dnsPolicy.
Only pods with "default" dnsPolicy inherit DNS from nodes, without the
cluster DNS server prepended.
* Make navigation and UI strings i18n friendly
This commit
* Extracts most UI strings into i18n bundles so they can be translated
* Makes a proper Hugo menu out of the hardcoded menu that is shown on smaller screens
* Changes the language selector logic to navigate to the current page in the other language if possible (e.g. the translation). If not possible, it takes you to the home page for that language.
For testing, this commit also adds Norwegian as a new language. This is turned off.
* Make the home page into reusable and translatable blocks
This commit adds a set of block type shortcodes that is then used to build the home page.
* These shortcodes gets common image resources from a new headless bundle. These resources can be inherited or overridden by translations.
* The hardcoded case studies section on the home page is replaced with a query and a loop.
* The hardcoded feature list on the home page is replaed qith a query and a loop.
* Change product name
From IBM Cloud Container Service to IBM Cloud Kubernetes Service
* Adding IKS to the table of solutions
Not sure about where in the table it should be placed. The note said,
“The above table is ordered by version test/used in nodes, followed by
support level.”
* Adding IKS to Cloud Providers page
* Adding IBM Cloud Container Registry to private registry topic
* Updating language on cloud provider page
* Revising text for the registry entry
* Specifying that it's calico network policies
The Product Security Team got a report about these unauthenticated
discovery roles. The reporter was surprised about getting 200 requests
when unauthenticated. And given the light documentation on the intention
of these roles it is justifiable.
Increase documentation on these roles.
The URL was not updated to point to release-1.11 branch when 1.11 was released.
This PR updates it to use the docsbranch param, so we don't have to
update it for every release.
The original doc contained "type: fast" which means the volume type
"fast" should exist on OpenStack/Cinder side.
However there is not any standard volume type name and most people
face the StorageClass issue when specifying this volume type.
In addition, the issue is hard to be debugged because the error
message which explains the nonexistent volume type is not output
on debugging information. Then external cloud-provider-openstack
doesn't contain the volume type "fast" today as [1].
This removes it for avoiding confusions for users who still use
the deprecated internal provisioner.
[1]: https://github.com/kubernetes/cloud-provider-openstack/blob/master/examples/persistent-volume-provisioning/cinder/cinder-storage-class.yaml
* Add instructions for staging site using Docker
Adds a condensed version of the instructions in the README to
the intermediate contribution page.
* Format code blocks
* Update high-availability.md
Fix for https://github.com/kubernetes/website/issues/9594#
Changed the value of `kubernetesVersion` to `v1.11.1` in the kubeadm-config.yaml so it pulls the correct server images for the latest v1.11 release.
I don't like the idea of having to change this value for every point release. Maybe someone can come up with a better solution that submitting a change to the documentation for every minor release?
* Update high-availability.md
* Changed Azure Container Service names and to Azure Kubernetes Service
* Changed docs link
* Service link redirects to aks link and remains unchanged.
* Copyedit and update with escape characters
- Use escape characters for {{< toc >}}.
- Copyedit the content.
* Remove the {{< toc >}} reference
The template does not need a {{< toc >}} as the TOC will be generated by default. Therefore, removed this info from the doc.
In Options section, "--feature-gates mapStringBool"
option was given as a "feature=true|false" format.
While in other cli-ref pages, like kube-apiserver,
it's like "feature=true|false (BETA - default=true)".
Make it consistent to be "feature=true|false (phase - default=true or false)"
like kube-apiserver, scheduler, etc.
* Propogating
not "Propogating", is "Propagating"
* `kubelet init` and `kubelet join`
`kubeadm init` and `kubeadm join`, not `kubelet init` and `kubelet join`
* Copyedit the page
A few minor updates were made.
* Update conjuction
Three options. The first (original) was OK, the second (change in this PR) was ambiguous, the third is a bit clearer.
* Format security note with proper callout
The information about security of ssh keys might benefit from standing out more. Thus included it in a caution shortcode. Formatting is now more aligned with the style guide.
* close caution tag
Page titles are in the verb's infinitive form throughout the d11n. Changed the title from the gerund form to infinitive to align it with the other page titles.
* Prevent hugo's wrong yaml rendering
* moved a couple of yaml descriptions to examples directory
* remove command prompt
* split each code snippet into command and output
* revert newline character
* add new test in examples_test.go
* change kind to ResourceQuota from List
* revert using examples/quota-objects-priority.yaml
* fix indent number
* unify file extension to yaml
This patch fix content "List existing nodes, pods, services and more,
in all namespaces, or in just one:" lost pod list.
Signed-off-by: Yuanbin.Chen <cybing4@gmail.com>
* Added shortcode callouts and removed future tense
* Added colons according to the style guide
* Add a few more copyedits
@cody-clark inspired me. More to do, but progress is being made!
* Fixes#9787. Be explicit with page name for Hugo to find section
* Revert "Fixes #9787. Be explicit with page name for Hugo to find section"
This reverts commit b3f4d5be10.
* Follow @bep suggestions to fix#9787
* Fix sentence style capitalization in title
Capitalization of topic title was inconsistent with other titles. Fixed to sentence style capitalization.
* Fix object name
Minor change to nice fix, thank you!
The ordered list of content under "Creating a Deployment" was not ordered as per the example. Since it was confusing to search for the meaning around, I reordered the content.
Replaced "we" with "you" as per the style guide.
This block of code was missing the correct formatting
Changed the formatting
Rechanged it
Sorry I got kind of mixed up with the highlighting, this is what you meant right?
three backticks formatting
Inserted newlines to fix code formatting
Re-added white space
Yet more whitespace adjustment
* create-cluster-kubeadm: update notes about flannel
Add note that a specific manifest can be used to support
different architectures until version 0.11.0 is released.
* Fix passive voice
Style guide compliance
* Fix link order in Setup section
* fix merge conflict
* Co-authored-by: Jennifer Rondeau <jennifer.rondeau@gmail>
* flip front matter order
* Remove Imported section and add Community section
* revert flip
* change section weights
* revert case study change
It was not clear what "Before you begin" meant and how it needs to be added only if the task or tutorial is version specific. Therefore, added this info in.
* update kops version to latest (1.10.0)
added a more recent version of kops.
now also supports kubernetes 1.10.x
* more updates on the kops.md
- added links to markup files in the kops repo
- slack channel updated
* rebase certificates PR on Hugo master
Co-authored-by: liztio <liz@heptio.com>
* fix per comments, add note about front-proxy
* fix up key usage table and references
As the sentence before the changes in this PR says, member/snap/db is a file
inside the datadir. It's not where datadir is located. Also, we are already
providing link to the data directory definition.
* Add info about requesting access
This includes how to get a sponsor, how to be a sponsor,
how to become a reviewer, approver, and website admin.
* Address feedback
* Generically refer to container runtimes.
Update nodes.md to refer to "container runtimes" instead of identifying Docker specifically.
* Update nodes.md link for Container Runtime to be relative to the domain.
* Update nodes.md
* Reorganize docs contrib guide
* Address first round of feedback from Brad, Jared
* Standardize on 'SIG Docs'
* Address more feedback
* Rewrites to participating.md
* Tweak navigation titles
* Document PR Wrangler
* Document SIG Docs chairperson
* Fix codeblock that shows how to use <codenew>
It was being interpreted as a Hugo shortcode.
* Document the wire format for Extra introduced in #65799
Bytes which aren't [legal in HTTP headers](https://tools.ietf.org/html/rfc7230#section-3.2.6) need to be percent-encoded over the wire.
* Update authentication.md
code review feedback
* Update authentication.md
more review feedback
* Update authentication.md
feedback
* Update authentication.md
feedback
* Add necessity of metrics-server for HPA
Current HPA doc1 mentions metrics-server like
For resource metrics, this is the metrics.k8s.io API,
generally provided by metrics-server. It can be launched
as a cluster addon.
The metrics.k8s.io API is mandatory for HPA, so the above means
metrics-server needs to be launched for HPA. However it is difficult
to understand that requirement because the above seems metrics-server
as just a addon, and that is described on small section.
In addition, many people are facing HPA issue that fetching metrics
doesn't work on the internet like
$ kubectl get hpa
NAME REFERENCE TARGETS MINPODS MAXPODS REPLICAS AGE
nginx Deployment/nginx <unknown>/50% 1 3 0 7s
The above sample "<unknown>" shows HPA feature cannot get current
metrics due to metrics-server doesn't work fine.
This adds necessity of metrics-server for HPA directly to solve
the problem.
fixes: #9728
* Copyedit
The explanation to setup auto completion of zsh with Oh-My-Zsh is correct, however the example code is incorrectly mentioned as `source <(kubectl completion zsh)`. This pull request updates it to `plugins=(kubectl)`
- mention `kubeadm config migrate`.
- don't inline control plane flag info, but rather link
to the new dedicated page.
- mention that kuberenetesVersion controls the version of the
images.
* kubeadm: Add a kubelet-kubeadm integration reference doc
* kubeadm: edits for the kubelet-kubeadm integration doc
* kubeadm: move the kubelet-kubeadm integration doc
* Apply edits to kubelet-integration.md
* Make kubelet-integration.md use a template
Also apply MD formatting fixes.
* Copyedit
* Address feedback on copyedit
* added a couple of typo fixes
Technically speaking SRV targets are address record names, not CNAMEs. In fact, the SRV RFC states that SRV targets must point to an address record name, and cannot be an alias (e.g. CNAME).
There are a few cases which were missed during previous effort on
consolidating all example YAML files. This PR fixes them all in the
English version.
Closes: #9674
Qiming
Chao Wang
Justin Nauman
Heng WU
Damien Duportal
Heng WU
WanLinghao
Gerald Haydtner
Bob Killen
Matthias Lübken
Matheus Neder
Sunny
Karen Bradshaw
Quan Tian
Misty Linville
Shida Qiu
Sam Foo
Jake Sanders
zhanggaogong
Jim Angel
Sapphire Mason-Brown
CaoShuFeng
Ryan McGinnis
Maciej Kwiek
Kevin Lefevre
Bjørn Erik Pedersen
Keith Schaab
tanshanshan
Cody Clark
Zach Corleissen
Duffie Cooley
John O'Neill
Eric Tune
vsoutherner
Andy Zhang
Michelle Au
Art
Brandon Philips
Michael Schubert
alex-libre
Ajay Kemparaj
Joseph Ruane
Robert Bailey
Michael Taufen
Alois Mayr
linyouchong
Xinhai Wang
swatisehgal
Eyal Levin
rongzhang
Yuanbin Chen
Junichi Yoshise
Joey
Xinzhao Xu
Piotr Gospodarek
Masahito Zembutsu
欧林宝
AdamDang
makocchi
Shen Yuanyu
Diógenes Rettori
Yaniv Oliver
Paul
Kenichi Omichi
Alexey Volkov
David Young
yan xuean
shavidissa
Tim Fogarty
Lubomir I. Ivanov
Geoff
ocofaigh
Julie Bruce
Dwai Banerjee
Lele
Fan Zhang
Kilian Ries
caishan2018
Gao Wen
Li Zebang
tvshc
krmayankk
Miguel Angel Medina Mondragon
Andrew Chen
Arnaud M
Ben Hall
Lion-Wei
David Glasser
fqsghostcloud
Jose A. Iñigo
Zach Arnold
Bryan Boreham
Brad Topol
mofelee
Nikhita Raghunath
Dana Katz
Jari Kolehmainen
Lon Ilesanmi
John Oss
Slava Semushin
Takumasa Ochi
Herrmann Hinz
chenhuan
Jennifer Rondeau
Igor Mameshin
Sahdev Zala
Brad Fitzpatrick
MengZeLee
Chuck Ha
Michael Mackend
Nihanth Dara
Logan Rakai
Bas Tichelaar
Ahmet Alp Balkan
Victor
Chen Hong
Pradheep Shrinivasan
Pavel Druyan
Bobby (Babak) Salamat
Peter (XiangPeng) Zhao
Eike Herzbach
Oleg Artenii
Shivakumar Thanikachalam
Erik Erlandson
Hongzhi
Chris Knowles
Matt Rickard
Tobias Brunner
Tair Sabirgaliev
JasperTimm
Tamal Saha
Samuel Birocchi
Alfonso Palacios
Sebastiaan van Steenis
Georgios Andrianakis
Xiao An
Chris O'Haver