images

Documentation

Overview

Package images manages application images on KraftCloud.

Index

• Constants
• type ImagesService
  • func NewImagesClientFromOptions(opts *options.Options) ImagesService
• type ListResponseItem

Constants

const Endpoint = "/images"

Endpoint is the public path for the images service.

Types

type ImagesService

type ImagesService interface {
	kcclient.ServiceClient[ImagesService]

	// Lists all existing images. You can filter by digest, tag and based on
	// whether the image is public or not. The returned groups fulfill all
	// provided filter criteria. No particular value is assumed if a filter is not
	// part of the request.
	//
	// See: https://docs.kraft.cloud/api/v1/images/#list-existing-images
	List(ctx context.Context) (*kcclient.ServiceResponse[ListResponseItem], error)

	// Delete an image by its provided name.
	DeleteByName(ctx context.Context, name string) error
}

func NewImagesClientFromOptions

func NewImagesClientFromOptions(opts *options.Options) ImagesService

NewImagesClientFromOptions instantiates a new image services client based on the provided pre-existing options.

type ListResponseItem

type ListResponseItem struct {
	Digest      string   `json:"digest"`
	Tags        []string `json:"tags"`
	Initrd      bool     `json:"initrd"`
	SizeInBytes int64    `json:"size_in_bytes"`
	Args        string   `json:"args"`
	KernelArgs  string   `json:"kernel_args"`

	kcclient.APIResponseCommon
}

ListResponseItem is a data item from a response to a /images/list request. https://docs.kraft.cloud/api/v1/images/#list-existing-images