rancher v2.15.1

RoleTemplate

RoleTemplate holds configuration for a template that is used to create kubernetes Roles and ClusterRoles (in the rbac.authorization.k8s.io group) for a cluster or project.

16 fields
RoleTemplate fields and descriptions
Field / TypeDescription
administrative
boolean

Administrative field is deprecated and no longer used.

apiVersion
string

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: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

builtin
boolean

Builtin if true specifies that this RoleTemplate was created by Rancher and is immutable. Default to false.

clusterCreatorDefault
boolean

ClusterCreatorDefault if true, a binding with this RoleTemplate will be created for a users when they create a new cluster. ClusterCreatorDefault is only evaluated if the context of the RoleTemplate is set to cluster. Default to false.

context
string

Context describes if the roleTemplate applies to clusters or projects. Valid values are "project", "cluster" or "".

  • enum: ["project","cluster",""]
description
string

Description holds text that describes the resource.

displayName
string

DisplayName is the human-readable name displayed in the UI for this resource.

external
boolean

External if true specifies that rules for this RoleTemplate should be gathered from a ClusterRole with the matching name. If set to true the Rules on the template will not be evaluated. External's value is only evaluated if the RoleTemplate's context is set to "cluster" Default to false.

object[]

ExternalRules hold the external PolicyRules that will be used for authorization. This field is required when External=true and no underlying ClusterRole exists in the local cluster. This field is just used when the feature flag 'external-rules' is on.

hidden
boolean

Hidden if true informs the Rancher UI not to display this RoleTemplate. Default to false.

kind
string

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: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

locked
boolean

Locked if true, new bindings will not be able to use this RoleTemplate. Default to false.

metadata
object

No description provided.

projectCreatorDefault
boolean

ProjectCreatorDefault if true, a binding with this RoleTemplate will be created for a user when they create a new project. ProjectCreatorDefault is only evaluated if the context of the RoleTemplate is set to project. Default to false.

string[]

RoleTemplateNames list of RoleTemplate names that this RoleTemplate will inherit. This RoleTemplate will grant all rules defined in an inherited RoleTemplate. Inherited RoleTemplates must already exist.

object[]

Rules hold all the PolicyRules for this RoleTemplate.