github.com/alibaba/sealer@v0.8.6-0.20220430115802-37a2bdaa8173/pkg/image/image_interface.go (about)

     1  // Copyright © 2021 Alibaba Group Holding Ltd.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package image
    16  
    17  import (
    18  	"github.com/alibaba/sealer/pkg/image/store"
    19  	v1 "github.com/alibaba/sealer/types/api/v1"
    20  )
    21  
    22  // MetadataService is the interface for providing image metadata service
    23  type MetadataService interface {
    24  	Tag(imageName, tarImageName string) error
    25  	List() (store.ImageMetadataMap, error)
    26  	GetImage(imageName string, platform *v1.Platform) (*v1.Image, error)
    27  	GetRemoteImage(imageName string, platform *v1.Platform) (v1.Image, error)
    28  	DeleteImage(imageName string, platform *v1.Platform) error
    29  }
    30  
    31  // FileService is the interface for file operations
    32  type FileService interface {
    33  	Load(imageSrc string) error
    34  	Save(imageName, imageTar string, platforms []*v1.Platform) error
    35  	Merge(image *v1.Image) error
    36  }
    37  
    38  // Service is image service
    39  type Service interface {
    40  	Pull(imageName string, platform []*v1.Platform) error
    41  	PullIfNotExist(imageName string, platform []*v1.Platform) error
    42  	Push(imageName string) error
    43  	Delete(imageName string, platforms []*v1.Platform) error
    44  	Login(RegistryURL, RegistryUsername, RegistryPasswd string) error
    45  	CacheBuilder
    46  }
    47  
    48  type LayerService interface {
    49  	LayerStore() store.LayerStore
    50  }