Skip to content

rbac_v1beta1

AggregationRule

class lightkube.models.rbac_v1beta1.AggregationRule(clusterRoleSelectors=None)

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

parameters

  • clusterRoleSelectors meta_v1.LabelSelector - (optional) ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added

ClusterRole

class lightkube.models.rbac_v1beta1.ClusterRole(aggregationRule=None, apiVersion=None, kind=None, metadata=None, rules=None)

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRole, and will no longer be served in v1.22.

parameters

  • aggregationRule AggregationRule - (optional) AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.
  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ObjectMeta - (optional) Standard object's metadata.
  • rules PolicyRule - (optional) Rules holds all the PolicyRules for this ClusterRole

ClusterRoleBinding

class lightkube.models.rbac_v1beta1.ClusterRoleBinding(roleRef, apiVersion=None, kind=None, metadata=None, subjects=None)

ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBinding, and will no longer be served in v1.22.

parameters

  • roleRef RoleRef - RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ObjectMeta - (optional) Standard object's metadata.
  • subjects Subject - (optional) Subjects holds references to the objects the role applies to.

ClusterRoleBindingList

class lightkube.models.rbac_v1beta1.ClusterRoleBindingList(items, apiVersion=None, kind=None, metadata=None)

ClusterRoleBindingList is a collection of ClusterRoleBindings. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBindingList, and will no longer be served in v1.22.

parameters

  • items ClusterRoleBinding - Items is a list of ClusterRoleBindings
  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ListMeta - (optional) Standard object's metadata.

ClusterRoleList

class lightkube.models.rbac_v1beta1.ClusterRoleList(items, apiVersion=None, kind=None, metadata=None)

ClusterRoleList is a collection of ClusterRoles. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoles, and will no longer be served in v1.22.

parameters

  • items ClusterRole - Items is a list of ClusterRoles
  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ListMeta - (optional) Standard object's metadata.

PolicyRule

class lightkube.models.rbac_v1beta1.PolicyRule(verbs, apiGroups=None, nonResourceURLs=None, resourceNames=None, resources=None)

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.

parameters

  • verbs List[str] - Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
  • apiGroups List[str] - (optional) 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.
  • nonResourceURLs List[str] - (optional) 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 Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
  • resourceNames List[str] - (optional) ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
  • resources List[str] - (optional) Resources is a list of resources this rule applies to. '' represents all resources in the specified apiGroups. '/foo' represents the subresource 'foo' for all resources in the specified apiGroups.

Role

class lightkube.models.rbac_v1beta1.Role(apiVersion=None, kind=None, metadata=None, rules=None)

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 Role, and will no longer be served in v1.22.

parameters

  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ObjectMeta - (optional) Standard object's metadata.
  • rules PolicyRule - (optional) Rules holds all the PolicyRules for this Role

RoleBinding

class lightkube.models.rbac_v1beta1.RoleBinding(roleRef, apiVersion=None, kind=None, metadata=None, subjects=None)

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. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBinding, and will no longer be served in v1.22.

parameters

  • roleRef RoleRef - RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ObjectMeta - (optional) Standard object's metadata.
  • subjects Subject - (optional) Subjects holds references to the objects the role applies to.

RoleBindingList

class lightkube.models.rbac_v1beta1.RoleBindingList(items, apiVersion=None, kind=None, metadata=None)

RoleBindingList is a collection of RoleBindings Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBindingList, and will no longer be served in v1.22.

parameters

  • items RoleBinding - Items is a list of RoleBindings
  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ListMeta - (optional) Standard object's metadata.

RoleList

class lightkube.models.rbac_v1beta1.RoleList(items, apiVersion=None, kind=None, metadata=None)

RoleList is a collection of Roles Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleList, and will no longer be served in v1.22.

parameters

  • items Role - Items is a list of Roles
  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ListMeta - (optional) Standard object's metadata.

RoleRef

class lightkube.models.rbac_v1beta1.RoleRef(apiGroup, kind, name)

RoleRef contains information that points to the role being used

parameters

  • apiGroup str - APIGroup is the group for the resource being referenced
  • kind str - Kind is the type of resource being referenced
  • name str - Name is the name of resource being referenced

Subject

class lightkube.models.rbac_v1beta1.Subject(kind, name, apiGroup=None, namespace=None)

Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.

parameters

  • kind str - Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
  • name str - Name of the object being referenced.
  • apiGroup str - (optional) APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
  • namespace str - (optional) Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.