Pod reference contains broken links to KEP

[oke-py]

This is a Bug Report

Problem:

These links are broken.

• https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md
• https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md
• https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md

Proposed Solution:

The correct links would be as follows.

• https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class
• https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates
• https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead

Page to Update:
https://kubernetes.io/docs/reference/kubernetes-api/workloads-resources/pod-v1/

The OpenAPI definition, not this page, should be modified, right?

[Cweiping]

It looks like it's being updated and needs to be regenerated.

/triage accepted
/language en
/kind bug

[jai]

@oke-py @Cweiping so this just involves regenerating the reference documentation from the OpenAPI spec, a la https://kubernetes.io/docs/contribute/generate-ref-docs/kubernetes-api/?

[jai]

/assign

[jai]

I regenerated the API docs, but the same links are still there (the broken ones).

These are the locations where they appear in the k8s source (just using the second broken link as an example):

staging/src/k8s.io/cli-runtime/artifacts/openapi/swagger.json
8905:          "description": "If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to \"True\" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md",

staging/src/k8s.io/api/core/v1/types_swagger_doc_generated.go
1644:	"readinessGates":                "If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to \"True\" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md",

staging/src/k8s.io/api/core/v1/types.go
3123:	// More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md

staging/src/k8s.io/api/core/v1/generated.proto
3570:  // More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md

staging/src/k8s.io/apiserver/pkg/endpoints/handlers/fieldmanager/testdata/swagger.json
2522:          "description": "If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to \"True\" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md",

staging/src/k8s.io/kubectl/testdata/openapi/swagger.json
8905:          "description": "If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to \"True\" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md",

api/openapi-spec/swagger.json
8908:          "description": "If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to \"True\" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md",

vendor/sigs.k8s.io/kustomize/kyaml/openapi/kubernetesapi/v1204/swagger.json
8550:          "description": "If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to \"True\" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md",

pkg/apis/core/types.go
2836:	// More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md

obviously some of them are generated but given that trunk still has these broken references I don't think generating the API docs helps. I'll see about submitting a PR into k8s source I guess.

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[jai]

/remove-lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Reopen this issue or PR with /reopen
• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

[k8s-ci-robot]

@k8s-triage-robot: Closing this issue.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Reopen this issue or PR with /reopen
• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[jai]

FYI this looks like it was fixed btw: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#pod-v1-core