 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Index ¶
- Constants
- Variables
- func AddToScheme(scheme *runtime.Scheme)
- type AuthorizationAttributes
- type ClusterPolicy
- type ClusterPolicyBinding
- type ClusterPolicyBindingList
- type ClusterPolicyList
- type ClusterRole
- type ClusterRoleBinding
- type ClusterRoleBindingList
- type ClusterRoleList
- type IsPersonalSubjectAccessReview
- type LocalResourceAccessReview
- type LocalSubjectAccessReview
- type NamedClusterRole
- type NamedClusterRoleBinding
- type NamedRole
- type NamedRoleBinding
- type Policy
- type PolicyBinding
- type PolicyBindingList
- type PolicyList
- type PolicyRule
- type ResourceAccessReview
- type ResourceAccessReviewResponse
- type Role
- type RoleBinding
- type RoleBindingList
- type RoleList
- type SubjectAccessReview
- type SubjectAccessReviewResponse
Constants ¶
const GroupName = ""
    Variables ¶
var SchemeGroupVersion = unversioned.GroupVersion{Group: GroupName, Version: "v1"}
    SchemeGroupVersion is group version used to register these objects
Functions ¶
Types ¶
type AuthorizationAttributes ¶ added in v1.0.5
type AuthorizationAttributes struct {
	// Namespace is the namespace of the action being requested.  Currently, there is no distinction between no namespace and all namespaces
	Namespace string `json:"namespace"`
	// Verb is one of: get, list, watch, create, update, delete
	Verb string `json:"verb"`
	// Group is the API group of the resource
	// Serialized as resourceAPIGroup to avoid confusion with the 'groups' field when inlined
	Group string `json:"resourceAPIGroup"`
	// Version is the API version of the resource
	// Serialized as resourceAPIVersion to avoid confusion with TypeMeta.apiVersion and ObjectMeta.resourceVersion when inlined
	Version string `json:"resourceAPIVersion"`
	// Resource is one of the existing resource types
	Resource string `json:"resource"`
	// ResourceName is the name of the resource being requested for a "get" or deleted for a "delete"
	ResourceName string `json:"resourceName"`
	// Content is the actual content of the request for create and update
	Content kruntime.RawExtension `json:"content,omitempty"`
}
    AuthorizationAttributes describes a request to the API server
func (AuthorizationAttributes) SwaggerDoc ¶ added in v1.1.4
func (AuthorizationAttributes) SwaggerDoc() map[string]string
type ClusterPolicy ¶
type ClusterPolicy struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	kapi.ObjectMeta `json:"metadata,omitempty"`
	// LastModified is the last time that any part of the ClusterPolicy was created, updated, or deleted
	LastModified unversioned.Time `json:"lastModified"`
	// Roles holds all the ClusterRoles held by this ClusterPolicy, mapped by ClusterRole.Name
	Roles []NamedClusterRole `json:"roles"`
}
    ClusterPolicy is a object that holds all the ClusterRoles for a particular namespace. There is at most one ClusterPolicy document per namespace.
func (*ClusterPolicy) GetObjectKind ¶ added in v1.1.3
func (obj *ClusterPolicy) GetObjectKind() unversioned.ObjectKind
func (ClusterPolicy) SwaggerDoc ¶ added in v1.1.4
func (ClusterPolicy) SwaggerDoc() map[string]string
type ClusterPolicyBinding ¶
type ClusterPolicyBinding struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	kapi.ObjectMeta `json:"metadata,omitempty"`
	// LastModified is the last time that any part of the ClusterPolicyBinding was created, updated, or deleted
	LastModified unversioned.Time `json:"lastModified"`
	// PolicyRef is a reference to the ClusterPolicy that contains all the ClusterRoles that this ClusterPolicyBinding's RoleBindings may reference
	PolicyRef kapi.ObjectReference `json:"policyRef"`
	// RoleBindings holds all the ClusterRoleBindings held by this ClusterPolicyBinding, mapped by ClusterRoleBinding.Name
	RoleBindings []NamedClusterRoleBinding `json:"roleBindings"`
}
    ClusterPolicyBinding is a object that holds all the ClusterRoleBindings for a particular namespace. There is one ClusterPolicyBinding document per referenced ClusterPolicy namespace
