rest

Documentation

Index

• Variables
• func DencodeID(id string) (string, error)
• func EncodeID(id string) string
• func NewRouter(s *Server) *mux.Router
• func NewSchema() *client.Schemas
• type DiskCollection
• type JournalInput
• type PrepareRebuildOutput
• type RegReplica
• type Replica
  • func NewReplica(context *api.ApiContext, address string, mode types.Mode) *Replica
• type ReplicaCollection
• type ResizeInput
• type RevertInput
• type Server
  • func NewServer(c *controller.Controller) *Server
  • func (s *Server) CreateQuorumReplica(rw http.ResponseWriter, req *http.Request) error
  • func (s *Server) CreateReplica(rw http.ResponseWriter, req *http.Request) error
  • func (s *Server) DeleteReplica(rw http.ResponseWriter, req *http.Request) error
  • func (s *Server) GetReplica(rw http.ResponseWriter, req *http.Request) error
  • func (s *Server) GetVolume(rw http.ResponseWriter, req *http.Request) error
  • func (s *Server) GetVolumeStats(rw http.ResponseWriter, req *http.Request) error
  • func (s *Server) ListJournal(rw http.ResponseWriter, req *http.Request) error
  • func (s *Server) ListReplicas(rw http.ResponseWriter, req *http.Request) error
  • func (s *Server) ListVolumes(rw http.ResponseWriter, req *http.Request) error
  • func (s *Server) PrepareRebuildReplica(rw http.ResponseWriter, req *http.Request) error
  • func (s *Server) RegisterReplica(rw http.ResponseWriter, req *http.Request) error
  • func (s *Server) ResizeVolume(rw http.ResponseWriter, req *http.Request) error
  • func (s *Server) RevertVolume(rw http.ResponseWriter, req *http.Request) error
  • func (s *Server) ShutdownVolume(rw http.ResponseWriter, req *http.Request) error
  • func (s *Server) SnapshotVolume(rw http.ResponseWriter, req *http.Request) error
  • func (s *Server) StartVolume(rw http.ResponseWriter, req *http.Request) error
  • func (s *Server) UpdateReplica(rw http.ResponseWriter, req *http.Request) error
  • func (s *Server) VerifyRebuildReplica(rw http.ResponseWriter, req *http.Request) error
• type SnapshotInput
• type SnapshotOutput
• type StartInput
• type Volume
  • func NewVolume(context *api.ApiContext, name string, readOnly bool, replicas int) *Volume
• type VolumeCollection
• type VolumeStats

Variables

var (
	// OpenEBSJivaRegestrationRequestDuration gets the response time of the
	// requested api.
	OpenEBSJivaRegestrationRequestDuration = prometheus.NewHistogramVec(
		prometheus.HistogramOpts{
			Name:    "openebs_jiva_registration_request_duration_seconds",
			Help:    "Request response time of the /v1/register to register replicas.",
			Buckets: []float64{0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.5, 1, 2.5, 5, 10},
		},

		[]string{"code", "method"},
	)
	// OpenEBSJivaRegestrationRequestCounter Count the no of request Since a request has been made on /v1/volume
	OpenEBSJivaRegestrationRequestCounter = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Name: "openebs_jiva_registration_requests_total",
			Help: "Total number of /v1/register requests to register replicas.",
		},
		[]string{"code", "method"},
	)
)

Functions

func DencodeID

func DencodeID(id string) (string, error)

func EncodeID

func EncodeID(id string) string

func NewRouter

func NewRouter(s *Server) *mux.Router

func NewSchema

func NewSchema() *client.Schemas

Types

type DiskCollection

type DiskCollection struct {
	client.Collection
	Data []string `json:"data"`
}

type JournalInput

type JournalInput struct {
	client.Resource
	Limit int `json:"limit"`
}

type PrepareRebuildOutput

type PrepareRebuildOutput struct {
	client.Resource
	Disks []string `json:"disks"`
}

type RegReplica

type RegReplica struct {
	client.Resource
	Address     string            `json:"Address"`
	RevCount    string            `json:"RevCount"`
	PeerDetails types.PeerDetails `json:"PeerDetails"`
	RepType     string            `json:"RepType"`
	RepState    string            `json:"RepState"`
	UpTime      time.Duration     `json:"UpTime"`
}

type Replica

type Replica struct {
	client.Resource
	Address string `json:"address"`
	Mode    string `json:"mode"`
}

func NewReplica

func NewReplica(context *api.ApiContext, address string, mode types.Mode) *Replica

type ReplicaCollection

type ReplicaCollection struct {
	client.Collection
	Data []Replica `json:"data"`
}

