Commit Graph

2852 Commits

Author SHA1 Message Date
Tim Bannister e5eea5d8b9 Clean up kubeadm install guide (#17584)
* Fix link to cluster upgrade with kubeadm

* Improve kubeadm container runtime install steps

* Use tabs for Linux vs. non-Linux kubeadm CRI details

* Tweak wording

* Use dagger in place of double asterisk

(Double asterisks don't render as well, and also can confuse
Markdown-aware editors).

* Move link inside preceding tabs

Repeating the text makes life easier for readers.
2020-02-11 05:52:05 -08:00
Jacky Wu 0da849d6d3 chore: update terminology list content and add ref link. (#18968) 2020-02-11 05:28:01 -08:00
Zach Corleissen d4437d56c5 Change url to alias (#19070) 2020-02-11 00:48:02 -08:00
Jim Angel db5ddfab15 adding redir (#18834) 2020-02-10 20:02:01 -08:00
Qiming Teng b550c6c051 Remove shortcode 'code' (#19035)
A long time ago, we added a new shortcode `codenew` as a replacement of
the `code` shortcode. The intention was to consolidate all example
manifests to a single subdirectory, i.e. `content/<lang>/examples`. Now
this transition is almost over. We have only two instances where the old
`code` shortcode is referenced.

This PR makes the `policy.rego` file inlined content so that all
referenes to `code` are killed. We can safely drop the `code` shortcode.
If desired, we can rename the `codenew` shortcode to `code` in a
(series of) separate PR(s).
2020-02-10 19:52:00 -08:00
Tim Bannister 2faf1024d9 Tweak linking for Kubernetes object concept (#18122)
- Add a link from /docs/reference/using-api/api-concepts/
- Tweak other incoming links to match
2020-02-10 19:24:01 -08:00
Naoki Oketani ae7ace0f71 Replace links with redirect destination (#19038) 2020-02-10 18:18:01 -08:00
Cory O'Daniel 6ff38e05c8 adding elixir k8s client (#19056) 2020-02-10 14:43:54 -08:00
Celeste Horgan eddbb00cbe Convert to {{ note }} shortcode (#19054) 2020-02-10 10:55:54 -08:00
rm 680f6fc086 Update automated-tasks-with-cron-jobs.md (#19043) 2020-02-10 08:09:53 -08:00
Armand Grillet e80f1f7da8 update command used to create deployment (#19005)
The previous one was showing a deprecation warning when used.
2020-02-09 15:03:53 -08:00
Kabir Kwatra cd2f675b5b Updated CHANGELOG-11 link (#19036) 2020-02-09 14:53:53 -08:00
Mariyan Dimitrov 3482077227 Remove command prompt from Windows example (#18906)
* Remove command prompt from Windows example

According to the [style
guide](https://kubernetes.io/docs/contribute/style/style-guide/#don-t-include-the-command-prompt),
the command prompt should not be included in the examples. Removing the
Windows command prompt from the jsonpath example.

Signed-off-by: Mariyan Dimitrov <mariyan.dimitrov@gmail.com>

* Put Windows example inside note shortcode

I'm putting the Windows example in a Hug note shortcode to be consistent
with the rest of the documentation.

Signed-off-by: Mariyan Dimitrov <mariyan.dimitrov@gmail.com>
2020-02-09 05:15:52 -08:00
Naoki Oketani c9aace3c09 cleanup /docs/concepts/workloads/pods/pod-lifecycle/ (#19009) 2020-02-08 11:49:53 -08:00
Mariyan Dimitrov b70d434b36 Add kubectl patch example with quotes on Windows (#18853)
* Add kubectl patch example with quotes on Windows

When running the `kubectl patch` example, on Windows systems you get an
error when passing the patch request in single quotes. Passing it in
double quotes with the inner ones escaped produced the desired behavior
as is in the example given for Linux systems. I've added a small note
for Windows users to have that in mind.

Signed-off-by: Mariyan Dimitrov <mariyan.dimitrov@gmail.com>

* Use Hugo note shortcode

Windows note is placed inside a
[shortcode](https://kubernetes.io/docs/contribute/style/style-guide/#shortcodes)
to be consistent with the style guide.

Signed-off-by: Mariyan Dimitrov <mariyan.dimitrov@gmail.com>

* Remove shell Markdown syntax

I've removed the shell syntax from the Windows example and have changed
the description to be the same as the one used in
[jsonpath](https://kubernetes.io/docs/reference/kubectl/jsonpath/)
document to be more consistent. The jsonpath example uses cmd syntax,
though it is note inside a note shortcode, therefore I've opted out of
using any syntax as it seems to break rendering inside the shortcode.

Signed-off-by: Mariyan Dimitrov <mariyan.dimitrov@gmail.com>

* Add cmd markdown syntax and fix order list

I've tested this locally with `make docker-serve` on my Linux machine
and finally things are looking better, I've managed to address these two
issues:

- the Windows example is now inside `note` shortcode and also the cmd
syntax renders correctly on the page

- the list of steps broke after the first one, I've indented a paragraph
and now the steps are in the expected order

Signed-off-by: Mariyan Dimitrov <mariyan.dimitrov@gmail.com>

* Remove command prompt from example

According to the [style guide](https://kubernetes.io/docs/contribute/style/style-guide/#don-t-include-the-command-prompt), the command prompt should not be included when showing an example. This commit removes it for consistency with the style guide.

Signed-off-by: Mariyan Dimitrov <mariyan.dimitrov@gmail.com>
2020-02-08 11:23:53 -08:00
vishakha 4c3a5c6f5f Adding contribution best practice in contribute docs (#18059) 2020-02-08 06:17:52 -08:00
Alexander Zimmermann 01e3420896 Separated commands from output (#19023) 2020-02-07 11:59:46 -08:00
Victor Martinez d473853186 Add Elastic metricbeat to examples of DaemonSets and rename logstash (#19024)
* Add Elastic metricbeat to examples of DaemonSets

The URL points to the docs related to how to configure metricbeat on k8s

* Filebeat is the next thing
2020-02-07 11:51:45 -08:00
Sam dd362a9f33 Correct description of Knitter CNI plugin (#18983) 2020-02-07 11:47:46 -08:00
Prasad Honavar 9da040d5d0 Update cheatsheet.md (#18975)
* Update cheatsheet.md

"List all pods in the namespace, with more details" command corrected by adding --all-namespaces

* Update content/en/docs/reference/kubectl/cheatsheet.md

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

Co-authored-by: Tim Bannister <tim@scalefactory.com>
2020-02-07 11:45:46 -08:00
Katarzyna Kańska 1e6d12b9e0 Fix of pull request #18960 (#18974)
* Fix of pull request #18960

* Add yaml configuration file snippets

* Remove redundant code snippet for  command
2020-02-07 11:43:45 -08:00
Celeste Horgan 9bcde5cd94 Remove duplicate content: Roles & Responsibilities (#18920)
* Remove duplicate content: Roles & Responsibilities

Signed-off-by: Celeste <celeste@cncf.io>
Address feedback

Signed-off-by: Celeste <celeste@cncf.io>

* Apply suggestions from review

Co-Authored-By: Zach Corleissen <zacharysarah@users.noreply.github.com>

* Link to contribution guidelines

Signed-off-by: Celeste Horgan <celeste@cncf.io>

* Address PR feedback

Signed-off-by: Celeste Horgan <celeste@cncf.io>

Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>
2020-02-07 11:33:45 -08:00
Jacky Wu b9ff4f1bf8 fix: add dns search record limit note. (#18913) 2020-02-07 11:31:46 -08:00
Tim Bannister ecda7af470 Reword kubelet live reconfiguration task (#18629)
- Revise version requirements
- Use glossary tooltips in summary
- Use sentence case for headings
- Write kubelet in lowercase where appropriate
- Add “What's next” section
2020-02-07 11:13:46 -08:00
Tim Bannister 40869a3695 Use built-in version check & metadata (#18542) 2020-02-07 10:29:46 -08:00
Karen Bradshaw f4163a90a1 clean up secret generators (#18320) 2020-02-07 10:19:46 -08:00
Tim Bannister b129075249 Improve network policies concept (#18091)
* Adopt website style guidelines

* Tweak wording

Co-Authored-By: cmluciano <cmluciano@cruznet.org>

* Make sample NetworkPolicies downloadable

Co-authored-by: cmluciano <cmluciano@cruznet.org>
2020-02-07 10:13:45 -08:00
tom1299 98ea2cdfc0 Refined unclear sentence on 3rd party dependencies (#18015)
* Refined unclear sentence on 3rd party dependencies

I reworded the sentence on third party dependencies a bit in order to make it more sound

* Update content/en/docs/concepts/security/overview.md

Sounds much better

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

Co-authored-by: Tim Bannister <tim@scalefactory.com>
2020-02-07 10:09:46 -08:00
RA489 b5800954dd Document none driver compatibility with non docker runtime. (#17952) 2020-02-07 10:05:46 -08:00
Marek Siarkowicz 26827a909e Document control plane monitoring (#17578)
* Document control plane monitoring

* Update content/en/docs/concepts/cluster-administration/monitoring.md

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

* Update content/en/docs/concepts/cluster-administration/monitoring.md

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

* Merge controller-metrics.md into monitoring.md

Co-authored-by: Tim Bannister <tim@scalefactory.com>
2020-02-07 10:01:46 -08:00
Tim Bannister d43ac11196 Revise glossary entry for Device Plugin (#16291) 2020-02-07 09:49:46 -08:00
Tim Bannister 8dcc13981d Link to setup page about Kind (#18996)
Link from /docs/setup/ to /docs/setup/learning-environment/kind/ now
that the target page exists.
2020-02-07 09:37:46 -08:00
Aman Gupta 7e0dd4f59f (fix) Removed -n test from kubectl get pv command (#18877)
- PV are cluster scoped rather than namespaced scope
    - So, there is no need to list it by namespace

Signed-off-by: Aman Gupta <aman.gupta@mayadata.io>
2020-02-07 07:23:45 -08:00
Karen Bradshaw 121076085c updating contrib for ref docs (#18787)
more cleanup
2020-02-06 13:53:25 -08:00
Andrew Sy Kim 79e1b94c91 Add common examples to Service Topology documentation (#18712)
* service topology: add missing 'enabling service topology' page

Signed-off-by: Andrew Sy Kim <kiman@vmware.com>

* service topology: add common examples

Signed-off-by: Andrew Sy Kim <kiman@vmware.com>
2020-02-06 13:11:26 -08:00
Sharjeel Aziz 21447e7d22 Update kubectl create configmap section (#18885) 2020-02-06 13:07:25 -08:00
Tim Bannister a84463852e Revise “Encrypting Secret Data at Rest” (#18810)
* Drop reference to old Kubernetes versions

At the time of writing, Kubernetes v1.13 is the oldest supported
version, and encryption-at-rest is no longer alpha.

* Tidy whitespace

* Add table caption

* Set metadata for required Kubernetes version
2020-02-06 13:03:24 -08:00
Marko Lukša ac69de5422 Remove "Unschedulable" pod condition type from the pod lifecycle docs (#18956)
The pod lifecycle documentation erroneously indicated `Unschedulable` as a possible `type` of pod condition. That's not true. Only four condition types exist. The `Unschedulable` value is not a type, but one of the possible reasons of the `PodScheduled` condition type.
2020-02-06 12:59:25 -08:00
Maria Ntalla a816bd7175 Document list/map/structType and listMapKeys (#18977)
These markers where introduced to describe topology of lists, maps,
structs - primarily in support of server-side apply.

Secondarily, a small typo fix:)
2020-02-06 12:57:25 -08:00
Jie Shen 376791802d Add description for TTL (#19001) 2020-02-06 05:57:33 -08:00
Alexander Zimmermann 3e639b3c8e Added a note about built-in priority-classes (#18979)
* Added a note about build-in priority-classes

* Update content/en/docs/concepts/configuration/pod-priority-preemption.md

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

Co-authored-by: Tim Bannister <tim@scalefactory.com>
2020-02-06 05:45:34 -08:00
RA489 dbe9590aaa Add KIND as the options for spinning up a test kubernetes environment (#17860) 2020-02-05 14:53:54 -08:00
MMeent 37ec720fa8 Add note for LB behaviour for cordoned nodes. (#18784)
* Add note for LB behaviour for cordoned nodes.

See also https://github.com/kubernetes/kubernetes/issues/65013
This is a reasonably common pitfall: `kubectl cordon <all nodes>` will also drop all LB traffic to the cluster, but this is not documented anywhere but in issues, when found it is usually already too late.

* Update with feedback
2020-02-05 14:31:56 -08:00
Ray76 c1eb3eab0e Update certificates.md (#18970) 2020-02-04 00:53:26 -08:00
Tim Bannister d0f6d60ec9 Revise pull request template (#18744)
* Revise pull request template

* Reference compiled docs in PR template

Refer readers to https://k8s.io/contribute/start/

This keeps the template short, and it lets Hugo use templating for
the current version.
2020-02-03 23:25:26 -08:00
Laurens Versluis fa598f196e Typo fix (#18830) 2020-02-03 15:15:26 -08:00
Jacky Wu 644c356ca7 doc: add link for type=LoadBalancer service in tutorial. (#18916) 2020-02-03 11:01:21 -08:00
Katarzyna Kańska 5e9716e6b5 Update horizontal-pod-autoscale-walkthrough.md (#18960)
Update command for creating php-apache deployment due to the following warning: `kubectl run --generator=deployment/apps.v1 is DEPRECATED and will be removed in a future version. Use kubectl run --generator=run-pod/v1 or kubectl create instead.`
2020-02-03 10:45:21 -08:00
Arjun d0cf343dd1 Revert "Configurable Scaling for the HPA (#18157)" (#18963)
This reverts commit 5dbfaafe1a.
2020-02-03 08:21:22 -08:00
Neil Jerram ef5550f12e Fix that dual-stack does not require Kubenet specifically (#18924)
* Fix that dual-stack does not require Kubenet specifically

Rather it requires a network plugin that supports dual-stack, and
others are available, including Calico.

* Update content/en/docs/tasks/network/validate-dual-stack.md

Added link to doc about network plugins

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

Co-authored-by: Tim Bannister <tim@scalefactory.com>
2020-02-03 02:09:21 -08:00