options

Documentation

Index

• type Options
  • func New() *Options
• type OptionsAthenz
• type OptionsCertManager
• type OptionsDriver
• type OptionsVolume

Types

type Options

type Options struct {
	*flags.Flags

	// Driver are options specific to the driver itself.
	Driver OptionsDriver

	// CertManager are options specific to created cert-manager
	// CertificateRequests.
	CertManager OptionsCertManager

	// Volume are options specific to mounted volumes.
	Volume OptionsVolume

	// Athenz are options specific to Athenz.
	Athenz OptionsAthenz
}

Options are the CSI Driver flag options.

func New

func New() *Options

type OptionsAthenz

type OptionsAthenz struct {
	// ZTS is the URL of the ZTS server.
	ZTS string

	// Provider prefix for the backend provider in ZTS which is responsible for verifying and
	// issuing the identity.
	ProviderPrefix string

	// Athenz CA certificate file path.
	CACertFile string

	// DNS domains to be added in the service identity certificate.
	DNSDomains string

	// Country name in the service identity certificate.
	CertCountryName string

	// Organization name in the service identity certificate.
	CertOrgName string

	// Cloud provider where service is running.
	CloudProvider string

	// Cloud region where service is running.
	CloudRegion string
}

OptionsAthenz is options specific to Athenz.

type OptionsCertManager

type OptionsCertManager struct {
	// TrustDomain is the trust domain of this SPIFFE PKI. The TrustDomain will
	// appear in signed certificate's URI SANs.
	TrustDomain string

	// CertificateRequestAnnotations are annotations that are to be added to certificate requests created by the driver
	CertificateRequestAnnotations map[string]string

	// CertificateRequestDuration is the duration CertificateRequests will be
	// requested with.
	CertificateRequestDuration time.Duration

	// IssuerRef is the IssuerRef used when creating CertificateRequests.
	IssuerRef cmmeta.ObjectReference
}

OptionsCertManager is options specific to cert-manager CertificateRequests.

type OptionsDriver

type OptionsDriver struct {
	// NodeID is the name of the node the driver is running on.
	NodeID string

	// DataRoot is the path to the in-memory data directory used to store data.
	DataRoot string

	// Endpoint is the endpoint which is used to listen for gRPC requests.
	Endpoint string
}

OptionsDriver are options specific to the CSI driver itself.

type OptionsVolume

type OptionsVolume struct {
	// CertificateFileName is the name of the file that the signed certificate
	// will be written to inside the Pod's volume.
	CertificateFileName string

	// KeyFileName is the name of the file that the private key will be written
	// to inside the Pod's volume.
	// Default to `tls.key` if empty.
	KeyFileName string

	// FileName is the name of the file that the root CA certificates will be
	// written to inside the Pod's volume. Ignored if SourceCABundleFile is not
	// defined.
	CAFileName string

	// SourceCABundleFile is the file path location containing a bundle of PEM
	// encoded X.509 root CA certificates that will be written to managed volumes
	// at the CSICAFileName path. No CAs will be written if this is empty.
	SourceCABundleFile string
}

OptionsVolume is options specific to mounted volumes.