Skip to content

Commit

Permalink
Merge pull request #29847 from sftim/20210928_migrate_kubectl_overview
Browse files Browse the repository at this point in the history
Move kubectl overview to be section index
  • Loading branch information
k8s-ci-robot authored Mar 5, 2022
2 parents 90188d3 + 77a598c commit 3bcb656
Show file tree
Hide file tree
Showing 19 changed files with 578 additions and 570 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ deployment.apps/my-deployment created
persistentvolumeclaim/my-pvc created
```

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

## Using labels effectively

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ many core Kubernetes functions are now built using custom resources, making Kube
Custom resources can appear and disappear in a running cluster through dynamic registration,
and cluster admins can update custom resources independently of the cluster itself.
Once a custom resource is installed, users can create and access its objects using
[kubectl](/docs/reference/kubectl/overview/), just as they do for built-in resources like
[kubectl](/docs/reference/kubectl/), just as they do for built-in resources like
*Pods*.

## Custom controllers
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/concepts/overview/kubernetes-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The Kubernetes API lets you query and manipulate the state of API objects in Kub
(for example: Pods, Namespaces, ConfigMaps, and Events).

Most operations can be performed through the
[kubectl](/docs/reference/kubectl/overview/) command-line interface or other
[kubectl](/docs/reference/kubectl/) command-line interface or other
command-line tools, such as
[kubeadm](/docs/reference/setup-tools/kubeadm/), which in turn use the
API. However, you can also access the API directly using REST calls.
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/reference/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ client libraries:

## CLI

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

Expand Down
11 changes: 7 additions & 4 deletions content/en/docs/reference/glossary/kubectl.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,19 @@ id: kubectl
date: 2018-04-12
full_link: /docs/user-guide/kubectl-overview/
short_description: >
A command line tool for communicating with a Kubernetes API server.
A command line tool for communicating with a Kubernetes cluster.
aka:
aka:
- kubectl
tags:
- tool
- fundamental
---
A command line tool for communicating with a {{< glossary_tooltip text="Kubernetes API" term_id="kubernetes-api" >}} server.
Command line tool for communicating with a Kubernetes cluster's
{{< glossary_tooltip text="control plane" term_id="control-plane" >}},
using the Kubernetes API.

<!--more-->

You can use kubectl to create, inspect, update, and delete Kubernetes objects.
You can use `kubectl` to create, inspect, update, and delete Kubernetes objects.

553 changes: 552 additions & 1 deletion content/en/docs/reference/kubectl/_index.md

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions content/en/docs/reference/kubectl/cheatsheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ reviewers:
- krousey
- clove
content_type: concept
weight: 10 # highlight it
card:
name: reference
weight: 30
Expand Down Expand Up @@ -423,7 +424,7 @@ kubectl get pods -A -o=custom-columns='DATA:spec.containers[?(@.image!="k8s.gcr.
kubectl get pods -A -o=custom-columns='DATA:metadata.*'
```

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

### Kubectl output verbosity and debugging

Expand All @@ -444,7 +445,7 @@ Verbosity | Description

## {{% heading "whatsnext" %}}

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

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

Expand Down
1 change: 0 additions & 1 deletion content/en/docs/reference/kubectl/jsonpath.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: JSONPath Support
content_type: concept
weight: 25
---

<!-- overview -->
Expand Down
1 change: 1 addition & 0 deletions content/en/docs/reference/kubectl/kubectl-cmds.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: kubectl Commands
weight: 20
---

[kubectl Command Reference](/docs/reference/generated/kubectl/kubectl-commands/)
548 changes: 0 additions & 548 deletions content/en/docs/reference/kubectl/overview.md

This file was deleted.

2 changes: 1 addition & 1 deletion content/en/docs/setup/production-environment/tools/kops.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ See the [list of add-ons](/docs/concepts/cluster-administration/addons/) to expl
## {{% heading "whatsnext" %}}


