firewaller

Documentation

Index

• type Machine
  • func (m *Machine) ActiveNetworks() ([]names.NetworkTag, error)
  • func (m *Machine) InstanceId() (instance.Id, error)
  • func (m *Machine) Life() params.Life
  • func (m *Machine) OpenedPorts(networkTag names.NetworkTag) (map[network.PortRange]names.UnitTag, error)
  • func (m *Machine) Tag() names.MachineTag
  • func (m *Machine) WatchUnits() (watcher.StringsWatcher, error)
• type Service
  • func (s *Service) IsExposed() (bool, error)
  • func (s *Service) Life() params.Life
  • func (s *Service) Name() string
  • func (s *Service) Refresh() error
  • func (s *Service) Tag() names.ServiceTag
  • func (s *Service) Watch() (watcher.NotifyWatcher, error)
• type State
  • func NewState(caller base.APICaller) *State
  • func (st *State) BestAPIVersion() int
  • func (st *State) EnvironTag() (names.EnvironTag, error)
  • func (st *State) Machine(tag names.MachineTag) (*Machine, error)
  • func (st *State) Unit(tag names.UnitTag) (*Unit, error)
  • func (st *State) WatchEnvironMachines() (watcher.StringsWatcher, error)
  • func (st *State) WatchOpenedPorts() (watcher.StringsWatcher, error)
• type Unit
  • func (u *Unit) AssignedMachine() (names.MachineTag, error)
  • func (u *Unit) Life() params.Life
  • func (u *Unit) Name() string
  • func (u *Unit) Refresh() error
  • func (u *Unit) Service() (*Service, error)
  • func (u *Unit) Tag() names.UnitTag

Types

type Machine

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

Machine represents a juju machine as seen by the firewaller worker.

func (*Machine) ActiveNetworks

func (m *Machine) ActiveNetworks() ([]names.NetworkTag, error)

ActiveNetworks returns a list of network tags for which the machine has opened ports.

func (*Machine) InstanceId

func (m *Machine) InstanceId() (instance.Id, error)

InstanceId returns the provider specific instance id for this machine, or a CodeNotProvisioned error, if not set.

func (*Machine) Life

func (m *Machine) Life() params.Life

Life returns the machine's life cycle value.

func (*Machine) OpenedPorts

func (m *Machine) OpenedPorts(networkTag names.NetworkTag) (map[network.PortRange]names.UnitTag, error)

OpenedPorts returns a map of network.PortRange to unit tag for all opened port ranges on the machine for the given network tag.

func (*Machine) Tag

func (m *Machine) Tag() names.MachineTag

Tag returns the machine tag.

func (*Machine) WatchUnits

func (m *Machine) WatchUnits() (watcher.StringsWatcher, error)

WatchUnits starts a StringsWatcher to watch all units assigned to the machine.

type Service

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

Service represents the state of a service.

func (*Service) IsExposed

func (s *Service) IsExposed() (bool, error)

IsExposed returns whether this service is exposed. The explicitly open ports (with open-port) for exposed services may be accessed from machines outside of the local deployment network.

NOTE: This differs from state.Service.IsExposed() by returning an error as well, because it needs to make an API call.

func (*Service) Life

func (s *Service) Life() params.Life

Life returns the service's current life state.

func (*Service) Name

func (s *Service) Name() string

Name returns the service name.

func (*Service) Refresh

func (s *Service) Refresh() error

Refresh refreshes the contents of the Service from the underlying state.

func (*Service) Tag

func (s *Service) Tag() names.ServiceTag

Tag returns the service tag.

func (*Service) Watch

func (s *Service) Watch() (watcher.NotifyWatcher, error)

Watch returns a watcher for observing changes to a service.

type State

type State struct {
	*common.EnvironWatcher
	// contains filtered or unexported fields
}

State provides access to the Firewaller API facade.

func NewState

func NewState(caller base.APICaller) *State

NewState creates a new client-side Firewaller API facade.

func (*State) BestAPIVersion

func (st *State) BestAPIVersion() int

BestAPIVersion returns the API version that we were able to determine is supported by both the client and the API Server.

func (*State) EnvironTag

func (st *State) EnvironTag() (names.EnvironTag, error)

EnvironTag returns the current environment's tag.

func (*State) Machine

func (st *State) Machine(tag names.MachineTag) (*Machine, error)

Machine provides access to methods of a state.Machine through the facade.

func (*State) Unit

func (st *State) Unit(tag names.UnitTag) (*Unit, error)

Unit provides access to methods of a state.Unit through the facade.

func (*State) WatchEnvironMachines

func (st *State) WatchEnvironMachines() (watcher.StringsWatcher, error)

WatchEnvironMachines returns a StringsWatcher that notifies of changes to the life cycles of the top level machines in the current environment.

func (*State) WatchOpenedPorts

func (st *State) WatchOpenedPorts() (watcher.StringsWatcher, error)

WatchOpenedPorts returns a StringsWatcher that notifies of changes to the opened ports for the current environment.

type Unit

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

Unit represents a juju unit as seen by a firewaller worker.

func (*Unit) AssignedMachine

func (u *Unit) AssignedMachine() (names.MachineTag, error)

AssignedMachine returns the tag of this unit's assigned machine (if any), or a CodeNotAssigned error.

func (*Unit) Life

func (u *Unit) Life() params.Life

Life returns the unit's life cycle value.

func (*Unit) Name

func (u *Unit) Name() string

Name returns the name of the unit.

func (*Unit) Refresh

func (u *Unit) Refresh() error

Refresh updates the cached local copy of the unit's data.

func (*Unit) Service

func (u *Unit) Service() (*Service, error)

Service returns the service.

func (*Unit) Tag

func (u *Unit) Tag() names.UnitTag

Tag returns the unit tag.