Documentation

Overview

    Package courier interfaces with the Executor to run specific Cloud Foundry CLI commands.

    Index

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    func NewCourier

    func NewCourier(executor I.Executor) I.Courier

    Types

    type Courier

    type Courier struct {
    	Executor I.Executor
    }

      Courier has an Executor to execute Cloud Foundry commands.

      func (Courier) BindService

      func (c Courier) BindService(appName, dbName string) ([]byte, error)

      func (Courier) CleanUp

      func (c Courier) CleanUp() error

        CleanUp removes the temporary directory created by the Executor.

        func (Courier) CreateService

        func (c Courier) CreateService(service, plan, name string) ([]byte, error)

        func (Courier) Cups

        func (c Courier) Cups(appName string, body string) ([]byte, error)

          Cups runs the Cloud Foundry CUPS command to create user provided services.

          Returns the combined standard output and standard error.

          func (Courier) Delete

          func (c Courier) Delete(appName string) ([]byte, error)

            Delete runs the Cloud Foundry delete command. Returns the combined standard output and standard error.

            func (Courier) DeleteRoute

            func (c Courier) DeleteRoute(domain, hostname string) ([]byte, error)

            func (Courier) DeleteService

            func (c Courier) DeleteService(serviceName string) ([]byte, error)

            func (Courier) Domains

            func (c Courier) Domains() ([]string, error)

              Domains returns a list of domain in a foundation.

              Returns the combined standard output and standard error.

              func (Courier) Exists

              func (c Courier) Exists(appName string) bool

                Exists checks to see whether the application name exists already.

                Returns true if the application exists.

                func (Courier) Login

                func (c Courier) Login(foundationURL, username, password, org, space string, skipSSL bool) ([]byte, error)

                  Login runs the Cloud Foundry login command.

                  Returns the combined standard output and standard error.

                  func (Courier) Logs

                  func (c Courier) Logs(appName string) ([]byte, error)

                    Logs runs the Cloud Foundry logs command.

                    Returns the combined standard output and standard error.

                    func (Courier) MapRoute

                    func (c Courier) MapRoute(appName, domain, hostname string) ([]byte, error)

                      MapRoute runs the Cloud Foundry map-route command.

                      Returns the combined standard output and standard error.

                      func (Courier) MapRouteWithPath

                      func (c Courier) MapRouteWithPath(appName, domain, hostname, path string) ([]byte, error)

                        MapRoute runs the Cloud Foundry map-route command and added path arguement

                        Returns the combined standard output and standard error.

                        func (Courier) Push

                        func (c Courier) Push(appName, appLocation, hostname string, instances uint16) ([]byte, error)

                          Push runs the Cloud Foundry push command.

                          Returns the combined standard output and standard error.

                          func (Courier) Rename

                          func (c Courier) Rename(appName, newAppName string) ([]byte, error)

                            Rename runs the Cloud Foundry rename command.

                            Returns the combined standard output and standard error.

                            func (Courier) Restage

                            func (c Courier) Restage(appName string) ([]byte, error)

                            func (Courier) Start

                            func (c Courier) Start(appName string) ([]byte, error)

                            func (Courier) Stop

                            func (c Courier) Stop(appName string) ([]byte, error)

                            func (Courier) UnbindService

                            func (c Courier) UnbindService(appName, dbName string) ([]byte, error)

                            func (Courier) UnmapRoute

                            func (c Courier) UnmapRoute(appName, domain, hostname string) ([]byte, error)

                              UnmapRoute runs the Cloud Foundry unmap-route command.

                              Returns the combined standard output and standard error.

                              func (Courier) UnmapRouteWithPath

                              func (c Courier) UnmapRouteWithPath(appName, domain, hostname, path string) ([]byte, error)

                                UnmapRoute runs the Cloud Foundry unmap-route command.

                                Returns the combined standard output and standard error.

                                func (Courier) Uups

                                func (c Courier) Uups(appName string, body string) ([]byte, error)

                                  Uups runs the Cloud Foundry UUPS command to update a user provided serivce

                                  type CourierConstructor

                                  type CourierConstructor func(executor I.Executor) I.Courier

                                  Source Files

                                  Directories

                                  Path Synopsis
                                  Package executor runs commands against the Cloud Foundry binary.
                                  Package executor runs commands against the Cloud Foundry binary.