Skip to content

Commit 6e8de37

Browse files
Merge pull request #52897 from huzhengchuan/fix/incorrect_links_api
Automatic merge from submit-queue (batch tested with PRs 52556, 52897, 54342). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>. Fix broken links in api after moving proposals to subdirs **What this PR does / why we need it**: fix incorrect links in api after kubernetes/community#1010 **Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: fixes kubernetes/community#918 **Special notes for your reviewer**: CC @bgrant0607 **Release note**: ``` NONE ``` Kubernetes-commit: e02d4a985554ceeff1f4456693f71b419df599f6
2 parents f01cb15 + 7541c9b commit 6e8de37

10 files changed

+47
-47
lines changed

Godeps/Godeps.json

+20-20
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

batch/v1/generated.proto

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

batch/v1/types.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ type JobSpec struct {
107107
// and other jobs to not function correctly. However, You may see
108108
// `manualSelector=true` in jobs that were created with the old `extensions/v1beta1`
109109
// API.
110-
// More info: https://git.k8s.io/community/contributors/design-proposals/selector-generation.md
110+
// More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector
111111
// +optional
112112
ManualSelector *bool `json:"manualSelector,omitempty" protobuf:"varint,5,opt,name=manualSelector"`
113113

batch/v1/types_swagger_doc_generated.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ var map_JobSpec = map[string]string{
6969
"activeDeadlineSeconds": "Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer",
7070
"backoffLimit": "Specifies the number of retries before marking this job failed. Defaults to 6",
7171
"selector": "A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors",
72-
"manualSelector": "manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://git.k8s.io/community/contributors/design-proposals/selector-generation.md",
72+
"manualSelector": "manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector",
7373
"template": "Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/",
7474
}
7575

core/v1/generated.proto

+7-7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

core/v1/types.go

+7-7
Original file line numberDiff line numberDiff line change
@@ -1996,7 +1996,7 @@ type Container struct {
19961996
ImagePullPolicy PullPolicy `json:"imagePullPolicy,omitempty" protobuf:"bytes,14,opt,name=imagePullPolicy,casttype=PullPolicy"`
19971997
// Security options the pod should run with.
19981998
// More info: https://kubernetes.io/docs/concepts/policy/security-context/
1999-
// More info: https://git.k8s.io/community/contributors/design-proposals/security_context.md
1999+
// More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
20002000
// +optional
20012001
SecurityContext *SecurityContext `json:"securityContext,omitempty" protobuf:"bytes,15,opt,name=securityContext"`
20022002

@@ -3825,15 +3825,15 @@ const (
38253825
// NamespaceSpec describes the attributes on a Namespace.
38263826
type NamespaceSpec struct {
38273827
// Finalizers is an opaque list of values that must be empty to permanently remove object from storage.
3828-
// More info: https://git.k8s.io/community/contributors/design-proposals/namespaces.md#finalizers
3828+
// More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
38293829
// +optional
38303830
Finalizers []FinalizerName `json:"finalizers,omitempty" protobuf:"bytes,1,rep,name=finalizers,casttype=FinalizerName"`
38313831
}
38323832

38333833
// NamespaceStatus is information about the current status of a Namespace.
38343834
type NamespaceStatus struct {
38353835
// Phase is the current lifecycle phase of the namespace.
3836-
// More info: https://git.k8s.io/community/contributors/design-proposals/namespaces.md#phases
3836+
// More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
38373837
// +optional
38383838
Phase NamespacePhase `json:"phase,omitempty" protobuf:"bytes,1,opt,name=phase,casttype=NamespacePhase"`
38393839
}
@@ -4376,7 +4376,7 @@ type LimitRangeList struct {
43764376
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
43774377

43784378
// Items is a list of LimitRange objects.
4379-
// More info: https://git.k8s.io/community/contributors/design-proposals/admission_control_limit_range.md
4379+
// More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
43804380
Items []LimitRange `json:"items" protobuf:"bytes,2,rep,name=items"`
43814381
}
43824382

@@ -4433,7 +4433,7 @@ const (
44334433
// ResourceQuotaSpec defines the desired hard limits to enforce for Quota.
44344434
type ResourceQuotaSpec struct {
44354435
// Hard is the set of desired hard limits for each named resource.
4436-
// More info: https://git.k8s.io/community/contributors/design-proposals/admission_control_resource_quota.md
4436+
// More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
44374437
// +optional
44384438
Hard ResourceList `json:"hard,omitempty" protobuf:"bytes,1,rep,name=hard,casttype=ResourceList,castkey=ResourceName"`
44394439
// A collection of filters that must match each object tracked by a quota.
@@ -4445,7 +4445,7 @@ type ResourceQuotaSpec struct {
44454445
// ResourceQuotaStatus defines the enforced hard limits and observed use.
44464446
type ResourceQuotaStatus struct {
44474447
// Hard is the set of enforced hard limits for each named resource.
4448-
// More info: https://git.k8s.io/community/contributors/design-proposals/admission_control_resource_quota.md
4448+
// More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
44494449
// +optional
44504450
Hard ResourceList `json:"hard,omitempty" protobuf:"bytes,1,rep,name=hard,casttype=ResourceList,castkey=ResourceName"`
44514451
// Used is the current observed total usage of the resource in the namespace.
@@ -4486,7 +4486,7 @@ type ResourceQuotaList struct {
44864486
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
44874487

44884488
// Items is a list of ResourceQuota objects.
4489-
// More info: https://git.k8s.io/community/contributors/design-proposals/admission_control_resource_quota.md
4489+
// More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
44904490
Items []ResourceQuota `json:"items" protobuf:"bytes,2,rep,name=items"`
44914491
}
44924492

core/v1/types_swagger_doc_generated.go

+7-7
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ var map_Container = map[string]string{
284284
"terminationMessagePath": "Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.",
285285
"terminationMessagePolicy": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.",
286286
"imagePullPolicy": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
287-
"securityContext": "Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://git.k8s.io/community/contributors/design-proposals/security_context.md",
287+
"securityContext": "Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/",
288288
"stdin": "Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.",
289289
"stdinOnce": "Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false",
290290
"tty": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.",
@@ -765,7 +765,7 @@ func (LimitRangeItem) SwaggerDoc() map[string]string {
765765
var map_LimitRangeList = map[string]string{
766766
"": "LimitRangeList is a list of LimitRange items.",
767767
"metadata": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
768-
"items": "Items is a list of LimitRange objects. More info: https://git.k8s.io/community/contributors/design-proposals/admission_control_limit_range.md",
768+
"items": "Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/",
769769
}
770770

771771
func (LimitRangeList) SwaggerDoc() map[string]string {
@@ -866,7 +866,7 @@ func (NamespaceList) SwaggerDoc() map[string]string {
866866

867867
var map_NamespaceSpec = map[string]string{
868868
"": "NamespaceSpec describes the attributes on a Namespace.",
869-
"finalizers": "Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://git.k8s.io/community/contributors/design-proposals/namespaces.md#finalizers",
869+
"finalizers": "Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/",
870870
}
871871

872872
func (NamespaceSpec) SwaggerDoc() map[string]string {
@@ -875,7 +875,7 @@ func (NamespaceSpec) SwaggerDoc() map[string]string {
875875

876876
var map_NamespaceStatus = map[string]string{
877877
"": "NamespaceStatus is information about the current status of a Namespace.",
878-
"phase": "Phase is the current lifecycle phase of the namespace. More info: https://git.k8s.io/community/contributors/design-proposals/namespaces.md#phases",
878+
"phase": "Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/",
879879
}
880880

881881
func (NamespaceStatus) SwaggerDoc() map[string]string {
@@ -1683,7 +1683,7 @@ func (ResourceQuota) SwaggerDoc() map[string]string {
16831683
var map_ResourceQuotaList = map[string]string{
16841684
"": "ResourceQuotaList is a list of ResourceQuota items.",
16851685
"metadata": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
1686-
"items": "Items is a list of ResourceQuota objects. More info: https://git.k8s.io/community/contributors/design-proposals/admission_control_resource_quota.md",
1686+
"items": "Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/",
16871687
}
16881688

16891689
func (ResourceQuotaList) SwaggerDoc() map[string]string {
@@ -1692,7 +1692,7 @@ func (ResourceQuotaList) SwaggerDoc() map[string]string {
16921692

16931693
var map_ResourceQuotaSpec = map[string]string{
16941694
"": "ResourceQuotaSpec defines the desired hard limits to enforce for Quota.",
1695-
"hard": "Hard is the set of desired hard limits for each named resource. More info: https://git.k8s.io/community/contributors/design-proposals/admission_control_resource_quota.md",
1695+
"hard": "Hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/",
16961696
"scopes": "A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.",
16971697
}
16981698

@@ -1702,7 +1702,7 @@ func (ResourceQuotaSpec) SwaggerDoc() map[string]string {
17021702

17031703
var map_ResourceQuotaStatus = map[string]string{
17041704
"": "ResourceQuotaStatus defines the enforced hard limits and observed use.",
1705-
"hard": "Hard is the set of enforced hard limits for each named resource. More info: https://git.k8s.io/community/contributors/design-proposals/admission_control_resource_quota.md",
1705+
"hard": "Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/",
17061706
"used": "Used is the current observed total usage of the resource in the namespace.",
17071707
}
17081708

0 commit comments

Comments
 (0)