service

Documentation

Index

• Variables
• func CreateServiceInstance(instance ServiceInstance, service *Service, user *auth.User) error
• func DeleteInstance(si *ServiceInstance) error
• func GetServicesNames(services []Service) []string
• func Proxy(service *Service, path string, w http.ResponseWriter, r *http.Request) error
• func UpdateService(si *ServiceInstance) error
• type Client
  • func (c *Client) BindApp(instance *ServiceInstance, app bind.App) (map[string]string, error)
  • func (c *Client) BindUnit(instance *ServiceInstance, app bind.App, unit bind.Unit) error
  • func (c *Client) Create(instance *ServiceInstance, user string) error
  • func (c *Client) Destroy(instance *ServiceInstance) error
  • func (c *Client) Info(instance *ServiceInstance) ([]map[string]string, error)
  • func (c *Client) Plans() ([]Plan, error)
  • func (c *Client) Proxy(path string, w http.ResponseWriter, r *http.Request) error
  • func (c *Client) Status(instance *ServiceInstance) (string, error)
  • func (c *Client) UnbindApp(instance *ServiceInstance, app bind.App) error
  • func (c *Client) UnbindUnit(instance *ServiceInstance, app bind.App, unit bind.Unit) error
• type Plan
  • func GetPlanByServiceNameAndPlanName(serviceName, planName string) (Plan, error)
  • func GetPlansByServiceName(serviceName string) ([]Plan, error)
• type Service
  • func GetServicesByFilter(filter bson.M) ([]Service, error)
  • func GetServicesByOwnerTeamsAndServices(teams []string, services []string) ([]Service, error)
  • func GetServicesByTeamsAndServices(teams []string, services []string) ([]Service, error)
  • func (s *Service) Create() error
  • func (s *Service) Delete() error
  • func (s *Service) Get() error
  • func (s *Service) GetUsername() string
  • func (s *Service) GrantAccess(team *auth.Team) error
  • func (s *Service) HasTeam(team *auth.Team) bool
  • func (s *Service) RevokeAccess(team *auth.Team) error
  • func (s *Service) Update() error
• type ServiceInstance
  • func GetServiceInstance(serviceName string, instanceName string) (*ServiceInstance, error)
  • func GetServiceInstancesByServices(services []Service) ([]ServiceInstance, error)
  • func GetServicesInstancesByTeamsAndNames(teams []string, names []string, appName, serviceName string) ([]ServiceInstance, error)
  • func (si *ServiceInstance) BindApp(app bind.App, shouldRestart bool, writer io.Writer) error
  • func (si *ServiceInstance) BindUnit(app bind.App, unit bind.Unit) error
  • func (si *ServiceInstance) Create() error
  • func (si *ServiceInstance) FindApp(appName string) int
  • func (si *ServiceInstance) GetIdentifier() string
  • func (si *ServiceInstance) Grant(teamName string) error
  • func (si *ServiceInstance) Info() (map[string]string, error)
  • func (si *ServiceInstance) MarshalJSON() ([]byte, error)
  • func (si *ServiceInstance) Revoke(teamName string) error
  • func (si *ServiceInstance) Service() *Service
  • func (si *ServiceInstance) Status() (string, error)
  • func (si *ServiceInstance) UnbindApp(app bind.App, shouldRestart bool, writer io.Writer) error
  • func (si *ServiceInstance) UnbindUnit(app bind.App, unit bind.Unit) error
• type ServiceModel

Variables

var (
	ErrInstanceAlreadyExistsInAPI = errors.New("instance already exists in the service API")
	ErrInstanceNotFoundInAPI      = errors.New("instance does not exist in the service API")
	ErrInstanceNotReady           = errors.New("instance is not ready yet")
)

var (
	ErrServiceInstanceNotFound   = errors.New("service instance not found")
	ErrInvalidInstanceName       = errors.New("invalid service instance name")
	ErrInstanceNameAlreadyExists = errors.New("instance name already exists.")
	ErrAccessNotAllowed          = errors.New("user does not have access to this service instance")
	ErrTeamMandatory             = errors.New("please specify the team that owns the service instance")
	ErrAppAlreadyBound           = errors.New("app is already bound to this service instance")
	ErrAppNotBound               = errors.New("app is not bound to this service instance")
	ErrUnitAlreadyBound          = errors.New("unit is already bound to this service instance")
	ErrUnitNotBound              = errors.New("unit is not bound to this service instance")
	ErrServiceInstanceBound      = errors.New("This service instance is bound to at least one app. Unbind them before removing it")
)

var (
	ErrServiceAlreadyExists = errors.New("Service already exists.")
)

Functions

func CreateServiceInstance

func CreateServiceInstance(instance ServiceInstance, service *Service, user *auth.User) error

func DeleteInstance

func DeleteInstance(si *ServiceInstance) error

DeleteInstance deletes the service instance from the database.

func GetServicesNames

func GetServicesNames(services []Service) []string

func Proxy

func Proxy(service *Service, path string, w http.ResponseWriter, r *http.Request) error

Proxy is a proxy between tsuru and the service. This method allow customized service methods.

func UpdateService

func UpdateService(si *ServiceInstance) error

Types

type Client

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

func (*Client) BindApp

func (c *Client) BindApp(instance *ServiceInstance, app bind.App) (map[string]string, error)

func (*Client) BindUnit

