app

Documentation

Index

• Constants
• func CreateNamespace(req *CreateRequest, k8sClientset *clientset.Clientset) error
• func GetClearServiceAccountpolicy(currentPolicy *cloudresourcemanager.Policy, req ApplyIamRequest) cloudresourcemanager.Policy
• func GetRepoName(project string) string
• func GetUpdatedPolicy(currentPolicy *cloudresourcemanager.Policy, iamConf *IamConf, ...) cloudresourcemanager.Policy
• func InsertOauthCredentails(req *CreateRequest, k8sClientset *clientset.Clientset) error
• func LoadConfig(path string, o interface{}) error
• func NewServer(appsDir string, registries []RegistryConfig, gkeVersionOverride string) (*ksServer, error)
• func PrepareAccount(account string) string
• func Run(opt *options.ServerOption) error
• func UpdateCloudShellConfig(repoDir string, project string, appName string, kfVersion string, zone string) error
• func UpdateDmConfig(repoDir string, project string, appName string, kfVersion string, ...) error
• type AppConfig
• type AppConfigFile
• type ApplyIamRequest
• type ApplyRequest
• type CreateRequest
  • func (s *CreateRequest) Validate() error
• type DmConf
• type HealthzRequest
• type HealthzResponse
• type IamBinding
• type IamConf
• type InitProjectRequest
• type KsComponent
• type KsPackage
• type KsParameter
• type KsRegistry
• type KsService
• type LibrarySpec
• type MultiError
  • func (m *MultiError) Collect(err error)
  • func (m MultiError) ToError() error
• type RegistriesConfigFile
• type RegistryConfig
• type Resource

Constants

const CachedRegistries = "/opt/versioned_registries"

root dir of local cached VERSIONED REGISTRIES

const CloudShellFolder = "kf_util"

const CloudShellTemplatePath = "/opt/registries/kubeflow/deployment/gke/cloud_shell_templates"

const DefaultStorageAnnotation = "storageclass.beta.kubernetes.io/is-default-class"

DefaultStorageAnnotation is the Name of the default annotation used to indicate whether a storage class is the default.

const DmFolder = "gcp_config"

const GcloudPath = "gcloud"

Assume gcloud is on the path.

const IAM_ADMIN_ROLE = "roles/resourcemanager.projectIamAdmin"

const JupyterPrototype = "jupyterhub"

The name of the prototype for Jupyter.

const KubeflowFolder = "ks_app"

const KubeflowRegName = "kubeflow"

const OauthSecretName = "kubeflow-oauth"

const RecommendedConfigPathEnvVar = "KUBECONFIG"

RecommendedConfigPathEnvVar is a environment variable for path configuration

const RegistriesRoot = "/opt/registries"

const StartTime = "StartTime"

key used for storing start time of a request to deploy in the request contexts

Functions

func CreateNamespace

func CreateNamespace(req *CreateRequest, k8sClientset *clientset.Clientset) error

func GetClearServiceAccountpolicy

func GetClearServiceAccountpolicy(currentPolicy *cloudresourcemanager.Policy, req ApplyIamRequest) cloudresourcemanager.Policy

Clear existing bindings for auto-generated service accounts of current deployment. Those bindings could be leftover from previous actions.

func GetRepoName

func GetRepoName(project string) string

func GetUpdatedPolicy

func GetUpdatedPolicy(currentPolicy *cloudresourcemanager.Policy, iamConf *IamConf, req ApplyIamRequest) cloudresourcemanager.Policy

func InsertOauthCredentails

func InsertOauthCredentails(req *CreateRequest, k8sClientset *clientset.Clientset) error

func LoadConfig

func LoadConfig(path string, o interface{}) error

Load yaml config

func NewServer

func NewServer(appsDir string, registries []RegistryConfig, gkeVersionOverride string) (*ksServer, error)

NewServer constructs a ksServer.

func PrepareAccount

func PrepareAccount(account string) string

func Run

func Run(opt *options.ServerOption) error

Run the application.

func UpdateCloudShellConfig

func UpdateCloudShellConfig(repoDir string, project string, appName string, kfVersion string, zone string) error

Save cloud shell config to project source repo.

func UpdateDmConfig

func UpdateDmConfig(repoDir string, project string, appName string, kfVersion string, dmDeploy *deploymentmanager.Deployment) error

Save ks app config local changes to project source repo. Not thread safe, be aware when call it.

Types

type AppConfig

type AppConfig struct {
	Registries []RegistryConfig
	Packages   []KsPackage
	Components []KsComponent
	Parameters []KsParameter
}

type AppConfigFile

type AppConfigFile struct {
	// App describes a ksonnet application.
	App AppConfig
}

AppConfigFile corresponds to a YAML file specifying information about the app to create.

