objectstore-api: kmodules.xyz/objectstore-api/api/v1 Index | Files

package v1

import "kmodules.xyz/objectstore-api/api/v1"

+k8s:deepcopy-gen=package +k8s:openapi-gen=true

Index

Package Files

doc.go helpers.go openapi_generated.go types.go zz_generated.deepcopy.go

Constants

const (
    ProviderLocal = "local"
    ProviderS3    = "s3"
    ProviderGCS   = "gcs"
    ProviderAzure = "azure"
    ProviderSwift = "swift"
    ProviderB2    = "b2"
    ProviderRest  = "rest"
)
const (
    AWS_ACCESS_KEY_ID     = "AWS_ACCESS_KEY_ID"
    AWS_SECRET_ACCESS_KEY = "AWS_SECRET_ACCESS_KEY"
    CA_CERT_DATA          = "CA_CERT_DATA"

    GOOGLE_PROJECT_ID               = "GOOGLE_PROJECT_ID"
    GOOGLE_SERVICE_ACCOUNT_JSON_KEY = "GOOGLE_SERVICE_ACCOUNT_JSON_KEY"

    AZURE_ACCOUNT_NAME = "AZURE_ACCOUNT_NAME"
    AZURE_ACCOUNT_KEY  = "AZURE_ACCOUNT_KEY"

    // swift
    OS_USERNAME    = "OS_USERNAME"
    OS_PASSWORD    = "OS_PASSWORD"
    OS_REGION_NAME = "OS_REGION_NAME"
    OS_AUTH_URL    = "OS_AUTH_URL"

    // v3 specific
    OS_USER_DOMAIN_NAME    = "OS_USER_DOMAIN_NAME"
    OS_PROJECT_NAME        = "OS_PROJECT_NAME"
    OS_PROJECT_DOMAIN_NAME = "OS_PROJECT_DOMAIN_NAME"

    // v2 specific
    OS_TENANT_ID   = "OS_TENANT_ID"
    OS_TENANT_NAME = "OS_TENANT_NAME"

    // v1 specific
    ST_AUTH = "ST_AUTH"
    ST_USER = "ST_USER"
    ST_KEY  = "ST_KEY"

    // Manual authentication
    OS_STORAGE_URL = "OS_STORAGE_URL"
    OS_AUTH_TOKEN  = "OS_AUTH_TOKEN"
)

func GetOpenAPIDefinitions Uses

func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition

type AzureSpec Uses

type AzureSpec struct {
    Container      string `json:"container,omitempty"`
    Prefix         string `json:"prefix,omitempty"`
    MaxConnections int    `json:"maxConnections,omitempty"`
}

func (*AzureSpec) DeepCopy Uses

func (in *AzureSpec) DeepCopy() *AzureSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureSpec.

func (*AzureSpec) DeepCopyInto Uses

func (in *AzureSpec) DeepCopyInto(out *AzureSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type B2Spec Uses

type B2Spec struct {
    Bucket         string `json:"bucket,omitempty"`
    Prefix         string `json:"prefix,omitempty"`
    MaxConnections int    `json:"maxConnections,omitempty"`
}

func (*B2Spec) DeepCopy Uses

func (in *B2Spec) DeepCopy() *B2Spec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new B2Spec.

func (*B2Spec) DeepCopyInto Uses

func (in *B2Spec) DeepCopyInto(out *B2Spec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Backend Uses

type Backend struct {
    StorageSecretName string `json:"storageSecretName,omitempty"`

    Local *LocalSpec      `json:"local,omitempty"`
    S3    *S3Spec         `json:"s3,omitempty"`
    GCS   *GCSSpec        `json:"gcs,omitempty"`
    Azure *AzureSpec      `json:"azure,omitempty"`
    Swift *SwiftSpec      `json:"swift,omitempty"`
    B2    *B2Spec         `json:"b2,omitempty"`
    Rest  *RestServerSpec `json:"rest,omitempty"`
}

func (Backend) Container Uses

func (backend Backend) Container() (string, error)

Container returns name of the bucket

func (*Backend) DeepCopy Uses

func (in *Backend) DeepCopy() *Backend

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Backend.

func (*Backend) DeepCopyInto Uses

func (in *Backend) DeepCopyInto(out *Backend)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (Backend) Endpoint Uses

func (backend Backend) Endpoint() (string, bool)

Endpoint returns endpoint of Restic rest server and S3/S3 compatible backend

func (Backend) Location Uses

func (backend Backend) Location() (string, error)

Location returns the location of backend (<provider>:<bucket name>)

func (Backend) MaxConnections Uses

func (backend Backend) MaxConnections() int

MaxConnections returns maximum parallel connection to use to connect with the backend returns 0 if not specified

func (Backend) Prefix Uses

func (backend Backend) Prefix() (string, error)

Prefix returns the prefix used in the backend

func (Backend) Provider Uses

func (backend Backend) Provider() (string, error)

Provider returns the provider of the backend

type GCSSpec Uses

type GCSSpec struct {
    Bucket         string `json:"bucket,omitempty"`
    Prefix         string `json:"prefix,omitempty"`
    MaxConnections int    `json:"maxConnections,omitempty"`
}

func (*GCSSpec) DeepCopy Uses

func (in *GCSSpec) DeepCopy() *GCSSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GCSSpec.

func (*GCSSpec) DeepCopyInto Uses

func (in *GCSSpec) DeepCopyInto(out *GCSSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type LocalSpec Uses

type LocalSpec struct {
    core.VolumeSource `json:",inline"`
    MountPath         string `json:"mountPath,omitempty"`
    SubPath           string `json:"subPath,omitempty"`
}

func (*LocalSpec) DeepCopy Uses

func (in *LocalSpec) DeepCopy() *LocalSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LocalSpec.

func (*LocalSpec) DeepCopyInto Uses

func (in *LocalSpec) DeepCopyInto(out *LocalSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (LocalSpec) ToVolumeAndMount Uses

func (l LocalSpec) ToVolumeAndMount(volName string) (core.Volume, core.VolumeMount)

ToVolumeAndMount returns volumes and mounts for local backend

type RestServerSpec Uses

type RestServerSpec struct {
    URL string `json:"url,omitempty"`
}

func (*RestServerSpec) DeepCopy Uses

func (in *RestServerSpec) DeepCopy() *RestServerSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RestServerSpec.

func (*RestServerSpec) DeepCopyInto Uses

func (in *RestServerSpec) DeepCopyInto(out *RestServerSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type S3Spec Uses

type S3Spec struct {
    Endpoint string `json:"endpoint,omitempty"`
    Bucket   string `json:"bucket,omitempty"`
    Prefix   string `json:"prefix,omitempty"`
}

func (*S3Spec) DeepCopy Uses

func (in *S3Spec) DeepCopy() *S3Spec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new S3Spec.

func (*S3Spec) DeepCopyInto Uses

func (in *S3Spec) DeepCopyInto(out *S3Spec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SwiftSpec Uses

type SwiftSpec struct {
    Container string `json:"container,omitempty"`
    Prefix    string `json:"prefix,omitempty"`
}

func (*SwiftSpec) DeepCopy Uses

func (in *SwiftSpec) DeepCopy() *SwiftSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SwiftSpec.

func (*SwiftSpec) DeepCopyInto Uses

func (in *SwiftSpec) DeepCopyInto(out *SwiftSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Package v1 imports 5 packages (graph) and is imported by 30 packages. Updated 2019-09-12. Refresh now. Tools for package owners.