application

Documentation

Index

• func Create(client *occlient.Client, appName string) error
• func Delete(client *occlient.Client, name string) error
• func Exists(client *occlient.Client, appName string) (bool, error)
• func GetCurrent(projectName string) (string, error)
• func GetCurrentOrGetCreateSetDefault(client *occlient.Client) (string, error)
• func GetDefaultAppName(existingApps []config.ApplicationInfo) (string, error)
• func List(client *occlient.Client) ([]config.ApplicationInfo, error)
• func ListInProject(client *occlient.Client) ([]config.ApplicationInfo, error)
• func SetCurrent(client *occlient.Client, appName string) error
• type App
• type AppList
• type AppSpec
• type AppStatus

Functions

func Create

func Create(client *occlient.Client, appName string) error

Create a new application

func Delete

func Delete(client *occlient.Client, name string) error

Delete deletes the given application

func Exists

func Exists(client *occlient.Client, appName string) (bool, error)

Exists returns true if given application (appName) exists

func GetCurrent

func GetCurrent(projectName string) (string, error)

GetCurrent returns currently active application. If no application is active this functions returns empty string

func GetCurrentOrGetCreateSetDefault

func GetCurrentOrGetCreateSetDefault(client *occlient.Client) (string, error)

GetCurrentOrGetCreateSetDefault returns currently active application. If no application is active, a defaultApplication is created and set as default as well. Use this carefully only in places where user expects the state to be altered Do not use for read operations like get, list; only for write operations like create

func GetDefaultAppName

func GetDefaultAppName(existingApps []config.ApplicationInfo) (string, error)

GetDefaultAppName returns randomly generated application name with unique configurable prefix suffixed by a randomly generated string which can be used as a default name in case the user doesn't provide a name.

func List

func List(client *occlient.Client) ([]config.ApplicationInfo, error)

List all applications in current project

func ListInProject

func ListInProject(client *occlient.Client) ([]config.ApplicationInfo, error)

ListInProject lists all applications in given project Queries cluster and config file. Shows also empty applications (empty applications are those that are just mentioned in config file but don't have any object associated with it on cluster).

func SetCurrent

func SetCurrent(client *occlient.Client, appName string) error

SetCurrent set application as active

Types

type App

type App struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              AppSpec   `json:"spec,omitempty"`
	Status            AppStatus `json:"status,omitempty"`
}

Application

type AppList

type AppList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []App `json:"items"`
}

AppList is a list of applications

type AppSpec

type AppSpec struct {
	Components []string `json:"components,omitempty"`
}

AppSpec is list of components present in given application

type AppStatus

type AppStatus struct {
	Active bool `json:"active"`
}

AppStatus shows the application is active or not