package
0.0.0-20240910131244-13d20f98e541
Repository: https://github.com/redhatinsights/edge-api.git
Documentation: pkg.go.dev

# Packages

nolint:revive,typecheck.
FIXME: golangci-lint nolint:revive.
Package mock_files is a generated GoMock package.
Package mock_services is a generated GoMock package.
nolint:revive,typecheck.
FIXME: golangci-lint nolint:revive.

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetDiffOnUpdate returns the diff between two images.
GetImageReposFromDB return ThirdParty repo of image by OrgID.
GetStorageInstallerIsoURL return the installer application storage url.
NewCommitService gives a instance of the main implementation of CommitServiceInterface.
NewDeviceGroupsService return an instance of the main implementation of a DeviceGroupsServiceInterface.
NewDeviceService gives a instance of the main implementation of DeviceServiceInterface.
NewFilesService creates a new service to handle files.
NewImageService gives a instance of the main implementation of a ImageServiceInterface.
NewImageSetsService gives an instance of the main implementation of a ImageSetsServiceInterface.
NewKafkaConsumerService gives a instance of the Kafka implementation of ConsumerService.
NewRepoBuilder initializes the repository builder in this package.
NewRepoService gives a instance of the main implementation of RepoServiceInterface.
NewS3FilesServices return a new FilesService with s3 client.
NewService creates a new service.
NewTemplateRemoteInfo contains the info for the ostree remote file to be written to the system.
NewThirdPartyRepoService gives a instance of the main implementation of a ThirdPartyRepoServiceInterface.
NewUpdateService gives an instance of the main implementation of a UpdateServiceInterface.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RepoRevParse Handle the RevParse separate since we need the stdout parsed.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ReturnDevicesView returns the devices association and status properly.
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
InventoryEventTypeCreated represent the Created inventory event type.
InventoryEventTypeDelete represent the "delete" inventory event type.
InventoryEventTypeUpdated represent the Updated inventory event type.
InventoryHostTypeEdge represent the inventory host_ype = "edge".
No description provided by the author
No description provided by the author
NotificationConfigApplication to be used.
NotificationConfigBundle to be used.
NotificationConfigEventTypeDevice to be used.
NotificationConfigEventTypeImage to be used.
NotificationConfigUser to be used.
NotificationConfigVersion to be used.
NotificationTopic to be used.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PlaybookStatusFailure is the status when a playbook execution fails.
PlaybookStatusRunning is the status when a playbook is still running.
PlaybookStatusSuccess is the status when a playbook has run successfully.
PlaybookStatusTimeout is the status when a playbook execution times out.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

BuildCommand references the exec.Command for calls to the system.
No description provided by the author
ErrOrgIDMismatch returned when the context orgID is different from an entity OrgID.
ErrUndefinedCommit indicate that the update transaction/image or some entity has no commit defined.

# Structs

