project

Documentation

Index

• func Create(client *occlient.Client, projectName string, wait bool) error
• func Delete(client *occlient.Client, projectName string) error
• func Exists(client *occlient.Client, projectName string) (bool, error)
• func GetCurrent(client *occlient.Client) string
• func MachineReadableSuccessOutput(projectName string, message string)
• func SetCurrent(client *occlient.Client, projectName string) error
• type Project
  • func GetMachineReadableFormat(projectName string, isActive bool, apps []string) Project
• type ProjectList
  • func DescribeProjects(client *occlient.Client) (ProjectList, error)
• type ProjectSpec
• type ProjectStatus

Functions

func Create

func Create(client *occlient.Client, projectName string, wait bool) error

func Delete

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

Delete deletes the project with name projectName and returns errors if any

func Exists

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

Exists Checks whether a project with the given name exists or not projectName is the project name to perform check for The first returned parameter is a bool indicating if a project with the given name already exists or not The second returned parameter is the error that might occurs while execution

func GetCurrent

func GetCurrent(client *occlient.Client) string

GetCurrent return current project

func MachineReadableSuccessOutput

func MachineReadableSuccessOutput(projectName string, message string)

MachineReadableSuccessOutput outputs a success output that includes project information and namespace

func SetCurrent

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

SetCurrent sets the projectName as current project

Types

type Project

type Project struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              ProjectSpec   `json:"spec,omitempty"`
	Status            ProjectStatus `json:"status,omitempty"`
}

func GetMachineReadableFormat

func GetMachineReadableFormat(projectName string, isActive bool, apps []string) Project

GetMachineReadableFormat gathers the readable format and output a Project struct for json to marshal

type ProjectList

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

func DescribeProjects

func DescribeProjects(client *occlient.Client) (ProjectList, error)

type ProjectSpec

type ProjectSpec struct {
	Applications []string `json:"apps"`
}

type ProjectStatus

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