occlient

Documentation

Index

• Constants
• type Client
  • func New() (*Client, error)
  • func (c *Client) AddEnvironmentVariablesToDeploymentConfig(envs []corev1.EnvVar, dc *appsv1.DeploymentConfig) error
  • func (c *Client) AddPVCToDeploymentConfig(dc *appsv1.DeploymentConfig, pvc string, path string) error
  • func (c *Client) CreateNewProject(name string) error
  • func (c *Client) CreatePVC(name string, size string, labels map[string]string) (*corev1.PersistentVolumeClaim, error)
  • func (c *Client) CreateRoute(service string, labels map[string]string) (*routev1.Route, error)
  • func (c *Client) Delete(kind string, name string, labels map[string]string) (string, error)
  • func (c *Client) DeletePVC(name string) error
  • func (c *Client) DeleteProject(name string) error
  • func (c *Client) DeleteRoute(name string) error
  • func (c *Client) FollowBuildLog(buildName string) error
  • func (c *Client) GetBuildConfig(name string, project string) (*buildv1.BuildConfig, error)
  • func (c *Client) GetClusterServiceClassExternalNames() ([]string, error)
  • func (c *Client) GetClusterServiceClasses() ([]scv1beta1.ClusterServiceClass, error)
  • func (c *Client) GetCurrentProjectName() string
  • func (c *Client) GetDeploymentConfigFromName(name string) (*appsv1.DeploymentConfig, error)
  • func (c *Client) GetDeploymentConfigsFromSelector(selector string) ([]appsv1.DeploymentConfig, error)
  • func (c *Client) GetImageStreams(namespace string) ([]imagev1.ImageStream, error)
  • func (c *Client) GetImageStreamsNames(namespace string) ([]string, error)
  • func (c *Client) GetLabelValues(project string, label string, selector string) ([]string, error)
  • func (c *Client) GetLatestBuildName(buildConfigName string) (string, error)
  • func (c *Client) GetOneDeploymentConfigFromSelector(selector string) (*appsv1.DeploymentConfig, error)
  • func (c *Client) GetOnePodFromSelector(selector string) (*corev1.Pod, error)
  • func (c *Client) GetOneServiceFromSelector(selector string) (*corev1.Service, error)
  • func (c *Client) GetPVCNamesFromSelector(selector string) ([]string, error)
  • func (c *Client) GetPVCsFromSelector(selector string) ([]corev1.PersistentVolumeClaim, error)
  • func (c *Client) GetProjectNames() ([]string, error)
  • func (c *Client) GetServicesFromSelector(selector string) ([]corev1.Service, error)
  • func (c *Client) ListRouteNames(labelSelector string) ([]string, error)
  • func (c *Client) ListRoutes(labelSelector string) ([]routev1.Route, error)
  • func (c *Client) NewAppS2I(name string, builderImage string, gitUrl string, labels map[string]string, ...) error
  • func (c *Client) RemoveVolumeFromDeploymentConfig(pvc string, dcName string) error
  • func (c *Client) SetCurrentProject(project string) error
  • func (c *Client) StartBinaryBuild(name string, dir string) error
  • func (c *Client) StartBuild(name string) error
  • func (c *Client) SyncPath(localPath string, targetPodName string, targetPath string) (string, error)
  • func (c *Client) UpdateBuildConfig(buildConfigName string, projectName string, gitUrl string, ...) error
• type OcCommand

Constants

const (
	OpenShiftNameSpace = "openshift"
)

Types

type Client

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

func New

func New() (*Client, error)

func (*Client) AddEnvironmentVariablesToDeploymentConfig

func (c *Client) AddEnvironmentVariablesToDeploymentConfig(envs []corev1.EnvVar, dc *appsv1.DeploymentConfig) error

AddEnvironmentVariablesToDeploymentConfig adds the given environment variables to the only container in the Deployment Config and updates in the cluster

func (*Client) AddPVCToDeploymentConfig

func (c *Client) AddPVCToDeploymentConfig(dc *appsv1.DeploymentConfig, pvc string, path string) error

AddPVCToDeploymentConfig adds the given PVC to the given Deployment Config at the given path

func (*Client) CreateNewProject

func (c *Client) CreateNewProject(name string) error

func (*Client) CreatePVC

func (c *Client) CreatePVC(name string, size string, labels map[string]string) (*corev1.PersistentVolumeClaim, error)

CreatePVC creates a PVC resource in the cluster with the given name, size and labels

func (*Client) CreateRoute

func (c *Client) CreateRoute(service string, labels map[string]string) (*routev1.Route, error)

CreateRoute creates a route object for the given service and with the given labels

func (*Client) Delete

func (c *Client) Delete(kind string, name string, labels map[string]string) (string, error)

Delete calls oc delete kind is always required (can be set to 'all') name can be omitted if labels are set, in that case set name to ” if you want to delete object just by its name set labels to nil

func (*Client) DeletePVC

func (c *Client) DeletePVC(name string) error

DeletePVC deletes the given PVC by name

func (*Client) DeleteProject

func (c *Client) DeleteProject(name string) error

func (*Client) DeleteRoute

func (c *Client) DeleteRoute(name string) error

DeleteRoute deleted the given route

func (*Client) FollowBuildLog

func (c *Client) FollowBuildLog(buildName string) error

FollowBuildLog stream build log to stdout

func (*Client) GetBuildConfig

func (c *Client) GetBuildConfig(name string, project string) (*buildv1.BuildConfig, error)

