Update User Guide and Admin links to point to new resources. (#3438)
* Update links to outdated user-guide and admin docs * Add script for updating outdated links. * Update regex to include init-containers file. * Pull upstream, rewrite links in and to namespaces walkthrough.
This commit is contained in:
PaulJuliusMartinez
committed by
Andrew Chen
Andrew Chen
parent
1592494620
commit
7f0294c579
+23
-23
@@ -9,7 +9,7 @@ title: User Guide
|
||||
The Kubernetes **Guides** can help you work with various aspects of the Kubernetes system.
|
||||
|
||||
* The Kubernetes [User Guide](#user-guide-internal) can help you run programs and services on an existing Kubernetes cluster.
|
||||
* The [Cluster Admin Guide](/docs/admin/) can help you set up and administrate your own Kubernetes cluster.
|
||||
* The [Cluster Admin Guide](/docs/tasks/administer-cluster/overview/) can help you set up and administrate your own Kubernetes cluster.
|
||||
* The [Developer Guide] can help you either write code to directly access the Kubernetes API, or to contribute directly to the Kubernetes project.
|
||||
|
||||
## <a name="user-guide-internal"></a>Kubernetes User Guide
|
||||
@@ -19,28 +19,28 @@ The following topics in the Kubernetes User Guide can help you run applications
|
||||
1. [Quick start: launch and expose an application](/docs/user-guide/quick-start/)
|
||||
1. [Configuring and launching containers: configuring common container parameters](/docs/user-guide/configuring-containers/)
|
||||
1. [Deploying continuously running applications](/docs/user-guide/deploying-applications/)
|
||||
1. [Connecting applications: exposing applications to clients and users](/docs/user-guide/connecting-applications/)
|
||||
1. [Connecting applications: exposing applications to clients and users](/docs/concepts/services-networking/connect-applications-service/)
|
||||
1. [Working with containers in production](/docs/user-guide/production-pods/)
|
||||
1. [Managing deployments](/docs/concepts/cluster-administration/manage-deployment/)
|
||||
1. [Application introspection and debugging](/docs/user-guide/introspection-and-debugging/)
|
||||
1. [Using the Kubernetes web user interface](/docs/user-guide/ui/)
|
||||
1. [Logging](/docs/user-guide/logging/overview/)
|
||||
1. [Monitoring](/docs/user-guide/monitoring/)
|
||||
1. [Getting into containers via `exec`](/docs/user-guide/getting-into-containers/)
|
||||
1. [Connecting to containers via proxies](/docs/user-guide/connecting-to-applications-proxy/)
|
||||
1. [Connecting to containers via port forwarding](/docs/user-guide/connecting-to-applications-port-forward/)
|
||||
1. [Application introspection and debugging](/docs/tasks/debug-application-cluster/debug-application-introspection/)
|
||||
1. [Using the Kubernetes web user interface](/docs/tasks/web-ui-dashboard/)
|
||||
1. [Logging](/docs/concepts/clusters/logging/)
|
||||
1. [Monitoring](/docs/concepts/cluster-administration/resource-usage-monitoring/)
|
||||
1. [Getting into containers via `exec`](/docs/tasks/kubectl/get-shell-running-container/)
|
||||
1. [Connecting to containers via proxies](/docs/tasks/access-kubernetes-api/http-proxy-access-api/)
|
||||
1. [Connecting to containers via port forwarding](/docs/tasks/access-application-cluster/port-forward-access-application-cluster/)
|
||||
|
||||
Before running examples in the user guides, please ensure you have completed [installing kubectl](/docs/tasks/kubectl/install/).
|
||||
|
||||
## Kubernetes Concepts
|
||||
|
||||
[**Cluster**](/docs/admin/)
|
||||
[**Cluster**](/docs/tasks/administer-cluster/overview/)
|
||||
: A cluster is a set of physical or virtual machines and other infrastructure resources used by Kubernetes to run your applications.
|
||||
|
||||
[**Node**](/docs/admin/node/)
|
||||
[**Node**](/docs/concepts/nodes/node/)
|
||||
: A node is a physical or virtual machine running Kubernetes, onto which pods can be scheduled.
|
||||
|
||||
[**Pod**](/docs/user-guide/pods/)
|
||||
[**Pod**](/docs/concepts/workloads/pods/pod/)
|
||||
: A pod is a co-located group of containers and volumes.
|
||||
|
||||
[**Label**](/docs/user-guide/labels/)
|
||||
@@ -49,44 +49,44 @@ Before running examples in the user guides, please ensure you have completed [in
|
||||
[**Selector**](/docs/user-guide/labels/#label-selectors)
|
||||
: A selector is an expression that matches labels in order to identify related resources, such as which pods are targeted by a load-balanced service.
|
||||
|
||||
[**Replication Controller**](/docs/user-guide/replication-controller/)
|
||||
[**Replication Controller**](/docs/concepts/workloads/controllers/replicationcontroller/)
|
||||
: A replication controller ensures that a specified number of pod replicas are running at any one time. It both allows for easy scaling of replicated systems and handles re-creation of a pod when the machine it is on reboots or otherwise fails.
|
||||
|
||||
[**Service**](/docs/user-guide/services/)
|
||||
[**Service**](/docs/concepts/services-networking/service/)
|
||||
: A service defines a set of pods and a means by which to access them, such as single stable IP address and corresponding DNS name.
|
||||
|
||||
[**Volume**](/docs/concepts/storage/volumes/)
|
||||
: A volume is a directory, possibly with some data in it, which is accessible to a Container as part of its filesystem. Kubernetes volumes build upon [Docker Volumes](https://docs.docker.com/engine/tutorials/dockervolumes/), adding provisioning of the volume directory and/or device.
|
||||
|
||||
[**Secret**](/docs/user-guide/secrets/)
|
||||
[**Secret**](/docs/concepts/configuration/secret/)
|
||||
: A secret stores sensitive data, such as authentication tokens, which can be made available to containers upon request.
|
||||
|
||||
[**Name**](/docs/user-guide/identifiers/)
|
||||
[**Name**](/docs/concepts/overview/working-with-objects/names/)
|
||||
: A user- or client-provided name for a resource.
|
||||
|
||||
[**Namespace**](/docs/user-guide/namespaces/)
|
||||
[**Namespace**](/docs/concepts/overview/working-with-objects/namespaces/)
|
||||
: A namespace is like a prefix to the name of a resource. Namespaces help different projects, teams, or customers to share a cluster, such as by preventing name collisions between unrelated teams.
|
||||
|
||||
[**Annotation**](/docs/user-guide/annotations/)
|
||||
[**Annotation**](/docs/concepts/overview/working-with-objects/annotations/)
|
||||
: A key/value pair that can hold larger (compared to a label), and possibly not human-readable, data, intended to store non-identifying auxiliary data, especially data manipulated by tools and system extensions. Efficient filtering by annotation values is not supported.
|
||||
|
||||
## Further reading
|
||||
|
||||
API resources
|
||||
|
||||
* [Working with resources](/docs/user-guide/working-with-resources/)
|
||||
* [Working with resources](/docs/concepts/tools/kubectl/object-management-overview/)
|
||||
|
||||
Pods and containers
|
||||
|
||||
* [Pod lifecycle and restart policies](/docs/user-guide/pod-states/)
|
||||
* [Pod lifecycle and restart policies](/docs/concepts/workloads/pods/pod-lifecycle/)
|
||||
* [Lifecycle hooks](/docs/concepts/containers/container-lifecycle-hooks/)
|
||||
* [Compute resources, such as cpu and memory](/docs/user-guide/compute-resources/)
|
||||
* [Compute resources, such as cpu and memory](/docs/concepts/configuration/manage-compute-resources-container/)
|
||||
* [Specifying commands and requesting capabilities](/docs/user-guide/containers/)
|
||||
* [Downward API: accessing system configuration from a pod](/docs/user-guide/downward-api/)
|
||||
* [Downward API: accessing system configuration from a pod](/docs/tasks/configure-pod-container/downward-api-volume-expose-pod-information/)
|
||||
* [Images and registries](/docs/concepts/containers/images/)
|
||||
* [Migrating from docker-cli to kubectl](/docs/user-guide/docker-cli-to-kubectl/)
|
||||
* [Configuration Best Practices and Tips](/docs/concepts/configuration/overview/)
|
||||
* [Assign pods to selected nodes](/docs/user-guide/node-selection/)
|
||||
* [Assign pods to selected nodes](/docs/concepts/configuration/assign-pod-node/)
|
||||
* [Perform a rolling update on a running group of pods](/docs/tasks/run-application/rolling-update-replication-controller/)
|
||||
|
||||
[Developer Guide]: https://github.com/kubernetes/community/blob/master/contributors/devel/README.md
|
||||
|
||||
@@ -27,7 +27,7 @@ If you haven't installed and configured kubectl, finish [installing kubectl](/do
|
||||
|
||||
In Kubernetes, a group of one or more containers is called a _pod_. Containers in a pod are deployed together, and are started, stopped, and replicated as a group.
|
||||
|
||||
See [pods](/docs/user-guide/pods/) for more details.
|
||||
See [pods](/docs/concepts/workloads/pods/pod/) for more details.
|
||||
|
||||
|
||||
#### Pod Definition
|
||||
@@ -55,7 +55,7 @@ List all pods:
|
||||
$ kubectl get pods
|
||||
```
|
||||
|
||||
On most providers, the pod IPs are not externally accessible. The easiest way to test that the pod is working is to create a busybox pod and exec commands on it remotely. See the [command execution documentation](/docs/user-guide/getting-into-containers/) for details.
|
||||
On most providers, the pod IPs are not externally accessible. The easiest way to test that the pod is working is to create a busybox pod and exec commands on it remotely. See the [command execution documentation](/docs/tasks/kubectl/get-shell-running-container/) for details.
|
||||
|
||||
Provided the pod IP is accessible, you should be able to access its http endpoint with wget on port 80:
|
||||
|
||||
|
||||
@@ -106,7 +106,7 @@ Delete the Deployment by name:
|
||||
kubectl delete deployment nginx-deployment
|
||||
```
|
||||
|
||||
For more information, such as how to rollback Deployment changes to a previous version, see [_Deployments_](/docs/user-guide/deployments/).
|
||||
For more information, such as how to rollback Deployment changes to a previous version, see [_Deployments_](/docs/concepts/workloads/controllers/deployment/).
|
||||
|
||||
|
||||
## Services
|
||||
@@ -156,7 +156,7 @@ kubectl delete service nginx-service
|
||||
|
||||
When created, each service is assigned a unique IP address. This address is tied to the lifespan of the Service, and will not change while the Service is alive. Pods can be configured to talk to the service, and know that communication to the service will be automatically load-balanced out to some Pod that is a member of the set identified by the label selector in the Service.
|
||||
|
||||
For more information, see [Services](/docs/user-guide/services/).
|
||||
For more information, see [Services](/docs/concepts/services-networking/service/).
|
||||
|
||||
|
||||
## Health Checking
|
||||
|
||||
Reference in New Issue
Block a user