api

package
v0.1.56 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 27, 2025 License: GPL-3.0 Imports: 69 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ListenEvents added in v0.1.30 

func ListenEvents(ctx context.Context, wss *wss.WebSockets, position int, conn *websocket.Conn, lock *sync.RWMutex)

Types

type Api 

type Api struct {
	Server          *embed.Etcd
	Etcd            *clientv3.Client
	LeaseIdentifier *clientv3.LeaseGrantResponse
	User            *authentication.User
	Config          *configuration.Configuration
	Keys            *keys.Keys
	DnsCache        *dns.Records
	Wss             *wss.WebSockets

	Cluster       *cluster.Cluster
	Replication   *distributed.Replication
	Kinds         *relations.RelationRegistry
	KindsRegistry map[string]ikinds.Kind
	Manager       *manager.Manager
	Version       *version.Version
	// contains filtered or unexported fields
}

func NewApi 

func NewApi(config *configuration.Configuration) *Api

func (*Api) AddNode added in v0.0.57 

func (a *Api) AddNode(c *gin.Context)

func (*Api) CompareKind added in v0.1.30 

func (a *Api) CompareKind(c *gin.Context)

CompareKind godoc 

@Summary		Get specific kind
@Description	get specific kind from the store
@Tags			database
@Produce		json

@Success 200 {object} contracts.Response @Failure 400 {object} contracts.Response @Failure 404 {object} contracts.Response @Failure 500 {object} contracts.Response @Router /kind/{prefix}/{category}/{kind}/{group}/{name} [get]

func (*Api) Control added in v0.1.42 

func (a *Api) Control(c *gin.Context)

func (*Api) CreateUser added in v0.0.10 

func (a *Api) CreateUser(c *gin.Context)

func (*Api) Debug added in v0.0.114 

func (a *Api) Debug(c *gin.Context)

func (*Api) DeleteKind added in v0.0.137 

func (a *Api) DeleteKind(c *gin.Context)

DeleteKind godoc 

@Summary		List kind objects
@Description	list kind objects in the store
@Tags			database
@Produce		json

@Success 200 {object} contracts.Response @Failure 400 {object} contracts.Response @Failure 404 {object} contracts.Response @Failure 500 {object} contracts.Response @Router /kind/{prefix}/{category}/{kind}/{group}/{name} [delete]

func (*Api) DisplayVersion added in v0.1.56 

func (a *Api) DisplayVersion(c *gin.Context)

func (*Api) Events added in v0.1.30 

func (a *Api) Events(c *gin.Context)

func (*Api) Exec added in v0.1.32 

func (a *Api) Exec(c *gin.Context)

func (*Api) ExportClients added in v0.0.116 

func (a *Api) ExportClients(c *gin.Context)

func (*Api) GetCluster added in v0.0.57 

func (a *Api) GetCluster() *cluster.Cluster

func (*Api) GetConfChangeC added in v0.1.56 

func (a *Api) GetConfChangeC() chan raftpb.ConfChange

func (*Api) GetConfig added in v0.1.56 

func (a *Api) GetConfig() *configuration.Configuration

func (*Api) GetDnsCache added in v0.1.56 

func (a *Api) GetDnsCache() *dns.Records

func (*Api) GetEtcd added in v0.1.56 

func (a *Api) GetEtcd() *clientv3.Client

func (*Api) GetKeys added in v0.1.56 

func (a *Api) GetKeys() *keys.Keys

func (*Api) GetKind added in v0.0.137 

func (a *Api) GetKind(c *gin.Context)

GetKind godoc 

@Summary		Get specific kind
@Description	get specific kind from the store
@Tags			database
@Produce		json

@Success 200 {object} contracts.Response @Failure 400 {object} contracts.Response @Failure 404 {object} contracts.Response @Failure 500 {object} contracts.Response @Router /kind/{prefix}/{category}/{kind}/{group}/{name} [get]

func (*Api) GetKinds added in v0.1.56 

func (a *Api) GetKinds() *relations.RelationRegistry

func (*Api) GetKindsRegistry added in v0.1.56 

