wwapiv1

package
v0.0.0-...-ad2992c Latest Latest
Warning

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

Go to latest
Published: Apr 20, 2024 License: BSD-3-Clause Imports: 17 Imported by: 0

Documentation

Overview

Package wwapiv1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source
var (
	GetNodeList_ListType_name = map[int32]string{
		0: "Simple",
		1: "Ipmi",
		2: "Network",
		3: "Long",
		4: "All",
		5: "FullAll",
		6: "YAML",
		7: "JSON",
	}
	GetNodeList_ListType_value = map[string]int32{
		"Simple":  0,
		"Ipmi":    1,
		"Network": 2,
		"Long":    3,
		"All":     4,
		"FullAll": 5,
		"YAML":    6,
		"JSON":    7,
	}
)

Enum value maps for GetNodeList_ListType.

View Source
var File_routes_proto protoreflect.FileDescriptor
View Source
var WWApi_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "wwapi.v1.WWApi",
	HandlerType: (*WWApiServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ContainerBuild",
			Handler:    _WWApi_ContainerBuild_Handler,
		},
		{
			MethodName: "ContainerDelete",
			Handler:    _WWApi_ContainerDelete_Handler,
		},
		{
			MethodName: "ContainerCopy",
			Handler:    _WWApi_ContainerCopy_Handler,
		},
		{
			MethodName: "ContainerImport",
			Handler:    _WWApi_ContainerImport_Handler,
		},
		{
			MethodName: "ContainerList",
			Handler:    _WWApi_ContainerList_Handler,
		},
		{
			MethodName: "ContainerShow",
			Handler:    _WWApi_ContainerShow_Handler,
		},
		{
			MethodName: "ContainerRename",
			Handler:    _WWApi_ContainerRename_Handler,
		},
		{
			MethodName: "NodeAdd",
			Handler:    _WWApi_NodeAdd_Handler,
		},
		{
			MethodName: "NodeDelete",
			Handler:    _WWApi_NodeDelete_Handler,
		},
		{
			MethodName: "NodeList",
			Handler:    _WWApi_NodeList_Handler,
		},
		{
			MethodName: "NodeSet",
			Handler:    _WWApi_NodeSet_Handler,
		},
		{
			MethodName: "NodeStatus",
			Handler:    _WWApi_NodeStatus_Handler,
		},
		{
			MethodName: "Version",
			Handler:    _WWApi_Version_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "routes.proto",
}

WWApi_ServiceDesc is the grpc.ServiceDesc for WWApi service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterWWApiHandler

func RegisterWWApiHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterWWApiHandler registers the http handlers for service WWApi to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterWWApiHandlerClient

func RegisterWWApiHandlerClient(ctx context.Context, mux *runtime.ServeMux, client WWApiClient) error

RegisterWWApiHandlerClient registers the http handlers for service WWApi to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "WWApiClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "WWApiClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "WWApiClient" to call the correct interceptors.

func RegisterWWApiHandlerFromEndpoint

func RegisterWWApiHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterWWApiHandlerFromEndpoint is same as RegisterWWApiHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterWWApiHandlerServer

func RegisterWWApiHandlerServer(ctx context.Context, mux *runtime.ServeMux, server WWApiServer) error

RegisterWWApiHandlerServer registers the http handlers for service WWApi to "mux". UnaryRPC :call WWApiServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterWWApiHandlerFromEndpoint instead.

func RegisterWWApiServer

func RegisterWWApiServer(s grpc.ServiceRegistrar, srv WWApiServer)

Types

type CanWriteConfig

type CanWriteConfig struct {
	CanWriteConfig bool `protobuf:"varint,1,opt,name=canWriteConfig,proto3" json:"canWriteConfig,omitempty"`
	// contains filtered or unexported fields
}

Check if config is writeable

func (*CanWriteConfig) Descriptor deprecated

func (*CanWriteConfig) Descriptor() ([]byte, []int)

Deprecated: Use CanWriteConfig.ProtoReflect.Descriptor instead.

func (*CanWriteConfig) GetCanWriteConfig

func (x *CanWriteConfig) GetCanWriteConfig() bool

func (*CanWriteConfig) ProtoMessage

func (*CanWriteConfig) ProtoMessage()

func (*CanWriteConfig) ProtoReflect

func (x *CanWriteConfig) ProtoReflect() protoreflect.Message

func (*CanWriteConfig) Reset

func (x *CanWriteConfig) Reset()

func (*CanWriteConfig) String

func (x *CanWriteConfig) String() string

type ContainerBuildParameter

