Skip to content

Commit 73cd38c

Browse files
author
Tim Bannister
committed
Move kubectl overview to be section index
Also: - use glossary definition in page introduction - tidy broken link in What's Next section - update links to refer to moved page
1 parent 57f4ad9 commit 73cd38c

File tree

17 files changed

+570
-569
lines changed

17 files changed

+570
-569
lines changed

content/en/docs/concepts/cluster-administration/manage-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ deployment.apps/my-deployment created
154154
persistentvolumeclaim/my-pvc created
155155
```
156156

157-
If you're interested in learning more about `kubectl`, go ahead and read [kubectl Overview](/docs/reference/kubectl/overview/).
157+
If you're interested in learning more about `kubectl`, go ahead and read [Command line tool (kubectl)](/docs/reference/kubectl/).
158158

159159
## Using labels effectively
160160

content/en/docs/concepts/extend-kubernetes/api-extension/custom-resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ many core Kubernetes functions are now built using custom resources, making Kube
2626
Custom resources can appear and disappear in a running cluster through dynamic registration,
2727
and cluster admins can update custom resources independently of the cluster itself.
2828
Once a custom resource is installed, users can create and access its objects using
29-
[kubectl](/docs/reference/kubectl/overview/), just as they do for built-in resources like
29+
[kubectl](/docs/reference/kubectl/), just as they do for built-in resources like
3030
*Pods*.
3131

3232
## Custom controllers

content/en/docs/concepts/overview/kubernetes-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The Kubernetes API lets you query and manipulate the state of API objects in Kub
2323
(for example: Pods, Namespaces, ConfigMaps, and Events).
2424

2525
Most operations can be performed through the
26-
[kubectl](/docs/reference/kubectl/overview/) command-line interface or other
26+
[kubectl](/docs/reference/kubectl/) command-line interface or other
2727
command-line tools, such as
2828
[kubeadm](/docs/reference/setup-tools/kubeadm/), which in turn use the
2929
API. However, you can also access the API directly using REST calls.

content/en/docs/reference/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ client libraries:
4343

4444
## CLI
4545

46-
* [kubectl](/docs/reference/kubectl/overview/) - Main CLI tool for running commands and managing Kubernetes clusters.
46+
* [kubectl](/docs/reference/kubectl/) - Main CLI tool for running commands and managing Kubernetes clusters.
4747
* [JSONPath](/docs/reference/kubectl/jsonpath/) - Syntax guide for using [JSONPath expressions](https://goessner.net/articles/JsonPath/) with kubectl.
4848
* [kubeadm](/docs/reference/setup-tools/kubeadm/) - CLI tool to easily provision a secure Kubernetes cluster.
4949

content/en/docs/reference/glossary/kubectl.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,19 @@ id: kubectl
44
date: 2018-04-12
55
full_link: /docs/user-guide/kubectl-overview/
66
short_description: >
7-
A command line tool for communicating with a Kubernetes API server.
7+
A command line tool for communicating with a Kubernetes cluster.
88
9-
aka:
9+
aka:
10+
- kubectl
1011
tags:
1112
- tool
1213
- fundamental
1314
---
14-
A command line tool for communicating with a {{< glossary_tooltip text="Kubernetes API" term_id="kubernetes-api" >}} server.
15+
Command line tool for communicating with a Kubernetes cluster's
16+
{{< glossary_tooltip text="control plane" term_id="control-plane" >}},
17+
using the Kubernetes API.
1518

1619
<!--more-->
1720

18-
You can use kubectl to create, inspect, update, and delete Kubernetes objects.
21+
You can use `kubectl` to create, inspect, update, and delete Kubernetes objects.
1922

content/en/docs/reference/kubectl/_index.md

Lines changed: 546 additions & 1 deletion
Large diffs are not rendered by default.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -423,7 +423,7 @@ kubectl get pods -A -o=custom-columns='DATA:spec.containers[?(@.image!="k8s.gcr.
423423
kubectl get pods -A -o=custom-columns='DATA:metadata.*'
424424
```
425425

426-
More examples in the kubectl [reference documentation](/docs/reference/kubectl/overview/#custom-columns).
426+
More examples in the kubectl [reference documentation](/docs/reference/kubectl/#custom-columns).
427427

428428
### Kubectl output verbosity and debugging
429429

@@ -444,7 +444,7 @@ Verbosity | Description
444444

445445
## {{% heading "whatsnext" %}}
446446

447-
* Read the [kubectl overview](/docs/reference/kubectl/overview/) and learn about [JsonPath](/docs/reference/kubectl/jsonpath).
447+
* Read the [kubectl overview](/docs/reference/kubectl/) and learn about [JsonPath](/docs/reference/kubectl/jsonpath).
448448

449449
* See [kubectl](/docs/reference/kubectl/kubectl/) options.
450450

content/en/docs/reference/kubectl/overview.md

Lines changed: 0 additions & 548 deletions
This file was deleted.

content/en/docs/setup/production-environment/tools/kops.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ See the [list of add-ons](/docs/concepts/cluster-administration/addons/) to expl
231231
## {{% heading "whatsnext" %}}
232232

233233

234-
* Learn more about Kubernetes [concepts](/docs/concepts/) and [`kubectl`](/docs/reference/kubectl/overview/).
234+
* Learn more about Kubernetes [concepts](/docs/concepts/) and [`kubectl`](/docs/reference/kubectl/).
235235
* Learn more about `kops` [advanced usage](https://kops.sigs.k8s.io/) for tutorials, best practices and advanced configuration options.
236236
* Follow `kops` community discussions on Slack: [community discussions](https://github.com/kubernetes/kops#other-ways-to-communicate-with-the-contributors)
237237
* Contribute to `kops` by addressing or raising an issue [GitHub Issues](https://github.com/kubernetes/kops/issues)

content/en/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -500,7 +500,7 @@ options.
500500
* <a id="lifecycle" />See [Upgrading kubeadm clusters](/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade/)
501501
for details about upgrading your cluster using `kubeadm`.
502502
* Learn about advanced `kubeadm` usage in the [kubeadm reference documentation](/docs/reference/setup-tools/kubeadm/kubeadm)
503-
* Learn more about Kubernetes [concepts](/docs/concepts/) and [`kubectl`](/docs/reference/kubectl/overview/).
503+
* Learn more about Kubernetes [concepts](/docs/concepts/) and [`kubectl`](/docs/reference/kubectl/).
504504
* See the [Cluster Networking](/docs/concepts/cluster-administration/networking/) page for a bigger list
505505
of Pod network add-ons.
506506
* <a id="other-addons" />See the [list of add-ons](/docs/concepts/cluster-administration/addons/) to

0 commit comments

Comments
 (0)