blob: b16715bc492d82ea83fe6860a453a71e876961a6 [file] [log] [blame]
Zack Williamse940c7a2019-08-21 14:25:39 -07001/*
2Copyright The Kubernetes Authors.
3
4Licensed under the Apache License, Version 2.0 (the "License");
5you may not use this file except in compliance with the License.
6You may obtain a copy of the License at
7
8 http://www.apache.org/licenses/LICENSE-2.0
9
10Unless required by applicable law or agreed to in writing, software
11distributed under the License is distributed on an "AS IS" BASIS,
12WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13See the License for the specific language governing permissions and
14limitations under the License.
15*/
16
17
18// This file was autogenerated by go-to-protobuf. Do not edit it manually!
19
20syntax = 'proto2';
21
22package k8s.io.api.rbac.v1alpha1;
23
24import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto";
25import "k8s.io/apimachinery/pkg/runtime/generated.proto";
26import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
27
28// Package-wide variables from generator "generated".
29option go_package = "v1alpha1";
30
31// AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole
32message AggregationRule {
33 // ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules.
34 // If any of the selectors match, then the ClusterRole's permissions will be added
35 // +optional
36 repeated k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector clusterRoleSelectors = 1;
37}
38
39// ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.
40message ClusterRole {
41 // Standard object's metadata.
42 // +optional
43 optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
44
45 // Rules holds all the PolicyRules for this ClusterRole
46 // +optional
47 repeated PolicyRule rules = 2;
48
49 // AggregationRule is an optional field that describes how to build the Rules for this ClusterRole.
50 // If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be
51 // stomped by the controller.
52 // +optional
53 optional AggregationRule aggregationRule = 3;
54}
55
56// ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace,
57// and adds who information via Subject.
58message ClusterRoleBinding {
59 // Standard object's metadata.
60 // +optional
61 optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
62
63 // Subjects holds references to the objects the role applies to.
64 // +optional
65 repeated Subject subjects = 2;
66
67 // RoleRef can only reference a ClusterRole in the global namespace.
68 // If the RoleRef cannot be resolved, the Authorizer must return an error.
69 optional RoleRef roleRef = 3;
70}
71
72// ClusterRoleBindingList is a collection of ClusterRoleBindings
73message ClusterRoleBindingList {
74 // Standard object's metadata.
75 // +optional
76 optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
77
78 // Items is a list of ClusterRoleBindings
79 repeated ClusterRoleBinding items = 2;
80}
81
82// ClusterRoleList is a collection of ClusterRoles
83message ClusterRoleList {
84 // Standard object's metadata.
85 // +optional
86 optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
87
88 // Items is a list of ClusterRoles
89 repeated ClusterRole items = 2;
90}
91
92// PolicyRule holds information that describes a policy rule, but does not contain information
93// about who the rule applies to or which namespace the rule applies to.
94message PolicyRule {
95 // Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
96 repeated string verbs = 1;
97
98 // APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of
99 // the enumerated resources in any API group will be allowed.
100 // +optional
101 repeated string apiGroups = 3;
102
103 // Resources is a list of resources this rule applies to. ResourceAll represents all resources.
104 // +optional
105 repeated string resources = 4;
106
107 // ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
108 // +optional
109 repeated string resourceNames = 5;
110
111 // 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
112 // This name is intentionally different than the internal type so that the DefaultConvert works nicely and because the ordering may be different.
113 // Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.
114 // Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
115 // +optional
116 repeated string nonResourceURLs = 6;
117}
118
119// Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.
120message Role {
121 // Standard object's metadata.
122 // +optional
123 optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
124
125 // Rules holds all the PolicyRules for this Role
126 // +optional
127 repeated PolicyRule rules = 2;
128}
129
130// RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace.
131// It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given
132// namespace only have effect in that namespace.
133message RoleBinding {
134 // Standard object's metadata.
135 // +optional
136 optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
137
138 // Subjects holds references to the objects the role applies to.
139 // +optional
140 repeated Subject subjects = 2;
141
142 // RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace.
143 // If the RoleRef cannot be resolved, the Authorizer must return an error.
144 optional RoleRef roleRef = 3;
145}
146
147// RoleBindingList is a collection of RoleBindings
148message RoleBindingList {
149 // Standard object's metadata.
150 // +optional
151 optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
152
153 // Items is a list of RoleBindings
154 repeated RoleBinding items = 2;
155}
156
157// RoleList is a collection of Roles
158message RoleList {
159 // Standard object's metadata.
160 // +optional
161 optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
162
163 // Items is a list of Roles
164 repeated Role items = 2;
165}
166
167// RoleRef contains information that points to the role being used
168message RoleRef {
169 // APIGroup is the group for the resource being referenced
170 optional string apiGroup = 1;
171
172 // Kind is the type of resource being referenced
173 optional string kind = 2;
174
175 // Name is the name of resource being referenced
176 optional string name = 3;
177}
178
179// Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference,
180// or a value for non-objects such as user and group names.
181message Subject {
182 // Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount".
183 // If the Authorizer does not recognized the kind value, the Authorizer should report an error.
184 optional string kind = 1;
185
186 // APIVersion holds the API group and version of the referenced subject.
187 // Defaults to "v1" for ServiceAccount subjects.
188 // Defaults to "rbac.authorization.k8s.io/v1alpha1" for User and Group subjects.
189 // +k8s:conversion-gen=false
190 // +optional
191 optional string apiVersion = 2;
192
193 // Name of the object being referenced.
194 optional string name = 3;
195
196 // Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty
197 // the Authorizer should report an error.
198 // +optional
199 optional string namespace = 4;
200}
201