soko

README

soko (倉庫)

Server metadata inventory Manager, backended with Consul, EC2, OpenStack Nova and so on

Why soko?

In some case we need to know the server's role(web server? api server?), or master/slave (in case of MySQL, Solr, &c.), or some kind of metadata.

soko is designed for handling such metadata from Server inventory in one liner.

soko is very friendly with shell scripts(which are easy and available in cloud-init), ohai for Chef, facter for Puppet, run_command in Itamae, and so on.

Inventory backends with:

• Consul KV
• EC2's Tags
• Metadata attribute in OpenStack Compute API v2

And more, soon...

Install

• Download linux binary zipball via https://github.com/udzura/soko/releases/latest
• Then extract

[cloud-user@www901 ~]$ ./soko help
Usage of ./soko:
  -server-id="f6809f77-e7b2-4d66-832e-XXXX": Target server's ID to get/put/delete. Defaults to cloud-init's server ID
[cloud-user@www901 ~]$ ./soko get Hi
Value for Hi seems to be empty.

[cloud-user@www901 ~]$ ./soko get Test
Value for Test seems to be empty.

[cloud-user@www901 ~]$ ./soko put Test Hello
OK
[cloud-user@www901 ~]$ ./soko get Test
Hello
[cloud-user@www901 ~]$ ./soko delete Test
OK
[cloud-user@www901 ~]$ ./soko get Test
Value for Test seems to be empty.

Configuration

• Exists /etc/soko.toml

[default]
# backend should be in [consul, aws, openstack]
backend = "consul"

[consul]
# Set just a consul backend URL
url = "consul://foo.example.consul:8500/"

[openstack]
# OpenStack specific config
username = "udzura"
password = "XXXXXXXXXXXXXX"
tenant_name = "soko-test"
auth_url = "https://keystone.example.com:1234/v2.0"
region = "RegionOne"

[aws]
# AWS specific config
access_key_id = "AKIXXXXXXXXXXXXX"
secret_access_key = "4Jr6DXXXXXXXXXXXXXXXXXXXXXX"
region = "ap-northeast-1"

• You can configure soko by one liner:

$ soko open aws access_key_id=$AWS_ACCESS_KEY_ID secret_access_key=$AWS_SECRET_ACCESS_KEY region=ap-northeast-1
# It goes such a way with other backends

soko will work on

• Cloud servers(such as EC2, OpenStack... with file /var/lib/cloud/data/instance-id existing)
• Cousul cluster backended

Under testing

• OpenStack compute API v2
• AWS EC2

Yaruzo!!

• Google Compute Engine
• etcd....???
• Redis....??????

Documentation

Index

• Constants
• func CloudServerID() string
• type AWSBackend
  • func NewAWSBackend(config SectionConfig) (*AWSBackend, error)
  • func (b *AWSBackend) Delete(serverID string, key string) error
  • func (b *AWSBackend) Get(serverID string, key string) (string, error)
  • func (b *AWSBackend) Put(serverID string, key string, value string) error
  • func (b *AWSBackend) Save() error
• type Backend
  • func FindBackend(config *Config) (Backend, error)
• type Config
  • func DefaultConfig() (*Config, error)
  • func NewConfig(backend string, args []string) (*Config, error)
  • func (c *Config) SetConfigByBackend(data *toml.TomlTree) error
• type ConsulBackend
  • func NewConsulBackend(hostWithPort string, ssl bool) (*ConsulBackend, error)
  • func (b *ConsulBackend) Delete(serverID string, key string) error
  • func (b *ConsulBackend) Get(serverID string, key string) (string, error)
  • func (b *ConsulBackend) Put(serverID string, key string, value string) error
  • func (b *ConsulBackend) Save() error
• type OpenStackBackend
  • func NewOpenStackBackend(config SectionConfig) (*OpenStackBackend, error)
  • func (b *OpenStackBackend) Delete(serverID string, key string) error
  • func (b *OpenStackBackend) Get(serverID string, key string) (string, error)
  • func (b *OpenStackBackend) Put(serverID string, key string, value string) error
  • func (b *OpenStackBackend) Save() error
• type Runner
  • func (r *Runner) Delete(key string)
  • func (r *Runner) Get(key string)
  • func (r *Runner) Put(key string, value string)
  • func (r *Runner) Run(subcommand string, args []string)
  • func (r *Runner) Save()
• type SectionConfig

Constants

const Version = "0.1.0"

Functions

func CloudServerID

func CloudServerID() string

Types

type AWSBackend

type AWSBackend struct {
	SectionConfig
	// contains filtered or unexported fields
}

func NewAWSBackend

func NewAWSBackend(config SectionConfig) (*AWSBackend, error)

func (*AWSBackend) Delete

func (b *AWSBackend) Delete(serverID string, key string) error

func (*AWSBackend) Get

func (b *AWSBackend) Get(serverID string, key string) (string, error)

func (*AWSBackend) Put

func (b *AWSBackend) Put(serverID string, key string, value string) error

func (*AWSBackend) Save

func (b *AWSBackend) Save() error

type Backend

type Backend interface {
	// Saves current configuration to a specific file
	Save() error

	// APIs to control backend metadata
	// Gets value from key
	Get(serverID string, key string) (string, error)

	// Put value on the key
	Put(serverID string, key string, value string) error

	// Delete value on the key
	Delete(serverID string, key string) error
}

func FindBackend

func FindBackend(config *Config) (Backend, error)

type Config

type Config struct {
	Backend string
	SectionConfig
}

func DefaultConfig

func DefaultConfig() (*Config, error)

func NewConfig

func NewConfig(backend string, args []string) (*Config, error)

func (*Config) SetConfigByBackend

func (c *Config) SetConfigByBackend(data *toml.TomlTree) error

type ConsulBackend

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

func NewConsulBackend

func NewConsulBackend(hostWithPort string, ssl bool) (*ConsulBackend, error)

func (*ConsulBackend) Delete

func (b *ConsulBackend) Delete(serverID string, key string) error

func (*ConsulBackend) Get

func (b *ConsulBackend) Get(serverID string, key string) (string, error)

func (*ConsulBackend) Put

func (b *ConsulBackend) Put(serverID string, key string, value string) error

func (*ConsulBackend) Save

func (b *ConsulBackend) Save() error

type OpenStackBackend

type OpenStackBackend struct {
	SectionConfig
	// contains filtered or unexported fields
}

func NewOpenStackBackend

func NewOpenStackBackend(config SectionConfig) (*OpenStackBackend, error)

func (*OpenStackBackend) Delete

func (b *OpenStackBackend) Delete(serverID string, key string) error

func (*OpenStackBackend) Get

func (b *OpenStackBackend) Get(serverID string, key string) (string, error)

func (*OpenStackBackend) Put

func (b *OpenStackBackend) Put(serverID string, key string, value string) error

func (*OpenStackBackend) Save

func (b *OpenStackBackend) Save() error

type Runner

type Runner struct {
	ServerID string
	// contains filtered or unexported fields
}

func (*Runner) Delete

func (r *Runner) Delete(key string)

func (*Runner) Get

func (r *Runner) Get(key string)

func (*Runner) Put

func (r *Runner) Put(key string, value string)

func (*Runner) Run

func (r *Runner) Run(subcommand string, args []string)

func (*Runner) Save

func (r *Runner) Save()

type SectionConfig

type SectionConfig map[string]string