github.com/sealerio/sealer@v0.11.1-0.20240507115618-f4f89c5853ae/pkg/imagedistributor/interface.go (about)

     1  // Copyright © 2022 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 imagedistributor
    16  
    17  import (
    18  	"net"
    19  
    20  	v1 "github.com/sealerio/sealer/types/api/v1"
    21  )
    22  
    23  type Distributor interface {
    24  	// Distribute each files under mounted cluster image directory to target hosts.
    25  	Distribute(hosts []net.IP, dest string) error
    26  	// DistributeRegistry each files under registry directory to target hosts.
    27  	DistributeRegistry(deployHosts []net.IP, dataDir string) error
    28  	// Restore will do some clean works via infra driver, like delete rootfs.
    29  	Restore(targetDir string, hosts []net.IP) error
    30  }
    31  
    32  type Mounter interface {
    33  	//Mount sealer image with specified platform, return mount Dir,container ID,image ID and err.
    34  	Mount(imageName string, platform v1.Platform, dest string) (string, string, string, error)
    35  
    36  	//Umount :delete all mounted directory and remove related working container.
    37  	Umount(dir, containerID string) error
    38  }