Documentation
¶
Index ¶
- Variables
- type AppToContainerService
- type DockerHubService
- type EndpointService
- func (service *EndpointService) CreateEndpoint(endpoint *dockm.Endpoint) error
- func (service *EndpointService) DeleteEndpoint(ID dockm.EndpointID) error
- func (service *EndpointService) Endpoint(ID dockm.EndpointID) (*dockm.Endpoint, error)
- func (service *EndpointService) Endpoints() ([]dockm.Endpoint, error)
- func (service *EndpointService) Synchronize(toCreate, toUpdate, toDelete []*dockm.Endpoint) error
- func (service *EndpointService) UpdateEndpoint(ID dockm.EndpointID, endpoint *dockm.Endpoint) error
- type Migrator
- type RegistryService
- func (service *RegistryService) CreateRegistry(registry *dockm.Registry) error
- func (service *RegistryService) DeleteRegistry(ID dockm.RegistryID) error
- func (service *RegistryService) Registries() ([]dockm.Registry, error)
- func (service *RegistryService) Registry(ID dockm.RegistryID) (*dockm.Registry, error)
- func (service *RegistryService) UpdateRegistry(ID dockm.RegistryID, registry *dockm.Registry) error
- type ResourceControlService
- func (service *ResourceControlService) CreateResourceControl(resourceControl *dockm.ResourceControl) error
- func (service *ResourceControlService) DeleteResourceControl(ID dockm.ResourceControlID) error
- func (service *ResourceControlService) ResourceControl(ID dockm.ResourceControlID) (*dockm.ResourceControl, error)
- func (service *ResourceControlService) ResourceControlByResourceID(resourceID string) (*dockm.ResourceControl, error)
- func (service *ResourceControlService) ResourceControls() ([]dockm.ResourceControl, error)
- func (service *ResourceControlService) UpdateResourceControl(ID dockm.ResourceControlID, resourceControl *dockm.ResourceControl) error
- type SettingsService
- type StackService
- func (service *StackService) CreateStack(stack *dockm.Stack) error
- func (service *StackService) DeleteStack(ID dockm.StackID) error
- func (service *StackService) Stack(ID dockm.StackID) (*dockm.Stack, error)
- func (service *StackService) Stacks() ([]dockm.Stack, error)
- func (service *StackService) StacksByEndpointID(id dockm.EndpointID) ([]dockm.Stack, error)
- func (service *StackService) UpdateStack(ID dockm.StackID, stack *dockm.Stack) error
- type Store
- type TeamMembershipService
- func (service *TeamMembershipService) CreateTeamMembership(membership *dockm.TeamMembership) error
- func (service *TeamMembershipService) DeleteTeamMembership(ID dockm.TeamMembershipID) error
- func (service *TeamMembershipService) DeleteTeamMembershipByTeamID(teamID dockm.TeamID) error
- func (service *TeamMembershipService) DeleteTeamMembershipByUserID(userID dockm.UserID) error
- func (service *TeamMembershipService) TeamMembership(ID dockm.TeamMembershipID) (*dockm.TeamMembership, error)
- func (service *TeamMembershipService) TeamMemberships() ([]dockm.TeamMembership, error)
- func (service *TeamMembershipService) TeamMembershipsByTeamID(teamID dockm.TeamID) ([]dockm.TeamMembership, error)
- func (service *TeamMembershipService) TeamMembershipsByUserID(userID dockm.UserID) ([]dockm.TeamMembership, error)
- func (service *TeamMembershipService) UpdateTeamMembership(ID dockm.TeamMembershipID, membership *dockm.TeamMembership) error
- type TeamService
- func (service *TeamService) CreateTeam(team *dockm.Team) error
- func (service *TeamService) DeleteTeam(ID dockm.TeamID) error
- func (service *TeamService) Team(ID dockm.TeamID) (*dockm.Team, error)
- func (service *TeamService) TeamByName(name string) (*dockm.Team, error)
- func (service *TeamService) Teams() ([]dockm.Team, error)
- func (service *TeamService) UpdateTeam(ID dockm.TeamID, team *dockm.Team) error
- type UserService
- func (service *UserService) CreateUser(user *dockm.User) error
- func (service *UserService) DeleteUser(ID dockm.UserID) error
- func (service *UserService) UpdateUser(ID dockm.UserID, user *dockm.User) error
- func (service *UserService) User(ID dockm.UserID) (*dockm.User, error)
- func (service *UserService) UserByUsername(username string) (*dockm.User, error)
- func (service *UserService) Users() ([]dockm.User, error)
- func (service *UserService) UsersByRole(role dockm.UserRole) ([]dockm.User, error)
- type VersionService
Constants ¶
This section is empty.
Variables ¶
var Output string
Functions ¶
This section is empty.
Types ¶
type AppToContainerService ¶
type AppToContainerService struct {
// contains filtered or unexported fields
}
func (*AppToContainerService) BuildAppToContainer ¶
func (service *AppToContainerService) BuildAppToContainer(atoc *dockm.AToC, endpoint *dockm.Endpoint) (error, string)
type DockerHubService ¶
type DockerHubService struct {
// contains filtered or unexported fields
}
DockerHubService represents a service for managing registries.
func (*DockerHubService) DockerHub ¶
func (service *DockerHubService) DockerHub() (*dockm.DockerHub, error)
DockerHub returns the DockerHub object.
func (*DockerHubService) StoreDockerHub ¶
func (service *DockerHubService) StoreDockerHub(dockerhub *dockm.DockerHub) error
StoreDockerHub persists a DockerHub object.
type EndpointService ¶
type EndpointService struct {
// contains filtered or unexported fields
}
EndpointService represents a service for managing endpoints.
func (*EndpointService) CreateEndpoint ¶
func (service *EndpointService) CreateEndpoint(endpoint *dockm.Endpoint) error
CreateEndpoint assign an ID to a new endpoint and saves it.
func (*EndpointService) DeleteEndpoint ¶
func (service *EndpointService) DeleteEndpoint(ID dockm.EndpointID) error
DeleteEndpoint deletes an endpoint.
func (*EndpointService) Endpoint ¶
func (service *EndpointService) Endpoint(ID dockm.EndpointID) (*dockm.Endpoint, error)
Endpoint returns an endpoint by ID.
func (*EndpointService) Endpoints ¶
func (service *EndpointService) Endpoints() ([]dockm.Endpoint, error)
Endpoints return an array containing all the endpoints.
func (*EndpointService) Synchronize ¶
func (service *EndpointService) Synchronize(toCreate, toUpdate, toDelete []*dockm.Endpoint) error
Synchronize creates, updates and deletes endpoints inside a single transaction.
func (*EndpointService) UpdateEndpoint ¶
func (service *EndpointService) UpdateEndpoint(ID dockm.EndpointID, endpoint *dockm.Endpoint) error
UpdateEndpoint updates an endpoint.
type Migrator ¶
type Migrator struct {
UserService *UserService
EndpointService *EndpointService
ResourceControlService *ResourceControlService
SettingsService *SettingsService
VersionService *VersionService
CurrentDBVersion int
// contains filtered or unexported fields
}
Migrator defines a service to migrate data after a DockM version update.
func NewMigrator ¶
NewMigrator creates a new Migrator.
type RegistryService ¶
type RegistryService struct {
// contains filtered or unexported fields
}
RegistryService represents a service for managing registries.
func (*RegistryService) CreateRegistry ¶
func (service *RegistryService) CreateRegistry(registry *dockm.Registry) error
CreateRegistry creates a new registry.
func (*RegistryService) DeleteRegistry ¶
func (service *RegistryService) DeleteRegistry(ID dockm.RegistryID) error
DeleteRegistry deletes an registry.
func (*RegistryService) Registries ¶
func (service *RegistryService) Registries() ([]dockm.Registry, error)
Registries returns an array containing all the registries.
func (*RegistryService) Registry ¶
func (service *RegistryService) Registry(ID dockm.RegistryID) (*dockm.Registry, error)
Registry returns an registry by ID.
func (*RegistryService) UpdateRegistry ¶
func (service *RegistryService) UpdateRegistry(ID dockm.RegistryID, registry *dockm.Registry) error
UpdateRegistry updates an registry.
type ResourceControlService ¶
type ResourceControlService struct {
// contains filtered or unexported fields
}
ResourceControlService represents a service for managing resource controls.
func (*ResourceControlService) CreateResourceControl ¶
func (service *ResourceControlService) CreateResourceControl(resourceControl *dockm.ResourceControl) error
CreateResourceControl creates a new ResourceControl object
func (*ResourceControlService) DeleteResourceControl ¶
func (service *ResourceControlService) DeleteResourceControl(ID dockm.ResourceControlID) error
DeleteResourceControl deletes a ResourceControl object by ID
func (*ResourceControlService) ResourceControl ¶
func (service *ResourceControlService) ResourceControl(ID dockm.ResourceControlID) (*dockm.ResourceControl, error)
ResourceControl returns a ResourceControl object by ID
func (*ResourceControlService) ResourceControlByResourceID ¶
func (service *ResourceControlService) ResourceControlByResourceID(resourceID string) (*dockm.ResourceControl, error)
ResourceControlByResourceID returns a ResourceControl object by checking if the resourceID is equal to the main ResourceID or in SubResourceIDs
func (*ResourceControlService) ResourceControls ¶
func (service *ResourceControlService) ResourceControls() ([]dockm.ResourceControl, error)
ResourceControls returns all the ResourceControl objects
func (*ResourceControlService) UpdateResourceControl ¶
func (service *ResourceControlService) UpdateResourceControl(ID dockm.ResourceControlID, resourceControl *dockm.ResourceControl) error
UpdateResourceControl saves a ResourceControl object.
type SettingsService ¶
type SettingsService struct {
// contains filtered or unexported fields
}
SettingsService represents a service to manage application settings.
func (*SettingsService) Settings ¶
func (service *SettingsService) Settings() (*dockm.Settings, error)
Settings retrieve the settings object.
func (*SettingsService) StoreSettings ¶
func (service *SettingsService) StoreSettings(settings *dockm.Settings) error
StoreSettings persists a Settings object.
type StackService ¶
type StackService struct {
// contains filtered or unexported fields
}
StackService represents a service for managing stacks.
func (*StackService) CreateStack ¶
func (service *StackService) CreateStack(stack *dockm.Stack) error
CreateStack creates a new stack.
func (*StackService) DeleteStack ¶
func (service *StackService) DeleteStack(ID dockm.StackID) error
DeleteStack deletes an stack.
func (*StackService) Stack ¶
func (service *StackService) Stack(ID dockm.StackID) (*dockm.Stack, error)
Stack returns a stack object by ID.
func (*StackService) Stacks ¶
func (service *StackService) Stacks() ([]dockm.Stack, error)
Stacks returns an array containing all the stacks.
func (*StackService) StacksByEndpointID ¶
func (service *StackService) StacksByEndpointID(id dockm.EndpointID) ([]dockm.Stack, error)
StacksByEndpointID return an array containing all the stacks related to the specified endpoint ID.
func (*StackService) UpdateStack ¶
func (service *StackService) UpdateStack(ID dockm.StackID, stack *dockm.Stack) error
UpdateStack updates an stack.
type Store ¶
type Store struct {
// Path where is stored the BoltDB database.
Path string
// Services
UserService *UserService
TeamService *TeamService
TeamMembershipService *TeamMembershipService
EndpointService *EndpointService
AppToContainerService *AppToContainerService //click2cloud-apptocontainer
ResourceControlService *ResourceControlService
VersionService *VersionService
SettingsService *SettingsService
RegistryService *RegistryService
DockerHubService *DockerHubService
StackService *StackService
// contains filtered or unexported fields
}
Store defines the implementation of dockm.DataStore using BoltDB as the storage system.
func (*Store) MigrateData ¶
MigrateData automatically migrate the data based on the DBVersion.
type TeamMembershipService ¶
type TeamMembershipService struct {
// contains filtered or unexported fields
}
TeamMembershipService represents a service for managing TeamMembership objects.
func (*TeamMembershipService) CreateTeamMembership ¶
func (service *TeamMembershipService) CreateTeamMembership(membership *dockm.TeamMembership) error
CreateTeamMembership creates a new TeamMembership object.
func (*TeamMembershipService) DeleteTeamMembership ¶
func (service *TeamMembershipService) DeleteTeamMembership(ID dockm.TeamMembershipID) error
DeleteTeamMembership deletes a TeamMembership object.
func (*TeamMembershipService) DeleteTeamMembershipByTeamID ¶
func (service *TeamMembershipService) DeleteTeamMembershipByTeamID(teamID dockm.TeamID) error
DeleteTeamMembershipByTeamID deletes all the TeamMembership object associated to a TeamID.
func (*TeamMembershipService) DeleteTeamMembershipByUserID ¶
func (service *TeamMembershipService) DeleteTeamMembershipByUserID(userID dockm.UserID) error
DeleteTeamMembershipByUserID deletes all the TeamMembership object associated to a UserID.
func (*TeamMembershipService) TeamMembership ¶
func (service *TeamMembershipService) TeamMembership(ID dockm.TeamMembershipID) (*dockm.TeamMembership, error)
TeamMembership returns a TeamMembership object by ID
func (*TeamMembershipService) TeamMemberships ¶
func (service *TeamMembershipService) TeamMemberships() ([]dockm.TeamMembership, error)
TeamMemberships return an array containing all the TeamMembership objects.
func (*TeamMembershipService) TeamMembershipsByTeamID ¶
func (service *TeamMembershipService) TeamMembershipsByTeamID(teamID dockm.TeamID) ([]dockm.TeamMembership, error)
TeamMembershipsByTeamID return an array containing all the TeamMembership objects where the specified teamID is present.
func (*TeamMembershipService) TeamMembershipsByUserID ¶
func (service *TeamMembershipService) TeamMembershipsByUserID(userID dockm.UserID) ([]dockm.TeamMembership, error)
TeamMembershipsByUserID return an array containing all the TeamMembership objects where the specified userID is present.
func (*TeamMembershipService) UpdateTeamMembership ¶
func (service *TeamMembershipService) UpdateTeamMembership(ID dockm.TeamMembershipID, membership *dockm.TeamMembership) error
UpdateTeamMembership saves a TeamMembership object.
type TeamService ¶
type TeamService struct {
// contains filtered or unexported fields
}
TeamService represents a service for managing teams.
func (*TeamService) CreateTeam ¶
func (service *TeamService) CreateTeam(team *dockm.Team) error
CreateTeam creates a new Team.
func (*TeamService) DeleteTeam ¶
func (service *TeamService) DeleteTeam(ID dockm.TeamID) error
DeleteTeam deletes a Team.
func (*TeamService) Team ¶
func (service *TeamService) Team(ID dockm.TeamID) (*dockm.Team, error)
Team returns a Team by ID
func (*TeamService) TeamByName ¶
func (service *TeamService) TeamByName(name string) (*dockm.Team, error)
TeamByName returns a team by name.
func (*TeamService) Teams ¶
func (service *TeamService) Teams() ([]dockm.Team, error)
Teams return an array containing all the teams.
func (*TeamService) UpdateTeam ¶
func (service *TeamService) UpdateTeam(ID dockm.TeamID, team *dockm.Team) error
UpdateTeam saves a Team.
type UserService ¶
type UserService struct {
// contains filtered or unexported fields
}
UserService represents a service for managing users.
func (*UserService) CreateUser ¶
func (service *UserService) CreateUser(user *dockm.User) error
CreateUser creates a new user.
func (*UserService) DeleteUser ¶
func (service *UserService) DeleteUser(ID dockm.UserID) error
DeleteUser deletes a user.
func (*UserService) UpdateUser ¶
func (service *UserService) UpdateUser(ID dockm.UserID, user *dockm.User) error
UpdateUser saves a user.
func (*UserService) User ¶
func (service *UserService) User(ID dockm.UserID) (*dockm.User, error)
User returns a user by ID
func (*UserService) UserByUsername ¶
func (service *UserService) UserByUsername(username string) (*dockm.User, error)
UserByUsername returns a user by username.
func (*UserService) Users ¶
func (service *UserService) Users() ([]dockm.User, error)
Users return an array containing all the users.
func (*UserService) UsersByRole ¶
func (service *UserService) UsersByRole(role dockm.UserRole) ([]dockm.User, error)
UsersByRole return an array containing all the users with the specified role.
type VersionService ¶
type VersionService struct {
// contains filtered or unexported fields
}
VersionService represents a service to manage stored versions.
func (*VersionService) DBVersion ¶
func (service *VersionService) DBVersion() (int, error)
DBVersion retrieves the stored database version.
func (*VersionService) StoreDBVersion ¶
func (service *VersionService) StoreDBVersion(version int) error
StoreDBVersion store the database version.
Source Files
¶
- apptocontainer_service.go
- datastore.go
- dockerhub_service.go
- endpoint_service.go
- migrate_dbversion0.go
- migrate_dbversion1.go
- migrate_dbversion2.go
- migrator.go
- registry_service.go
- resource_control_service.go
- settings_service.go
- stack_service.go
- team_membership_service.go
- team_service.go
- user_service.go
- version_service.go