type ResizeInput

type ResizeInput struct {
	client.Resource
	Name string `json:"name"`
	Size string `json:"size"`
}

type RevertInput

type RevertInput struct {
	client.Resource
	Name string `json:"name"`
}

type Server

type Server struct {
	RequestDuration *prometheus.HistogramVec
	RequestCounter  *prometheus.CounterVec
	// contains filtered or unexported fields
}

func NewServer

func NewServer(c *controller.Controller) *Server

func (*Server) CreateQuorumReplica

func (s *Server) CreateQuorumReplica(rw http.ResponseWriter, req *http.Request) error

func (*Server) CreateReplica

func (s *Server) CreateReplica(rw http.ResponseWriter, req *http.Request) error

func (*Server) DeleteReplica

func (s *Server) DeleteReplica(rw http.ResponseWriter, req *http.Request) error

func (*Server) GetReplica

func (s *Server) GetReplica(rw http.ResponseWriter, req *http.Request) error

func (*Server) GetVolume

func (s *Server) GetVolume(rw http.ResponseWriter, req *http.Request) error

func (*Server) GetVolumeStats

func (s *Server) GetVolumeStats(rw http.ResponseWriter, req *http.Request) error

func (*Server) ListJournal

func (s *Server) ListJournal(rw http.ResponseWriter, req *http.Request) error

ListJournal flushes operation journal (replica read/write, ping, etc.) accumulated since previous flush

func (*Server) ListReplicas

func (s *Server) ListReplicas(rw http.ResponseWriter, req *http.Request) error

func (*Server) ListVolumes

func (s *Server) ListVolumes(rw http.ResponseWriter, req *http.Request) error

func (*Server) PrepareRebuildReplica

func (s *Server) PrepareRebuildReplica(rw http.ResponseWriter, req *http.Request) error

func (*Server) RegisterReplica

func (s *Server) RegisterReplica(rw http.ResponseWriter, req *http.Request) error

func (*Server) ResizeVolume

func (s *Server) ResizeVolume(rw http.ResponseWriter, req *http.Request) error

func (*Server) RevertVolume

func (s *Server) RevertVolume(rw http.ResponseWriter, req *http.Request) error

func (*Server) ShutdownVolume

func (s *Server) ShutdownVolume(rw http.ResponseWriter, req *http.Request) error

func (*Server) SnapshotVolume

func (s *Server) SnapshotVolume(rw http.ResponseWriter, req *http.Request) error

func (*Server) StartVolume

func (s *Server) StartVolume(rw http.ResponseWriter, req *http.Request) error

func (*Server) UpdateReplica

func (s *Server) UpdateReplica(rw http.ResponseWriter, req *http.Request) error

func (*Server) VerifyRebuildReplica

func (s *Server) VerifyRebuildReplica(rw http.ResponseWriter, req *http.Request) error

type SnapshotInput

type SnapshotInput struct {
	client.Resource
	Name string `json:"name"`
}

type SnapshotOutput

type SnapshotOutput struct {
	client.Resource
}

type StartInput

type StartInput struct {
	client.Resource
	Replicas []string `json:"replicas"`
}

type Volume

type Volume struct {
	client.Resource
	Name         string `json:"name"`
	ReplicaCount int    `json:"replicaCount"`
	ReadOnly     string `json:"readOnly"`
}

func NewVolume

func NewVolume(context *api.ApiContext, name string, readOnly bool, replicas int) *Volume

type VolumeCollection

type VolumeCollection struct {
	client.Collection
	Data []Volume `json:"data"`
}

type VolumeStats

type VolumeStats struct {
	client.Resource
	RevisionCounter int64         `json:"RevisionCounter"`
	ReplicaCounter  int64         `json:"ReplicaCounter"`
	SCSIIOCount     map[int]int64 `json:"SCSIIOCount"`

	ReadIOPS            string `json:"ReadIOPS"`
	TotalReadTime       string `json:"TotalReadTime"`
	TotalReadBlockCount string `json:"TotalReadBlockCount"`

	WriteIOPS            string `json:"WriteIOPS"`
	TotalWriteTime       string `json:"TotalWriteTime"`
	TotalWriteBlockCount string `json:"TotatWriteBlockCount"`

	UsedLogicalBlocks string  `json:"UsedLogicalBlocks"`
	UsedBlocks        string  `json:"UsedBlocks"`
	SectorSize        string  `json:"SectorSize"`
	Size              string  `json:"Size"`
	UpTime            float64 `json:"UpTime"`
	Name              string  `json:"Name"`
}