interface.go

/*
 * Tencent is pleased to support the open source community by making TKEStack
 * available.
 *
 * Copyright (C) 2012-2019 Tencent. All Rights Reserved.
 *
 * 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
 *
 * https://opensource.org/licenses/Apache-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 OF ANY KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations under the License.
 */

package cluster

import (
	"k8s.io/apimachinery/pkg/util/validation/field"
	"tkestack.io/tke/api/platform"
	v1 "tkestack.io/tke/api/platform/v1"
)

// UserInfo describes a user that has been authenticated to the system.
type UserInfo struct {
	// Name returns the name that uniquely identifies this user among all
	// other active users.
	Name string
	// Groups returns the names of the groups the user is a member of
	Groups []string
	// GetExtra can contain any additional information that the authenticator
	// thought was interesting.  One example would be scopes on a token.
	// Keys in this map should be namespaced to the authenticator or
	// authenticator/authorizer pair making use of them.
	Extra map[string][]string
}

// Cluster wrap cluster and it's credential
type Cluster struct {
	v1.Cluster
	ClusterCredential v1.ClusterCredential
}

// InternalCluster wrap internal version cluster and it's credential
type InternalCluster struct {
	platform.Cluster
	ClusterCredential platform.ClusterCredential
}

// Provider defines a set of response interfaces for specific cluster
// types in cluster management.
type Provider interface {
	Name() string

	ValidateCredential(cluster InternalCluster) field.ErrorList
	Validate(cluster *platform.Cluster) field.ErrorList

	PreCreate(user UserInfo, cluster platform.Cluster) (platform.Cluster, error)
	AfterCreate(cluster platform.Cluster) ([]interface{}, error)

	OnInitialize(cluster Cluster) (Cluster, error)
	OnUpdate(cluster Cluster) (Cluster, error)
	OnDelete(cluster v1.Cluster) error
}