Skip to content

Commit 8dbf667

Browse files
author
Tim Bannister
committed
Omit API reference updates for v1.21
Omitting this merge to make it easier to merge in from primary branch and back in to the same primary branch.
1 parent dfaf833 commit 8dbf667

File tree

73 files changed

+5091
-5281
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+5091
-5281
lines changed

content/en/docs/reference/kubernetes-api/authorization-resources/self-subject-rules-review-v1.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,13 @@ SelfSubjectRulesReview enumerates the set of actions the current user can perfor
5151
<a name="NonResourceRule"></a>
5252
*NonResourceRule holds information that describes a rule for the non-resource*
5353

54-
- **status.nonResourceRules.verbs** ([]string), required
54+
- **status.nonResourceRules.verbs** ([]string), required
5555

56-
Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all.
56+
Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all.
5757

58-
- **status.nonResourceRules.nonResourceURLs** ([]string)
58+
- **status.nonResourceRules.nonResourceURLs** ([]string)
5959

60-
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path. "*" means all.
60+
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path. "*" means all.
6161

6262
- **status.resourceRules** ([]ResourceRule), required
6363

@@ -66,22 +66,22 @@ SelfSubjectRulesReview enumerates the set of actions the current user can perfor
6666
<a name="ResourceRule"></a>
6767
*ResourceRule is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.*
6868

69-
- **status.resourceRules.verbs** ([]string), required
69+
- **status.resourceRules.verbs** ([]string), required
7070

71-
Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all.
71+
Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all.
7272

73-
- **status.resourceRules.apiGroups** ([]string)
73+
- **status.resourceRules.apiGroups** ([]string)
7474

75-
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all.
75+
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all.
7676

77-
- **status.resourceRules.resourceNames** ([]string)
77+
- **status.resourceRules.resourceNames** ([]string)
7878

79-
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all.
79+
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all.
8080

81-
- **status.resourceRules.resources** ([]string)
81+
- **status.resourceRules.resources** ([]string)
8282

83-
Resources is a list of resources this rule applies to. "*" means all in the specified apiGroups.
84-
"*/foo" represents the subresource 'foo' for all resources in the specified apiGroups.
83+
Resources is a list of resources this rule applies to. "*" means all in the specified apiGroups.
84+
"*/foo" represents the subresource 'foo' for all resources in the specified apiGroups.
8585

8686
- **status.evaluationError** (string)
8787

content/en/docs/reference/kubernetes-api/cluster-resources/event-v1.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,16 @@ Event is a report of an event somewhere in the cluster. It generally denotes som
2626
- **kind**: Event
2727

2828

29-
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
30-
31-
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
32-
3329
- **eventTime** (MicroTime), required
3430

3531
eventTime is the time when this Event was first observed. It is required.
3632

3733
<a name="MicroTime"></a>
3834
*MicroTime is version of Time with microsecond level precision.*
3935

36+
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>), required
37+
38+
4039
- **action** (string)
4140

4241
action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field cannot be empty for new Events and it can have at most 128 characters.

content/en/docs/reference/kubernetes-api/cluster-resources/flow-schema-v1beta1.md

Lines changed: 51 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -92,43 +92,43 @@ FlowSchemaSpec describes how the FlowSchema's specification looks like.
9292
<a name="Subject"></a>
9393
*Subject matches the originator of a request, as identified by the request authentication system. There are three ways of matching an originator; by user, group, or service account.*
9494

95-
- **rules.subjects.kind** (string), required
95+
- **rules.subjects.kind** (string), required
9696

97-
Required
97+
Required
9898

99-
- **rules.subjects.group** (GroupSubject)
99+
- **rules.subjects.group** (GroupSubject)
100100

101101

102-
<a name="GroupSubject"></a>
103-
*GroupSubject holds detailed information for group-kind subject.*
102+
<a name="GroupSubject"></a>
103+
*GroupSubject holds detailed information for group-kind subject.*
104104

105-
- **rules.subjects.group.name** (string), required
105+
- **rules.subjects.group.name** (string), required
106106

107-
name is the user group that matches, or "*" to match all user groups. See https://github.com/kubernetes/apiserver/blob/master/pkg/authentication/user/user.go for some well-known group names. Required.
107+
name is the user group that matches, or "*" to match all user groups. See https://github.com/kubernetes/apiserver/blob/master/pkg/authentication/user/user.go for some well-known group names. Required.
108108

109-
- **rules.subjects.serviceAccount** (ServiceAccountSubject)
109+
- **rules.subjects.serviceAccount** (ServiceAccountSubject)
110110

111111

112-
<a name="ServiceAccountSubject"></a>
113-
*ServiceAccountSubject holds detailed information for service-account-kind subject.*
112+
<a name="ServiceAccountSubject"></a>
113+
*ServiceAccountSubject holds detailed information for service-account-kind subject.*
114114

115-
- **rules.subjects.serviceAccount.name** (string), required
115+
- **rules.subjects.serviceAccount.name** (string), required
116116

117-
`name` is the name of matching ServiceAccount objects, or "*" to match regardless of name. Required.
117+
`name` is the name of matching ServiceAccount objects, or "*" to match regardless of name. Required.
118118

119-
- **rules.subjects.serviceAccount.namespace** (string), required
119+
- **rules.subjects.serviceAccount.namespace** (string), required
120120