GetBuildConfig get BuildConfig by its name

func (*Client) GetClusterServiceClassExternalNames

func (c *Client) GetClusterServiceClassExternalNames() ([]string, error)

GetClusterServiceClassExternalNames returns the names of all the cluster service classes in the cluster

func (*Client) GetClusterServiceClasses

func (c *Client) GetClusterServiceClasses() ([]scv1beta1.ClusterServiceClass, error)

GetClusterServiceClasses queries the service service catalog to get all the currently available cluster service classes

func (*Client) GetCurrentProjectName

func (c *Client) GetCurrentProjectName() string

func (*Client) GetDeploymentConfigFromName

func (c *Client) GetDeploymentConfigFromName(name string) (*appsv1.DeploymentConfig, error)

GetDeploymentConfigFromName returns the Deployment Config resource given the Deployment Config name

func (*Client) GetDeploymentConfigsFromSelector

func (c *Client) GetDeploymentConfigsFromSelector(selector string) ([]appsv1.DeploymentConfig, error)

GetDeploymentConfigsFromSelector returns an array of Deployment Config resources which match the given selector

func (*Client) GetImageStreams

func (c *Client) GetImageStreams(namespace string) ([]imagev1.ImageStream, error)

GetImageStreams returns the Image Stream objects in the given namespace

func (*Client) GetImageStreamsNames

func (c *Client) GetImageStreamsNames(namespace string) ([]string, error)

GetImageStreamsNames returns the names of the image streams in a given namespace

func (*Client) GetLabelValues

func (c *Client) GetLabelValues(project string, label string, selector string) ([]string, error)

GetLabelValues get label values of given label from objects in project that are matching selector returns slice of uniq label values

func (*Client) GetLatestBuildName

func (c *Client) GetLatestBuildName(buildConfigName string) (string, error)

GetLatestBuildName gets the name of the latest build buildConfigName is the name of the buildConfig for which we are fetching the build name returns the name of the latest build or the error

func (*Client) GetOneDeploymentConfigFromSelector

func (c *Client) GetOneDeploymentConfigFromSelector(selector string) (*appsv1.DeploymentConfig, error)

GetOneDeploymentConfigFromSelector returns the Deployment Config object associated with the given selector. An error is thrown when exactly one Deployment Config is not found for the selector.

func (*Client) GetOnePodFromSelector

func (c *Client) GetOnePodFromSelector(selector string) (*corev1.Pod, error)

GetOnePodFromSelector returns the Pod object associated with the given selector. An error is thrown when exactly one Pod is not found.

func (*Client) GetOneServiceFromSelector

func (c *Client) GetOneServiceFromSelector(selector string) (*corev1.Service, error)

GetOneServiceFromSelector returns the Service object associated with the given selector. An error is thrown when exactly one Service is not found for the selector

func (*Client) GetPVCNamesFromSelector

func (c *Client) GetPVCNamesFromSelector(selector string) ([]string, error)

GetPVCNamesFromSelector returns the PVC names for the given selector

func (*Client) GetPVCsFromSelector

func (c *Client) GetPVCsFromSelector(selector string) ([]corev1.PersistentVolumeClaim, error)

GetPVCsFromSelector returns the PVCs based on the given selector

func (*Client) GetProjectNames

func (c *Client) GetProjectNames() ([]string, error)

GetProjectNames return list of existing projects that user has access to.

func (*Client) GetServicesFromSelector

func (c *Client) GetServicesFromSelector(selector string) ([]corev1.Service, error)

GetServicesFromSelector returns an array of Service resources which match the given selector

func (*Client) ListRouteNames

func (c *Client) ListRouteNames(labelSelector string) ([]string, error)

ListRouteNames lists all the names of the routes based on the given label selector

func (*Client) ListRoutes

func (c *Client) ListRoutes(labelSelector string) ([]routev1.Route, error)

ListRoutes lists all the routes based on the given label selector

func (*Client) NewAppS2I

func (c *Client) NewAppS2I(name string, builderImage string, gitUrl string, labels map[string]string, annotations map[string]string) error

NewAppS2I create new application using S2I if gitUrl is "" than it creates binary build otherwise uses gitUrl as buildSource

func (*Client) RemoveVolumeFromDeploymentConfig

func (c *Client) RemoveVolumeFromDeploymentConfig(pvc string, dcName string) error

RemoveVolumeFromDeploymentConfig removes the volume associated with the given PVC from the Deployment Config. Both, the volume entry and the volume mount entry in the containers, are deleted.

func (*Client) SetCurrentProject

func (c *Client) SetCurrentProject(project string) error

func (*Client) StartBinaryBuild

func (c *Client) StartBinaryBuild(name string, dir string) error

StartBinaryBuild starts new build and streams dir as source for build

func (*Client) StartBuild

func (c *Client) StartBuild(name string) error

StartBuild starts new build as it is

func (*Client) SyncPath

func (c *Client) SyncPath(localPath string, targetPodName string, targetPath string) (string, error)

SyncPath copies local directory to directory in running Pod.

func (*Client) UpdateBuildConfig

func (c *Client) UpdateBuildConfig(buildConfigName string, projectName string, gitUrl string, annotations map[string]string) error

UpdateBuildConfig updates the BuildConfig file buildConfigName is the name of the BuildConfig file to be updated projectName is the name of the project gitUrl equals to the git URL of the source and is equals to "" if the source is of type dir or binary annotations contains the annotations for the BuildConfig file

type OcCommand

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