interface.go

Documentation: github.com/redhat-developer/odo/pkg/podman

     1  package podman
     2  
     3  import (
     4  	"context"
     5  
     6  	corev1 "k8s.io/api/core/v1"
     7  
     8  	"github.com/redhat-developer/odo/pkg/api"
     9  	"github.com/redhat-developer/odo/pkg/platform"
    10  )
    11  
    12  type Client interface {
    13  	platform.Client
    14  
    15  	// PlayKube creates the Pod with Podman
    16  	PlayKube(pod *corev1.Pod) error
    17  
    18  	// KubeGenerate returns a Kubernetes Pod definition of an existing Pod
    19  	KubeGenerate(name string) (*corev1.Pod, error)
    20  
    21  	// PodStop stops the pod with given podname
    22  	PodStop(podname string) error
    23  
    24  	// PodRm deletes the pod with given podname
    25  	PodRm(podname string) error
    26  
    27  	// PodLs lists the names of existing pods
    28  	PodLs() (map[string]bool, error)
    29  
    30  	// VolumeLs lists the names of existing volumes
    31  	VolumeLs() (map[string]bool, error)
    32  
    33  	// VolumeRm deletes the volume with given volumeName
    34  	VolumeRm(volumeName string) error
    35  
    36  	// CleanupPodResources stops and removes a pod and its associated resources (volumes)
    37  	CleanupPodResources(pod *corev1.Pod, cleanVolumes bool) error
    38  
    39  	ListAllComponents() ([]api.ComponentAbstract, error)
    40  
    41  	Version(ctx context.Context) (SystemVersionReport, error)
    42  
    43  	// GetCapabilities returns the capabilities of the underlying system
    44  	GetCapabilities() (Capabilities, error)
    45  }
    46
View as plain text