Documentation
¶
Overview ¶
Package types contains all user-defined data types used in Insights Operator CLI client. Some types that are the same as in other services (especially in Insights Results Aggregator, Content Service) might be imported from (based on) the common package insights-operator-utils/types.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Cluster ¶
Cluster structure represents cluster record in the controller service.
ID: unique key
Name: cluster GUID in the following format:
c8590f31-e97e-4b85-b506-c45ce1911a12
type ClusterConfiguration ¶
type ClusterConfiguration struct {
ID int `json:"id"`
Cluster string `json:"cluster"`
Configuration string `json:"configuration"`
ChangedAt string `json:"changed_at"`
ChangedBy string `json:"changed_by"`
Active string `json:"active"`
Reason string `json:"reason"`
}
ClusterConfiguration structure represents cluster configuration record in the controller service.
ID: unique key Cluster: cluster ID (not name) Configuration: a JSON structure stored in a string ChangeAt: timestamp of the last configuration change ChangeBy: username of admin that created or updated the configuration Active: flag indicating whether the configuration is active or not Reason: a string with any comment(s) about the cluster configuration
type ClusterConfigurationsResponse ¶
type ClusterConfigurationsResponse struct {
Status string `json:"status"`
Configurations []ClusterConfiguration `json:"configuration"`
}
ClusterConfigurationsResponse represents response of controller service to cluster configuration request.
Status: status of response Configurations: list of configurations
type ClustersResponse ¶
ClustersResponse structure represents response of controller service to cluster request.
Status: status of response Clusters: list of clusters
type ConfigurationProfile ¶
type ConfigurationProfile struct {
ID int `json:"id"`
Configuration string `json:"configuration"`
ChangedAt string `json:"changed_at"`
ChangedBy string `json:"changed_by"`
Description string `json:"description"`
}
ConfigurationProfile structure represents configuration profile record in the controller service.
ID: unique key Configuration: a JSON structure stored in a string ChangeAt: username of admin that created or updated the configuration ChangeBy: timestamp of the last configuration change Description: a string with any comment(s) about the configuration
type ConfigurationProfileResponse ¶
type ConfigurationProfileResponse struct {
Status string `json:"status"`
Profile ConfigurationProfile `json:"profile"`
}
ConfigurationProfileResponse structure represents response of controller service to single configuration profile request.
Status: status of response Profile: single configuration profile
type ConfigurationProfilesResponse ¶
type ConfigurationProfilesResponse struct {
Status string `json:"status"`
Profiles []ConfigurationProfile `json:"profiles"`
}
ConfigurationProfilesResponse structure represents response of controller service to configuration profiles request.
Status: status of response Profiles: list of configuration profiles
type ConfigurationResponse ¶
type ConfigurationResponse struct {
Status string `json:"status"`
Configuration string `json:"configuration"`
}
ConfigurationResponse structure represents response of controller service to configuration request.
Status: status of response Configuration: JSON string of single configuration
type Response ¶
type Response struct {
Status string `json:"status"`
}
Response structure represents default response of controller service to different POST PUT requests.
Status: status of response
type Trigger ¶
type Trigger struct {
ID int `json:"id"`
Type string `json:"type"`
Cluster string `json:"cluster"`
Reason string `json:"reason"`
Link string `json:"link"`
TriggeredAt string `json:"triggered_at"`
TriggeredBy string `json:"triggered_by"`
AckedAt string `json:"acked_at"`
Parameters string `json:"parameters"`
Active int `json:"active"`
}
Trigger structure represents trigger record in the controller service
ID: unique key Type: ID of trigger type Cluster: cluster ID (not name) Reason: a string with any comment(s) about the trigger Link: link to any document with customer ACK with the trigger TriggeredAt: timestamp of the last configuration change TriggeredBy: username of admin that created or updated the trigger AckedAt: timestamp where the insights operator acked the trigger Parameters: parameters that needs to be pass to trigger code Active: flag indicating whether the trigger is still active or not
type TriggerResponse ¶
TriggerResponse structure represents response of controller service to single trigger request.
Status: status of response Trigger: single trigger
type TriggersResponse ¶
TriggersResponse structure represents response of controller service to triggers request.
Status: status of response Triggers: list of triggers
Source Files