options

Documentation

Index

• Constants
• Variables
• func COSIDriverName() string
• func Cmd() *cobra.Command
• func ObjectBucketProvisionerName() string
• func RunOptions(cmd *cobra.Command, args []string)
• func SubDomainNS() string
• func WatchNamespace() string

Constants

const (
	// ContainerImageOrg is the org of the default image url
	ContainerImageOrg = "noobaa"
	// ContainerImageRepo is the repo of the default image url
	ContainerImageRepo = "noobaa-core"
	// ContainerImageTag is the tag of the default image url
	ContainerImageTag = "master-20240520"
	// ContainerImageSemverLowerBound is the lower bound for supported image versions
	ContainerImageSemverLowerBound = "5.0.0"
	// ContainerImageSemverUpperBound is the upper bound for supported image versions
	ContainerImageSemverUpperBound = "6.0.0"
	// ContainerImageName is the default image name without the tag/version
	ContainerImageName = ContainerImageOrg + "/" + ContainerImageRepo
	// ContainerImage is the full default image url
	ContainerImage = ContainerImageName + ":" + ContainerImageTag

	// AdminAccountEmail is the default email used by the admin account
	AdminAccountEmail = "admin@noobaa.io"

	// OperatorAccountEmail is the default email used by the operator account
	OperatorAccountEmail = "operator@noobaa.io"

	// SystemName is a constant as we want just a single system per namespace
	SystemName = "noobaa"

	// ServiceServingCertCAFile points to OCP root CA to be added to the default root CA list
	ServiceServingCertCAFile = "/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt"
)

Variables

var AWSSTSARN = ""

AWSSTSARN is used in an AWS STS cluster to assume role ARN it can be overridden for testing.

var AdmissionWebhook = false

AdmissionWebhook is used for deploying the system with admission validation webhook

var AutoscalerType = ""

AutoscalerType is the default noobaa-endpoint autoscaler type it can be overridden for testing or different types. there is no default autoscaler for endpoint

var CosiDriverPath = "/var/lib/cosi/cosi.sock"

CosiDriverPath is the cosi socket fs path

var CosiSideCarImage = "gcr.io/k8s-staging-sig-storage/objectstorage-sidecar/objectstorage-sidecar:v20221117-v0.1.0-22-g0e67387"

CosiSideCarImage is the container image url built from https://github.com/kubernetes-sigs/container-object-storage-interface-provisioner-sidecar

var DBImage = "quay.io/sclorg/postgresql-15-c9s"

DBImage is the default db image url it can be overridden for testing or different registry locations.

var DBStorageClass = ""

DBStorageClass is used for PVC's allocation for the noobaa server data it can be overridden for testing or different PV providers.

var DBType = "postgres"

DBType is the default db image type it can be overridden for testing or different types.

var DBVolumeSizeGB = 0

DBVolumeSizeGB can be used to override the default database volume size

var DebugLevel = "default_level"

DebugLevel can be used to override the default debug level

var DevEnv = false

DevEnv setting this option indicates to the operator that it is deployed on development environment This info is used by the operator for environment based decisions (e.g. number of resources to request per pod)

var DisableLoadBalancerService = false

DisableLoadBalancerService is used for setting the service type to ClusterIP instead of LoadBalancer

var FlagSet = pflag.NewFlagSet("noobaa", pflag.ContinueOnError)

FlagSet defines the

var ImagePullSecret = ""

ImagePullSecret is optionally used to authenticate when pulling the container images which is needed when using a private container registry.

var ManualDefaultBackingStore = false

ManualDefaultBackingStore is used for disabling and allow deletion of default backingstore

var MiniEnv = false

MiniEnv setting this option indicates to the operator that it is deployed on low resource environment This info is used by the operator for environment based decisions (e.g. number of resources to request per pod)

var Namespace = "noobaa"

Namespace is the target namespace for locating the noobaa system default is "noobaa" but in shared clusters (mainly for developers?) this can be very confusing and cause unintentional overrides so we may consider to use current namespace.

var NooBaaImage = ContainerImage

NooBaaImage is the container image url built from https://github.com/noobaa/noobaa-core it can be overridden for testing or different registry locations.

var OperatorImage = "noobaa/noobaa-operator:" + version.Version

OperatorImage is the container image url built from https://github.com/noobaa/noobaa-operator it can be overridden for testing or different registry locations.

var PVPoolDefaultStorageClass = ""

PVPoolDefaultStorageClass is used for PVC's allocation for the noobaa server data it can be overridden for testing or different PV providers.

var PostgresDbURL = ""

PostgresDbURL is used for providing postgres url it can be overridden for testing or different url.

var PostgresSSLCert = ""

PostgresSSLCert is used for providing the path to the client SSL cert file when working with external pgsql

var PostgresSSLKey = ""

PostgresSSLKey is used for providing the path to the client SSL key file when working with external pgsql

var PostgresSSLRequired = false

PostgresSSLRequired is used to force noobaa to work with SSL with external pgsql when using an external postgres DB.

var PostgresSSLSelfSigned = false

PostgresSSLSelfSigned is used to allow noobaa to work with self-signed SSL with external pgsql when using an external postgres DB.

var PrometheusNamespace = ""

PrometheusNamespace is prometheus installed namespace it can be overridden for testing or different namespace.

var Psql12Image = "centos/postgresql-12-centos7"

Psql12Image is the default postgres12 db image url currently it can not be overridden.

var S3LoadBalancerSourceSubnets = []string{}

S3LoadBalancerSourceSubnets is used for setting the source subnets for the load balancer created for noobaa S3 service

var STSLoadBalancerSourceSubnets = []string{}

STSLoadBalancerSourceSubnets is used for setting the source subnets for the load balancer created for noobaa STS service

var ShowSecrets = false

ShowSecrets is used to show the secrets in the status output

var TestEnv = false

TestEnv is used for deploying the system with test env minimal resources

Functions

func COSIDriverName

func COSIDriverName() string

COSIDriverName returns the driver name to be used in for COSI

func Cmd

func Cmd() *cobra.Command

Cmd returns a CLI command

func ObjectBucketProvisionerName

func ObjectBucketProvisionerName() string

ObjectBucketProvisionerName returns the provisioner name to be used in storage classes for OB/OBC

func RunOptions

func RunOptions(cmd *cobra.Command, args []string)

RunOptions runs a CLI command

func SubDomainNS

func SubDomainNS() string

SubDomainNS returns a unique subdomain for the namespace

func WatchNamespace

func WatchNamespace() string

WatchNamespace returns the namespace which NooBaa operator will watch for changes