func (*ClusterPolicyBinding) GetObjectKind ¶ added in v1.1.3
func (obj *ClusterPolicyBinding) GetObjectKind() unversioned.ObjectKind
func (ClusterPolicyBinding) SwaggerDoc ¶ added in v1.1.4
func (ClusterPolicyBinding) SwaggerDoc() map[string]string
type ClusterPolicyBindingList ¶
type ClusterPolicyBindingList struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	unversioned.ListMeta `json:"metadata,omitempty"`
	// Items is a list of ClusterPolicyBindings
	Items []ClusterPolicyBinding `json:"items"`
}
    ClusterPolicyBindingList is a collection of ClusterPolicyBindings
func (*ClusterPolicyBindingList) GetObjectKind ¶ added in v1.1.3
func (obj *ClusterPolicyBindingList) GetObjectKind() unversioned.ObjectKind
func (ClusterPolicyBindingList) SwaggerDoc ¶ added in v1.1.4
func (ClusterPolicyBindingList) SwaggerDoc() map[string]string
type ClusterPolicyList ¶
type ClusterPolicyList struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	unversioned.ListMeta `json:"metadata,omitempty"`
	// Items is a list of ClusterPolicies
	Items []ClusterPolicy `json:"items"`
}
    ClusterPolicyList is a collection of ClusterPolicies
func (*ClusterPolicyList) GetObjectKind ¶ added in v1.1.3
func (obj *ClusterPolicyList) GetObjectKind() unversioned.ObjectKind
func (ClusterPolicyList) SwaggerDoc ¶ added in v1.1.4
func (ClusterPolicyList) SwaggerDoc() map[string]string
type ClusterRole ¶
type ClusterRole struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	kapi.ObjectMeta `json:"metadata,omitempty"`
	// Rules holds all the PolicyRules for this ClusterRole
	Rules []PolicyRule `json:"rules"`
}
    ClusterRole is a logical grouping of PolicyRules that can be referenced as a unit by ClusterRoleBindings.
func (*ClusterRole) GetObjectKind ¶ added in v1.1.3
func (obj *ClusterRole) GetObjectKind() unversioned.ObjectKind
func (ClusterRole) SwaggerDoc ¶ added in v1.1.4
func (ClusterRole) SwaggerDoc() map[string]string
type ClusterRoleBinding ¶
type ClusterRoleBinding struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	kapi.ObjectMeta `json:"metadata,omitempty"`
	// UserNames holds all the usernames directly bound to the role
	UserNames []string `json:"userNames"`
	// GroupNames holds all the groups directly bound to the role
	GroupNames []string `json:"groupNames"`
	// Subjects hold object references to authorize with this rule
	Subjects []kapi.ObjectReference `json:"subjects"`
	// RoleRef can only reference the current namespace and the global namespace
	// If the ClusterRoleRef cannot be resolved, the Authorizer must return an error.
	// Since Policy is a singleton, this is sufficient knowledge to locate a role
	RoleRef kapi.ObjectReference `json:"roleRef"`
}
    ClusterRoleBinding references a ClusterRole, but not contain it. It can reference any ClusterRole in the same namespace or in the global namespace. It adds who information via Users and Groups and namespace information by which namespace it exists in. ClusterRoleBindings in a given namespace only have effect in that namespace (excepting the master namespace which has power in all namespaces).
