/* Copyright 2020 KubeSphere Authors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ package group import ( "context" "encoding/json" "fmt" corev1 "k8s.io/api/core/v1" "k8s.io/apimachinery/pkg/api/errors" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/labels" "k8s.io/apimachinery/pkg/types" "k8s.io/apimachinery/pkg/util/validation/field" "k8s.io/client-go/kubernetes" "k8s.io/klog" iamv1alpha2 "kubesphere.io/api/iam/v1alpha2" tenantv1alpha1 "kubesphere.io/api/tenant/v1alpha1" "kubesphere.io/kubesphere/pkg/api" "kubesphere.io/kubesphere/pkg/apiserver/query" kubesphere "kubesphere.io/kubesphere/pkg/client/clientset/versioned" "kubesphere.io/kubesphere/pkg/informers" resourcesv1alpha3 "kubesphere.io/kubesphere/pkg/models/resources/v1alpha3/resource" ) type GroupOperator interface { ListGroups(workspace string, queryParam *query.Query) (*api.ListResult, error) CreateGroup(workspace string, namespace *iamv1alpha2.Group) (*iamv1alpha2.Group, error) DescribeGroup(workspace, group string) (*iamv1alpha2.Group, error) DeleteGroup(workspace, group string) error UpdateGroup(workspace string, group *iamv1alpha2.Group) (*iamv1alpha2.Group, error) PatchGroup(workspace string, group *iamv1alpha2.Group) (*iamv1alpha2.Group, error) DeleteGroupBinding(workspace, name string) error CreateGroupBinding(workspace, groupName, userName string) (*iamv1alpha2.GroupBinding, error) ListGroupBindings(workspace string, queryParam *query.Query) (*api.ListResult, error) } type groupOperator struct { k8sclient kubernetes.Interface ksclient kubesphere.Interface resourceGetter *resourcesv1alpha3.ResourceGetter } func New(informers informers.InformerFactory, ksclient kubesphere.Interface, k8sclient kubernetes.Interface) GroupOperator { return &groupOperator{ resourceGetter: resourcesv1alpha3.NewResourceGetter(informers, nil), k8sclient: k8sclient, ksclient: ksclient, } } func (t *groupOperator) ListGroups(workspace string, queryParam *query.Query) (*api.ListResult, error) { if workspace != "" { // filter by workspace queryParam.Filters[query.FieldLabel] = query.Value(fmt.Sprintf("%s=%s", tenantv1alpha1.WorkspaceLabel, workspace)) } result, err := t.resourceGetter.List("groups", "", queryParam) if err != nil { klog.Error(err) return nil, err } return result, nil } // CreateGroup adds a workspace label to group which indicates group is under the workspace func (t *groupOperator) CreateGroup(workspace string, group *iamv1alpha2.Group) (*iamv1alpha2.Group, error) { if group.GenerateName == "" { err := errors.NewInvalid(iamv1alpha2.SchemeGroupVersion.WithKind(iamv1alpha2.ResourcePluralGroup).GroupKind(), "", []*field.Error{field.Required(field.NewPath("metadata.generateName"), "generateName is required")}) klog.Error(err) return nil, err } // generateName is used as displayName // ensure generateName is unique in workspace scope if unique, err := t.isGenerateNameUnique(workspace, group.GenerateName); err != nil { return nil, err } else if !unique { err = errors.NewConflict(iamv1alpha2.Resource(iamv1alpha2.ResourcePluralGroup), group.GenerateName, fmt.Errorf("a group named %s already exists in the workspace", group.GenerateName)) klog.Error(err) return nil, err } return t.ksclient.IamV1alpha2().Groups().Create(context.Background(), labelGroupWithWorkspaceName(group, workspace), metav1.CreateOptions{}) } func (t *groupOperator) isGenerateNameUnique(workspace, generateName string) (bool, error) { result, err := t.ListGroups(workspace, query.New()) if err != nil { klog.Error(err) return false, err } for _, obj := range result.Items { g := obj.(*iamv1alpha2.Group) if g.GenerateName == generateName { return false, err } } return true, nil } func (t *groupOperator) DescribeGroup(workspace, group string) (*iamv1alpha2.Group, error) { obj, err := t.resourceGetter.Get("groups", "", group) if err != nil { return nil, err } ns := obj.(*iamv1alpha2.Group) if ns.Labels[tenantv1alpha1.WorkspaceLabel] != workspace { err := errors.NewNotFound(corev1.Resource("group"), group) klog.Error(err) return nil, err } return ns, nil } func (t *groupOperator) DeleteGroup(workspace, group string) error { _, err := t.DescribeGroup(workspace, group) if err != nil { return err } return t.ksclient.IamV1alpha2().Groups().Delete(context.Background(), group, *metav1.NewDeleteOptions(0)) } func (t *groupOperator) UpdateGroup(workspace string, group *iamv1alpha2.Group) (*iamv1alpha2.Group, error) { _, err := t.DescribeGroup(workspace, group.Name) if err != nil { return nil, err } group = labelGroupWithWorkspaceName(group, workspace) return t.ksclient.IamV1alpha2().Groups().Update(context.Background(), group, metav1.UpdateOptions{}) } func (t *groupOperator) PatchGroup(workspace string, group *iamv1alpha2.Group) (*iamv1alpha2.Group, error) { _, err := t.DescribeGroup(workspace, group.Name) if err != nil { return nil, err } if group.Labels != nil { group.Labels[tenantv1alpha1.WorkspaceLabel] = workspace } data, err := json.Marshal(group) if err != nil { return nil, err } return t.ksclient.IamV1alpha2().Groups().Patch(context.Background(), group.Name, types.MergePatchType, data, metav1.PatchOptions{}) } func (t *groupOperator) DeleteGroupBinding(workspace, name string) error { obj, err := t.resourceGetter.Get("groupbindings", "", name) if err != nil { return err } ns := obj.(*iamv1alpha2.GroupBinding) if ns.Labels[tenantv1alpha1.WorkspaceLabel] != workspace { err := errors.NewNotFound(corev1.Resource("groupbinding"), name) klog.Error(err) return err } return t.ksclient.IamV1alpha2().GroupBindings().Delete(context.Background(), name, *metav1.NewDeleteOptions(0)) } func (t *groupOperator) CreateGroupBinding(workspace, groupName, userName string) (*iamv1alpha2.GroupBinding, error) { groupBinding := iamv1alpha2.GroupBinding{ ObjectMeta: metav1.ObjectMeta{ GenerateName: fmt.Sprintf("%s-%s-", groupName, userName), Labels: map[string]string{ iamv1alpha2.UserReferenceLabel: userName, iamv1alpha2.GroupReferenceLabel: groupName, tenantv1alpha1.WorkspaceLabel: workspace, }, }, Users: []string{userName}, GroupRef: iamv1alpha2.GroupRef{ APIGroup: iamv1alpha2.SchemeGroupVersion.Group, Kind: iamv1alpha2.ResourcePluralGroup, Name: groupName, }, } return t.ksclient.IamV1alpha2().GroupBindings().Create(context.Background(), &groupBinding, metav1.CreateOptions{}) } func (t *groupOperator) ListGroupBindings(workspace string, query *query.Query) (*api.ListResult, error) { lableSelector, err := labels.ConvertSelectorToLabelsMap(query.LabelSelector) if err != nil { klog.Error(err) return nil, err } // workspace resources must be filtered by workspace wsSelector := labels.Set{tenantv1alpha1.WorkspaceLabel: workspace} query.LabelSelector = labels.Merge(lableSelector, wsSelector).String() result, err := t.resourceGetter.List("groupbindings", "", query) if err != nil { klog.Error(err) return nil, err } return result, nil } // labelGroupWithWorkspaceName adds a kubesphere.io/workspace=[workspaceName] label to namespace which // indicates namespace is under the workspace func labelGroupWithWorkspaceName(namespace *iamv1alpha2.Group, workspaceName string) *iamv1alpha2.Group { if namespace.Labels == nil { namespace.Labels = make(map[string]string, 0) } namespace.Labels[tenantv1alpha1.WorkspaceLabel] = workspaceName // label namespace with workspace name return namespace }