func (a *Api) GetKindsRegistry() map[string]ikinds.Kind

func (*Api) GetLeaseIdentifier added in v0.1.56 

func (a *Api) GetLeaseIdentifier() *clientv3.LeaseGrantResponse

func (*Api) GetManager added in v0.1.56 

func (a *Api) GetManager() *manager.Manager

func (*Api) GetNode added in v0.1.42 

func (a *Api) GetNode(c *gin.Context)

func (*Api) GetNodeVersion added in v0.1.42 

func (a *Api) GetNodeVersion(c *gin.Context)

func (*Api) GetReplication added in v0.1.56 

func (a *Api) GetReplication() *distributed.Replication

func (*Api) GetServer added in v0.1.56 

func (a *Api) GetServer() *embed.Etcd

func (*Api) GetState added in v0.1.56 

func (a *Api) GetState(c *gin.Context)

GetState godoc 

@Summary		Get specific kind
@Description	get specific kind from the store
@Tags			database
@Produce		json

@Success 200 {object} contracts.Response @Failure 400 {object} contracts.Response @Failure 404 {object} contracts.Response @Failure 500 {object} contracts.Response @Router /kind/{prefix}/state/{kind}/{group}/{name}/{field} [get]

func (*Api) GetUser added in v0.1.56 

func (a *Api) GetUser() *authentication.User

func (*Api) GetVersion added in v0.1.42 

func (a *Api) GetVersion() *version.Version

func (*Api) GetWss added in v0.1.56 

func (a *Api) GetWss() *wss.WebSockets

func (*Api) HandleDns 

func (a *Api) HandleDns(w mdns.ResponseWriter, m *mdns.Msg)

func (*Api) Health 

func (a *Api) Health(c *gin.Context)

func (*Api) Kind added in v0.1.3 

func (a *Api) Kind(c *gin.Context)

func (*Api) List added in v0.0.137 

func (a *Api) List(c *gin.Context)

List godoc 

@Summary		List kind objects
@Description	list kind objects in the store
@Tags			database
@Produce		json

@Success 200 {object} contracts.Response @Failure 400 {object} contracts.Response @Failure 404 {object} contracts.Response @Failure 500 {object} contracts.Response @Router /kind/{prefix}/{category}/{kind} [get]

func (*Api) ListKind added in v0.0.137 

func (a *Api) ListKind(c *gin.Context)

ListKind godoc 

@Summary		List kind objects
@Description	list kind objects in the store
@Tags			database
@Produce		json

func (*Api) ListState added in v0.1.56 

func (a *Api) ListState(c *gin.Context)

@Success 200 {object} contracts.Response @Failure 400 {object} contracts.Response @Failure 404 {object} contracts.Response @Failure 500 {object} contracts.Response @Router /kind/{prefix}/{category}/{kind} [get]

func (*Api) ListenNode added in v0.0.128 

func (a *Api) ListenNode()

func (*Api) Logs 

func (a *Api) Logs(c *gin.Context)

func (*Api) MetricsHandle added in v0.0.136 

func (a *Api) MetricsHandle() gin.HandlerFunc

func (*Api) Nodes added in v0.1.30 

func (a *Api) Nodes(c *gin.Context)

func (*Api) Propose added in v0.0.65 

func (a *Api) Propose(c *gin.Context)

func (*Api) ProposeKey added in v0.0.137 

func (a *Api) ProposeKey(c *gin.Context)

ProposeKey godoc 

@Summary		List kind objects
@Description	list kind objects in the store
@Tags			database
@Produce		json

@Success 200 {object} contracts.Response @Failure 400 {object} contracts.Response @Failure 404 {object} contracts.Response @Failure 500 {object} contracts.Response @Router /key/propose/{key} [post]

func (*Api) ProposeKind added in v0.0.137 

func (a *Api) ProposeKind(c *gin.Context)

ProposeKind godoc 

@Summary		List kind objects
@Description	list kind objects in the store
@Tags			database
@Produce		json

@Success 200 {object} contracts.Response @Failure 400 {object} contracts.Response @Failure 404 {object} contracts.Response @Failure 500 {object} contracts.Response @Router /kind/propose/{prefix}/{category}/{kind}/{group}/{name} [post]

