config

Documentation

Overview

Copyright 2018 The Kubeflow 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.

Index

• Constants
• type ArenaConfiger
  • func GetArenaConfiger() *ArenaConfiger
  • func InitArenaConfiger(args types.ArenaClientArgs) (*ArenaConfiger, error)
  • func (a *ArenaConfiger) GetAPIExtensionClientSet() *extclientset.Clientset
  • func (a *ArenaConfiger) GetAdminUsers() []User
  • func (a *ArenaConfiger) GetArenaNamespace() string
  • func (a *ArenaConfiger) GetClientConfig() clientcmd.ClientConfig
  • func (a *ArenaConfiger) GetClientSet() *kubernetes.Clientset
  • func (a *ArenaConfiger) GetClusterInstalledCRDs() []string
  • func (a *ArenaConfiger) GetConfigsFromConfigFile() map[string]string
  • func (a *ArenaConfiger) GetNamespace() string
  • func (a *ArenaConfiger) GetRestConfig() *rest.Config
  • func (a *ArenaConfiger) GetUser() User
  • func (a *ArenaConfiger) IsAdminUser() bool
  • func (a *ArenaConfiger) IsDaemonMode() bool
  • func (a *ArenaConfiger) IsIsolateUserInNamespace() bool
• type User
  • func (u User) GetId() string
  • func (u User) GetName() string

Constants

const (
	RecommendedConfigPathEnvVar = "ARENA_CONFIG"
	DefaultArenaConfigPath      = "~/.arena/config"
	GlobalConfigmapName         = "arena-config"
	AdminUserKeyInConfigmap     = "adminUsers"
)

Types

type ArenaConfiger

type ArenaConfiger struct {
	// contains filtered or unexported fields
}

func GetArenaConfiger

func GetArenaConfiger() *ArenaConfiger

GetArenaConfiger returns the arena configer,it must be invoked after invoking function InitArenaConfiger(...)

func InitArenaConfiger

func InitArenaConfiger(args types.ArenaClientArgs) (*ArenaConfiger, error)

InitArenaConfiger initilize

func (*ArenaConfiger) GetAPIExtensionClientSet

func (a *ArenaConfiger) GetAPIExtensionClientSet() *extclientset.Clientset

func (*ArenaConfiger) GetAdminUsers

func (a *ArenaConfiger) GetAdminUsers() []User

func (*ArenaConfiger) GetArenaNamespace

func (a *ArenaConfiger) GetArenaNamespace() string

GetArenaNamespace returns the kubernetes namespace which some operators exists in

func (*ArenaConfiger) GetClientConfig

func (a *ArenaConfiger) GetClientConfig() clientcmd.ClientConfig

GetClientConfig returns the kubernetes ClientConfig

func (*ArenaConfiger) GetClientSet

func (a *ArenaConfiger) GetClientSet() *kubernetes.Clientset

GetClientSet returns the kubernetes ClientSet

func (*ArenaConfiger) GetClusterInstalledCRDs

func (a *ArenaConfiger) GetClusterInstalledCRDs() []string

func (*ArenaConfiger) GetConfigsFromConfigFile

func (a *ArenaConfiger) GetConfigsFromConfigFile() map[string]string

GetConfigsFromConfigFile returns the configs read from config file

func (*ArenaConfiger) GetNamespace

func (a *ArenaConfiger) GetNamespace() string

GetNamespace returns the namespace of user assigns

func (*ArenaConfiger) GetRestConfig

func (a *ArenaConfiger) GetRestConfig() *rest.Config

GetRestConfig returns the kubernetes RestConfig

func (*ArenaConfiger) GetUser

func (a *ArenaConfiger) GetUser() User

func (*ArenaConfiger) IsAdminUser

func (a *ArenaConfiger) IsAdminUser() bool

func (*ArenaConfiger) IsDaemonMode

func (a *ArenaConfiger) IsDaemonMode() bool

func (*ArenaConfiger) IsIsolateUserInNamespace

func (a *ArenaConfiger) IsIsolateUserInNamespace() bool

type User

type User struct {
	// contains filtered or unexported fields
}

func (User) GetId

func (u User) GetId() string

func (User) GetName

func (u User) GetName() string