func (*ClusterRoleBinding) GetObjectKind ¶ added in v1.1.3
func (obj *ClusterRoleBinding) GetObjectKind() unversioned.ObjectKind
func (ClusterRoleBinding) SwaggerDoc ¶ added in v1.1.4
func (ClusterRoleBinding) SwaggerDoc() map[string]string
type ClusterRoleBindingList ¶
type ClusterRoleBindingList struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	unversioned.ListMeta `json:"metadata,omitempty"`
	// Items is a list of ClusterRoleBindings
	Items []ClusterRoleBinding `json:"items"`
}
    ClusterRoleBindingList is a collection of ClusterRoleBindings
func (*ClusterRoleBindingList) GetObjectKind ¶ added in v1.1.3
func (obj *ClusterRoleBindingList) GetObjectKind() unversioned.ObjectKind
func (ClusterRoleBindingList) SwaggerDoc ¶ added in v1.1.4
func (ClusterRoleBindingList) SwaggerDoc() map[string]string
type ClusterRoleList ¶
type ClusterRoleList struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	unversioned.ListMeta `json:"metadata,omitempty"`
	// Items is a list of ClusterRoles
	Items []ClusterRole `json:"items"`
}
    ClusterRoleList is a collection of ClusterRoles
func (*ClusterRoleList) GetObjectKind ¶ added in v1.1.3
func (obj *ClusterRoleList) GetObjectKind() unversioned.ObjectKind
func (ClusterRoleList) SwaggerDoc ¶ added in v1.1.4
func (ClusterRoleList) SwaggerDoc() map[string]string
type IsPersonalSubjectAccessReview ¶
type IsPersonalSubjectAccessReview struct {
	unversioned.TypeMeta `json:",inline"`
}
    IsPersonalSubjectAccessReview is a marker for PolicyRule.AttributeRestrictions that denotes that subjectaccessreviews on self should be allowed
func (*IsPersonalSubjectAccessReview) GetObjectKind ¶ added in v1.1.3
func (obj *IsPersonalSubjectAccessReview) GetObjectKind() unversioned.ObjectKind
func (IsPersonalSubjectAccessReview) SwaggerDoc ¶ added in v1.1.4
func (IsPersonalSubjectAccessReview) SwaggerDoc() map[string]string
type LocalResourceAccessReview ¶ added in v1.0.5
type LocalResourceAccessReview struct {
	unversioned.TypeMeta `json:",inline"`
	// AuthorizationAttributes describes the action being tested.  The Namespace element is FORCED to the current namespace.
	AuthorizationAttributes `json:",inline"`
}
    LocalResourceAccessReview is a means to request a list of which users and groups are authorized to perform the action specified by spec in a particular namespace
func (*LocalResourceAccessReview) GetObjectKind ¶ added in v1.1.3
func (obj *LocalResourceAccessReview) GetObjectKind() unversioned.ObjectKind
func (LocalResourceAccessReview) SwaggerDoc ¶ added in v1.1.4
func (LocalResourceAccessReview) SwaggerDoc() map[string]string
type LocalSubjectAccessReview ¶ added in v1.0.5
type LocalSubjectAccessReview struct {
	unversioned.TypeMeta `json:",inline"`
	// AuthorizationAttributes describes the action being tested.  The Namespace element is FORCED to the current namespace.
	AuthorizationAttributes `json:",inline"`
	// User is optional.  If both User and Groups are empty, the current authenticated user is used.
	User string `json:"user"`
	// Groups is optional.  Groups is the list of groups to which the User belongs.
	GroupsSlice []string `json:"groups"`
}
    LocalSubjectAccessReview is an object for requesting information about whether a user or group can perform an action in a particular namespace
func (*LocalSubjectAccessReview) GetObjectKind ¶ added in v1.1.3
func (obj *LocalSubjectAccessReview) GetObjectKind() unversioned.ObjectKind
func (LocalSubjectAccessReview) SwaggerDoc ¶ added in v1.1.4
func (LocalSubjectAccessReview) SwaggerDoc() map[string]string
type NamedClusterRole ¶
type NamedClusterRole struct {
	// Name is the name of the cluster role
	Name string `json:"name"`
	// Role is the cluster role being named
	Role ClusterRole `json:"role"`
}
    NamedClusterRole relates a name with a cluster role