func (c *Client) BindUnit(instance *ServiceInstance, app bind.App, unit bind.Unit) error

func (*Client) Create

func (c *Client) Create(instance *ServiceInstance, user string) error

func (*Client) Destroy

func (c *Client) Destroy(instance *ServiceInstance) error

func (*Client) Info

func (c *Client) Info(instance *ServiceInstance) ([]map[string]string, error)

Info returns the additional info about a service instance. The api should be prepared to receive the request, like below: GET /resources/<name>

func (*Client) Plans

func (c *Client) Plans() ([]Plan, error)

Plans returns the service plans. The api should be prepared to receive the request, like below: GET /resources/plans

func (*Client) Proxy

func (c *Client) Proxy(path string, w http.ResponseWriter, r *http.Request) error

Proxy is a proxy between tsuru and the service. This method allow customized service methods.

func (*Client) Status

func (c *Client) Status(instance *ServiceInstance) (string, error)

func (*Client) UnbindApp

func (c *Client) UnbindApp(instance *ServiceInstance, app bind.App) error

func (*Client) UnbindUnit

func (c *Client) UnbindUnit(instance *ServiceInstance, app bind.App, unit bind.Unit) error

type Plan

type Plan struct {
	Name        string
	Description string
}

Plan represents a service plan

func GetPlanByServiceNameAndPlanName

func GetPlanByServiceNameAndPlanName(serviceName, planName string) (Plan, error)

func GetPlansByServiceName

func GetPlansByServiceName(serviceName string) ([]Plan, error)

type Service

type Service struct {
	Name         string `bson:"_id"`
	Username     string
	Password     string
	Endpoint     map[string]string
	OwnerTeams   []string `bson:"owner_teams"`
	Teams        []string
	Doc          string
	IsRestricted bool `bson:"is_restricted"`
}

func GetServicesByFilter

func GetServicesByFilter(filter bson.M) ([]Service, error)

func GetServicesByOwnerTeamsAndServices

func GetServicesByOwnerTeamsAndServices(teams []string, services []string) ([]Service, error)

func GetServicesByTeamsAndServices

func GetServicesByTeamsAndServices(teams []string, services []string) ([]Service, error)

func (*Service) Create

func (s *Service) Create() error

func (*Service) Delete

func (s *Service) Delete() error

func (*Service) Get

func (s *Service) Get() error

func (*Service) GetUsername

func (s *Service) GetUsername() string

func (*Service) GrantAccess

func (s *Service) GrantAccess(team *auth.Team) error

func (*Service) HasTeam

func (s *Service) HasTeam(team *auth.Team) bool

func (*Service) RevokeAccess

func (s *Service) RevokeAccess(team *auth.Team) error

func (*Service) Update

func (s *Service) Update() error

type ServiceInstance

type ServiceInstance struct {
	Name        string
	Id          int
	ServiceName string `bson:"service_name"`
	PlanName    string `bson:"plan_name"`
	Apps        []string
	Units       []string
	Teams       []string
	TeamOwner   string
	Description string
}

func GetServiceInstance

func GetServiceInstance(serviceName string, instanceName string) (*ServiceInstance, error)

func GetServiceInstancesByServices

func GetServiceInstancesByServices(services []Service) ([]ServiceInstance, error)

func GetServicesInstancesByTeamsAndNames

func GetServicesInstancesByTeamsAndNames(teams []string, names []string, appName, serviceName string) ([]ServiceInstance, error)

func (*ServiceInstance) BindApp

func (si *ServiceInstance) BindApp(app bind.App, shouldRestart bool, writer io.Writer) error

BindApp makes the bind between the service instance and an app.

func (*ServiceInstance) BindUnit

func (si *ServiceInstance) BindUnit(app bind.App, unit bind.Unit) error

BindUnit makes the bind between the binder and an unit.

func (*ServiceInstance) Create

func (si *ServiceInstance) Create() error

func (*ServiceInstance) FindApp

func (si *ServiceInstance) FindApp(appName string) int

func (*ServiceInstance) GetIdentifier

func (si *ServiceInstance) GetIdentifier() string

func (*ServiceInstance) Grant

func (si *ServiceInstance) Grant(teamName string) error

func (*ServiceInstance) Info

func (si *ServiceInstance) Info() (map[string]string, error)

func (*ServiceInstance) MarshalJSON

func (si *ServiceInstance) MarshalJSON() ([]byte, error)

MarshalJSON marshals the ServiceName in json format.

func (*ServiceInstance) Revoke

func (si *ServiceInstance) Revoke(teamName string) error

func (*ServiceInstance) Service

func (si *ServiceInstance) Service() *Service

func (*ServiceInstance) Status

func (si *ServiceInstance) Status() (string, error)

Status returns the service instance status.

func (*ServiceInstance) UnbindApp

func (si *ServiceInstance) UnbindApp(app bind.App, shouldRestart bool, writer io.Writer) error

UnbindApp makes the unbind between the service instance and an app.

func (*ServiceInstance) UnbindUnit

func (si *ServiceInstance) UnbindUnit(app bind.App, unit bind.Unit) error

UnbindUnit makes the unbind between the service instance and an unit.

type ServiceModel

type ServiceModel struct {
	Service   string   `json:"service"`
	Instances []string `json:"instances"`
	Plans     []string `json:"plans"`
}