type ApplyIamRequest

type ApplyIamRequest struct {
	Project string `json:"project"`
	Cluster string `json:"cluster"`
	Email   string `json:"email"`
	Token   string `json:"token"`
	Action  string `json:"action`
}

type ApplyRequest

type ApplyRequest struct {
	// Name of the app to apply
	Name string

	// kubeflow version
	KfVersion string

	// Environment is the environment to use.
	Environment string

	// Components is a list of the names of the components to apply.
	Components []string

	// target GKE cLuster info
	Cluster string
	Project string
	Zone    string

	// Token is an authorization token to use to authorize to the K8s API Server.
	// Leave blank to use the pods service account.
	Token string
	Email string

	// For test: GCP service account client id
	SAClientId string

	// pass *appInfo if ks app is already on disk.
	AppInfo *appInfo
}

Request to apply an app.

type CreateRequest

type CreateRequest struct {
	// Name for the app.
	Name string
	// AppConfig is the config for the app.
	AppConfig AppConfig

	// Namespace for the app.
	Namespace string

	// Whether to try to autoconfigure the app.
	AutoConfigure bool

	// target GKE cLuster info
	Cluster       string
	Project       string
	ProjectNumber string
	Zone          string

	// Access token, need to access target cluster in order for AutoConfigure
	Token string
	Apply bool
	Email string
	// temporary
	ClientId     string
	ClientSecret string
	IpName       string

	// For test: GCP service account client id
	SAClientId string
}

CreateRequest represents a request to create a ksonnet application.

func (*CreateRequest) Validate

func (s *CreateRequest) Validate() error

type DmConf

type DmConf struct {
	Imports   interface{} `json:"imports"`
	Resources []Resource  `json:"resources"`
}

type HealthzRequest

type HealthzRequest struct {
	Msg string
}

type HealthzResponse

type HealthzResponse struct {
	Reply string
}

type IamBinding

type IamBinding struct {
	Members []string `type:"members`
	Roles   []string `type:"roles"`
}

type IamConf

type IamConf struct {
	IamBindings []IamBinding `json:"bindings"`
}

type InitProjectRequest

type InitProjectRequest struct {
	Project       string
	ProjectNumber string
	Token         string
}

type KsComponent

type KsComponent struct {
	Name      string
	Prototype string
}

type KsPackage

type KsPackage struct {
	Name string
	// Registry should be the name of the registry containing the package.
	Registry string
}

type KsParameter

type KsParameter struct {
	Component string
	Name      string
	Value     string
}

type KsRegistry

type KsRegistry struct {
	ApiVersion string
	Kind       string
	Libraries  map[string]LibrarySpec
}

KsRegistry corresponds to ksonnet.io/registry which is the registry.yaml file found in every registry.

type KsService

type KsService interface {
	// CreateApp creates a ksonnet application.
	CreateApp(context.Context, CreateRequest, *deploymentmanager.Deployment) error
	// Apply ksonnet app to target GKE cluster
	Apply(ctx context.Context, req ApplyRequest) error
	ConfigCluster(context.Context, CreateRequest) error
	BindRole(context.Context, string, string, string) error
	InsertDeployment(context.Context, CreateRequest) (*deploymentmanager.Deployment, error)
	GetDeploymentStatus(context.Context, CreateRequest) (string, error)
	ApplyIamPolicy(context.Context, ApplyIamRequest) error
	GetProjectLock(string) *sync.Mutex
}

KsService defines an interface for working with ksonnet.

type LibrarySpec

type LibrarySpec struct {
	Version string
	Path    string
}

type MultiError

type MultiError struct {
	Errors []error
}

func (*MultiError) Collect

func (m *MultiError) Collect(err error)

func (MultiError) ToError

func (m MultiError) ToError() error

type RegistriesConfigFile

type RegistriesConfigFile struct {
	// Registries provides information about known registries.
	Registries []RegistryConfig
}

RegistriesConfigFile corresponds to a YAML file specifying information about known registries.

type RegistryConfig

type RegistryConfig struct {
	Name    string
	Repo    string
	Version string
	Path    string
	RegUri  string
}

RegistryConfig is used for two purposes:

1. used during image build, to configure registries that should be baked into the bootstrapper docker image. (See: https://github.com/kubeflow/kubeflow/blob/master/bootstrap/image_registries.yaml)
2. used during app create rpc call, specifies a registry to be added to an app. required info for registry: Name, Repo, Version, Path Additionally if any of required fields is blank we will try to map with one of the registries baked into the Docker image using the name.

type Resource

type Resource struct {
	Name       string                 `json:"name"`
	Type       string                 `json:"type"`
	Properties map[string]interface{} `json:"properties"`
}