121-
`namespace` is the namespace of matching ServiceAccount objects. Required.
121+
`namespace` is the namespace of matching ServiceAccount objects. Required.
122122

123-
- **rules.subjects.user** (UserSubject)
123+
- **rules.subjects.user** (UserSubject)
124124

125125

126-
<a name="UserSubject"></a>
127-
*UserSubject holds detailed information for user-kind subject.*
126+
<a name="UserSubject"></a>
127+
*UserSubject holds detailed information for user-kind subject.*
128128

129-
- **rules.subjects.user.name** (string), required
129+
- **rules.subjects.user.name** (string), required
130130

131-
`name` is the username that matches, or "*" to match all usernames. Required.
131+
`name` is the username that matches, or "*" to match all usernames. Required.
132132

133133
- **rules.nonResourceRules** ([]NonResourcePolicyRule)
134134

@@ -139,23 +139,23 @@ FlowSchemaSpec describes how the FlowSchema's specification looks like.
139139
<a name="NonResourcePolicyRule"></a>
140140
*NonResourcePolicyRule is a predicate that matches non-resource requests according to their verb and the target non-resource URL. A NonResourcePolicyRule matches a request if and only if both (a) at least one member of verbs matches the request and (b) at least one member of nonResourceURLs matches the request.*
141141

142-
- **rules.nonResourceRules.nonResourceURLs** ([]string), required
142+
- **rules.nonResourceRules.nonResourceURLs** ([]string), required
143143

144-
*Set: unique values will be kept during a merge*
145-
146-
`nonResourceURLs` is a set of url prefixes that a user should have access to and may not be empty. For example:
147-
- "/healthz" is legal
148-
- "/hea*" is illegal
149-
- "/hea" is legal but matches nothing
150-
- "/hea/*" also matches nothing
151-
- "/healthz/*" matches all per-component health checks.
152-
"*" matches all non-resource urls. if it is present, it must be the only entry. Required.
144+
*Set: unique values will be kept during a merge*
145+
146+
`nonResourceURLs` is a set of url prefixes that a user should have access to and may not be empty. For example:
147+
- "/healthz" is legal
148+
- "/hea*" is illegal
149+
- "/hea" is legal but matches nothing
150+
- "/hea/*" also matches nothing
151+
- "/healthz/*" matches all per-component health checks.
152+
"*" matches all non-resource urls. if it is present, it must be the only entry. Required.
153153

154-
- **rules.nonResourceRules.verbs** ([]string), required
154+
- **rules.nonResourceRules.verbs** ([]string), required
155155

156-
*Set: unique values will be kept during a merge*
157-
158-
`verbs` is a list of matching verbs and may not be empty. "*" matches all verbs. If it is present, it must be the only entry. Required.
156+
*Set: unique values will be kept during a merge*
157+
158+
`verbs` is a list of matching verbs and may not be empty. "*" matches all verbs. If it is present, it must be the only entry. Required.
159159

160160
- **rules.resourceRules** ([]ResourcePolicyRule)
161161

@@ -166,33 +166,33 @@ FlowSchemaSpec describes how the FlowSchema's specification looks like.
166166
<a name="ResourcePolicyRule"></a>
167167
*ResourcePolicyRule is a predicate that matches some resource requests, testing the request's verb and the target resource. A ResourcePolicyRule matches a resource request if and only if: (a) at least one member of verbs matches the request, (b) at least one member of apiGroups matches the request, (c) at least one member of resources matches the request, and (d) least one member of namespaces matches the request.*
168168

169-
- **rules.resourceRules.apiGroups** ([]string), required
169+
- **rules.resourceRules.apiGroups** ([]string), required
170170

171-
*Set: unique values will be kept during a merge*
172-
173-
`apiGroups` is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required.
171+
*Set: unique values will be kept during a merge*
172+
173+
`apiGroups` is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required.
174174

175-
- **rules.resourceRules.resources** ([]string), required
175+
- **rules.resourceRules.resources** ([]string), required
176176

177-
*Set: unique values will be kept during a merge*
178-
179-
`resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required.
177+
*Set: unique values will be kept during a merge*
178+
179+
`resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required.
180180

181-
- **rules.resourceRules.verbs** ([]string), required
181+
- **rules.resourceRules.verbs** ([]string), required
182182

183-
*Set: unique values will be kept during a merge*
184-
185-
`verbs` is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required.
183+
*Set: unique values will be kept during a merge*
184+
185+
`verbs` is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required.
186186

187-
- **rules.resourceRules.clusterScope** (boolean)
187+
- **rules.resourceRules.clusterScope** (boolean)
188188

189-
`clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the `namespaces` field must contain a non-empty list.
189+
`clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the `namespaces` field must contain a non-empty list.
190190

191-
- **rules.resourceRules.namespaces** ([]string)
191+
- **rules.resourceRules.namespaces** ([]string)
192192

193-
*Set: unique values will be kept during a merge*
194-
195-
`namespaces` is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "*". Note that "*" matches any specified namespace but does not match a request that _does not specify_ a namespace (see the `clusterScope` field for that). This list may be empty, but only if `clusterScope` is true.
193+
*Set: unique values will be kept during a merge*
194+
195+
`namespaces` is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "*". Note that "*" matches any specified namespace but does not match a request that _does not specify_ a namespace (see the `clusterScope` field for that). This list may be empty, but only if `clusterScope` is true.
196196

197197

198198

0 commit comments

Comments
 (0)