* Learn more about Kubernetes [concepts](/docs/concepts/) and [`kubectl`](/docs/reference/kubectl/overview/).
* Learn more about Kubernetes [concepts](/docs/concepts/) and [`kubectl`](/docs/reference/kubectl/).
* Learn more about `kops` [advanced usage](https://kops.sigs.k8s.io/) for tutorials, best practices and advanced configuration options.
* Follow `kops` community discussions on Slack: [community discussions](https://github.com/kubernetes/kops#other-ways-to-communicate-with-the-contributors)
* Contribute to `kops` by addressing or raising an issue [GitHub Issues](https://github.com/kubernetes/kops/issues)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -500,7 +500,7 @@ options.
* <a id="lifecycle" />See [Upgrading kubeadm clusters](/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade/)
for details about upgrading your cluster using `kubeadm`.
* Learn about advanced `kubeadm` usage in the [kubeadm reference documentation](/docs/reference/setup-tools/kubeadm/kubeadm)
* Learn more about Kubernetes [concepts](/docs/concepts/) and [`kubectl`](/docs/reference/kubectl/overview/).
* Learn more about Kubernetes [concepts](/docs/concepts/) and [`kubectl`](/docs/reference/kubectl/).
* See the [Cluster Networking](/docs/concepts/cluster-administration/networking/) page for a bigger list
of Pod network add-ons.
* <a id="other-addons" />See the [list of add-ons](/docs/concepts/cluster-administration/addons/) to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This guide walks you through the steps to configure and deploy a Windows contain
control plane and a [worker node running Windows Server](/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes/)
* It is important to note that creating and deploying services and workloads on Kubernetes
behaves in much the same way for Linux and Windows containers.
[Kubectl commands](/docs/reference/kubectl/overview/) to interface with the cluster are identical.
[Kubectl commands](/docs/reference/kubectl/) to interface with the cluster are identical.
The example in the section below is provided to jumpstart your experience with Windows containers.

## Getting Started: Deploying a Windows container
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ kubectl config view
```

Many of the [examples](/docs/reference/kubectl/cheatsheet/) provide an introduction to using
kubectl and complete documentation is found in the
[kubectl manual](/docs/reference/kubectl/overview/).
`kubectl`, and complete documentation is found in the
[kubectl reference](/docs/reference/kubectl/).

## Directly accessing the REST API

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ kubectl config view
```

Many of the [examples](https://github.com/kubernetes/examples/tree/master/) provide an introduction to using
kubectl. Complete documentation is found in the [kubectl manual](/docs/reference/kubectl/overview/).
kubectl. Complete documentation is found in the [kubectl manual](/docs/reference/kubectl/).

### Directly accessing the REST API

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ accomplish commonly used tasks, and [Tutorials](/docs/tutorials/) are more
comprehensive walkthroughs of real-world, industry-specific, or end-to-end
development scenarios. The [Reference](/docs/reference/) section provides
detailed documentation on the [Kubernetes API](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/)
and command-line interfaces (CLIs), such as [`kubectl`](/docs/reference/kubectl/overview/).
and command-line interfaces (CLIs), such as [`kubectl`](/docs/reference/kubectl/).

## Help! My question isn't covered! I need help now!

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1125,7 +1125,7 @@ with `foo` pruned and defaulted because the field is non-nullable, `bar` maintai

CustomResourceDefinition [OpenAPI v3 validation schemas](#validation) which are [structural](#specifying-a-structural-schema) and [enable pruning](#field-pruning) are published as part of the [OpenAPI v2 spec](/docs/concepts/overview/kubernetes-api/#openapi-and-swagger-definitions) from Kubernetes API server.

The [kubectl](/docs/reference/kubectl/overview) command-line tool consumes the published schema to perform client-side validation (`kubectl create` and `kubectl apply`), schema explanation (`kubectl explain`) on custom resources. The published schema can be consumed for other purposes as well, like client generation or documentation.
The [kubectl](/docs/reference/kubectl/) command-line tool consumes the published schema to perform client-side validation (`kubectl create` and `kubectl apply`), schema explanation (`kubectl explain`) on custom resources. The published schema can be consumed for other purposes as well, like client generation or documentation.

The OpenAPI v3 validation schema is converted to OpenAPI v2 schema, and
show up in `definitions` and `paths` fields in the [OpenAPI v2 spec](/docs/concepts/overview/kubernetes-api/#openapi-and-swagger-definitions).
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/tutorials/hello-minikube.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Pod runs a Container based on the provided Docker image.
```

{{< note >}}
For more information about `kubectl` commands, see the [kubectl overview](/docs/reference/kubectl/overview/).
For more information about `kubectl` commands, see the [kubectl overview](/docs/reference/kubectl/).
{{< /note >}}

## Create a Service
Expand Down
3 changes: 2 additions & 1 deletion static/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,7 @@

/docs/reference/glossary/maintainer/ /docs/reference/glossary/approver/ 301

/docs/reference/kubectl/overview/ /docs/reference/kubectl/ 301
/docs/reference/kubectl/kubectl-cmds/ /docs/reference/generated/kubectl/kubectl-commands/ 301!
/docs/reference/kubectl/kubectl/kubectl_* /docs/reference/generated/kubectl/kubectl-commands#:splat 301
/docs/reference/scheduling/profiles/ /docs/reference/scheduling/config/#profiles 301
Expand Down Expand Up @@ -400,7 +401,7 @@
/docs/user-guide/jobs/work-queue-1/ /docs/tasks/job/coarse-parallel-processing-work-queue/ 301
/docs/user-guide/jobs/work-queue-2/ /docs/tasks/job/fine-parallel-processing-work-queue/ 301
/docs/user-guide/kubeconfig-file/ /docs/tasks/access-application-cluster/authenticate-across-clusters-kubeconfig/ 301
/docs/user-guide/kubectl-overview/ /docs/reference/kubectl/overview/
/docs/user-guide/kubectl-overview/ /docs/reference/kubectl/ 301
/docs/user-guide/kubectl/ /docs/reference/generated/kubectl/kubectl-options/
/docs/user-guide/kubectl-conventions/ /docs/reference/kubectl/conventions/
/docs/user-guide/kubectl-cheatsheet/ /docs/reference/kubectl/cheatsheet/
Expand Down

0 comments on commit 3bcb656

Please sign in to comment.