secret

Documentation

Index

• type ImagePullSecretSpec
  • func (spec *ImagePullSecretSpec) GetData() map[string][]byte
  • func (spec *ImagePullSecretSpec) GetName() string
  • func (spec *ImagePullSecretSpec) GetNamespace() string
  • func (spec *ImagePullSecretSpec) GetType() api.SecretType
• type Secret
  • func CreateSecret(client *client.Client, spec SecretSpec) (*Secret, error)
  • func NewSecret(secret *api.Secret) *Secret
• type SecretCell
  • func (self SecretCell) GetProperty(name dataselect.PropertyName) dataselect.ComparableValue
• type SecretDetail
  • func GetSecretDetail(client *client.Client, namespace, name string) (*SecretDetail, error)
• type SecretList
  • func GetSecretList(client *client.Client, namespace *common.NamespaceQuery, ...) (*SecretList, error)
  • func NewSecretList(secrets []api.Secret, dsQuery *dataselect.DataSelectQuery) *SecretList
• type SecretSpec

Types

type ImagePullSecretSpec

type ImagePullSecretSpec struct {
	Name      string `json:"name"`
	Namespace string `json:"namespace"`
	// The value of the .dockercfg property. It must be Base64 encoded.
	Data []byte `json:"data"`
}

ImagePullSecretSpec - specification of an image pull secret implements SecretSpec

func (*ImagePullSecretSpec) GetData

func (spec *ImagePullSecretSpec) GetData() map[string][]byte

GetData - return the data the secret carries, it is a single key-value pair

func (*ImagePullSecretSpec) GetName

func (spec *ImagePullSecretSpec) GetName() string

GetName - return the name of the ImagePullSecret

func (*ImagePullSecretSpec) GetNamespace

func (spec *ImagePullSecretSpec) GetNamespace() string

GetNamespace - return the namespace of the ImagePullSecret

func (*ImagePullSecretSpec) GetType

func (spec *ImagePullSecretSpec) GetType() api.SecretType

GetType - return the type of the ImagePullSecret, which is always api.SecretTypeDockercfg

type Secret

type Secret struct {
	common.ObjectMeta `json:"objectMeta"`
	common.TypeMeta   `json:"typeMeta"`
}

Secret - a single secret returned to the frontend.

func CreateSecret

func CreateSecret(client *client.Client, spec SecretSpec) (*Secret, error)

CreateSecret - create a single secret using the cluster API client

func NewSecret

func NewSecret(secret *api.Secret) *Secret

NewSecret - creates a new instance of Secret struct based on K8s Secret.

type SecretCell

type SecretCell api.Secret

func (SecretCell) GetProperty

func (self SecretCell) GetProperty(name dataselect.PropertyName) dataselect.ComparableValue

type SecretDetail

type SecretDetail struct {
	ObjectMeta common.ObjectMeta `json:"objectMeta"`
	TypeMeta   common.TypeMeta   `json:"typeMeta"`

	// Data contains the secret data.  Each key must be a valid DNS_SUBDOMAIN
	// or leading dot followed by valid DNS_SUBDOMAIN.
	// The serialized form of the secret data is a base64 encoded string,
	// representing the arbitrary (possibly non-string) data value here.
	Data map[string][]byte `json:"data"`

	// Used to facilitate programmatic handling of secret data.
	Type api.SecretType `json:"type"`
}

SecretDetail API resource provides mechanisms to inject containers with configuration data while keeping containers agnostic of Kubernetes

func GetSecretDetail

func GetSecretDetail(client *client.Client, namespace, name string) (*SecretDetail, error)

GetSecretDetail returns returns detailed information about a secret

type SecretList

type SecretList struct {
	common.ListMeta `json:"listMeta"`

	// Unordered list of Secrets.
	Secrets []Secret `json:"secrets"`
}

SecretsList - response structure for a queried secrets list.

func GetSecretList

func GetSecretList(client *client.Client, namespace *common.NamespaceQuery,
	dsQuery *dataselect.DataSelectQuery) (*SecretList, error)

GetSecretList - return all secrets in the given namespace.

func NewSecretList

func NewSecretList(secrets []api.Secret, dsQuery *dataselect.DataSelectQuery) *SecretList

NewSecret - creates a new instance of SecretList struct based on K8s Secrets array.

type SecretSpec

type SecretSpec interface {
	GetName() string
	GetType() api.SecretType
	GetNamespace() string
	GetData() map[string][]byte
}

SecretSpec - common interface for the specification of different secrets.