func (*Api) RemoveKey added in v0.1.17 

func (a *Api) RemoveKey(c *gin.Context)

DeleteKey godoc 

@Summary		List kind objects
@Description	list kind objects in the store
@Tags			database
@Produce		json

@Success 200 {object} contracts.Response @Failure 400 {object} contracts.Response @Failure 404 {object} contracts.Response @Failure 500 {object} contracts.Response @Router /key/remove/{key} [delete]

func (*Api) RemoveNode added in v0.0.57 

func (a *Api) RemoveNode(c *gin.Context)

func (*Api) SaveClusterConfiguration added in v0.0.57 

func (a *Api) SaveClusterConfiguration()

func (*Api) SetCluster added in v0.1.56 

func (a *Api) SetCluster(c *cluster.Cluster)

func (*Api) SetConfChangeC added in v0.1.56 

func (a *Api) SetConfChangeC(c chan raftpb.ConfChange)

func (*Api) SetConfig added in v0.1.56 

func (a *Api) SetConfig(c *configuration.Configuration)

func (*Api) SetDnsCache added in v0.1.56 

func (a *Api) SetDnsCache(d *dns.Records)

func (*Api) SetEtcd added in v0.1.56 

func (a *Api) SetEtcd(c *clientv3.Client)

func (*Api) SetKey added in v0.0.137 

func (a *Api) SetKey(c *gin.Context)

SetKey godoc 

@Summary		List kind objects
@Description	list kind objects in the store
@Tags			database
@Produce		json

@Success 200 {object} contracts.Response @Failure 400 {object} contracts.Response @Failure 404 {object} contracts.Response @Failure 500 {object} contracts.Response @Router /key/set/{key} [post]

func (*Api) SetKeys added in v0.1.56 

func (a *Api) SetKeys(k *keys.Keys)

func (*Api) SetKind added in v0.0.137 

func (a *Api) SetKind(c *gin.Context)

SetKind godoc 

@Summary		List kind objects
@Description	list kind objects in the store
@Tags			database
@Produce		json

@Success 200 {object} contracts.Response @Failure 400 {object} contracts.Response @Failure 404 {object} contracts.Response @Failure 500 {object} contracts.Response @Router /kind/{prefix}/{category}/{kind}/{group}/{name} [post]

func (*Api) SetKinds added in v0.1.56 

func (a *Api) SetKinds(k *relations.RelationRegistry)

func (*Api) SetKindsRegistry added in v0.1.56 

func (a *Api) SetKindsRegistry(m map[string]ikinds.Kind)

func (*Api) SetLeaseIdentifier added in v0.1.56 

func (a *Api) SetLeaseIdentifier(l *clientv3.LeaseGrantResponse)

func (*Api) SetManager added in v0.1.56 

func (a *Api) SetManager(m *manager.Manager)

func (*Api) SetReplication added in v0.1.56 

func (a *Api) SetReplication(r *distributed.Replication)

func (*Api) SetServer added in v0.1.56 

func (a *Api) SetServer(e *embed.Etcd)

func (*Api) SetUser added in v0.1.56 

func (a *Api) SetUser(u *authentication.User)

func (*Api) SetVersion added in v0.1.56 

func (a *Api) SetVersion(v *version.Version)

func (*Api) SetWss added in v0.1.56 

func (a *Api) SetWss(w *wss.WebSockets)

func (*Api) SetupCluster added in v0.0.129 

func (a *Api) SetupCluster(TLSConfig *tls.Config, n *node.Node, cluster *cluster.Cluster, join bool) error

func (*Api) SetupEtcd added in v0.0.127 

func (a *Api) SetupEtcd()

func (*Api) SetupReplication added in v0.1.56 

func (a *Api) SetupReplication()

func (*Api) StartCluster added in v0.0.57 

func (a *Api) StartCluster(c *gin.Context)

func (*Api) StatusCluster added in v0.1.56 

func (a *Api) StatusCluster(c *gin.Context)

type Kv 

type Kv struct {
	Value string
	Auth  string
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.