func (NamedClusterRole) SwaggerDoc ¶ added in v1.1.4
func (NamedClusterRole) SwaggerDoc() map[string]string
type NamedClusterRoleBinding ¶
type NamedClusterRoleBinding struct {
	// Name is the name of the cluster role binding
	Name string `json:"name"`
	// RoleBinding is the cluster role binding being named
	RoleBinding ClusterRoleBinding `json:"roleBinding"`
}
    NamedClusterRoleBinding relates a name with a cluster role binding
func (NamedClusterRoleBinding) SwaggerDoc ¶ added in v1.1.4
func (NamedClusterRoleBinding) SwaggerDoc() map[string]string
type NamedRole ¶
type NamedRole struct {
	// Name is the name of the role
	Name string `json:"name"`
	// Role is the role being named
	Role Role `json:"role"`
}
    NamedRole relates a Role with a name
type NamedRoleBinding ¶
type NamedRoleBinding struct {
	// Name is the name of the role binding
	Name string `json:"name"`
	// RoleBinding is the role binding being named
	RoleBinding RoleBinding `json:"roleBinding"`
}
    NamedRoleBinding relates a role binding with a name
func (NamedRoleBinding) SwaggerDoc ¶ added in v1.1.4
func (NamedRoleBinding) SwaggerDoc() map[string]string
type Policy ¶
type Policy struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	kapi.ObjectMeta `json:"metadata,omitempty"`
	// LastModified is the last time that any part of the Policy was created, updated, or deleted
	LastModified unversioned.Time `json:"lastModified"`
	// Roles holds all the Roles held by this Policy, mapped by Role.Name
	Roles []NamedRole `json:"roles"`
}
    Policy is a object that holds all the Roles for a particular namespace. There is at most one Policy document per namespace.
func (*Policy) GetObjectKind ¶ added in v1.1.3
func (obj *Policy) GetObjectKind() unversioned.ObjectKind
type PolicyBinding ¶
type PolicyBinding struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	kapi.ObjectMeta `json:"metadata,omitempty"`
	// LastModified is the last time that any part of the PolicyBinding was created, updated, or deleted
	LastModified unversioned.Time `json:"lastModified"`
	// PolicyRef is a reference to the Policy that contains all the Roles that this PolicyBinding's RoleBindings may reference
	PolicyRef kapi.ObjectReference `json:"policyRef"`
	// RoleBindings holds all the RoleBindings held by this PolicyBinding, mapped by RoleBinding.Name
	RoleBindings []NamedRoleBinding `json:"roleBindings"`
}
    PolicyBinding is a object that holds all the RoleBindings for a particular namespace. There is one PolicyBinding document per referenced Policy namespace
func (*PolicyBinding) GetObjectKind ¶ added in v1.1.3
func (obj *PolicyBinding) GetObjectKind() unversioned.ObjectKind
func (PolicyBinding) SwaggerDoc ¶ added in v1.1.4
func (PolicyBinding) SwaggerDoc() map[string]string
type PolicyBindingList ¶
type PolicyBindingList struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	unversioned.ListMeta `json:"metadata,omitempty"`
	// Items is a list of PolicyBindings
	Items []PolicyBinding `json:"items"`
}
    PolicyBindingList is a collection of PolicyBindings
func (*PolicyBindingList) GetObjectKind ¶ added in v1.1.3
func (obj *PolicyBindingList) GetObjectKind() unversioned.ObjectKind
func (PolicyBindingList) SwaggerDoc ¶ added in v1.1.4
func (PolicyBindingList) SwaggerDoc() map[string]string
type PolicyList ¶
type PolicyList struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	unversioned.ListMeta `json:"metadata,omitempty"`
	// Items is a list of Policies
	Items []Policy `json:"items"`
}
    PolicyList is a collection of Policies
