Documentation ¶
Overview ¶
Package cfgmgmt is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterConfigMgmtHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterConfigMgmtHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ConfigMgmtClient) error
- func RegisterConfigMgmtHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterConfigMgmtHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ConfigMgmtServer) error
- func RegisterConfigMgmtServer(s *grpc.Server, srv ConfigMgmtServer)
- type ConfigMgmtClient
- type ConfigMgmtServer
- type ConfigMgmt_NodeExportClient
- type ConfigMgmt_NodeExportServer
- type ConfigMgmt_ReportExportClient
- type ConfigMgmt_ReportExportServer
- type UnimplementedConfigMgmtServer
- func (*UnimplementedConfigMgmtServer) CreateRollout(context.Context, *request.CreateRollout) (*response.Rollout, error)
- func (*UnimplementedConfigMgmtServer) CreateRolloutTest(context.Context, *request.CreateRolloutTest) (*response.CreateRolloutTest, error)
- func (*UnimplementedConfigMgmtServer) GetAttributes(context.Context, *request.Node) (*response.NodeAttribute, error)
- func (*UnimplementedConfigMgmtServer) GetCheckInCountsTimeSeries(context.Context, *request.CheckInCountsTimeSeries) (*response.CheckInCountsTimeSeries, error)
- func (*UnimplementedConfigMgmtServer) GetErrors(context.Context, *request.Errors) (*response.Errors, error)
- func (*UnimplementedConfigMgmtServer) GetMissingNodeDurationCounts(context.Context, *request.MissingNodeDurationCounts) (*response.MissingNodeDurationCounts, error)
- func (*UnimplementedConfigMgmtServer) GetNodeMetadataCounts(context.Context, *request.NodeMetadataCounts) (*response.NodeMetadataCounts, error)
- func (*UnimplementedConfigMgmtServer) GetNodeRun(context.Context, *request.NodeRun) (*response.Run, error)
- func (*UnimplementedConfigMgmtServer) GetNodeRunsDailyStatusTimeSeries(context.Context, *request.NodeRunsDailyStatusTimeSeries) (*response.NodeRunsDailyStatusTimeSeries, error)
- func (*UnimplementedConfigMgmtServer) GetNodes(context.Context, *request.Nodes) (*structpb.ListValue, error)
- func (*UnimplementedConfigMgmtServer) GetNodesCounts(context.Context, *request.NodesCounts) (*response.NodesCounts, error)
- func (*UnimplementedConfigMgmtServer) GetNodesUsageCount(context.Context, *request.GetNodesUsageCountRequest) (*response.GetNodesUsageCountResponse, error)
- func (*UnimplementedConfigMgmtServer) GetOrganizations(context.Context, *request.Organizations) (*structpb.ListValue, error)
- func (*UnimplementedConfigMgmtServer) GetPolicyCookbooks(context.Context, *request.PolicyRevision) (*response.PolicyCookbooks, error)
- func (*UnimplementedConfigMgmtServer) GetRolloutById(context.Context, *request.RolloutById) (*response.Rollout, error)
- func (*UnimplementedConfigMgmtServer) GetRolloutForChefRun(context.Context, *request.RolloutForChefRun) (*response.Rollout, error)
- func (*UnimplementedConfigMgmtServer) GetRollouts(context.Context, *request.Rollouts) (*response.Rollouts, error)
- func (*UnimplementedConfigMgmtServer) GetRuns(context.Context, *request.Runs) (*structpb.ListValue, error)
- func (*UnimplementedConfigMgmtServer) GetRunsCounts(context.Context, *request.RunsCounts) (*response.RunsCounts, error)
- func (*UnimplementedConfigMgmtServer) GetSourceFqdns(context.Context, *request.SourceFqdns) (*structpb.ListValue, error)
- func (*UnimplementedConfigMgmtServer) GetSuggestions(context.Context, *query.Suggestion) (*structpb.ListValue, error)
- func (*UnimplementedConfigMgmtServer) GetVersion(context.Context, *version.VersionInfoRequest) (*version.VersionInfo, error)
- func (*UnimplementedConfigMgmtServer) ListNodeSegmentsWithRolloutProgress(context.Context, *request.ListNodeSegmentsWithRolloutProgress) (*response.NodeSegmentsWithRolloutProgress, error)
- func (*UnimplementedConfigMgmtServer) NodeExport(*request.NodeExport, ConfigMgmt_NodeExportServer) error
- func (*UnimplementedConfigMgmtServer) ReportExport(*request.ReportExport, ConfigMgmt_ReportExportServer) error
- func (*UnimplementedConfigMgmtServer) UpdateTelemetryReported(context.Context, *request.UpdateTelemetryReportedRequest) (*response.UpdateTelemetryReportedResponse, error)
Constants ¶
This section is empty.
Variables ¶
var File_external_cfgmgmt_cfgmgmt_proto protoreflect.FileDescriptor
Functions ¶
func RegisterConfigMgmtHandler ¶
func RegisterConfigMgmtHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterConfigMgmtHandler registers the http handlers for service ConfigMgmt to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterConfigMgmtHandlerClient ¶
func RegisterConfigMgmtHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ConfigMgmtClient) error
RegisterConfigMgmtHandlerClient registers the http handlers for service ConfigMgmt to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "ConfigMgmtClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "ConfigMgmtClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "ConfigMgmtClient" to call the correct interceptors.
func RegisterConfigMgmtHandlerFromEndpoint ¶
func RegisterConfigMgmtHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterConfigMgmtHandlerFromEndpoint is same as RegisterConfigMgmtHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterConfigMgmtHandlerServer ¶
func RegisterConfigMgmtHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ConfigMgmtServer) error
RegisterConfigMgmtHandlerServer registers the http handlers for service ConfigMgmt to "mux". UnaryRPC :call ConfigMgmtServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906.
func RegisterConfigMgmtServer ¶
func RegisterConfigMgmtServer(s *grpc.Server, srv ConfigMgmtServer)
Types ¶
type ConfigMgmtClient ¶
type ConfigMgmtClient interface { // List Checked-in Nodes // // Returns a list of infra nodes that have checked in to Automate. // Adding a filter makes a list of all nodes that meet the filter criteria. // Filters for the same field are ORd together, while filters across different fields are ANDed together. // Supports pagination, filtering (with wildcard support), and sorting. // Max return payload size is 4MB, use pagination to fetch remaining data. // // Example: // “` // cfgmgmt/nodes?pagination.page=1&pagination.size=100&sorting.field=name&sorting.order=ASC&filter=name:mySO*&filter=platform:ubun* // “` // // Authorization Action: // “` // “` // //infra:nodes:list GetNodes(ctx context.Context, in *request.Nodes, opts ...grpc.CallOption) (*structpb.ListValue, error) // List Run Details // // Returns a list of run metadata (id, start and end time, and status) for the provided node ID. // Supports pagination. // Accepts a `start` parameter to denote start date for the list and a filter of type `status`. // // Authorization Action: // “` // “` // //infra:nodes:list GetRuns(ctx context.Context, in *request.Runs, opts ...grpc.CallOption) (*structpb.ListValue, error) // List Node Status Counts // // Returns totals for failed, success, missing, and overall total infra nodes that have reported into Automate. // Supports filtering. // // Example: // “` // cfgmgmt/stats/node_counts?filter=name:mySO*&filter=platform:ubun* // “` // // Authorization Action: // “` // “` // //infra:nodes:list GetNodesCounts(ctx context.Context, in *request.NodesCounts, opts ...grpc.CallOption) (*response.NodesCounts, error) // List Run Status Totals // // Returns totals for failed and successful runs given a `node_id`. // // Example: // “` // cfgmgmt/stats/run_counts?node_id=821fff07-abc9-4160-96b1-83d68ae5cfdd&start=2019-11-02 // “` // // Authorization Action: // “` // “` // //infra:nodes:list GetRunsCounts(ctx context.Context, in *request.RunsCounts, opts ...grpc.CallOption) (*response.RunsCounts, error) // List Node Checkins // // Returns a daily time series of unique node check-ins for the number of days requested. // If `days ago` value is empty, API will return the default 1 day ago results. // // Authorization Action: // “` // “` // //infra:nodes:list GetCheckInCountsTimeSeries(ctx context.Context, in *request.CheckInCountsTimeSeries, opts ...grpc.CallOption) (*response.CheckInCountsTimeSeries, error) // List Missing Nodes Count // // Returns a count of missing nodes for the provided durations. // // Example: // “` // cfgmgmt/stats/missing_node_duration_counts?durations=3d&durations=1w&durations=2w&durations=1M&durations=3M // “` // // Authorization Action: // “` // “` // //infra:nodes:list GetMissingNodeDurationCounts(ctx context.Context, in *request.MissingNodeDurationCounts, opts ...grpc.CallOption) (*response.MissingNodeDurationCounts, error) // Show Node Run // // Returns the infra run report for the provided node ID and run ID. // // Authorization Action: // “` // “` // //infra:nodes:get GetNodeRun(ctx context.Context, in *request.NodeRun, opts ...grpc.CallOption) (*response.Run, error) // List Filter Suggestions // // Returns possible filter values given a valid `type` parameter. All values returned until two or more characters are provided for the `text` parameter. // Supports wildcard (* and ?). // // Example: // “` // cfgmgmt/suggestions?type=environment&text=_d // “` // // Authorization Action: // “` // “` // //infra:nodes:list GetSuggestions(ctx context.Context, in *query.Suggestion, opts ...grpc.CallOption) (*structpb.ListValue, error) // List Organizations // // Returns a list of all organizations associated with nodes that have checked in to Automate. // // Authorization Action: // “` // “` // //infra:nodes:list GetOrganizations(ctx context.Context, in *request.Organizations, opts ...grpc.CallOption) (*structpb.ListValue, error) // List Associated Chef Infra Servers // // Returns a list of all Chef Infra Servers associated with nodes that have checked in to Automate. // // Authorization Action: // “` // “` // //infra:nodes:list GetSourceFqdns(ctx context.Context, in *request.SourceFqdns, opts ...grpc.CallOption) (*structpb.ListValue, error) // Show Attributes // // Returns the latest reported attributes for the provided node ID. // // Authorization Action: // “` // “` // //infra:nodes:get GetAttributes(ctx context.Context, in *request.Node, opts ...grpc.CallOption) (*response.NodeAttribute, error) GetVersion(ctx context.Context, in *version.VersionInfoRequest, opts ...grpc.CallOption) (*version.VersionInfo, error) // List Policy Cookbooks // // Returns Policy Names with a list of cookbook names and associated policy identifiers based on a policy revision ID. // Policy revision IDs are sent with an infra run report and identifies which instance of a policy the node used for this run. // // Authorization Action: // “` // “` // //infra:nodes:list GetPolicyCookbooks(ctx context.Context, in *request.PolicyRevision, opts ...grpc.CallOption) (*response.PolicyCookbooks, error) // List Errors // // Returns a list of the most common errors reported for infra nodes' most recent Chef Infra Client runs. // // Authorization Action: // “` // “` // //infra:nodes:list GetErrors(ctx context.Context, in *request.Errors, opts ...grpc.CallOption) (*response.Errors, error) NodeExport(ctx context.Context, in *request.NodeExport, opts ...grpc.CallOption) (ConfigMgmt_NodeExportClient, error) ReportExport(ctx context.Context, in *request.ReportExport, opts ...grpc.CallOption) (ConfigMgmt_ReportExportClient, error) // GetNodeMetadataCounts // // For each type of field requested this returns distinct values the amount of each. For example, // if the 'platform' field is requested 'windows' 10, 'redhat' 5, and 'ubuntu' 8 could be returned. // The number next to each represents the number of nodes with that type of platform. // // Example: // request // “` // cfgmgmt/node_metadata_counts?type=platform&type=status // “` // response // “` // { // "types": [ // { // "values": [ // { // "value": "mac_os_x 10.11.5", // "count": 28 // }, // { // "value": "linux 8.9", // "count": 1 // }, // { // "value": "macos 8.9", // "count": 1 // }, // { // "value": "windows 8.9", // "count": 1 // } // ], // "type": "platform" // }, // { // "value": [ // { // "value": "missing", // "count": 29 // }, // { // "value": "failure", // "count": 2 // } // ], // "type": "status" // } // ] // } // “` // // Authorization Action: // “` // “` // //infra:nodes:list GetNodeMetadataCounts(ctx context.Context, in *request.NodeMetadataCounts, opts ...grpc.CallOption) (*response.NodeMetadataCounts, error) // GetNodeRunsDailyStatusTimeSeries // // Provides the status of runs for each 24-hour duration. For multiple runs in one 24-hour duration, // the most recent failed run will be returned. If there are no failed runs the most recent successful // run will be returned. If no runs are found in the 24-hour duration, the status will be "missing" // and no run information will be returned. // // Example: // request // “` // cfgmgmt/node_runs_daily_status_time_series?node_id=507bd518-5c18-4c2d-a445-60fe7dde9961&days_ago=3 // “` // response // “` // { // "durations": [ // { // "start": "2020-04-25T19:00:00Z", // "end": "2020-04-26T18:59:59Z", // "status": "missing", // "run_id": "" // }, // { // "start": "2020-04-26T19:00:00Z", // "end": "2020-04-27T18:59:59Z", // "status": "missing", // "run_id": "" // }, // { // "start": "2020-04-27T19:00:00Z", // "end": "2020-04-28T18:59:59Z", // "status": "failure", // "run_id": "b7904f41-68b5-44ec-9da6-cf2481ff8600" // } // ] // } // “` // // Authorization Action: // “` // “` // //infra:nodes:list GetNodeRunsDailyStatusTimeSeries(ctx context.Context, in *request.NodeRunsDailyStatusTimeSeries, opts ...grpc.CallOption) (*response.NodeRunsDailyStatusTimeSeries, error) // CreateRollout // // Creates a Rollout record. A rollout represents the process of nodes acquiring // the latest policy revision pushed to a policy group. // // Authorization Action: // “` // “` // //ingest:unifiedEvents:create CreateRollout(ctx context.Context, in *request.CreateRollout, opts ...grpc.CallOption) (*response.Rollout, error) // CreateRolloutTest // // CreateRolloutTest is a no-op endpoint that has the same auth requirements as // CreateRollout. It can be used to verify end-to-end config/connectivity for // clients // // Authorization Action: // “` // “` // //ingest:unifiedEvents:create CreateRolloutTest(ctx context.Context, in *request.CreateRolloutTest, opts ...grpc.CallOption) (*response.CreateRolloutTest, error) // GetRollouts // // # Gives a list of rollouts // // Authorization Action: // “` // “` // //infra:nodes:list GetRollouts(ctx context.Context, in *request.Rollouts, opts ...grpc.CallOption) (*response.Rollouts, error) // GetRolloutById // // # Returns the rollout with the given Id // // Authorization Action: // “` // “` // //infra:nodes:list GetRolloutById(ctx context.Context, in *request.RolloutById, opts ...grpc.CallOption) (*response.Rollout, error) // GetRolloutForChefRun // // Returns the rollout for the given Chef Server/org, policy group, policy name, and policy revision // // Authorization Action: // “` // “` // //infra:nodes:list GetRolloutForChefRun(ctx context.Context, in *request.RolloutForChefRun, opts ...grpc.CallOption) (*response.Rollout, error) ListNodeSegmentsWithRolloutProgress(ctx context.Context, in *request.ListNodeSegmentsWithRolloutProgress, opts ...grpc.CallOption) (*response.NodeSegmentsWithRolloutProgress, error) // UpdateTelemetryReported // Acknowledge API to updates the last client run telemetry reported date in postgres // Authorization Action: // “` // “` // //iam:introspect:getAll UpdateTelemetryReported(ctx context.Context, in *request.UpdateTelemetryReportedRequest, opts ...grpc.CallOption) (*response.UpdateTelemetryReportedResponse, error) // GetNodesUsageCount // // Returns the count of unique nodes with lastRun in a given time. // The time duration can be between the last time Telemetry data sent and the day before the current date. // If the duration < 15 days --> 15 days // duration > 15 days --> duration // Authorization Action: // “` // “` // //iam:introspect:getAll GetNodesUsageCount(ctx context.Context, in *request.GetNodesUsageCountRequest, opts ...grpc.CallOption) (*response.GetNodesUsageCountResponse, error) }
ConfigMgmtClient is the client API for ConfigMgmt service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewConfigMgmtClient ¶
func NewConfigMgmtClient(cc grpc.ClientConnInterface) ConfigMgmtClient
type ConfigMgmtServer ¶
type ConfigMgmtServer interface { // List Checked-in Nodes // // Returns a list of infra nodes that have checked in to Automate. // Adding a filter makes a list of all nodes that meet the filter criteria. // Filters for the same field are ORd together, while filters across different fields are ANDed together. // Supports pagination, filtering (with wildcard support), and sorting. // Max return payload size is 4MB, use pagination to fetch remaining data. // // Example: // “` // cfgmgmt/nodes?pagination.page=1&pagination.size=100&sorting.field=name&sorting.order=ASC&filter=name:mySO*&filter=platform:ubun* // “` // // Authorization Action: // “` // “` // //infra:nodes:list GetNodes(context.Context, *request.Nodes) (*structpb.ListValue, error) // List Run Details // // Returns a list of run metadata (id, start and end time, and status) for the provided node ID. // Supports pagination. // Accepts a `start` parameter to denote start date for the list and a filter of type `status`. // // Authorization Action: // “` // “` // //infra:nodes:list GetRuns(context.Context, *request.Runs) (*structpb.ListValue, error) // List Node Status Counts // // Returns totals for failed, success, missing, and overall total infra nodes that have reported into Automate. // Supports filtering. // // Example: // “` // cfgmgmt/stats/node_counts?filter=name:mySO*&filter=platform:ubun* // “` // // Authorization Action: // “` // “` // //infra:nodes:list GetNodesCounts(context.Context, *request.NodesCounts) (*response.NodesCounts, error) // List Run Status Totals // // Returns totals for failed and successful runs given a `node_id`. // // Example: // “` // cfgmgmt/stats/run_counts?node_id=821fff07-abc9-4160-96b1-83d68ae5cfdd&start=2019-11-02 // “` // // Authorization Action: // “` // “` // //infra:nodes:list GetRunsCounts(context.Context, *request.RunsCounts) (*response.RunsCounts, error) // List Node Checkins // // Returns a daily time series of unique node check-ins for the number of days requested. // If `days ago` value is empty, API will return the default 1 day ago results. // // Authorization Action: // “` // “` // //infra:nodes:list GetCheckInCountsTimeSeries(context.Context, *request.CheckInCountsTimeSeries) (*response.CheckInCountsTimeSeries, error) // List Missing Nodes Count // // Returns a count of missing nodes for the provided durations. // // Example: // “` // cfgmgmt/stats/missing_node_duration_counts?durations=3d&durations=1w&durations=2w&durations=1M&durations=3M // “` // // Authorization Action: // “` // “` // //infra:nodes:list GetMissingNodeDurationCounts(context.Context, *request.MissingNodeDurationCounts) (*response.MissingNodeDurationCounts, error) // Show Node Run // // Returns the infra run report for the provided node ID and run ID. // // Authorization Action: // “` // “` // //infra:nodes:get GetNodeRun(context.Context, *request.NodeRun) (*response.Run, error) // List Filter Suggestions // // Returns possible filter values given a valid `type` parameter. All values returned until two or more characters are provided for the `text` parameter. // Supports wildcard (* and ?). // // Example: // “` // cfgmgmt/suggestions?type=environment&text=_d // “` // // Authorization Action: // “` // “` // //infra:nodes:list GetSuggestions(context.Context, *query.Suggestion) (*structpb.ListValue, error) // List Organizations // // Returns a list of all organizations associated with nodes that have checked in to Automate. // // Authorization Action: // “` // “` // //infra:nodes:list GetOrganizations(context.Context, *request.Organizations) (*structpb.ListValue, error) // List Associated Chef Infra Servers // // Returns a list of all Chef Infra Servers associated with nodes that have checked in to Automate. // // Authorization Action: // “` // “` // //infra:nodes:list GetSourceFqdns(context.Context, *request.SourceFqdns) (*structpb.ListValue, error) // Show Attributes // // Returns the latest reported attributes for the provided node ID. // // Authorization Action: // “` // “` // //infra:nodes:get GetAttributes(context.Context, *request.Node) (*response.NodeAttribute, error) GetVersion(context.Context, *version.VersionInfoRequest) (*version.VersionInfo, error) // List Policy Cookbooks // // Returns Policy Names with a list of cookbook names and associated policy identifiers based on a policy revision ID. // Policy revision IDs are sent with an infra run report and identifies which instance of a policy the node used for this run. // // Authorization Action: // “` // “` // //infra:nodes:list GetPolicyCookbooks(context.Context, *request.PolicyRevision) (*response.PolicyCookbooks, error) // List Errors // // Returns a list of the most common errors reported for infra nodes' most recent Chef Infra Client runs. // // Authorization Action: // “` // “` // //infra:nodes:list GetErrors(context.Context, *request.Errors) (*response.Errors, error) NodeExport(*request.NodeExport, ConfigMgmt_NodeExportServer) error ReportExport(*request.ReportExport, ConfigMgmt_ReportExportServer) error // GetNodeMetadataCounts // // For each type of field requested this returns distinct values the amount of each. For example, // if the 'platform' field is requested 'windows' 10, 'redhat' 5, and 'ubuntu' 8 could be returned. // The number next to each represents the number of nodes with that type of platform. // // Example: // request // “` // cfgmgmt/node_metadata_counts?type=platform&type=status // “` // response // “` // { // "types": [ // { // "values": [ // { // "value": "mac_os_x 10.11.5", // "count": 28 // }, // { // "value": "linux 8.9", // "count": 1 // }, // { // "value": "macos 8.9", // "count": 1 // }, // { // "value": "windows 8.9", // "count": 1 // } // ], // "type": "platform" // }, // { // "value": [ // { // "value": "missing", // "count": 29 // }, // { // "value": "failure", // "count": 2 // } // ], // "type": "status" // } // ] // } // “` // // Authorization Action: // “` // “` // //infra:nodes:list GetNodeMetadataCounts(context.Context, *request.NodeMetadataCounts) (*response.NodeMetadataCounts, error) // GetNodeRunsDailyStatusTimeSeries // // Provides the status of runs for each 24-hour duration. For multiple runs in one 24-hour duration, // the most recent failed run will be returned. If there are no failed runs the most recent successful // run will be returned. If no runs are found in the 24-hour duration, the status will be "missing" // and no run information will be returned. // // Example: // request // “` // cfgmgmt/node_runs_daily_status_time_series?node_id=507bd518-5c18-4c2d-a445-60fe7dde9961&days_ago=3 // “` // response // “` // { // "durations": [ // { // "start": "2020-04-25T19:00:00Z", // "end": "2020-04-26T18:59:59Z", // "status": "missing", // "run_id": "" // }, // { // "start": "2020-04-26T19:00:00Z", // "end": "2020-04-27T18:59:59Z", // "status": "missing", // "run_id": "" // }, // { // "start": "2020-04-27T19:00:00Z", // "end": "2020-04-28T18:59:59Z", // "status": "failure", // "run_id": "b7904f41-68b5-44ec-9da6-cf2481ff8600" // } // ] // } // “` // // Authorization Action: // “` // “` // //infra:nodes:list GetNodeRunsDailyStatusTimeSeries(context.Context, *request.NodeRunsDailyStatusTimeSeries) (*response.NodeRunsDailyStatusTimeSeries, error) // CreateRollout // // Creates a Rollout record. A rollout represents the process of nodes acquiring // the latest policy revision pushed to a policy group. // // Authorization Action: // “` // “` // //ingest:unifiedEvents:create CreateRollout(context.Context, *request.CreateRollout) (*response.Rollout, error) // CreateRolloutTest // // CreateRolloutTest is a no-op endpoint that has the same auth requirements as // CreateRollout. It can be used to verify end-to-end config/connectivity for // clients // // Authorization Action: // “` // “` // //ingest:unifiedEvents:create CreateRolloutTest(context.Context, *request.CreateRolloutTest) (*response.CreateRolloutTest, error) // GetRollouts // // # Gives a list of rollouts // // Authorization Action: // “` // “` // //infra:nodes:list GetRollouts(context.Context, *request.Rollouts) (*response.Rollouts, error) // GetRolloutById // // # Returns the rollout with the given Id // // Authorization Action: // “` // “` // //infra:nodes:list GetRolloutById(context.Context, *request.RolloutById) (*response.Rollout, error) // GetRolloutForChefRun // // Returns the rollout for the given Chef Server/org, policy group, policy name, and policy revision // // Authorization Action: // “` // “` // //infra:nodes:list GetRolloutForChefRun(context.Context, *request.RolloutForChefRun) (*response.Rollout, error) ListNodeSegmentsWithRolloutProgress(context.Context, *request.ListNodeSegmentsWithRolloutProgress) (*response.NodeSegmentsWithRolloutProgress, error) // UpdateTelemetryReported // Acknowledge API to updates the last client run telemetry reported date in postgres // Authorization Action: // “` // “` // //iam:introspect:getAll UpdateTelemetryReported(context.Context, *request.UpdateTelemetryReportedRequest) (*response.UpdateTelemetryReportedResponse, error) // GetNodesUsageCount // // Returns the count of unique nodes with lastRun in a given time. // The time duration can be between the last time Telemetry data sent and the day before the current date. // If the duration < 15 days --> 15 days // duration > 15 days --> duration // Authorization Action: // “` // “` // //iam:introspect:getAll GetNodesUsageCount(context.Context, *request.GetNodesUsageCountRequest) (*response.GetNodesUsageCountResponse, error) }
ConfigMgmtServer is the server API for ConfigMgmt service.
type ConfigMgmt_NodeExportClient ¶
type ConfigMgmt_NodeExportClient interface { Recv() (*common.ExportData, error) grpc.ClientStream }
type ConfigMgmt_NodeExportServer ¶
type ConfigMgmt_NodeExportServer interface { Send(*common.ExportData) error grpc.ServerStream }
type ConfigMgmt_ReportExportClient ¶
type ConfigMgmt_ReportExportClient interface { Recv() (*common.ExportData, error) grpc.ClientStream }
type ConfigMgmt_ReportExportServer ¶
type ConfigMgmt_ReportExportServer interface { Send(*common.ExportData) error grpc.ServerStream }
type UnimplementedConfigMgmtServer ¶
type UnimplementedConfigMgmtServer struct { }
UnimplementedConfigMgmtServer can be embedded to have forward compatible implementations.
func (*UnimplementedConfigMgmtServer) CreateRollout ¶
func (*UnimplementedConfigMgmtServer) CreateRollout(context.Context, *request.CreateRollout) (*response.Rollout, error)
func (*UnimplementedConfigMgmtServer) CreateRolloutTest ¶
func (*UnimplementedConfigMgmtServer) CreateRolloutTest(context.Context, *request.CreateRolloutTest) (*response.CreateRolloutTest, error)
func (*UnimplementedConfigMgmtServer) GetAttributes ¶
func (*UnimplementedConfigMgmtServer) GetAttributes(context.Context, *request.Node) (*response.NodeAttribute, error)
func (*UnimplementedConfigMgmtServer) GetCheckInCountsTimeSeries ¶
func (*UnimplementedConfigMgmtServer) GetCheckInCountsTimeSeries(context.Context, *request.CheckInCountsTimeSeries) (*response.CheckInCountsTimeSeries, error)
func (*UnimplementedConfigMgmtServer) GetMissingNodeDurationCounts ¶
func (*UnimplementedConfigMgmtServer) GetMissingNodeDurationCounts(context.Context, *request.MissingNodeDurationCounts) (*response.MissingNodeDurationCounts, error)
func (*UnimplementedConfigMgmtServer) GetNodeMetadataCounts ¶
func (*UnimplementedConfigMgmtServer) GetNodeMetadataCounts(context.Context, *request.NodeMetadataCounts) (*response.NodeMetadataCounts, error)
func (*UnimplementedConfigMgmtServer) GetNodeRun ¶
func (*UnimplementedConfigMgmtServer) GetNodeRunsDailyStatusTimeSeries ¶
func (*UnimplementedConfigMgmtServer) GetNodeRunsDailyStatusTimeSeries(context.Context, *request.NodeRunsDailyStatusTimeSeries) (*response.NodeRunsDailyStatusTimeSeries, error)
func (*UnimplementedConfigMgmtServer) GetNodesCounts ¶
func (*UnimplementedConfigMgmtServer) GetNodesCounts(context.Context, *request.NodesCounts) (*response.NodesCounts, error)
func (*UnimplementedConfigMgmtServer) GetNodesUsageCount ¶
func (*UnimplementedConfigMgmtServer) GetNodesUsageCount(context.Context, *request.GetNodesUsageCountRequest) (*response.GetNodesUsageCountResponse, error)
func (*UnimplementedConfigMgmtServer) GetOrganizations ¶
func (*UnimplementedConfigMgmtServer) GetOrganizations(context.Context, *request.Organizations) (*structpb.ListValue, error)
func (*UnimplementedConfigMgmtServer) GetPolicyCookbooks ¶
func (*UnimplementedConfigMgmtServer) GetPolicyCookbooks(context.Context, *request.PolicyRevision) (*response.PolicyCookbooks, error)
func (*UnimplementedConfigMgmtServer) GetRolloutById ¶
func (*UnimplementedConfigMgmtServer) GetRolloutById(context.Context, *request.RolloutById) (*response.Rollout, error)
func (*UnimplementedConfigMgmtServer) GetRolloutForChefRun ¶
func (*UnimplementedConfigMgmtServer) GetRolloutForChefRun(context.Context, *request.RolloutForChefRun) (*response.Rollout, error)
func (*UnimplementedConfigMgmtServer) GetRollouts ¶
func (*UnimplementedConfigMgmtServer) GetRunsCounts ¶
func (*UnimplementedConfigMgmtServer) GetRunsCounts(context.Context, *request.RunsCounts) (*response.RunsCounts, error)
func (*UnimplementedConfigMgmtServer) GetSourceFqdns ¶
func (*UnimplementedConfigMgmtServer) GetSourceFqdns(context.Context, *request.SourceFqdns) (*structpb.ListValue, error)
func (*UnimplementedConfigMgmtServer) GetSuggestions ¶
func (*UnimplementedConfigMgmtServer) GetSuggestions(context.Context, *query.Suggestion) (*structpb.ListValue, error)
func (*UnimplementedConfigMgmtServer) GetVersion ¶
func (*UnimplementedConfigMgmtServer) GetVersion(context.Context, *version.VersionInfoRequest) (*version.VersionInfo, error)
func (*UnimplementedConfigMgmtServer) ListNodeSegmentsWithRolloutProgress ¶
func (*UnimplementedConfigMgmtServer) ListNodeSegmentsWithRolloutProgress(context.Context, *request.ListNodeSegmentsWithRolloutProgress) (*response.NodeSegmentsWithRolloutProgress, error)
func (*UnimplementedConfigMgmtServer) NodeExport ¶
func (*UnimplementedConfigMgmtServer) NodeExport(*request.NodeExport, ConfigMgmt_NodeExportServer) error
func (*UnimplementedConfigMgmtServer) ReportExport ¶
func (*UnimplementedConfigMgmtServer) ReportExport(*request.ReportExport, ConfigMgmt_ReportExportServer) error
func (*UnimplementedConfigMgmtServer) UpdateTelemetryReported ¶
func (*UnimplementedConfigMgmtServer) UpdateTelemetryReported(context.Context, *request.UpdateTelemetryReportedRequest) (*response.UpdateTelemetryReportedResponse, error)