Fix redirections for generated api references (#7890)
We have been using redirections in many pages when referencing the API docs generated. Since the relocation of the generated files, this is becoming difficult to maintain. This PR redirects all such links to the generated artifacts so we can easily detect missing links if any. closes: #7874
This commit is contained in:
@@ -281,5 +281,5 @@ on each kubelet where you want to reserve resources.
|
||||
## API Object
|
||||
|
||||
Node is a top-level resource in the Kubernetes REST API. More details about the
|
||||
API object can be found at: [Node API
|
||||
object](/docs/api-reference/{{page.version}}/#node-v1-core).
|
||||
API object can be found at:
|
||||
[Node API object](/docs/reference/generated/kubernetes-api/{{page.version}}/#node-v1-core).
|
||||
|
||||
@@ -47,7 +47,7 @@ and reports two healthy devices on a node, the node status is updated
|
||||
to advertise 2 `vendor-domain/foo`.
|
||||
|
||||
Then, users can request devices in a
|
||||
[Container](/docs/api-reference/{{page.version}}/#container-v1-core)
|
||||
[Container](/docs/reference/generated/kubernetes-api/{{page.version}}/#container-v1-core)
|
||||
specification as they request other types of resources, with the following limitations:
|
||||
* Extended resources are only supported as integer resources and cannot be overcommitted.
|
||||
* Devices cannot be shared among Containers.
|
||||
@@ -118,9 +118,9 @@ The canonical directory `/var/lib/kubelet/device-plugins` requires privileged ac
|
||||
so a device plugin must run in a privileged security context.
|
||||
If a device plugin is running as a DaemonSet, `/var/lib/kubelet/device-plugins`
|
||||
must be mounted as a
|
||||
[Volume](/docs/api-reference/{{page.version}}/#volume-v1-core)
|
||||
[Volume](/docs/reference/generated/kubernetes-api/{{page.version}}/#volume-v1-core)
|
||||
in the plugin's
|
||||
[PodSpec](/docs/api-reference/{{page.version}}/#podspec-v1-core).
|
||||
[PodSpec](/docs/reference/generated/kubernetes-api/{{page.version}}/#podspec-v1-core).
|
||||
|
||||
Kubernetes device plugin support is still in alpha. As development continues, its API version can
|
||||
change in incompatible ways. We recommend that device plugin developers do the following:
|
||||
|
||||
@@ -239,7 +239,7 @@ the node.
|
||||
|
||||
The amount of resources available to Pods is less than the node capacity, because
|
||||
system daemons use a portion of the available resources. The `allocatable` field
|
||||
[NodeStatus](/docs/api-reference/{{page.version}}/#nodestatus-v1-core)
|
||||
[NodeStatus](/docs/reference/generated/kubernetes-api/{{page.version}}/#nodestatus-v1-core)
|
||||
gives the amount of resources that are available to Pods. For more information, see
|
||||
[Node Allocatable Resources](https://git.k8s.io/community/contributors/design-proposals/node/node-allocatable.md).
|
||||
|
||||
@@ -534,9 +534,9 @@ consistency across providers and platforms.
|
||||
|
||||
* Get hands-on experience [assigning CPU resources to containers and pods](/docs/tasks/configure-pod-container/assign-cpu-resource/).
|
||||
|
||||
* [Container](/docs/api-reference/{{page.version}}/#container-v1-core)
|
||||
* [Container](/docs/reference/generated/kubernetes-api/{{page.version}}/#container-v1-core)
|
||||
|
||||
* [ResourceRequirements](/docs/api-reference/{{page.version}}/#resourcerequirements-v1-core)
|
||||
* [ResourceRequirements](/docs/reference/generated/kubernetes-api/{{page.version}}/#resourcerequirements-v1-core)
|
||||
|
||||
{% endcapture %}
|
||||
|
||||
|
||||
@@ -976,7 +976,7 @@ template:
|
||||
- [Managing Kubernetes Objects Using Imperative Commands](/docs/concepts/overview/object-management-kubectl/imperative-command/)
|
||||
- [Imperative Management of Kubernetes Objects Using Configuration Files](/docs/concepts/overview/object-management-kubectl/imperative-config/)
|
||||
- [Kubectl Command Reference](/docs/user-guide/kubectl/{{page.version}}/)
|
||||
- [Kubernetes API Reference](/docs/api-reference/{{page.version}}/)
|
||||
- [Kubernetes API Reference](/docs/reference/generated/kubernetes-api/{{page.version}}/)
|
||||
{% endcapture %}
|
||||
|
||||
{% include templates/concept.md %}
|
||||
|
||||
@@ -153,7 +153,7 @@ kubectl create --edit -f /tmp/srv.yaml
|
||||
- [Managing Kubernetes Objects Using Object Configuration (Imperative)](/docs/concepts/overview/object-management-kubectl/imperative-config/)
|
||||
- [Managing Kubernetes Objects Using Object Configuration (Declarative)](/docs/concepts/overview/object-management-kubectl/declarative-config/)
|
||||
- [Kubectl Command Reference](/docs/user-guide/kubectl/{{page.version}}/)
|
||||
- [Kubernetes API Reference](/docs/api-reference/{{page.version}}/)
|
||||
- [Kubernetes API Reference](/docs/reference/generated/kubernetes-api/{{page.version}}/)
|
||||
{% endcapture %}
|
||||
|
||||
{% include templates/concept.md %}
|
||||
|
||||
@@ -24,7 +24,7 @@ for a discussion of the advantages and disadvantage of each kind of object manag
|
||||
## How to create objects
|
||||
|
||||
You can use `kubectl create -f` to create an object from a configuration file.
|
||||
Refer to the [kubernetes API reference](/docs/api-reference/{{page.version}}/)
|
||||
Refer to the [kubernetes API reference](/docs/reference/generated/kubernetes-api/{{page.version}}/)
|
||||
for details.
|
||||
|
||||
- `kubectl create -f <filename|url>`
|
||||
@@ -131,7 +131,7 @@ template:
|
||||
- [Managing Kubernetes Objects Using Imperative Commands](/docs/concepts/overview/object-management-kubectl/imperative-command/)
|
||||
- [Managing Kubernetes Objects Using Object Configuration (Declarative)](/docs/concepts/overview/object-management-kubectl/declarative-config/)
|
||||
- [Kubectl Command Reference](/docs/user-guide/kubectl/{{page.version}}/)
|
||||
- [Kubernetes API Reference](/docs/api-reference/{{page.version}}/)
|
||||
- [Kubernetes API Reference](/docs/reference/generated/kubernetes-api/{{page.version}}/)
|
||||
{% endcapture %}
|
||||
|
||||
{% include templates/concept.md %}
|
||||
|
||||
@@ -66,7 +66,7 @@ operation (create, replace, etc.), optional flags and at least one file
|
||||
name. The file specified must contain a full definition of the object
|
||||
in YAML or JSON format.
|
||||
|
||||
See the [API reference](/docs/api-reference/{{page.version}}/)
|
||||
See the [API reference](/docs/reference/generated/kubernetes-api/{{page.version}}/)
|
||||
for more details on object definitions.
|
||||
|
||||
**Warning:** The imperative `replace` command replaces the existing
|
||||
@@ -168,7 +168,7 @@ Disadvantages compared to imperative object configuration:
|
||||
- [Managing Kubernetes Objects Using Object Configuration (Imperative)](/docs/concepts/overview/object-management-kubectl/imperative-config/)
|
||||
- [Managing Kubernetes Objects Using Object Configuration (Declarative)](/docs/concepts/overview/object-management-kubectl/declarative-config/)
|
||||
- [Kubectl Command Reference](/docs/user-guide/kubectl/{{page.version}}/)
|
||||
- [Kubernetes API Reference](/docs/api-reference/{{page.version}}/)
|
||||
- [Kubernetes API Reference](/docs/reference/generated/kubernetes-api/{{page.version}}/)
|
||||
|
||||
{% comment %}
|
||||
{% endcomment %}
|
||||
|
||||
@@ -64,7 +64,7 @@ This is equivalent to `kubectl create -f` the following yaml:
|
||||
|
||||
{% include code.html language="yaml" file="nginx-svc.yaml" ghlink="/docs/concepts/services-networking/nginx-svc.yaml" %}
|
||||
|
||||
This specification will create a Service which targets TCP port 80 on any Pod with the `run: my-nginx` label, and expose it on an abstracted Service port (`targetPort`: is the port the container accepts traffic on, `port`: is the abstracted Service port, which can be any port other pods use to access the Service). View [service API object](/docs/api-reference/{{page.version}}/#service-v1-core) to see the list of supported fields in service definition.
|
||||
This specification will create a Service which targets TCP port 80 on any Pod with the `run: my-nginx` label, and expose it on an abstracted Service port (`targetPort`: is the port the container accepts traffic on, `port`: is the abstracted Service port, which can be any port other pods use to access the Service). View [service API object](/docs/reference/generated/kubernetes-api/{{page.version}}/#service-v1-core) to see the list of supported fields in service definition.
|
||||
Check your Service:
|
||||
|
||||
```shell
|
||||
|
||||
@@ -25,7 +25,7 @@ Pods become isolated by having a NetworkPolicy that selects them. Once there is
|
||||
|
||||
## The `NetworkPolicy` Resource
|
||||
|
||||
See the [api-reference](/docs/api-reference/{{page.version}}/#networkpolicy-v1-networking) for a full definition of the resource.
|
||||
See the [NetworkPolicy](/docs/reference/generated/kubernetes-api/{{page.version}}/#networkpolicy-v1-networking) for a full definition of the resource.
|
||||
|
||||
An example `NetworkPolicy` might look like this:
|
||||
|
||||
|
||||
@@ -889,8 +889,8 @@ Iptables operations slow down dramatically in large scale cluster e.g 10,000 Ser
|
||||
## API Object
|
||||
|
||||
Service is a top-level resource in the Kubernetes REST API. More details about the
|
||||
API object can be found at: [Service API
|
||||
object](/docs/api-reference/{{page.version}}/#service-v1-core).
|
||||
API object can be found at:
|
||||
[Service API object](/docs/reference/generated/kubernetes-api/{{page.version}}/#service-v1-core).
|
||||
|
||||
## For More Information
|
||||
|
||||
|
||||
@@ -236,8 +236,8 @@ The ReplicationController is intended to be a composable building-block primitiv
|
||||
## API Object
|
||||
|
||||
Replication controller is a top-level resource in the Kubernetes REST API. More details about the
|
||||
API object can be found at: [ReplicationController API
|
||||
object](/docs/api-reference/{{page.version}}/#replicationcontroller-v1-core).
|
||||
API object can be found at:
|
||||
[ReplicationController API object](/docs/reference/generated/kubernetes-api/{{page.version}}/#replicationcontroller-v1-core).
|
||||
|
||||
## Alternatives to ReplicationController
|
||||
|
||||
|
||||
@@ -131,7 +131,7 @@ during application updates is configured in the controller spec.
|
||||
(Learn about [updating a deployment](/docs/concepts/workloads/controllers/deployment/#updating-a-deployment).)
|
||||
|
||||
When a pod is evicted using the eviction API, it is gracefully terminated (see
|
||||
`terminationGracePeriodSeconds` in [PodSpec](/docs/api-reference/{{page.version}}/#podspec-v1-core).)
|
||||
`terminationGracePeriodSeconds` in [PodSpec](/docs/reference/generated/kubernetes-api/{{page.version}}/#podspec-v1-core).)
|
||||
|
||||
## PDB Example
|
||||
|
||||
|
||||
@@ -32,7 +32,10 @@ Init Containers are exactly like regular Containers, except:
|
||||
If an Init Container fails for a Pod, Kubernetes restarts the Pod repeatedly until the Init
|
||||
Container succeeds. However, if the Pod has a `restartPolicy` of Never, it is not restarted.
|
||||
|
||||
To specify a Container as an Init Container, add the `initContainers` field on the PodSpec as a JSON array of objects of type [v1.Container](/docs/api-reference/{{page.version}}/#container-v1-core) alongside the app `containers` array.
|
||||
To specify a Container as an Init Container, add the `initContainers` field on the PodSpec as
|
||||
a JSON array of objects of type
|
||||
[Container](/docs/reference/generated/kubernetes-api/{{page.version}}/#container-v1-core)
|
||||
alongside the app `containers` array.
|
||||
The status of the init containers is returned in `status.initContainerStatuses`
|
||||
field as an array of the container statuses (similar to the `status.containerStatuses`
|
||||
field).
|
||||
|
||||
@@ -17,7 +17,7 @@ This page describes the lifecycle of a Pod.
|
||||
## Pod phase
|
||||
|
||||
A Pod's `status` field is a
|
||||
[PodStatus](/docs/api-reference/{{page.version}}/#podstatus-v1-core)
|
||||
[PodStatus](/docs/reference/generated/kubernetes-api/{{page.version}}/#podstatus-v1-core)
|
||||
object, which has a `phase` field.
|
||||
|
||||
The phase of a Pod is a simple, high-level summary of where the Pod is in its
|
||||
@@ -52,7 +52,7 @@ Here are the possible values for `phase`:
|
||||
## Pod conditions
|
||||
|
||||
A Pod has a PodStatus, which has an array of
|
||||
[PodConditions](/docs/api-reference/{{page.version}}/#podcondition-v1-core). Each element
|
||||
[PodConditions](/docs/reference/generated/kubernetes-api/{{page.version}}/#podcondition-v1-core). Each element
|
||||
of the PodCondition array has a `type` field and a `status` field. The `type`
|
||||
field is a string, with possible values PodScheduled, Ready, Initialized, and
|
||||
Unschedulable. The `status` field is a string, with possible values True, False,
|
||||
@@ -60,22 +60,22 @@ and Unknown.
|
||||
|
||||
## Container probes
|
||||
|
||||
A [Probe](/docs/api-reference/{{page.version}}/#probe-v1-core) is a diagnostic
|
||||
A [Probe](/docs/reference/generated/kubernetes-api/{{page.version}}/#probe-v1-core) is a diagnostic
|
||||
performed periodically by the [kubelet](/docs/admin/kubelet/)
|
||||
on a Container. To perform a diagnostic,
|
||||
the kubelet calls a
|
||||
[Handler](https://godoc.org/k8s.io/kubernetes/pkg/api/v1#Handler) implemented by
|
||||
the Container. There are three types of handlers:
|
||||
|
||||
* [ExecAction](/docs/api-reference/{{page.version}}/#execaction-v1-core):
|
||||
* [ExecAction](/docs/reference/generated/kubernetes-api/{{page.version}}/#execaction-v1-core):
|
||||
Executes a specified command inside the Container. The diagnostic
|
||||
is considered successful if the command exits with a status code of 0.
|
||||
|
||||
* [TCPSocketAction](/docs/api-reference/{{page.version}}/#tcpsocketaction-v1-core):
|
||||
* [TCPSocketAction](/docs/reference/generated/kubernetes-api/{{page.version}}/#tcpsocketaction-v1-core):
|
||||
Performs a TCP check against the Container's IP address on
|
||||
a specified port. The diagnostic is considered successful if the port is open.
|
||||
|
||||
* [HTTPGetAction](/docs/api-reference/{{page.version}}/#httpgetaction-v1-core):
|
||||
* [HTTPGetAction](/docs/reference/generated/kubernetes-api/{{page.version}}/#httpgetaction-v1-core):
|
||||
Performs an HTTP Get request against the Container's IP
|
||||
address on a specified port and path. The diagnostic is considered successful
|
||||
if the response has a status code greater than or equal to 200 and less than 400.
|
||||
@@ -129,11 +129,11 @@ to stop.
|
||||
## Pod and Container status
|
||||
|
||||
For detailed information about Pod Container status, see
|
||||
[PodStatus](/docs/api-reference/{{page.version}}/#podstatus-v1-core)
|
||||
[PodStatus](/docs/reference/generated/kubernetes-api/{{page.version}}/#podstatus-v1-core)
|
||||
and
|
||||
[ContainerStatus](/docs/api-reference/{{page.version}}/#containerstatus-v1-core).
|
||||
[ContainerStatus](/docs/reference/generated/kubernetes-api/{{page.version}}/#containerstatus-v1-core).
|
||||
Note that the information reported as Pod status depends on the current
|
||||
[ContainerState](/docs/api-reference/{{page.version}}/#containerstatus-v1-core).
|
||||
[ContainerState](/docs/reference/generated/kubernetes-api/{{page.version}}/#containerstatus-v1-core).
|
||||
|
||||
## Restart policy
|
||||
|
||||
|
||||
@@ -197,5 +197,5 @@ spec.containers[0].securityContext.privileged: forbidden '<*>(0xc20b222db0)true'
|
||||
## API Object
|
||||
|
||||
Pod is a top-level resource in the Kubernetes REST API. More details about the
|
||||
API object can be found at: [Pod API
|
||||
object](/docs/api-reference/{{page.version}}/#pod-v1-core).
|
||||
API object can be found at:
|
||||
[Pod API object](/docs/reference/generated/kubernetes-api/{{page.version}}/#pod-v1-core).
|
||||
|
||||
Reference in New Issue
Block a user