func (*PolicyList) GetObjectKind ¶ added in v1.1.3
func (obj *PolicyList) GetObjectKind() unversioned.ObjectKind
func (PolicyList) SwaggerDoc ¶ added in v1.1.4
func (PolicyList) SwaggerDoc() map[string]string
type PolicyRule ¶
type PolicyRule struct {
	// Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule.  VerbAll represents all kinds.
	Verbs []string `json:"verbs"`
	// AttributeRestrictions will vary depending on what the Authorizer/AuthorizationAttributeBuilder pair supports.
	// If the Authorizer does not recognize how to handle the AttributeRestrictions, the Authorizer should report an error.
	AttributeRestrictions kruntime.RawExtension `json:"attributeRestrictions,omitempty"`
	// APIGroups is the name of the APIGroup that contains the resources.  If this field is empty, then both kubernetes and origin API groups are assumed.
	// That means that if an action is requested against one of the enumerated resources in either the kubernetes or the origin API group, the request
	// will be allowed
	APIGroups []string `json:"apiGroups"`
	// Resources is a list of resources this rule applies to.  ResourceAll represents all resources.
	Resources []string `json:"resources"`
	// ResourceNames is an optional white list of names that the rule applies to.  An empty set means that everything is allowed.
	ResourceNames []string `json:"resourceNames,omitempty"`
	// NonResourceURLsSlice 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
	// This name is intentionally different than the internal type so that the DefaultConvert works nicely and because the ordering may be different.
	NonResourceURLsSlice []string `json:"nonResourceURLs,omitempty"`
}
    PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.
func (PolicyRule) SwaggerDoc ¶ added in v1.1.4
func (PolicyRule) SwaggerDoc() map[string]string
type ResourceAccessReview ¶
type ResourceAccessReview struct {
	unversioned.TypeMeta `json:",inline"`
	// AuthorizationAttributes describes the action being tested.
	AuthorizationAttributes `json:",inline"`
}
    ResourceAccessReview is a means to request a list of which users and groups are authorized to perform the action specified by spec
func (*ResourceAccessReview) GetObjectKind ¶ added in v1.1.3
func (obj *ResourceAccessReview) GetObjectKind() unversioned.ObjectKind
func (ResourceAccessReview) SwaggerDoc ¶ added in v1.1.4
func (ResourceAccessReview) SwaggerDoc() map[string]string
type ResourceAccessReviewResponse ¶
type ResourceAccessReviewResponse struct {
	unversioned.TypeMeta `json:",inline"`
	// Namespace is the namespace used for the access review
	Namespace string `json:"namespace,omitempty"`
	// UsersSlice is the list of users who can perform the action
	UsersSlice []string `json:"users"`
	// GroupsSlice is the list of groups who can perform the action
	GroupsSlice []string `json:"groups"`
}
    ResourceAccessReviewResponse describes who can perform the action
func (*ResourceAccessReviewResponse) GetObjectKind ¶ added in v1.1.3
func (obj *ResourceAccessReviewResponse) GetObjectKind() unversioned.ObjectKind
func (ResourceAccessReviewResponse) SwaggerDoc ¶ added in v1.1.4
func (ResourceAccessReviewResponse) SwaggerDoc() map[string]string
type Role ¶
type Role struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	kapi.ObjectMeta `json:"metadata,omitempty"`
	// Rules holds all the PolicyRules for this Role
	Rules []PolicyRule `json:"rules"`
}
    Role is a logical grouping of PolicyRules that can be referenced as a unit by RoleBindings.