type ContainerBuildParameter struct {
	ContainerNames []string `protobuf:"bytes,1,rep,name=containerNames,proto3" json:"containerNames,omitempty"`
	Force          bool     `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
	All            bool     `protobuf:"varint,3,opt,name=all,proto3" json:"all,omitempty"`
	Default        bool     `protobuf:"varint,4,opt,name=default,proto3" json:"default,omitempty"`
	// contains filtered or unexported fields
}

ContainerBuildParameter contains input for building zero or more containers.

func (*ContainerBuildParameter) Descriptor deprecated

func (*ContainerBuildParameter) Descriptor() ([]byte, []int)

Deprecated: Use ContainerBuildParameter.ProtoReflect.Descriptor instead.

func (*ContainerBuildParameter) GetAll

func (x *ContainerBuildParameter) GetAll() bool

func (*ContainerBuildParameter) GetContainerNames

func (x *ContainerBuildParameter) GetContainerNames() []string

func (*ContainerBuildParameter) GetDefault

func (x *ContainerBuildParameter) GetDefault() bool

func (*ContainerBuildParameter) GetForce

func (x *ContainerBuildParameter) GetForce() bool

func (*ContainerBuildParameter) ProtoMessage

func (*ContainerBuildParameter) ProtoMessage()

func (*ContainerBuildParameter) ProtoReflect

func (x *ContainerBuildParameter) ProtoReflect() protoreflect.Message

func (*ContainerBuildParameter) Reset

func (x *ContainerBuildParameter) Reset()

func (*ContainerBuildParameter) String

func (x *ContainerBuildParameter) String() string

type ContainerCopyParameter

type ContainerCopyParameter struct {
	ContainerSource      string `protobuf:"bytes,1,opt,name=containerSource,proto3" json:"containerSource,omitempty"`
	ContainerDestination string `protobuf:"bytes,2,opt,name=containerDestination,proto3" json:"containerDestination,omitempty"`
	// contains filtered or unexported fields
}

ContainerCopyParameter contains 2 inputs : first one for the source container name and second one for the duplicated container name.

func (*ContainerCopyParameter) Descriptor deprecated

func (*ContainerCopyParameter) Descriptor() ([]byte, []int)

Deprecated: Use ContainerCopyParameter.ProtoReflect.Descriptor instead.

func (*ContainerCopyParameter) GetContainerDestination

func (x *ContainerCopyParameter) GetContainerDestination() string

func (*ContainerCopyParameter) GetContainerSource

func (x *ContainerCopyParameter) GetContainerSource() string

func (*ContainerCopyParameter) ProtoMessage

func (*ContainerCopyParameter) ProtoMessage()

func (*ContainerCopyParameter) ProtoReflect

func (x *ContainerCopyParameter) ProtoReflect() protoreflect.Message

func (*ContainerCopyParameter) Reset

func (x *ContainerCopyParameter) Reset()

func (*ContainerCopyParameter) String

func (x *ContainerCopyParameter) String() string

type ContainerDeleteParameter

type ContainerDeleteParameter struct {
	ContainerNames []string `protobuf:"bytes,1,rep,name=containerNames,proto3" json:"containerNames,omitempty"`
	// contains filtered or unexported fields
}

ContainerDeleteParameter contains input for removing containers from Warewulf management.

func (*ContainerDeleteParameter) Descriptor deprecated

func (*ContainerDeleteParameter) Descriptor() ([]byte, []int)

Deprecated: Use ContainerDeleteParameter.ProtoReflect.Descriptor instead.

func (*ContainerDeleteParameter) GetContainerNames

func (x *ContainerDeleteParameter) GetContainerNames() []string

func (*ContainerDeleteParameter) ProtoMessage

func (*ContainerDeleteParameter) ProtoMessage()

func (*ContainerDeleteParameter) ProtoReflect

func (x *ContainerDeleteParameter) ProtoReflect() protoreflect.Message

func (*ContainerDeleteParameter) Reset

func (x *ContainerDeleteParameter) Reset()

func (*ContainerDeleteParameter) String

func (x *ContainerDeleteParameter) String() string

type ContainerImportParameter

type ContainerImportParameter struct {
	Source   string `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"` // container source uri
	Name     string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`     // container name
	Force    bool   `protobuf:"varint,3,opt,name=force,proto3" json:"force,omitempty"`
	Update   bool   `protobuf:"varint,4,opt,name=update,proto3" json:"update,omitempty"`
	Build    bool   `protobuf:"varint,5,opt,name=build,proto3" json:"build,omitempty"`
	Default  bool   `protobuf:"varint,6,opt,name=default,proto3" json:"default,omitempty"`
	SyncUser bool   `protobuf:"varint,7,opt,name=syncUser,proto3" json:"syncUser,omitempty"`
	// contains filtered or unexported fields
}

ContainerImportParameter has all input for importing a container.

func (*ContainerImportParameter) Descriptor deprecated

func (*ContainerImportParameter) Descriptor() ([]byte, []int)

Deprecated: Use ContainerImportParameter.ProtoReflect.Descriptor instead.

func (*ContainerImportParameter) GetBuild

func (x *ContainerImportParameter) GetBuild() bool

func (*ContainerImportParameter) GetDefault

func (x *ContainerImportParameter) GetDefault() bool

func (*ContainerImportParameter) GetForce

func (x *ContainerImportParameter) GetForce() bool

func (*ContainerImportParameter) GetName

func (x *ContainerImportParameter) GetName() string

func (*ContainerImportParameter) GetSource

func (x *ContainerImportParameter) GetSource() string

func (*ContainerImportParameter) GetSyncUser

func (x *ContainerImportParameter) GetSyncUser() bool

func (*ContainerImportParameter) GetUpdate

func (x *ContainerImportParameter) GetUpdate() bool

func (*ContainerImportParameter) ProtoMessage

func (*ContainerImportParameter) ProtoMessage()

func (*ContainerImportParameter) ProtoReflect

func (x *ContainerImportParameter) ProtoReflect() protoreflect.Message

func (*ContainerImportParameter) Reset

func (x *ContainerImportParameter) Reset()

func (*ContainerImportParameter) String

func (x *ContainerImportParameter) String() string

type ContainerInfo

type ContainerInfo struct {
	Name          string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	NodeCount     uint32 `protobuf:"varint,2,opt,name=nodeCount,proto3" json:"nodeCount,omitempty"`
	KernelVersion string `protobuf:"bytes,3,opt,name=kernelVersion,proto3" json:"kernelVersion,omitempty"`
	CreateDate    uint64 `protobuf:"varint,4,opt,name=createDate,proto3" json:"createDate,omitempty"` // creation date in unix time
	ModDate       uint64 `protobuf:"varint,5,opt,name=modDate,proto3" json:"modDate,omitempty"`       // date of last modification in unix time
	Size          uint64 `protobuf:"varint,6,opt,name=size,proto3" json:"size,omitempty"`             // size of chroot and images in bytes
	// contains filtered or unexported fields
}

ContainerInfo has data on each container. This is emitted in the ContainerListResponse.

func (*ContainerInfo) Descriptor deprecated

func (*ContainerInfo) Descriptor() ([]byte, []int)

Deprecated: Use ContainerInfo.ProtoReflect.Descriptor instead.

func (*ContainerInfo) GetCreateDate

func (x *ContainerInfo) GetCreateDate() uint64

func (*ContainerInfo) GetKernelVersion

func (x *ContainerInfo) GetKernelVersion() string

func (*ContainerInfo) GetModDate

func (x *ContainerInfo) GetModDate() uint64

func (*ContainerInfo) GetName

func (x *ContainerInfo) GetName() string

func (*ContainerInfo) GetNodeCount

func (x *ContainerInfo) GetNodeCount() uint32

func (*ContainerInfo) GetSize

func (x *ContainerInfo) GetSize() uint64

func (*ContainerInfo) ProtoMessage

func (*ContainerInfo) ProtoMessage()

func (*ContainerInfo) ProtoReflect

func (x *ContainerInfo) ProtoReflect() protoreflect.Message

func (*ContainerInfo) Reset

func (x *ContainerInfo) Reset()

func (*ContainerInfo) String

func (x *ContainerInfo) String() string

type ContainerListResponse

type ContainerListResponse struct {
	Containers []*ContainerInfo `protobuf:"bytes,1,rep,name=containers,proto3" json:"containers,omitempty"`
	// contains filtered or unexported fields
}

ContainerListResponse has all information that ContainerList provides.

func (*ContainerListResponse) Descriptor deprecated

func (*ContainerListResponse) Descriptor() ([]byte, []int)

Deprecated: Use ContainerListResponse.ProtoReflect.Descriptor instead.

func (*ContainerListResponse) GetContainers

func (x *ContainerListResponse) GetContainers() []*ContainerInfo

func (*ContainerListResponse) ProtoMessage

func (*ContainerListResponse) ProtoMessage()

func (*ContainerListResponse) ProtoReflect

func (x *ContainerListResponse) ProtoReflect() protoreflect.Message

func (*ContainerListResponse) Reset

func (x *ContainerListResponse) Reset()

func (*ContainerListResponse) String

func (x *ContainerListResponse) String() string

type ContainerRenameParameter

type ContainerRenameParameter struct {
	ContainerName string `protobuf:"bytes,1,opt,name=containerName,proto3" json:"containerName,omitempty"`
	TargetName    string `protobuf:"bytes,2,opt,name=targetName,proto3" json:"targetName,omitempty"`
	Build         bool   `protobuf:"varint,3,opt,name=build,proto3" json:"build,omitempty"`
	// contains filtered or unexported fields
}

ContainerRenameParameter is the input for ContainerRename

func (*ContainerRenameParameter) Descriptor deprecated

func (*ContainerRenameParameter) Descriptor() ([]byte, []int)

Deprecated: Use ContainerRenameParameter.ProtoReflect.Descriptor instead.

func (*ContainerRenameParameter) GetBuild

func (x *ContainerRenameParameter) GetBuild() bool

func (*ContainerRenameParameter) GetContainerName

func (x *ContainerRenameParameter) GetContainerName() string

func (*ContainerRenameParameter) GetTargetName

func (x *ContainerRenameParameter) GetTargetName() string

func (*ContainerRenameParameter) ProtoMessage

func (*ContainerRenameParameter) ProtoMessage()

func (*ContainerRenameParameter) ProtoReflect

func (x *ContainerRenameParameter) ProtoReflect() protoreflect.Message

func (*ContainerRenameParameter) Reset

func (x *ContainerRenameParameter) Reset()

func (*ContainerRenameParameter) String

func (x *ContainerRenameParameter) String() string

type ContainerShowParameter

type ContainerShowParameter struct {
	ContainerName string `protobuf:"bytes,1,opt,name=containerName,proto3" json:"containerName,omitempty"`
	// contains filtered or unexported fields
}

ContainerShowParameter is the input for ContainerShow.

func (*ContainerShowParameter) Descriptor deprecated

func (*ContainerShowParameter) Descriptor() ([]byte, []int)

Deprecated: Use ContainerShowParameter.ProtoReflect.Descriptor instead.

func (*ContainerShowParameter) GetContainerName

func (x *ContainerShowParameter) GetContainerName() string

func (*ContainerShowParameter) ProtoMessage

func (*ContainerShowParameter) ProtoMessage()

func (*ContainerShowParameter) ProtoReflect

func (x *ContainerShowParameter) ProtoReflect() protoreflect.Message

func (*ContainerShowParameter) Reset

func (x *ContainerShowParameter) Reset()

func (*ContainerShowParameter) String

func (x *ContainerShowParameter) String() string

type ContainerShowResponse

type ContainerShowResponse struct {
	Name          string   `protobuf:"bytes,1,opt,name=Name,proto3" json:"Name,omitempty"`
	Rootfs        string   `protobuf:"bytes,2,opt,name=Rootfs,proto3" json:"Rootfs,omitempty"`
	Nodes         []string `protobuf:"bytes,3,rep,name=Nodes,proto3" json:"Nodes,omitempty"`
	KernelVersion string   `protobuf:"bytes,4,opt,name=KernelVersion,proto3" json:"KernelVersion,omitempty"`
	// contains filtered or unexported fields
}

ContainerShowResponse has all information emitted on ContainerShow.

func (*ContainerShowResponse) Descriptor deprecated

func (*ContainerShowResponse) Descriptor() ([]byte, []int)

Deprecated: Use ContainerShowResponse.ProtoReflect.Descriptor instead.

func (*ContainerShowResponse) GetKernelVersion

func (x *ContainerShowResponse) GetKernelVersion() string

func (*ContainerShowResponse) GetName

func (x *ContainerShowResponse) GetName() string

func (*ContainerShowResponse) GetNodes

func (x *ContainerShowResponse) GetNodes() []string

func (*ContainerShowResponse) GetRootfs

func (x *ContainerShowResponse) GetRootfs() string

func (*ContainerShowResponse) ProtoMessage

func (*ContainerShowResponse) ProtoMessage()

func (*ContainerShowResponse) ProtoReflect

func (x *ContainerShowResponse) ProtoReflect() protoreflect.Message

func (*ContainerShowResponse) Reset

func (x *ContainerShowResponse) Reset()

func (*ContainerShowResponse) String

func (x *ContainerShowResponse) String() string

type ContainerSyncUserParameter

type ContainerSyncUserParameter struct {
	ContainerName string `protobuf:"bytes,1,opt,name=containerName,proto3" json:"containerName,omitempty"`
	// contains filtered or unexported fields
}

ContainerSyncUserParameter is the input for ContainerSyncUser.

func (*ContainerSyncUserParameter) Descriptor deprecated

func (*ContainerSyncUserParameter) Descriptor() ([]byte, []int)

Deprecated: Use ContainerSyncUserParameter.ProtoReflect.Descriptor instead.

func (*ContainerSyncUserParameter) GetContainerName

func (x *ContainerSyncUserParameter) GetContainerName() string

func (*ContainerSyncUserParameter) ProtoMessage

func (*ContainerSyncUserParameter) ProtoMessage()

func (*ContainerSyncUserParameter) ProtoReflect

func (*ContainerSyncUserParameter) Reset

func (x *ContainerSyncUserParameter) Reset()

func (*ContainerSyncUserParameter) String

func (x *ContainerSyncUserParameter) String() string

type GetNodeList

type GetNodeList struct {
	Type  GetNodeList_ListType `protobuf:"varint,8,opt,name=type,proto3,enum=wwapi.v1.GetNodeList_ListType" json:"type,omitempty"`
	Nodes []string             `protobuf:"bytes,9,rep,name=Nodes,proto3" json:"Nodes,omitempty"`
	// contains filtered or unexported fields
}

Request a node list

func (*GetNodeList) Descriptor deprecated

func (*GetNodeList) Descriptor() ([]byte, []int)

Deprecated: Use GetNodeList.ProtoReflect.Descriptor instead.

func (*GetNodeList) GetNodes

func (x *GetNodeList) GetNodes() []string

func (*GetNodeList) GetType

func (x *GetNodeList) GetType() GetNodeList_ListType

func (*GetNodeList) ProtoMessage

func (*GetNodeList) ProtoMessage()

func (*GetNodeList) ProtoReflect

func (x *GetNodeList) ProtoReflect() protoreflect.Message

func (*GetNodeList) Reset

func (x *GetNodeList) Reset()

func (*GetNodeList) String

func (x *GetNodeList) String() string

type GetNodeList_ListType

type GetNodeList_ListType int32
const (
	GetNodeList_Simple  GetNodeList_ListType = 0
	GetNodeList_Ipmi    GetNodeList_ListType = 1
	GetNodeList_Network GetNodeList_ListType = 2
	GetNodeList_Long    GetNodeList_ListType = 3
	GetNodeList_All     GetNodeList_ListType = 4
	GetNodeList_FullAll GetNodeList_ListType = 5
	GetNodeList_YAML    GetNodeList_ListType = 6
	GetNodeList_JSON    GetNodeList_ListType = 7
)

func (GetNodeList_ListType) Descriptor

func (GetNodeList_ListType) Enum

func (GetNodeList_ListType) EnumDescriptor deprecated

func (GetNodeList_ListType) EnumDescriptor() ([]byte, []int)

Deprecated: Use GetNodeList_ListType.Descriptor instead.

func (GetNodeList_ListType) Number

func (GetNodeList_ListType) String

func (x GetNodeList_ListType) String() string

func (GetNodeList_ListType) Type

type GetProfileList

type GetProfileList struct {
	ShowAll     bool     `protobuf:"varint,1,opt,name=ShowAll,proto3" json:"ShowAll,omitempty"`
	ShowFullAll bool     `protobuf:"varint,2,opt,name=ShowFullAll,proto3" json:"ShowFullAll,omitempty"`
	ShowYaml    bool     `protobuf:"varint,3,opt,name=ShowYaml,proto3" json:"ShowYaml,omitempty"`
	ShowJson    bool     `protobuf:"varint,4,opt,name=ShowJson,proto3" json:"ShowJson,omitempty"`
	Profiles    []string `protobuf:"bytes,5,rep,name=Profiles,proto3" json:"Profiles,omitempty"`
	// contains filtered or unexported fields
}

Request a profile list view

func (*GetProfileList) Descriptor deprecated

func (*GetProfileList) Descriptor() ([]byte, []int)

Deprecated: Use GetProfileList.ProtoReflect.Descriptor instead.

func (*GetProfileList) GetProfiles

func (x *GetProfileList) GetProfiles() []string

func (*GetProfileList) GetShowAll

func (x *GetProfileList) GetShowAll() bool

func (*GetProfileList) GetShowFullAll

func (x *GetProfileList) GetShowFullAll() bool

func (*GetProfileList) GetShowJson

func (x *GetProfileList) GetShowJson() bool

func (*GetProfileList) GetShowYaml

func (x *GetProfileList) GetShowYaml() bool

func (*GetProfileList) ProtoMessage

func (*GetProfileList) ProtoMessage()

func (*GetProfileList) ProtoReflect

func (x *GetProfileList) ProtoReflect() protoreflect.Message

func (*GetProfileList) Reset

func (x *GetProfileList) Reset()

func (*GetProfileList) String

func (x *GetProfileList) String() string

type NetDev

type NetDev struct {
	Field map[string]*NodeField `` /* 151-byte string literal not displayed */
	Tags  map[string]*NodeField `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

NetDev is network devices (NICs) on a node.

func (*NetDev) Descriptor deprecated

func (*NetDev) Descriptor() ([]byte, []int)

Deprecated: Use NetDev.ProtoReflect.Descriptor instead.

func (*NetDev) GetField

func (x *NetDev) GetField() map[string]*NodeField

func (*NetDev) GetTags

func (x *NetDev) GetTags() map[string]*NodeField

func (*NetDev) ProtoMessage

func (*NetDev) ProtoMessage()

func (*NetDev) ProtoReflect

func (x *NetDev) ProtoReflect() protoreflect.Message

func (*NetDev) Reset

func (x *NetDev) Reset()

func (*NetDev) String

func (x *NetDev) String() string

type NodeAddParameter

type NodeAddParameter struct {
	NodeConfYaml string   `protobuf:"bytes,1,opt,name=nodeConfYaml,proto3" json:"nodeConfYaml,omitempty"`
	Force        bool     `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
	Hash         string   `protobuf:"bytes,3,opt,name=hash,proto3" json:"hash,omitempty"`
	NodeNames    []string `protobuf:"bytes,10,rep,name=nodeNames,proto3" json:"nodeNames,omitempty"`
	// contains filtered or unexported fields
}

NodeAddParameter contains all input for adding a node to be managed by Warewulf. Only adds nodes if the hash matches the actual hash of the configuration.

func (*NodeAddParameter) Descriptor deprecated

func (*NodeAddParameter) Descriptor() ([]byte, []int)

Deprecated: Use NodeAddParameter.ProtoReflect.Descriptor instead.

func (*NodeAddParameter) GetForce

func (x *NodeAddParameter) GetForce() bool

func (*NodeAddParameter) GetHash

func (x *NodeAddParameter) GetHash() string

func (*NodeAddParameter) GetNodeConfYaml

func (x *NodeAddParameter) GetNodeConfYaml() string

func (*NodeAddParameter) GetNodeNames

func (x *NodeAddParameter) GetNodeNames() []string

func (*NodeAddParameter) ProtoMessage

func (*NodeAddParameter) ProtoMessage()

func (*NodeAddParameter) ProtoReflect

func (x *NodeAddParameter) ProtoReflect() protoreflect.Message

func (*NodeAddParameter) Reset

func (x *NodeAddParameter) Reset()

func (*NodeAddParameter) String

func (x *NodeAddParameter) String() string

type NodeDBHash

type NodeDBHash struct {
	Hash string `protobuf:"bytes,1,opt,name=hash,proto3" json:"hash,omitempty"`
	// contains filtered or unexported fields
}

func (*NodeDBHash) Descriptor deprecated

func (*NodeDBHash) Descriptor() ([]byte, []int)

Deprecated: Use NodeDBHash.ProtoReflect.Descriptor instead.

func (*NodeDBHash) GetHash

func (x *NodeDBHash) GetHash() string

func (*NodeDBHash) ProtoMessage

func (*NodeDBHash) ProtoMessage()

func (*NodeDBHash) ProtoReflect

func (x *NodeDBHash) ProtoReflect() protoreflect.Message

func (*NodeDBHash) Reset

func (x *NodeDBHash) Reset()

func (*NodeDBHash) String

func (x *NodeDBHash) String() string

type NodeDeleteParameter

type NodeDeleteParameter struct {
	Force     bool     `protobuf:"varint,1,opt,name=force,proto3" json:"force,omitempty"`
	NodeNames []string `protobuf:"bytes,2,rep,name=nodeNames,proto3" json:"nodeNames,omitempty"`
	Hash      string   `protobuf:"bytes,3,opt,name=hash,proto3" json:"hash,omitempty"`
	// contains filtered or unexported fields
}

NodeDeleteParameter contains input for removing nodes from Warewulf management. If the given hash differs with the actual hash of the configuration, no node is deleted. The force option allows the deletion of nodes with a correct hash.

func (*NodeDeleteParameter) Descriptor deprecated

func (*NodeDeleteParameter) Descriptor() ([]byte, []int)

Deprecated: Use NodeDeleteParameter.ProtoReflect.Descriptor instead.

func (*NodeDeleteParameter) GetForce

func (x *NodeDeleteParameter) GetForce() bool

func (*NodeDeleteParameter) GetHash

func (x *NodeDeleteParameter) GetHash() string

func (*NodeDeleteParameter) GetNodeNames

func (x *NodeDeleteParameter) GetNodeNames() []string

func (*NodeDeleteParameter) ProtoMessage

func (*NodeDeleteParameter) ProtoMessage()

func (*NodeDeleteParameter) ProtoReflect

func (x *NodeDeleteParameter) ProtoReflect() protoreflect.Message

func (*NodeDeleteParameter) Reset

func (x *NodeDeleteParameter) Reset()

func (*NodeDeleteParameter) String

func (x *NodeDeleteParameter) String() string

type NodeField

type NodeField struct {
	Source string `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`
	Value  string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // TODO: Variable name okay?
	Print  string `protobuf:"bytes,3,opt,name=print,proto3" json:"print,omitempty"` // Empty values printed as -- in wwctl.
	// contains filtered or unexported fields
}

NodeField contains data output on NodeList.

func (*NodeField) Descriptor deprecated

func (*NodeField) Descriptor() ([]byte, []int)

Deprecated: Use NodeField.ProtoReflect.Descriptor instead.

func (*NodeField) GetPrint

func (x *NodeField) GetPrint() string

func (*NodeField) GetSource

func (x *NodeField) GetSource() string

func (*NodeField) GetValue

func (x *NodeField) GetValue() string

func (*NodeField) ProtoMessage

func (*NodeField) ProtoMessage()

func (*NodeField) ProtoReflect

func (x *NodeField) ProtoReflect() protoreflect.Message

func (*NodeField) Reset

func (x *NodeField) Reset()

func (*NodeField) String

func (x *NodeField) String() string

type NodeInfo

type NodeInfo struct {
	Fields  map[string]*NodeField `` /* 153-byte string literal not displayed */
	NetDevs map[string]*NetDev    `` /* 156-byte string literal not displayed */
	Tags    map[string]*NodeField `` /* 150-byte string literal not displayed */
	Keys    map[string]*NodeField `` // TODO: We may not need this. Tags may be it. Ask Greg.
	/* 150-byte string literal not displayed */
	// contains filtered or unexported fields
}

NodeInfo contains details about a node managed by Warewulf/

func (*NodeInfo) Descriptor deprecated

func (*NodeInfo) Descriptor() ([]byte, []int)

Deprecated: Use NodeInfo.ProtoReflect.Descriptor instead.

func (*NodeInfo) GetFields

func (x *NodeInfo) GetFields() map[string]*NodeField

func (*NodeInfo) GetKeys

func (x *NodeInfo) GetKeys() map[string]*NodeField

func (*NodeInfo) GetNetDevs

func (x *NodeInfo) GetNetDevs() map[string]*NetDev

func (*NodeInfo) GetTags

func (x *NodeInfo) GetTags() map[string]*NodeField

func (*NodeInfo) ProtoMessage

func (*NodeInfo) ProtoMessage()

func (*NodeInfo) ProtoReflect

func (x *NodeInfo) ProtoReflect() protoreflect.Message

func (*NodeInfo) Reset

func (x *NodeInfo) Reset()

func (*NodeInfo) String

func (x *NodeInfo) String() string

type NodeList

type NodeList struct {
	Output []string `protobuf:"bytes,1,rep,name=Output,proto3" json:"Output,omitempty"`
	// contains filtered or unexported fields
}

Get the formated output as string

func (*NodeList) Descriptor deprecated

func (*NodeList) Descriptor() ([]byte, []int)

Deprecated: Use NodeList.ProtoReflect.Descriptor instead.

func (*NodeList) GetOutput

func (x *NodeList) GetOutput() []string

func (*NodeList) ProtoMessage

func (*NodeList) ProtoMessage()

func (*NodeList) ProtoReflect

func (x *NodeList) ProtoReflect() protoreflect.Message

func (*NodeList) Reset

func (x *NodeList) Reset()

func (*NodeList) String

func (x *NodeList) String() string

type NodeListResponse

type NodeListResponse struct {
	Nodes []*NodeInfo `protobuf:"bytes,1,rep,name=nodes,proto3" json:"nodes,omitempty"`
	// contains filtered or unexported fields
}

NodeListResponse is the output of NodeList.

func (*NodeListResponse) Descriptor deprecated

func (*NodeListResponse) Descriptor() ([]byte, []int)

Deprecated: Use NodeListResponse.ProtoReflect.Descriptor instead.

func (*NodeListResponse) GetNodes

func (x *NodeListResponse) GetNodes() []*NodeInfo

func (*NodeListResponse) ProtoMessage

func (*NodeListResponse) ProtoMessage()

func (*NodeListResponse) ProtoReflect

func (x *NodeListResponse) ProtoReflect() protoreflect.Message

func (*NodeListResponse) Reset

func (x *NodeListResponse) Reset()

func (*NodeListResponse) String

func (x *NodeListResponse) String() string

type NodeNames

type NodeNames struct {
	NodeNames []string `protobuf:"bytes,1,rep,name=nodeNames,proto3" json:"nodeNames,omitempty"`
	// contains filtered or unexported fields
}

NodeNames is an array of node ids.

func (*NodeNames) Descriptor deprecated

func (*NodeNames) Descriptor() ([]byte, []int)

Deprecated: Use NodeNames.ProtoReflect.Descriptor instead.

func (*NodeNames) GetNodeNames

func (x *NodeNames) GetNodeNames() []string

func (*NodeNames) ProtoMessage

func (*NodeNames) ProtoMessage()

func (*NodeNames) ProtoReflect

func (x *NodeNames) ProtoReflect() protoreflect.Message

func (*NodeNames) Reset

func (x *NodeNames) Reset()

func (*NodeNames) String

func (x *NodeNames) String() string

type NodeSetParameter

type NodeSetParameter struct {
	NodeConfYaml     string   `protobuf:"bytes,1,opt,name=nodeConfYaml,proto3" json:"nodeConfYaml,omitempty"`
	NetdevDelete     string   `protobuf:"bytes,2,opt,name=netdevDelete,proto3" json:"netdevDelete,omitempty"`
	DiskDelete       string   `protobuf:"bytes,3,opt,name=diskDelete,proto3" json:"diskDelete,omitempty"`
	PartitionDelete  string   `protobuf:"bytes,4,opt,name=partitionDelete,proto3" json:"partitionDelete,omitempty"`
	FilesystemDelete string   `protobuf:"bytes,5,opt,name=filesystemDelete,proto3" json:"filesystemDelete,omitempty"`
	AllNodes         bool     `protobuf:"varint,6,opt,name=allNodes,proto3" json:"allNodes,omitempty"`
	Force            bool     `protobuf:"varint,7,opt,name=force,proto3" json:"force,omitempty"`
	NodeNames        []string `protobuf:"bytes,8,rep,name=nodeNames,proto3" json:"nodeNames,omitempty"`
	// contains filtered or unexported fields
}

NodeSetParameter contains all fields for updating aspects of nodes managed by Warewulf.

func (*NodeSetParameter) Descriptor deprecated

func (*NodeSetParameter) Descriptor() ([]byte, []int)

Deprecated: Use NodeSetParameter.ProtoReflect.Descriptor instead.

func (*NodeSetParameter) GetAllNodes

func (x *NodeSetParameter) GetAllNodes() bool

func (*NodeSetParameter) GetDiskDelete

func (x *NodeSetParameter) GetDiskDelete() string

func (*NodeSetParameter) GetFilesystemDelete

func (x *NodeSetParameter) GetFilesystemDelete() string

func (*NodeSetParameter) GetForce

func (x *NodeSetParameter) GetForce() bool

func (*NodeSetParameter) GetNetdevDelete

func (x *NodeSetParameter) GetNetdevDelete() string

func (*NodeSetParameter) GetNodeConfYaml

func (x *NodeSetParameter) GetNodeConfYaml() string

func (*NodeSetParameter) GetNodeNames

func (x *NodeSetParameter) GetNodeNames() []string

func (*NodeSetParameter) GetPartitionDelete

func (x *NodeSetParameter) GetPartitionDelete() string

func (*NodeSetParameter) ProtoMessage

func (*NodeSetParameter) ProtoMessage()

func (*NodeSetParameter) ProtoReflect

func (x *NodeSetParameter) ProtoReflect() protoreflect.Message

func (*NodeSetParameter) Reset

func (x *NodeSetParameter) Reset()

func (*NodeSetParameter) String

func (x *NodeSetParameter) String() string

type NodeStatus

type NodeStatus struct {
	NodeName string `protobuf:"bytes,1,opt,name=nodeName,proto3" json:"nodeName,omitempty"`  // Name (Id) of the node.
	Stage    string `protobuf:"bytes,2,opt,name=stage,proto3" json:"stage,omitempty"`        // Stage of imaging.
	Sent     string `protobuf:"bytes,3,opt,name=sent,proto3" json:"sent,omitempty"`          // Last overlay sent.
	Ipaddr   string `protobuf:"bytes,4,opt,name=ipaddr,proto3" json:"ipaddr,omitempty"`      // Node IP address.
	Lastseen int64  `protobuf:"varint,5,opt,name=lastseen,proto3" json:"lastseen,omitempty"` // Time in seconds since the node was last seen.
	// contains filtered or unexported fields
}

NodeStatus contains information about the imaging status per node.

func (*NodeStatus) Descriptor deprecated

func (*NodeStatus) Descriptor() ([]byte, []int)

Deprecated: Use NodeStatus.ProtoReflect.Descriptor instead.

func (*NodeStatus) GetIpaddr

func (x *NodeStatus) GetIpaddr() string

func (*NodeStatus) GetLastseen

func (x *NodeStatus) GetLastseen() int64

func (*NodeStatus) GetNodeName

func (x *NodeStatus) GetNodeName() string

func (*NodeStatus) GetSent

func (x *NodeStatus) GetSent() string

func (*NodeStatus) GetStage

func (x *NodeStatus) GetStage() string

func (*NodeStatus) ProtoMessage

func (*NodeStatus) ProtoMessage()

func (*NodeStatus) ProtoReflect

func (x *NodeStatus) ProtoReflect() protoreflect.Message

func (*NodeStatus) Reset

func (x *NodeStatus) Reset()

func (*NodeStatus) String

func (x *NodeStatus) String() string

type NodeStatusResponse

type NodeStatusResponse struct {
	NodeStatus []*NodeStatus `protobuf:"bytes,1,rep,name=nodeStatus,proto3" json:"nodeStatus,omitempty"`
	// contains filtered or unexported fields
}

NodeStatusResponse contains NodeStatus for zero or more nodes.

func (*NodeStatusResponse) Descriptor deprecated

func (*NodeStatusResponse) Descriptor() ([]byte, []int)

Deprecated: Use NodeStatusResponse.ProtoReflect.Descriptor instead.

func (*NodeStatusResponse) GetNodeStatus

func (x *NodeStatusResponse) GetNodeStatus() []*NodeStatus

func (*NodeStatusResponse) ProtoMessage

func (*NodeStatusResponse) ProtoMessage()

func (*NodeStatusResponse) ProtoReflect

func (x *NodeStatusResponse) ProtoReflect() protoreflect.Message

func (*NodeStatusResponse) Reset

func (x *NodeStatusResponse) Reset()

func (*NodeStatusResponse) String

func (x *NodeStatusResponse) String() string

type NodeYaml

type NodeYaml struct {
	NodeConfMapYaml string `protobuf:"bytes,1,opt,name=nodeConfMapYaml,proto3" json:"nodeConfMapYaml,omitempty"`
	Hash            string `protobuf:"bytes,2,opt,name=hash,proto3" json:"hash,omitempty"`
	// contains filtered or unexported fields
}

NodeYaml is just the updated YAML config which will be added to nodes.conf (is resused for profile edit)

func (*NodeYaml) Descriptor deprecated

func (*NodeYaml) Descriptor() ([]byte, []int)

Deprecated: Use NodeYaml.ProtoReflect.Descriptor instead.

func (*NodeYaml) GetHash

func (x *NodeYaml) GetHash() string

func (*NodeYaml) GetNodeConfMapYaml

func (x *NodeYaml) GetNodeConfMapYaml() string

func (*NodeYaml) ProtoMessage

func (*NodeYaml) ProtoMessage()

func (*NodeYaml) ProtoReflect

func (x *NodeYaml) ProtoReflect() protoreflect.Message

func (*NodeYaml) Reset

func (x *NodeYaml) Reset()

func (*NodeYaml) String

func (x *NodeYaml) String() string

type ProfileList

type ProfileList struct {
	Output []string `protobuf:"bytes,1,rep,name=Output,proto3" json:"Output,omitempty"`
	// contains filtered or unexported fields
}

Get the formated output as string

func (*ProfileList) Descriptor deprecated

func (*ProfileList) Descriptor() ([]byte, []int)

Deprecated: Use ProfileList.ProtoReflect.Descriptor instead.

func (*ProfileList) GetOutput

func (x *ProfileList) GetOutput() []string

func (*ProfileList) ProtoMessage

func (*ProfileList) ProtoMessage()

func (*ProfileList) ProtoReflect

func (x *ProfileList) ProtoReflect() protoreflect.Message

func (*ProfileList) Reset

func (x *ProfileList) Reset()

func (*ProfileList) String

func (x *ProfileList) String() string

type ProfileSetParameter

type ProfileSetParameter struct {
	NodeConfYaml     string   `protobuf:"bytes,1,opt,name=nodeConfYaml,proto3" json:"nodeConfYaml,omitempty"`
	NetdevDelete     string   `protobuf:"bytes,2,opt,name=netdevDelete,proto3" json:"netdevDelete,omitempty"`
	DiskDelete       string   `protobuf:"bytes,3,opt,name=diskDelete,proto3" json:"diskDelete,omitempty"`
	PartitionDelete  string   `protobuf:"bytes,4,opt,name=partitionDelete,proto3" json:"partitionDelete,omitempty"`
	FilesystemDelete string   `protobuf:"bytes,5,opt,name=filesystemDelete,proto3" json:"filesystemDelete,omitempty"`
	AllProfiles      bool     `protobuf:"varint,6,opt,name=allProfiles,proto3" json:"allProfiles,omitempty"`
	Force            bool     `protobuf:"varint,7,opt,name=force,proto3" json:"force,omitempty"`
	ProfileNames     []string `protobuf:"bytes,8,rep,name=profileNames,proto3" json:"profileNames,omitempty"`
	// contains filtered or unexported fields
}

ProfileSetParameter contains all fields for updating aspects of profiles managed. Basically a copy of NodeSetParameters by Warewulf.

func (*ProfileSetParameter) Descriptor deprecated

func (*ProfileSetParameter) Descriptor() ([]byte, []int)

Deprecated: Use ProfileSetParameter.ProtoReflect.Descriptor instead.

func (*ProfileSetParameter) GetAllProfiles

func (x *ProfileSetParameter) GetAllProfiles() bool

func (*ProfileSetParameter) GetDiskDelete

func (x *ProfileSetParameter) GetDiskDelete() string

func (*ProfileSetParameter) GetFilesystemDelete

func (x *ProfileSetParameter) GetFilesystemDelete() string

func (*ProfileSetParameter) GetForce

func (x *ProfileSetParameter) GetForce() bool

func (*ProfileSetParameter) GetNetdevDelete

func (x *ProfileSetParameter) GetNetdevDelete() string

func (*ProfileSetParameter) GetNodeConfYaml

func (x *ProfileSetParameter) GetNodeConfYaml() string

func (*ProfileSetParameter) GetPartitionDelete

func (x *ProfileSetParameter) GetPartitionDelete() string

func (*ProfileSetParameter) GetProfileNames

func (x *ProfileSetParameter) GetProfileNames() []string

func (*ProfileSetParameter) ProtoMessage

func (*ProfileSetParameter) ProtoMessage()

func (*ProfileSetParameter) ProtoReflect

func (x *ProfileSetParameter) ProtoReflect() protoreflect.Message

func (*ProfileSetParameter) Reset

func (x *ProfileSetParameter) Reset()

func (*ProfileSetParameter) String

func (x *ProfileSetParameter) String() string

type UnimplementedWWApiServer

type UnimplementedWWApiServer struct {
}

UnimplementedWWApiServer must be embedded to have forward compatible implementations.

func (UnimplementedWWApiServer) ContainerBuild

func (UnimplementedWWApiServer) ContainerCopy

func (UnimplementedWWApiServer) ContainerDelete

func (UnimplementedWWApiServer) ContainerImport

func (UnimplementedWWApiServer) ContainerList

func (UnimplementedWWApiServer) ContainerRename

func (UnimplementedWWApiServer) ContainerShow

func (UnimplementedWWApiServer) NodeAdd

func (UnimplementedWWApiServer) NodeDelete

func (UnimplementedWWApiServer) NodeList

func (UnimplementedWWApiServer) NodeSet

func (UnimplementedWWApiServer) NodeStatus

func (UnimplementedWWApiServer) Version

type UnsafeWWApiServer

type UnsafeWWApiServer interface {
	// contains filtered or unexported methods
}

UnsafeWWApiServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to WWApiServer will result in compilation errors.

type VersionResponse

type VersionResponse struct {
	ApiPrefix       string `protobuf:"bytes,1,opt,name=apiPrefix,proto3" json:"apiPrefix,omitempty"`
	ApiVersion      string `protobuf:"bytes,2,opt,name=apiVersion,proto3" json:"apiVersion,omitempty"`
	WarewulfVersion string `protobuf:"bytes,3,opt,name=warewulfVersion,proto3" json:"warewulfVersion,omitempty"`
	// contains filtered or unexported fields
}

VersionReponse contains versions of the software.

func (*VersionResponse) Descriptor deprecated

func (*VersionResponse) Descriptor() ([]byte, []int)

Deprecated: Use VersionResponse.ProtoReflect.Descriptor instead.

func (*VersionResponse) GetApiPrefix

func (x *VersionResponse) GetApiPrefix() string

func (*VersionResponse) GetApiVersion

func (x *VersionResponse) GetApiVersion() string

func (*VersionResponse) GetWarewulfVersion

func (x *VersionResponse) GetWarewulfVersion() string

func (*VersionResponse) ProtoMessage

func (*VersionResponse) ProtoMessage()

func (*VersionResponse) ProtoReflect

func (x *VersionResponse) ProtoReflect() protoreflect.Message

func (*VersionResponse) Reset

func (x *VersionResponse) Reset()

func (*VersionResponse) String

func (x *VersionResponse) String() string

type WWApiClient

type WWApiClient interface {
	// ContainerBuild builds zero or more containers.
	ContainerBuild(ctx context.Context, in *ContainerBuildParameter, opts ...grpc.CallOption) (*ContainerListResponse, error)
	// ContainerDelete removes one or more container from Warewulf management.
	ContainerDelete(ctx context.Context, in *ContainerDeleteParameter, opts ...grpc.CallOption) (*emptypb.Empty, error)
	ContainerCopy(ctx context.Context, in *ContainerCopyParameter, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// ContainerImport imports a container to Warewulf.
	ContainerImport(ctx context.Context, in *ContainerImportParameter, opts ...grpc.CallOption) (*ContainerListResponse, error)
	// ContainerList lists ContainerInfo for each container.
	ContainerList(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*ContainerListResponse, error)
	// ContainerShow lists ContainerShow for each container.
	ContainerShow(ctx context.Context, in *ContainerShowParameter, opts ...grpc.CallOption) (*ContainerShowResponse, error)
	// ContainerRename renames the container
	ContainerRename(ctx context.Context, in *ContainerRenameParameter, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// NodeAdd adds one or more nodes for management by Warewulf and returns
	// the added nodes. Node fields may be shimmed in per profiles.
	NodeAdd(ctx context.Context, in *NodeAddParameter, opts ...grpc.CallOption) (*NodeListResponse, error)
	// NodeDelete removes one or more nodes from Warewulf management.
	NodeDelete(ctx context.Context, in *NodeDeleteParameter, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// NodeList lists some or all nodes managed by Warewulf.
	NodeList(ctx context.Context, in *NodeNames, opts ...grpc.CallOption) (*NodeListResponse, error)
	// NodeSet updates node fields for one or more nodes.
	NodeSet(ctx context.Context, in *NodeSetParameter, opts ...grpc.CallOption) (*NodeListResponse, error)
	// NodeStatus returns the imaging state for nodes.
	// This requires warewulfd.
	NodeStatus(ctx context.Context, in *NodeNames, opts ...grpc.CallOption) (*NodeStatusResponse, error)
	// Version returns the wwapi version, the api prefix, and the Warewulf
	// version. This is also useful for testing if the service is up.
	Version(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*VersionResponse, error)
}

WWApiClient is the client API for WWApi service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewWWApiClient

func NewWWApiClient(cc grpc.ClientConnInterface) WWApiClient

type WWApiServer

type WWApiServer interface {
	// ContainerBuild builds zero or more containers.
	ContainerBuild(context.Context, *ContainerBuildParameter) (*ContainerListResponse, error)
	// ContainerDelete removes one or more container from Warewulf management.
	ContainerDelete(context.Context, *ContainerDeleteParameter) (*emptypb.Empty, error)
	ContainerCopy(context.Context, *ContainerCopyParameter) (*emptypb.Empty, error)
	// ContainerImport imports a container to Warewulf.
	ContainerImport(context.Context, *ContainerImportParameter) (*ContainerListResponse, error)
	// ContainerList lists ContainerInfo for each container.
	ContainerList(context.Context, *emptypb.Empty) (*ContainerListResponse, error)
	// ContainerShow lists ContainerShow for each container.
	ContainerShow(context.Context, *ContainerShowParameter) (*ContainerShowResponse, error)
	// ContainerRename renames the container
	ContainerRename(context.Context, *ContainerRenameParameter) (*emptypb.Empty, error)
	// NodeAdd adds one or more nodes for management by Warewulf and returns
	// the added nodes. Node fields may be shimmed in per profiles.
	NodeAdd(context.Context, *NodeAddParameter) (*NodeListResponse, error)
	// NodeDelete removes one or more nodes from Warewulf management.
	NodeDelete(context.Context, *NodeDeleteParameter) (*emptypb.Empty, error)
	// NodeList lists some or all nodes managed by Warewulf.
	NodeList(context.Context, *NodeNames) (*NodeListResponse, error)
	// NodeSet updates node fields for one or more nodes.
	NodeSet(context.Context, *NodeSetParameter) (*NodeListResponse, error)
	// NodeStatus returns the imaging state for nodes.
	// This requires warewulfd.
	NodeStatus(context.Context, *NodeNames) (*NodeStatusResponse, error)
	// Version returns the wwapi version, the api prefix, and the Warewulf
	// version. This is also useful for testing if the service is up.
	Version(context.Context, *emptypb.Empty) (*VersionResponse, error)
	// contains filtered or unexported methods
}

WWApiServer is the server API for WWApi service. All implementations must embed UnimplementedWWApiServer for forward compatibility

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL