role

Documentation

Overview

Package role provides roles, which are a way to share common attributes and run lists between different nodes.

Index

• func DoesExist(roleName string) (bool, util.Gerror)
• func GetList() []string
• type Role
  • func AllRoles() []*Role
  • func Get(roleName string) (*Role, error)
  • func GetMulti(roleNames []string) ([]*Role, util.Gerror)
  • func New(name string) (*Role, util.Gerror)
  • func NewFromJSON(jsonRole map[string]interface{}) (*Role, util.Gerror)
  • func (r *Role) Delete() error
  • func (r *Role) DocID() string
  • func (r *Role) Flatten() map[string]interface{}
  • func (r *Role) GetName() string
  • func (r *Role) Index() string
  • func (r *Role) Save() error
  • func (r *Role) URLType() string
  • func (r *Role) UpdateFromJSON(jsonRole map[string]interface{}) util.Gerror

Functions

func DoesExist

func DoesExist(roleName string) (bool, util.Gerror)

DoesExist checks if this role exists or not

func GetList

func GetList() []string

GetList gets a list of the roles on this server.

Types

type Role

type Role struct {
	Name        string                 `json:"name"`
	ChefType    string                 `json:"chef_type"`
	JSONClass   string                 `json:"json_class"`
	RunList     []string               `json:"run_list"`
	EnvRunLists map[string][]string    `json:"env_run_lists"`
	Description string                 `json:"description"`
	Default     map[string]interface{} `json:"default_attributes"`
	Override    map[string]interface{} `json:"override_attributes"`
}

Role is a way to specify shared run lists and attributes for nodes.

func AllRoles

func AllRoles() []*Role

AllRoles returns all the roles on the server

func Get

func Get(roleName string) (*Role, error)

Get a role.

func GetMulti

func GetMulti(roleNames []string) ([]*Role, util.Gerror)

GetMulti gets multiple roles from a slice of role names.

func New

func New(name string) (*Role, util.Gerror)

New creates a new role.

func NewFromJSON

func NewFromJSON(jsonRole map[string]interface{}) (*Role, util.Gerror)

NewFromJSON creates a new role from the uploaded JSON.

func (*Role) Delete

func (r *Role) Delete() error

Delete a role.

func (*Role) DocID

func (r *Role) DocID() string

DocID returns the role's name.

func (*Role) Flatten

func (r *Role) Flatten() map[string]interface{}

Flatten a role so it's suitable for indexing.

func (*Role) GetName

func (r *Role) GetName() string

GetName returns the role's name.

func (*Role) Index

func (r *Role) Index() string

Index tells the indexer where it should put the role when it's being indexed.

func (*Role) Save

func (r *Role) Save() error

Save the role.

func (*Role) URLType

func (r *Role) URLType() string

URLType returns the base element of a role's URL.

func (*Role) UpdateFromJSON

func (r *Role) UpdateFromJSON(jsonRole map[string]interface{}) util.Gerror

UpdateFromJSON updates an existing role with the uploaded JSON.