func (*Role) GetObjectKind ¶ added in v1.1.3
func (obj *Role) GetObjectKind() unversioned.ObjectKind
type RoleBinding ¶
type RoleBinding struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	kapi.ObjectMeta `json:"metadata,omitempty"`
	// UserNames holds all the usernames directly bound to the role
	UserNames []string `json:"userNames"`
	// GroupNames holds all the groups directly bound to the role
	GroupNames []string `json:"groupNames"`
	// Subjects hold object references to authorize with this rule
	Subjects []kapi.ObjectReference `json:"subjects"`
	// RoleRef can only reference the current namespace and the global namespace
	// If the RoleRef cannot be resolved, the Authorizer must return an error.
	// Since Policy is a singleton, this is sufficient knowledge to locate a role
	RoleRef kapi.ObjectReference `json:"roleRef"`
}
    RoleBinding references a Role, but not contain it. It can reference any Role in the same namespace or in the global namespace. It adds who information via Users and Groups and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace (excepting the master namespace which has power in all namespaces).
func (*RoleBinding) GetObjectKind ¶ added in v1.1.3
func (obj *RoleBinding) GetObjectKind() unversioned.ObjectKind
func (RoleBinding) SwaggerDoc ¶ added in v1.1.4
func (RoleBinding) SwaggerDoc() map[string]string
type RoleBindingList ¶
type RoleBindingList struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	unversioned.ListMeta `json:"metadata,omitempty"`
	// Items is a list of RoleBindings
	Items []RoleBinding `json:"items"`
}
    RoleBindingList is a collection of RoleBindings
func (*RoleBindingList) GetObjectKind ¶ added in v1.1.3
func (obj *RoleBindingList) GetObjectKind() unversioned.ObjectKind
func (RoleBindingList) SwaggerDoc ¶ added in v1.1.4
func (RoleBindingList) SwaggerDoc() map[string]string
type RoleList ¶
type RoleList struct {
	unversioned.TypeMeta `json:",inline"`
	// Standard object's metadata.
	unversioned.ListMeta `json:"metadata,omitempty"`
	// Items is a list of Roles
	Items []Role `json:"items"`
}
    RoleList is a collection of Roles
func (*RoleList) GetObjectKind ¶ added in v1.1.3
func (obj *RoleList) GetObjectKind() unversioned.ObjectKind
type SubjectAccessReview ¶
type SubjectAccessReview struct {
	unversioned.TypeMeta `json:",inline"`
	// AuthorizationAttributes describes the action being tested.
	AuthorizationAttributes `json:",inline"`
	// User is optional. If both User and Groups are empty, the current authenticated user is used.
	User string `json:"user"`
	// GroupsSlice is optional. Groups is the list of groups to which the User belongs.
	GroupsSlice []string `json:"groups"`
}
    SubjectAccessReview is an object for requesting information about whether a user or group can perform an action
func (*SubjectAccessReview) GetObjectKind ¶ added in v1.1.3
func (obj *SubjectAccessReview) GetObjectKind() unversioned.ObjectKind
func (SubjectAccessReview) SwaggerDoc ¶ added in v1.1.4
func (SubjectAccessReview) SwaggerDoc() map[string]string
type SubjectAccessReviewResponse ¶
type SubjectAccessReviewResponse struct {
	unversioned.TypeMeta `json:",inline"`
	// Namespace is the namespace used for the access review
	Namespace string `json:"namespace,omitempty"`
	// Allowed is required.  True if the action would be allowed, false otherwise.
	Allowed bool `json:"allowed"`
	// Reason is optional.  It indicates why a request was allowed or denied.
	Reason string `json:"reason,omitempty"`
}
    SubjectAccessReviewResponse describes whether or not a user or group can perform an action
func (*SubjectAccessReviewResponse) GetObjectKind ¶ added in v1.1.3
func (obj *SubjectAccessReviewResponse) GetObjectKind() unversioned.ObjectKind
func (SubjectAccessReviewResponse) SwaggerDoc ¶ added in v1.1.4
func (SubjectAccessReviewResponse) SwaggerDoc() map[string]string
       Source Files
      ¶
      Source Files
      ¶
    
- conversion.go
- defaults.go
- register.go
- swagger_doc.go
- types.go