AccountNotSet indicates the account was nil.
AccountOrOrgIDNotSet indicates the account or orgID was nil.
BasicFileService is the base file service struct It serves as a base for other file services implementations.
CommitImageNotFound indicates the Commit Image is not found.
CommitNotFound indicates commit matching the given id was not found.
CommitNotValid indicates commit matching the given id was not found.
CommitService is the main implementation of a CommitServiceInterface.
No description provided by the author
DBCommitError indicates a dbError during search.
DeviceGroupAccountOrIDUndefined indicates that device group account or ID was not supplied.
DeviceGroupAccountOrNameUndefined indicates that device group account or name are undefined.
DeviceGroupAlreadyExists indicates that device group already exists.
DeviceGroupDeviceNotSupplied indicates that device group device was not supplied.
DeviceGroupDevicesNotFound indicates that devices not found in the device group collection.
DeviceGroupDevicesNotSupplied indicates that device group devices was not supplied.
DeviceGroupMandatoryFieldsUndefined indicates that device group mandatory field are undefined.
DeviceGroupNotFound indicates the Third Party Repository was not found.
DeviceGroupOrgIDDevicesNotFound indicates that devices not found among the device group OrgID.
DeviceGroupsService is the main implementation of a DeviceGroupsServiceInterface.
DeviceHasImageUndefined indicates that device record has image not defined.
DeviceHasNoImageUpdate indicates that device record no image.
DeviceNotFoundError indicates the device was not found.
DeviceService is the main implementation of a DeviceServiceInterface.
DevicesHasMoreThanOneImageSet indicates that device record no image.
EntitiesImageSetsMismatch indicates the CommitID does not belong to the same ImageSet as of Device's Image.
EventNotification is used to track events to notification.
HeaderPlayBookDispatcher is the header for Playbook Dispatcher events.
IDMustBeInteger indicates the ID is required to be an integer value.
ImageCommitNotFound occurs when the image commit cannot be found.
ImageDetail return the structure to inform package info to images nolint: unused // golangci-lint does not parse well this block, it says Image not used, but it's used.
ImageHasNoImageSet indicates that device record no image.
ImageNameAlreadyExists indicates the image with supplied name already exists.
ImageNameChangeIsProhibited indicates that the image name was about to change, but this is not allowed mainly this happens when updating an image.
ImageNameUndefined indicates the image name is not defined.
ImageNotFoundError indicates the image was not found.
ImageNotification is the implementation of expected boddy notification.
ImageNotInErrorState indicates unable to delete an image.
ImageOnlyLatestCanModify indicates only the latest image can be modified.
ImageService is the main implementation of a ImageServiceInterface.
ImageSetAlreadyExists indicates the ImageSet attempting to be created already exists.
ImageSetIDView is the image set details view returned for ui image-set display.
ImageSetImageIDView is the image set image view returned for ui image-set / version display.
ImageSetInUse indicates unable to delete an image set.
ImageSetNotFoundError indicates the image-set was not found.
ImageSetsService is the main implementation of a ImageSetsServiceInterface.
ImageSetUnDefined indicates the image has no imageSetDefined.
ImagesViewData is the images view data return for images view with filters , limit, offSet.
ImageUnDefined indicates the image is undefined in the db.
ImageVersionAlreadyExists indicates the updated image version was already present.
InvalidURLForCustomRepo indicates the Third Party Repository url is invalid.
KafkaAllBrokersDown indicates that the error has occured due to kafka broker issue.
KafkaConsumerService is the implementation of a consumer service based on Kafka topics.
KafkaProducerInstanceUndefined indicates that we were not able to get a kafka producer instance.
LocalFilesService only handles local uploads.
No description provided by the author
OrgIDNotSet indicates the account was nil.
OstreeNotFound was not found.
PackageNameDoesNotExist indicates that package name doesn't exist.
ParsingISODateError occurs when parsing a string for iso date fails.
PlatformInsightsCreateUpdateEventPayload is the body of the create event found on the platform.inventory.events kafka topic.
PlatformInsightsDeleteEventPayload is the body of the delete event found on the platform.inventory.events kafka topic.
No description provided by the author
PlaybookDispatcherEvent is the event that gets sent to the Kafka broker when an update finishes.
PlaybookDispatcherEventPayload belongs to PlaybookDispatcherEvent.
No description provided by the author
RecipientNotification is used to track recipients to notification.
RepoBuilder is the implementation of a RepoBuilderInterface.
RepoService is the main implementation of a RepoServiceInterface.
No description provided by the author
No description provided by the author
RpmOSTreeDeployment is the member of PlatformInsightsCreateUpdateEventPayload host system profile rpm ostree deployments list.
S3FilesService contains S3 files-related information.
Service is a blueprint for a service.
SomeDevicesDoesNotExists indicates that device record no image.
No description provided by the author
TemplateRemoteInfo the values to playbook.
ThirdPartyRepoService is the main implementation of a ThirdPartyRepoServiceInterface.
ThirdPartyRepositoryAlreadyExists indicates the Third Party Repository already exists.
ThirdPartyRepositoryImagesExists indicates the Third Party Repository has been used in some images.
ThirdPartyRepositoryInfoIsInvalid indicates the Third Party Repository info is not valid.
ThirdPartyRepositoryNameIsEmpty indicates the Third Party Repository name is empty.
ThirdPartyRepositoryNotFound indicates the Third Party Repository was not found.
ThirdPartyRepositoryURLIsEmpty indicates the Third Party Repository url is empty.
ThirdPartyRepositoryWithURLAlreadyExists indicates the Third Party Repository already exists with the requested url.
UnameSSH is the template struct for username and ssh key.
UpdateNotFoundError indicates the update was not found.
UpdateService is the main implementation of a UpdateServiceInterface.

# Interfaces

CommitServiceInterface defines the interface to handle the business logic of RHEL for Edge Commits.
ConsumerService is the interface that takes care of our consumer implementation.
DeviceGroupsServiceInterface defines the interface that helps handle the business logic of creating and getting device groups.
DeviceServiceInterface defines the interface to handle the business logic of RHEL for Edge Devices.
FilesService is the interface for Files-related service information.
ImageServiceInterface defines the interface that helps handle the business logic of creating RHEL For Edge Images.
ImageSetsServiceInterface defines the interface that helps handle the business logic of ImageSets.
RepoBuilderInterface defines the interface of a repository builder.
RepoServiceInterface defines the interface to handle the business logic of RHEL for Edge Devices.
ServiceInterface defines the interface for a service.
ThirdPartyRepoServiceInterface defines the interface that helps handles the business logic of creating Third Party Repository.
UpdateServiceInterface defines the interface that helps handle the business logic of sending updates to an edge device.

# Type aliases

TypeEnum define type for groups.