nodes

package
v0.0.0-...-4b711b1 Latest Latest
Warning

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

 Go to latest Published: Dec 27, 2024 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Overview

Package nodes is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source 
var (
	Query_OrderType_name = map[int32]string{
		0: "ASC",
		1: "DESC",
	}
	Query_OrderType_value = map[string]int32{
		"ASC":  0,
		"DESC": 1,
	}
)

Enum value maps for Query_OrderType.

View Source 
var (
	LastContactData_Status_name = map[int32]string{
		0: "UNKNOWN",
		1: "PASSED",
		2: "FAILED",
		3: "SKIPPED",
	}
	LastContactData_Status_value = map[string]int32{
		"UNKNOWN": 0,
		"PASSED":  1,
		"FAILED":  2,
		"SKIPPED": 3,
	}
)

Enum value maps for LastContactData_Status.

View Source 
var File_external_nodes_nodes_proto protoreflect.FileDescriptor

Functions

func RegisterNodesServiceHandler 

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

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

func RegisterNodesServiceHandlerClient 

func RegisterNodesServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client NodesServiceClient) error

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

func RegisterNodesServiceHandlerFromEndpoint 

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

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

func RegisterNodesServiceHandlerServer 

func RegisterNodesServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server NodesServiceServer) error

RegisterNodesServiceHandlerServer registers the http handlers for service NodesService to "mux". UnaryRPC :call NodesServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906.

func RegisterNodesServiceServer 

func RegisterNodesServiceServer(s *grpc.Server, srv NodesServiceServer)

Types

type BulkDeleteResponse 

type BulkDeleteResponse struct {

	// List of deleted nodes, by name.
	Names []string `protobuf:"bytes,1,rep,name=names,proto3" json:"names,omitempty"`
	// contains filtered or unexported fields
}

func (*BulkDeleteResponse) Descriptor deprecated 

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

Deprecated: Use BulkDeleteResponse.ProtoReflect.Descriptor instead.

func (*BulkDeleteResponse) GetNames 

func (x *BulkDeleteResponse) GetNames() []string

func (*BulkDeleteResponse) ProtoMessage 

func (*BulkDeleteResponse) ProtoMessage()

func (*BulkDeleteResponse) ProtoReflect 

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

func (*BulkDeleteResponse) Reset 

func (x *BulkDeleteResponse) Reset()

func (*BulkDeleteResponse) String 

func (x *BulkDeleteResponse) String() string

type Id 

type Id struct {

	// Unique node ID (UUID)
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*Id) Descriptor deprecated 

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

Deprecated: Use Id.ProtoReflect.Descriptor instead.

func (*Id) GetId 

func (x *Id) GetId() string

func (*Id) ProtoMessage 

func (*Id) ProtoMessage()

func (*Id) ProtoReflect 

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

func (*Id) Reset 

func (x *Id) Reset()

func (*Id) String 

func (x *Id) String() string

type Ids 

type Ids struct {

	// List of node UUIDs.
	Ids []string `protobuf:"bytes,1,rep,name=ids,proto3" json:"ids,omitempty"`
	// contains filtered or unexported fields
}

func (*Ids) Descriptor deprecated 

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

Deprecated: Use Ids.ProtoReflect.Descriptor instead.

func (*Ids) GetIds 

func (x *Ids) GetIds() []string

func (*Ids) ProtoMessage 

func (*Ids) ProtoMessage()

func (*Ids) ProtoReflect 

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

func (*Ids) Reset 

func (x *Ids) Reset()

func (*Ids) String 

func (x *Ids) String() string

type LastContactData 

