kubectl源码分析之create role_create role 报错-优快云博客

var (
	roleLong = templates.LongDesc(i18n.T(`
		Create a role with single rule.`))

	roleExample = templates.Examples(i18n.T(`
		# Create a Role named "pod-reader" that allows user to perform "get", "watch" and "list" on pods
		kubectl create role pod-reader --verb=get --verb=list --verb=watch --resource=pods

		# Create a Role named "pod-reader" with ResourceName specified
		kubectl create role pod-reader --verb=get --resource=pods --resource-name=readablepod --resource-name=anotherpod

		# Create a Role named "foo" with API Group specified
		kubectl create role foo --verb=get,list,watch --resource=rs.extensions

		# Create a Role named "foo" with SubResource specified
		kubectl create role foo --verb=get,list,watch --resource=pods,pods/status`))

	// Valid resource verb list for validation.
    //有效动作
	validResourceVerbs = []string{"*", "get", "delete", "list", "create", "update", "patch", "watch", "proxy", "deletecollection", "use", "bind", "escalate", "impersonate"}

	// Specialized verbs and GroupResources
	specialVerbs = map[string][]schema.GroupResource{//特殊动作资源
		"use": {
			{
				Group:    "extensions",
				Resource: "podsecuritypolicies",
			},
		},
		"bind": {
			{
				Group:    "rbac.authorization.k8s.io",
				Resource: "roles",
			},
			{
				Group:    "rbac.authorization.k8s.io",
				Resource: "clusterroles",
			},
		},
		"escalate": {
			{
				Group:    "rbac.authorization.k8s.io",
				Resource: "roles",
			},
			{
				Group:    "rbac.authorization.k8s.io",
				Resource: "clusterroles",
			},
		},
		"impersonate": {
			{
				Group:    "",
				Resource: "users",
			},
			{
				Group:    "",
				Resource: "serviceaccounts",
			},
			{
				Group:    "",
				Resource: "groups",
			},
			{
				Group:    "authentication.k8s.io",
				Resource: "userextras",
			},
		},
	}
)

type ResourceOptions struct {//resource结构体
	Group       string
	Resource    string
	SubResource string
}

// CreateRoleOptions holds the options for 'create role' sub command
type CreateRoleOptions struct {//create role 结构体
	PrintFlags *genericclioptions.PrintFlags

	Name          string
	Verbs         []string
	Resources     []ResourceOptions
	ResourceNames []string

	DryRun       bool
	OutputFormat string
	Namespace    string
	Client       clientgorbacv1.RbacV1Interface
	Mapper       meta.RESTMapper
	PrintObj     func(obj runtime.Object) error

	genericclioptions.IOStreams
}

func NewCreateRoleOptions(ioStreams genericclioptions.IOStreams) *CreateRoleOptions {
	return &CreateRoleOptions{创建create role结构体
		PrintFlags: genericclioptions.NewPrintFlags("created").WithTypeSetter(scheme.Scheme),

		IOStreams: ioStreams,
	}
}

//创建create role 命令
func NewCmdCreateRole(f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command {
	o := NewCreateRoleOptions(ioStreams)//初始化结构体

	cmd := &cobra.Command{//创建cobra命令
		Use:                   "role NAME --verb=verb --resource=resource.group/subresource [--resource-name=resourcename] [--dry-run]",
		DisableFlagsInUseLine: true,
		Short:                 roleLong,
		Long:                  roleLong,
		Example:               roleExample,
		Run: func(cmd *cobra.Command, args []string) {
			cmdutil.CheckErr(o.Complete(f, cmd, args))//准备运行
			cmdutil.CheckErr(o.Validate())//校验参数
			cmdutil.CheckErr(o.RunCreateRole())//运行
		},
	}

	o.PrintFlags.AddFlags(cmd)//设置print选项

	cmdutil.AddApplyAnnotationFlags(cmd)//创建save-config选项
	cmdutil.AddValidateFlags(cmd)//创建validate选项
	cmdutil.AddDryRunFlag(cmd)//创建dry-run选项
	cmd.Flags().StringSliceVar(&o.Verbs, "verb", o.Verbs, "Verb that applies to the resources contained in the rule")//创建verb选项
	cmd.Flags().StringSlice("resource", []string{}, "Resource that the rule applies to")//创建resource选项
	cmd.Flags().StringArrayVar(&o.ResourceNames, "resource-name", o.ResourceNames, "Resource in the white list that the rule applies to, repeat this flag for multiple items")//创建resource-name选项

	return cmd
}

//准备函数
func (o *CreateRoleOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error {
	name, err := NameFromCommandArgs(cmd, args)//获取名称
	if err != nil {
		return err
	}
	o.Name = name//设置名称

	// Remove duplicate verbs.
	verbs := []string{}
	for _, v := range o.Verbs {//遍历verb
		// VerbAll respresents all kinds of verbs.
		if v == "*" {
			verbs = []string{"*"}//*跳出循环
			break
		}
		if !arrayContains(verbs, v) {//verb去重
			verbs = append(verbs, v)
		}
	}
	o.Verbs = verbs//设置verb

	// Support resource.group pattern. If no API Group specified, use "" as core API Group.
	// e.g. --resource=pods,deployments.extensions
	resources := cmdutil.GetFlagStringSlice(cmd, "resource")//获取资源
	for _, r := range resources {//遍历资源
		sections := strings.SplitN(r, "/", 2)//用/分割

		resource := &ResourceOptions{}
		if len(sections) == 2 {//设置子资源
			resource.SubResource = sections[1]
		}

		parts := strings.SplitN(sections[0], ".", 2)//用.分割
		if len(parts) == 2 {//设置group
			resource.Group = parts[1]
		}
		resource.Resource = parts[0]//设置resource

		if resource.Resource == "*" && len(parts) == 1 && len(sections) == 1 {
			o.Resources = []ResourceOptions{*resource}//如果是*，跳出循环
			break
		}

		o.Resources = append(o.Resources, *resource)//追加资源
	}

	// Remove duplicate resource names.
	resourceNames := []string{}
	for _, n := range o.ResourceNames {//遍历resource-name
		if !arrayContains(resourceNames, n) {//resource-name去重
			resourceNames = append(resourceNames, n)
		}
	}
	o.ResourceNames = resourceNames//设置resource-name

	// Complete other options for Run.
	o.Mapper, err = f.ToRESTMapper()//设置mapper
	if err != nil {
		return err
	}

	o.DryRun = cmdutil.GetDryRunFlag(cmd)//设置dry-run
	o.OutputFormat = cmdutil.GetFlagString(cmd, "output")//设置output

	if o.DryRun {
		o.PrintFlags.Complete("%s (dry run)")//dry-run准备函数
	}
	printer, err := o.PrintFlags.ToPrinter()//printflag转printer
	if err != nil {
		return err
	}
	o.PrintObj = func(obj runtime.Object) error {//设置printObj函数
		return printer.PrintObj(obj, o.Out)
	}

	o.Namespace, _, err = f.ToRawKubeConfigLoader().Namespace()获取namespace
	if err != nil {
		return err
	}

	clientset, err := f.KubernetesClientSet()//获取clientset
	if err != nil {
		return err
	}
	o.Client = clientset.RbacV1()//设置client

	return nil
}

//校验参数
func (o *CreateRoleOptions) Validate() error {
	if o.Name == "" {//名称为空报错
		return fmt.Errorf("name must be specified")
	}

	// validate verbs.
	if len(o.Verbs) == 0 {//动作为空报错
		return fmt.Errorf("at least one verb must be specified")
	}

	for _, v := range o.Verbs {//遍历动作
		if !arrayContains(validResourceVerbs, v) {//判断动作是否有效
			return fmt.Errorf("invalid verb: '%s'", v)
		}
	}

	// validate resources.
	if len(o.Resources) == 0 {//资源为空报错
		return fmt.Errorf("at least one resource must be specified")
	}

	return o.validateResource()//校验资源
}

//校验资源
func (o *CreateRoleOptions) validateResource() error {
	for _, r := range o.Resources {//遍历资源
		if len(r.Resource) == 0 {// 资源名称为空报错
			return fmt.Errorf("resource must be specified if apiGroup/subresource specified")
		}
		if r.Resource == "*" {//资源为*直接返回
			return nil
		}

		resource := schema.GroupVersionResource{Resource: r.Resource, Group: r.Group}
		groupVersionResource, err := o.Mapper.ResourceFor(schema.GroupVersionResource{Resource: r.Resource, Group: r.Group})//获取groupversionresource
		if err == nil {
			resource = groupVersionResource
		}

		for _, v := range o.Verbs {//遍历动作
			if groupResources, ok := specialVerbs[v]; ok {//判断是否特殊动作
				match := false
				for _, extra := range groupResources {//如果是特殊动作，遍历特殊动作的资源
					if resource.Resource == extra.Resource && resource.Group == extra.Group {
						match = true//如果特殊动作资源包含需校验的资源则match为true
						err = nil
						break
					}
				}
				if !match {//不match报错
					return fmt.Errorf("can not perform '%s' on '%s' in group '%s'", v, resource.Resource, resource.Group)
				}
			}
		}

		if err != nil {
			return err
		}
	}
	return nil
}

//运行命令
func (o *CreateRoleOptions) RunCreateRole() error {
	role := &rbacv1.Role{//构造role对象
		// this is ok because we know exactly how we want to be serialized
		TypeMeta: metav1.TypeMeta{APIVersion: rbacv1.SchemeGroupVersion.String(), Kind: "Role"},
	}
	role.Name = o.Name//设置名称
	rules, err := generateResourcePolicyRules(o.Mapper, o.Verbs, o.Resources, o.ResourceNames, []string{})//生成policyroles
	if err != nil {
		return err
	}
	role.Rules = rules//设置PolicyRules

	// Create role.
	if !o.DryRun {//非干跑
		role, err = o.Client.Roles(o.Namespace).Create(role)//创建role对象
		if err != nil {
			return err
		}
	}

	return o.PrintObj(role)//打印结果
}

//创建PolicyRoles
func generateResourcePolicyRules(mapper meta.RESTMapper, verbs []string, resources []ResourceOptions, resourceNames []string, nonResourceURLs []string) ([]rbacv1.PolicyRule, error) {
	// groupResourceMapping is a apigroup-resource map. The key of this map is api group, while the value
	// is a string array of resources under this api group.
	// E.g.  groupResourceMapping = {"extensions": ["replicasets", "deployments"], "batch":["jobs"]}
	groupResourceMapping := map[string][]string{}//构造map

	// This loop does the following work:
	// 1. Constructs groupResourceMapping based on input resources.
	// 2. Prevents pointing to non-existent resources.
	// 3. Transfers resource short name to long name. E.g. rs.extensions is transferred to replicasets.extensions
	for _, r := range resources {//遍历resource
		resource := schema.GroupVersionResource{Resource: r.Resource, Group: r.Group}
		groupVersionResource, err := mapper.ResourceFor(schema.GroupVersionResource{Resource: r.Resource, Group: r.Group})//获取groupversionresource
		if err == nil {
			resource = groupVersionResource
		}

		if len(r.SubResource) > 0 {//如果有子资源，则资源加子资源
			resource.Resource = resource.Resource + "/" + r.SubResource
		}
		if !arrayContains(groupResourceMapping[resource.Group], resource.Resource) {
			groupResourceMapping[resource.Group] = append(groupResourceMapping[resource.Group], resource.Resource)//如果map的group不包含资源，则添加
		}
	}

	// Create separate rule for each of the api group.
	rules := []rbacv1.PolicyRule{}//创建PolicyRule slice
	for _, g := range sets.StringKeySet(groupResourceMapping).List() {//遍历map的key
		rule := rbacv1.PolicyRule{}//创建PolicyRule
		rule.Verbs = verbs//设置动作
		rule.Resources = groupResourceMapping[g]//设置资源
		rule.APIGroups = []string{g}//设置apigroup
		rule.ResourceNames = resourceNames//设置资源名称
		rules = append(rules, rule)//追加
	}

	if len(nonResourceURLs) > 0 {//如果non-resource-url有值
		rule := rbacv1.PolicyRule{}//创建PolicyRule
		rule.Verbs = verbs// 设置动作
		rule.NonResourceURLs = nonResourceURLs//设置non-resource-url
		rules = append(rules, rule)
	}

	return rules, nil//返回rules
}