type LastContactData struct {

	// Chef Infra run report ID or InSpec scan report ID.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Last node report status.
	Status LastContactData_Status `protobuf:"varint,2,opt,name=status,proto3,enum=chef.automate.api.nodes.v1.LastContactData_Status" json:"status,omitempty"`
	// Next-to-last node status report.
	PenultimateStatus LastContactData_Status `` /* 168-byte string literal not displayed */
	// Last node report endtime.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

Most recent node data from the latest Chef Infra run and InSpec scan.

func (*LastContactData) Descriptor deprecated 

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

Deprecated: Use LastContactData.ProtoReflect.Descriptor instead.

func (*LastContactData) GetEndTime 

func (x *LastContactData) GetEndTime() *timestamppb.Timestamp

func (*LastContactData) GetId 

func (x *LastContactData) GetId() string

func (*LastContactData) GetPenultimateStatus 

func (x *LastContactData) GetPenultimateStatus() LastContactData_Status

func (*LastContactData) GetStatus 

func (x *LastContactData) GetStatus() LastContactData_Status

func (*LastContactData) ProtoMessage 

func (*LastContactData) ProtoMessage()

func (*LastContactData) ProtoReflect 

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

func (*LastContactData) Reset 

func (x *LastContactData) Reset()

func (*LastContactData) String 

func (x *LastContactData) String() string

type LastContactData_Status 

type LastContactData_Status int32
const (
	LastContactData_UNKNOWN LastContactData_Status = 0
	LastContactData_PASSED  LastContactData_Status = 1
	LastContactData_FAILED  LastContactData_Status = 2
	LastContactData_SKIPPED LastContactData_Status = 3
)

func (LastContactData_Status) Descriptor 

func (LastContactData_Status) Descriptor() protoreflect.EnumDescriptor

func (LastContactData_Status) Enum 

func (x LastContactData_Status) Enum() *LastContactData_Status

func (LastContactData_Status) EnumDescriptor deprecated 

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

Deprecated: Use LastContactData_Status.Descriptor instead.

func (LastContactData_Status) Number 

func (x LastContactData_Status) Number() protoreflect.EnumNumber

func (LastContactData_Status) String 

func (x LastContactData_Status) String() string

func (LastContactData_Status) Type 

func (LastContactData_Status) Type() protoreflect.EnumType

type Node 

type Node struct {

	// Unique node ID (UUID).
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// User-specified node name.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Node platform.
	Platform string `protobuf:"bytes,3,opt,name=platform,proto3" json:"platform,omitempty"`
	// Node platform version.
	PlatformVersion string `protobuf:"bytes,4,opt,name=platform_version,json=platformVersion,proto3" json:"platform_version,omitempty"`
	// Node manager (automate, aws-ec2, aws-api, azure-vm, azure-api, gcp).
	Manager string `protobuf:"bytes,5,opt,name=manager,proto3" json:"manager,omitempty"`
	// Node tags.
	Tags []*query.Kv `protobuf:"bytes,20,rep,name=tags,proto3" json:"tags,omitempty"`
	// Timestamp of the last `detect` or `exec` job.
	LastContact *timestamppb.Timestamp `protobuf:"bytes,21,opt,name=last_contact,json=lastContact,proto3" json:"last_contact,omitempty"`
	// Node status (unreachable, reachable, unknown).
	Status string `protobuf:"bytes,22,opt,name=status,proto3" json:"status,omitempty"`
	// Results of the last compliance scan job for this node.
	LastJob *ResultsRow `protobuf:"bytes,23,opt,name=last_job,json=lastJob,proto3" json:"last_job,omitempty"`
	// Node configuration for ssh or winrm.
	TargetConfig *TargetConfig `protobuf:"bytes,99,opt,name=target_config,json=targetConfig,proto3" json:"target_config,omitempty"`
	// List of manager IDs for the node.
	ManagerIds []string `protobuf:"bytes,24,rep,name=manager_ids,json=managerIds,proto3" json:"manager_ids,omitempty"`
	// Last connection error received when trying to contact the node.
	ConnectionError string `protobuf:"bytes,25,opt,name=connection_error,json=connectionError,proto3" json:"connection_error,omitempty"`
	// Last known node state (running, stopped, terminated).
	State string `protobuf:"bytes,26,opt,name=state,proto3" json:"state,omitempty"`
	// Prefix for node name. The full node name is the prefix + the host.
	NamePrefix string `protobuf:"bytes,27,opt,name=name_prefix,json=namePrefix,proto3" json:"name_prefix,omitempty"`
	// List of projects associated with the node.
	Projects []string `protobuf:"bytes,28,rep,name=projects,proto3" json:"projects,omitempty"`
	// Most recent node data from the last Chef Infra run results.
	RunData *LastContactData `protobuf:"bytes,29,opt,name=run_data,json=runData,proto3" json:"run_data,omitempty"`
	// Most recent compliance scan data for the node from the last InSpec scan.
	ScanData *LastContactData `protobuf:"bytes,30,opt,name=scan_data,json=scanData,proto3" json:"scan_data,omitempty"`
	// contains filtered or unexported fields
}

Node information.

func (*Node) Descriptor deprecated 

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

Deprecated: Use Node.ProtoReflect.Descriptor instead.

func (*Node) GetConnectionError 

func (x *Node) GetConnectionError() string

func (*Node) GetId 

func (x *Node) GetId() string

func (*Node) GetLastContact 

func (x *Node) GetLastContact() *timestamppb.Timestamp

func (*Node) GetLastJob 

func (x *Node) GetLastJob() *ResultsRow

func (*Node) GetManager 

func (x *Node) GetManager() string

func (*Node) GetManagerIds 

func (x *Node) GetManagerIds() []string

func (*Node) GetName 

func (x *Node) GetName() string

func (*Node) GetNamePrefix 

func (x *Node) GetNamePrefix() string

func (*Node) GetPlatform 

func (x *Node) GetPlatform() string

func (*Node) GetPlatformVersion 

func (x *Node) GetPlatformVersion() string

func (*Node) GetProjects 

func (x *Node) GetProjects() []string

func (*Node) GetRunData 

func (x *Node) GetRunData() *LastContactData

func (*Node) GetScanData 

func (x *Node) GetScanData() *LastContactData

func (*Node) GetState 

func (x *Node) GetState() string

func (*Node) GetStatus 

func (x *Node) GetStatus() string

func (*Node) GetTags 

func (x *Node) GetTags() []*query.Kv

func (*Node) GetTargetConfig 

func (x *Node) GetTargetConfig() *TargetConfig

func (*Node) ProtoMessage 

func (*Node) ProtoMessage()

func (*Node) ProtoReflect 

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

func (*Node) Reset 

func (x *Node) Reset()

func (*Node) String 

func (x *Node) String() string

type Nodes 

type Nodes struct {

	// List of nodes.
	Nodes []*Node `protobuf:"bytes,1,rep,name=nodes,proto3" json:"nodes,omitempty"`
	// Total number of nodes in the system.
	Total int32 `protobuf:"varint,20,opt,name=total,proto3" json:"total,omitempty"`
	// Total number of unreachable nodes in the system.
	TotalUnreachable int32 `protobuf:"varint,21,opt,name=total_unreachable,json=totalUnreachable,proto3" json:"total_unreachable,omitempty"`
	// Total number of reachable nodes in the system.
	TotalReachable int32 `protobuf:"varint,22,opt,name=total_reachable,json=totalReachable,proto3" json:"total_reachable,omitempty"`
	// Total number of unknown nodes in the system.
	TotalUnknown int32 `protobuf:"varint,23,opt,name=total_unknown,json=totalUnknown,proto3" json:"total_unknown,omitempty"`
	// contains filtered or unexported fields
}

func (*Nodes) Descriptor deprecated 

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

Deprecated: Use Nodes.ProtoReflect.Descriptor instead.

func (*Nodes) GetNodes 

func (x *Nodes) GetNodes() []*Node

func (*Nodes) GetTotal 

func (x *Nodes) GetTotal() int32

func (*Nodes) GetTotalReachable 

func (x *Nodes) GetTotalReachable() int32

func (*Nodes) GetTotalUnknown 

func (x *Nodes) GetTotalUnknown() int32

func (*Nodes) GetTotalUnreachable 

func (x *Nodes) GetTotalUnreachable() int32

func (*Nodes) ProtoMessage 

func (*Nodes) ProtoMessage()

func (*Nodes) ProtoReflect 

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

func (*Nodes) Reset 

func (x *Nodes) Reset()

func (*Nodes) String 

func (x *Nodes) String() string

type NodesServiceClient 

type NodesServiceClient interface {
	// Create a Node
	//
	// Creates a node and adds it to the Chef Automate node manager.
	// Requires a FQDN or IP address, a user-specified name, and a ssh or winrm credential reference.
	// Useful for creating nodes for the purpose of running compliance scan jobs.
	//
	// Example:
	// “`
	// {
	// "name": "my-vagrant-node",
	// "manager":"automate",
	// "target_config": {
	// "backend":"ssh",
	// "host":"localhost",
	// "secrets":["b75195e5-a173-4502-9f59-d949adfe2c38"],
	// "port": 22
	// },
	// "tags": [
	// { "key":"test-node", "value":"is amazing" }
	// ]
	// }
	// “`
	//
	// Authorization Action:
	// “`
	// “`
	//
	//infra:nodes:create
	Create(ctx context.Context, in *Node, opts ...grpc.CallOption) (*Id, error)
	// Show Node Details
	//
	// Returns the details for a node given the node ID.
	//
	// Authorization Action:
	// “`
	// “`
	//
	//infra:nodes:get
	Read(ctx context.Context, in *Id, opts ...grpc.CallOption) (*Node, error)
	// Update Node
	//
	// This PUT operation overwrites ALL node details and requires the complete set of node details,
	// consisting of a FQDN or IP address, a user-specified name, and the ID for an ssh or winrm credential.
	// Substitute the desired values for the existing node details in the PUT message.
	//
	// Authorization Action:
	// “`
	// “`
	//
	//infra:nodes:update
	Update(ctx context.Context, in *Node, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Delete a Node
	//
	// Deletes the node with the node ID.
	//
	// Authorization Action:
	// “`
	// “`
	//
	//infra:nodes:delete
	Delete(ctx context.Context, in *Id, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Bulk Delete Nodes by ID
	//
	// Deletes a set of nodes given a list of IDs.
	// Invalid IDs will be ignored.
	//
	// Authorization Action:
	// “`
	// “`
	//
	//infra:nodes:delete
	BulkDeleteById(ctx context.Context, in *Ids, opts ...grpc.CallOption) (*BulkDeleteResponse, error)
	// List and Filter Nodes
	//
	// Makes a list of nodes.
	// Supports filtering, pagination, and sorting.
	// Adding a filter narrows the list of nodes to only those that match the filter or filters.
	// Supported filters:
	// account_id, last_contact, manager_id, manager_type, name, platform_name,
	// platform_release, region, source_id, state, statechange_timerange, status,
	// last_run_timerange, last_scan_timerange, last_run_status, last_scan_status,
	// last_run_penultimate_status, last_scan_penultimate_status
	//
	// Example:
	// “`
	// {
	// "filters":[
	// {"key": "last_scan_status", "values": ["FAILED"]},
	// {"key": "last_scan_penultimate_status", "values": ["PASSED"]},
	// {"key": "name", "values": ["MyNode*"]}
	// ],
	// "page":1, "per_page":100,
	// "sort":"status", "order":"ASC"
	// }
	// “`
	//
	// Authorization Action:
	// “`
	// “`
	//
	//infra:nodes:list
	List(ctx context.Context, in *Query, opts ...grpc.CallOption) (*Nodes, error)
	// List Node Status
	//
	// Use this to run an `inspec detect` job on the node, which updates the status to reflect that the node is reachable or unreachable.
	//
	// Authorization Action:
	// “`
	// “`
	//
	//infra:nodes:rerun
	Rerun(ctx context.Context, in *Id, opts ...grpc.CallOption) (*RerunResponse, error)
	// Bulk Delete Nodes by Filter
	//
	// Deletes a set of nodes that match a filter.
	// Available filters: account_id, last_contact, manager_id, manager_type, name, platform_name,
	// platform_release, region, source_id, state, statechange_timerange, status,
	// last_run_timerange, last_scan_timerange, last_run_status, last_scan_status,
	// last_run_penultimate_status, last_scan_penultimate_status
	//
	// Example:
	// “`
	// {"filters": [{"key": "name", "values": ["vj*"]}]}'
	// “`
	//
	// Authorization Action:
	// “`
	// “`
	//
	//infra:nodes:delete
	BulkDelete(ctx context.Context, in *Query, opts ...grpc.CallOption) (*BulkDeleteResponse, error)
	// Bulk Create Nodes
	//
	// Creates multiple nodes from a list of node data.
	// `hosts` field is required. Multiple hosts may be defined in this field.
	//
	// Example:
	// “`
	// {
	// "name_prefix": "000-my-ssh-node",
	// "manager":"automate",
	// "target_config": {
	// "backend":"ssh",
	// "hosts":["localhost","127.0.0.1"],
	// "secrets":["b75195e5-a173-4502-9f59-d949adfe2c38"],
	// "port": 22
	// },
	// "tags": [
	// { "key":"test-node", "value":"is-amazing" },
	// ]
	// }
	// “`
	//
	// Authorization Action:
	// “`
	// “`
	//
	//infra:nodes:create
	BulkCreate(ctx context.Context, in *Nodes, opts ...grpc.CallOption) (*Ids, error)
}

NodesServiceClient is the client API for NodesService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewNodesServiceClient 

func NewNodesServiceClient(cc grpc.ClientConnInterface) NodesServiceClient

type NodesServiceServer 

type NodesServiceServer interface {
	// Create a Node
	//
	// Creates a node and adds it to the Chef Automate node manager.
	// Requires a FQDN or IP address, a user-specified name, and a ssh or winrm credential reference.
	// Useful for creating nodes for the purpose of running compliance scan jobs.
	//
	// Example:
	// “`
	// {
	// "name": "my-vagrant-node",
	// "manager":"automate",
	// "target_config": {
	// "backend":"ssh",
	// "host":"localhost",
	// "secrets":["b75195e5-a173-4502-9f59-d949adfe2c38"],
	// "port": 22
	// },
	// "tags": [
	// { "key":"test-node", "value":"is amazing" }
	// ]
	// }
	// “`
	//
	// Authorization Action:
	// “`
	// “`
	//
	//infra:nodes:create
	Create(context.Context, *Node) (*Id, error)
	// Show Node Details
	//
	// Returns the details for a node given the node ID.
	//
	// Authorization Action:
	// “`
	// “`
	//
	//infra:nodes:get
	Read(context.Context, *Id) (*Node, error)
	// Update Node
	//
	// This PUT operation overwrites ALL node details and requires the complete set of node details,
	// consisting of a FQDN or IP address, a user-specified name, and the ID for an ssh or winrm credential.
	// Substitute the desired values for the existing node details in the PUT message.
	//
	// Authorization Action:
	// “`
	// “`
	//
	//infra:nodes:update
	Update(context.Context, *Node) (*emptypb.Empty, error)
	// Delete a Node
	//
	// Deletes the node with the node ID.
	//
	// Authorization Action:
	// “`
	// “`
	//
	//infra:nodes:delete
	Delete(context.Context, *Id) (*emptypb.Empty, error)
	// Bulk Delete Nodes by ID
	//
	// Deletes a set of nodes given a list of IDs.
	// Invalid IDs will be ignored.
	//
	// Authorization Action:
	// “`
	// “`
	//
	//infra:nodes:delete
	BulkDeleteById(context.Context, *Ids) (*BulkDeleteResponse, error)
	// List and Filter Nodes
	//
	// Makes a list of nodes.
	// Supports filtering, pagination, and sorting.
	// Adding a filter narrows the list of nodes to only those that match the filter or filters.
	// Supported filters:
	// account_id, last_contact, manager_id, manager_type, name, platform_name,
	// platform_release, region, source_id, state, statechange_timerange, status,
	// last_run_timerange, last_scan_timerange, last_run_status, last_scan_status,
	// last_run_penultimate_status, last_scan_penultimate_status
	//
	// Example:
	// “`
	// {
	// "filters":[
	// {"key": "last_scan_status", "values": ["FAILED"]},
	// {"key": "last_scan_penultimate_status", "values": ["PASSED"]},
	// {"key": "name", "values": ["MyNode*"]}
	// ],
	// "page":1, "per_page":100,
	// "sort":"status", "order":"ASC"
	// }
	// “`
	//
	// Authorization Action:
	// “`
	// “`
	//
	//infra:nodes:list
	List(context.Context, *Query) (*Nodes, error)
	// List Node Status
	//
	// Use this to run an `inspec detect` job on the node, which updates the status to reflect that the node is reachable or unreachable.
	//
	// Authorization Action:
	// “`
	// “`
	//
	//infra:nodes:rerun
	Rerun(context.Context, *Id) (*RerunResponse, error)
	// Bulk Delete Nodes by Filter
	//
	// Deletes a set of nodes that match a filter.
	// Available filters: account_id, last_contact, manager_id, manager_type, name, platform_name,
	// platform_release, region, source_id, state, statechange_timerange, status,
	// last_run_timerange, last_scan_timerange, last_run_status, last_scan_status,
	// last_run_penultimate_status, last_scan_penultimate_status
	//
	// Example:
	// “`
	// {"filters": [{"key": "name", "values": ["vj*"]}]}'
	// “`
	//
	// Authorization Action:
	// “`
	// “`
	//
	//infra:nodes:delete
	BulkDelete(context.Context, *Query) (*BulkDeleteResponse, error)
	// Bulk Create Nodes
	//
	// Creates multiple nodes from a list of node data.
	// `hosts` field is required. Multiple hosts may be defined in this field.
	//
	// Example:
	// “`
	// {
	// "name_prefix": "000-my-ssh-node",
	// "manager":"automate",
	// "target_config": {
	// "backend":"ssh",
	// "hosts":["localhost","127.0.0.1"],
	// "secrets":["b75195e5-a173-4502-9f59-d949adfe2c38"],
	// "port": 22
	// },
	// "tags": [
	// { "key":"test-node", "value":"is-amazing" },
	// ]
	// }
	// “`
	//
	// Authorization Action:
	// “`
	// “`
	//
	//infra:nodes:create
	BulkCreate(context.Context, *Nodes) (*Ids, error)
}

NodesServiceServer is the server API for NodesService service.

type Query 

type Query struct {

	// Use filters to limit the set of nodes to delete.
	Filters []*query.Filter `protobuf:"bytes,20,rep,name=filters,proto3" json:"filters,omitempty"`
	Order   Query_OrderType `protobuf:"varint,21,opt,name=order,proto3,enum=chef.automate.api.nodes.v1.Query_OrderType" json:"order,omitempty"`
	// Sort the results on a specific field.
	Sort string `protobuf:"bytes,22,opt,name=sort,proto3" json:"sort,omitempty"`
	// Starting page for the results.
	Page int32 `protobuf:"varint,23,opt,name=page,proto3" json:"page,omitempty"`
	// The number of results on each page.
	PerPage int32 `protobuf:"varint,24,opt,name=per_page,json=perPage,proto3" json:"per_page,omitempty"`
	// contains filtered or unexported fields
}

func (*Query) Descriptor deprecated 

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

Deprecated: Use Query.ProtoReflect.Descriptor instead.

func (*Query) GetFilters 

func (x *Query) GetFilters() []*query.Filter

func (*Query) GetOrder 

func (x *Query) GetOrder() Query_OrderType

func (*Query) GetPage 

func (x *Query) GetPage() int32

func (*Query) GetPerPage 

func (x *Query) GetPerPage() int32

func (*Query) GetSort 

func (x *Query) GetSort() string

func (*Query) ProtoMessage 

func (*Query) ProtoMessage()

func (*Query) ProtoReflect 

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

func (*Query) Reset 

func (x *Query) Reset()

func (*Query) String 

func (x *Query) String() string

type Query_OrderType 

type Query_OrderType int32

Return the results in ascending or descending order. 

const (
	Query_ASC  Query_OrderType = 0
	Query_DESC Query_OrderType = 1
)

func (Query_OrderType) Descriptor 

func (Query_OrderType) Descriptor() protoreflect.EnumDescriptor

func (Query_OrderType) Enum 

func (x Query_OrderType) Enum() *Query_OrderType

func (Query_OrderType) EnumDescriptor deprecated 

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

Deprecated: Use Query_OrderType.Descriptor instead.

func (Query_OrderType) Number 

func (x Query_OrderType) Number() protoreflect.EnumNumber

func (Query_OrderType) String 

func (x Query_OrderType) String() string

func (Query_OrderType) Type 

func (Query_OrderType) Type() protoreflect.EnumType

type RerunResponse 

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

func (*RerunResponse) Descriptor deprecated 

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

Deprecated: Use RerunResponse.ProtoReflect.Descriptor instead.

func (*RerunResponse) ProtoMessage 

func (*RerunResponse) ProtoMessage()

func (*RerunResponse) ProtoReflect 

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

func (*RerunResponse) Reset 

func (x *RerunResponse) Reset()

func (*RerunResponse) String 

func (x *RerunResponse) String() string

type ResultsRow 

type ResultsRow struct {

	// Unique node ID.
	NodeId string `protobuf:"bytes,1,opt,name=node_id,json=nodeId,proto3" json:"node_id,omitempty"`
	// Unique ID of the report generated by the InSpec scan.
	ReportId string `protobuf:"bytes,2,opt,name=report_id,json=reportId,proto3" json:"report_id,omitempty"`
	// Status of the report (failed, success, skipped).
	Status string `protobuf:"bytes,3,opt,name=status,proto3" json:"status,omitempty"`
	// Error message returned after several failed attempts to contact a node.
	Result string `protobuf:"bytes,4,opt,name=result,proto3" json:"result,omitempty"`
	// Unique ID of the scan job that generated the report.
	JobId string `protobuf:"bytes,5,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// Start time on the report.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,20,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// End time on the report.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,21,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

Summary of the last Chef InSpec scan job run on the node.

func (*ResultsRow) Descriptor deprecated 

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

Deprecated: Use ResultsRow.ProtoReflect.Descriptor instead.

func (*ResultsRow) GetEndTime 

func (x *ResultsRow) GetEndTime() *timestamppb.Timestamp

func (*ResultsRow) GetJobId 

func (x *ResultsRow) GetJobId() string

func (*ResultsRow) GetNodeId 

func (x *ResultsRow) GetNodeId() string

func (*ResultsRow) GetReportId 

func (x *ResultsRow) GetReportId() string

func (*ResultsRow) GetResult 

func (x *ResultsRow) GetResult() string

func (*ResultsRow) GetStartTime 

func (x *ResultsRow) GetStartTime() *timestamppb.Timestamp

func (*ResultsRow) GetStatus 

func (x *ResultsRow) GetStatus() string

func (*ResultsRow) ProtoMessage 

func (*ResultsRow) ProtoMessage()

func (*ResultsRow) ProtoReflect 

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

func (*ResultsRow) Reset 

func (x *ResultsRow) Reset()

func (*ResultsRow) String 

func (x *ResultsRow) String() string

type TargetConfig 

type TargetConfig struct {

	// List of credential IDs for a node.
	Secrets []string `protobuf:"bytes,20,rep,name=secrets,proto3" json:"secrets,omitempty"`
	// Node backend type (ssh, winrm, aws, ssm, azure, gcp).
	Backend string `protobuf:"bytes,22,opt,name=backend,proto3" json:"backend,omitempty"`
	// Node FQDN or IP address.
	Host string `protobuf:"bytes,23,opt,name=host,proto3" json:"host,omitempty"`
	// ssh or winrm connection port
	Port int32 `protobuf:"varint,24,opt,name=port,proto3" json:"port,omitempty"`
	// Uses `sudo` (boolean).
	Sudo bool `protobuf:"varint,26,opt,name=sudo,proto3" json:"sudo,omitempty"`
	// Check ssl (boolean).
	Ssl bool `protobuf:"varint,27,opt,name=ssl,proto3" json:"ssl,omitempty"`
	// Allow self-signed certificate (boolean).
	SelfSigned bool `protobuf:"varint,28,opt,name=self_signed,json=selfSigned,proto3" json:"self_signed,omitempty"`
	// Username from the credential ID for this node.
	User string `protobuf:"bytes,29,opt,name=user,proto3" json:"user,omitempty"`
	// Sudo options to use when accessing the node.
	SudoOptions string `protobuf:"bytes,33,opt,name=sudo_options,json=sudoOptions,proto3" json:"sudo_options,omitempty"`
	// List of hostnames (FQDN or IP address) for bulk creating nodes.
	Hosts []string `protobuf:"bytes,40,rep,name=hosts,proto3" json:"hosts,omitempty"`
	// contains filtered or unexported fields
}

Details for ssh/winrm access of the node.

func (*TargetConfig) Descriptor deprecated 

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

Deprecated: Use TargetConfig.ProtoReflect.Descriptor instead.

func (*TargetConfig) GetBackend 

func (x *TargetConfig) GetBackend() string

func (*TargetConfig) GetHost 

func (x *TargetConfig) GetHost() string

func (*TargetConfig) GetHosts 

func (x *TargetConfig) GetHosts() []string

func (*TargetConfig) GetPort 

func (x *TargetConfig) GetPort() int32

func (*TargetConfig) GetSecrets 

func (x *TargetConfig) GetSecrets() []string

func (*TargetConfig) GetSelfSigned 

func (x *TargetConfig) GetSelfSigned() bool

func (*TargetConfig) GetSsl 

func (x *TargetConfig) GetSsl() bool

func (*TargetConfig) GetSudo 

func (x *TargetConfig) GetSudo() bool

func (*TargetConfig) GetSudoOptions 

func (x *TargetConfig) GetSudoOptions() string

func (*TargetConfig) GetUser 

func (x *TargetConfig) GetUser() string

func (*TargetConfig) ProtoMessage 

func (*TargetConfig) ProtoMessage()

func (*TargetConfig) ProtoReflect 

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

func (*TargetConfig) Reset 

func (x *TargetConfig) Reset()

func (*TargetConfig) String 

func (x *TargetConfig) String() string

type UnimplementedNodesServiceServer 

type UnimplementedNodesServiceServer struct {
}

UnimplementedNodesServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedNodesServiceServer) BulkCreate 

func (*UnimplementedNodesServiceServer) BulkCreate(context.Context, *Nodes) (*Ids, error)

func (*UnimplementedNodesServiceServer) BulkDelete 

func (*UnimplementedNodesServiceServer) BulkDelete(context.Context, *Query) (*BulkDeleteResponse, error)

func (*UnimplementedNodesServiceServer) BulkDeleteById 

func (*UnimplementedNodesServiceServer) BulkDeleteById(context.Context, *Ids) (*BulkDeleteResponse, error)

func (*UnimplementedNodesServiceServer) Create 

func (*UnimplementedNodesServiceServer) Create(context.Context, *Node) (*Id, error)

func (*UnimplementedNodesServiceServer) Delete 

func (*UnimplementedNodesServiceServer) Delete(context.Context, *Id) (*emptypb.Empty, error)

func (*UnimplementedNodesServiceServer) List 

func (*UnimplementedNodesServiceServer) List(context.Context, *Query) (*Nodes, error)

func (*UnimplementedNodesServiceServer) Read 

func (*UnimplementedNodesServiceServer) Read(context.Context, *Id) (*Node, error)

func (*UnimplementedNodesServiceServer) Rerun 

func (*UnimplementedNodesServiceServer) Rerun(context.Context, *Id) (*RerunResponse, error)

func (*UnimplementedNodesServiceServer) Update 

func (*UnimplementedNodesServiceServer) Update(context.Context, *Node) (*emptypb.Empty, error)

Source Files

View all Source files

Directories

Path Synopsis
Package manager is a reverse proxy.
 Package manager is a reverse proxy.

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.