comments on base64-ness of secrets

This commit is contained in:
Tim Hockin 2015-02-23 10:57:51 -08:00
parent 607b736a3f
commit 3e7248f0f4
5 changed files with 13 additions and 7 deletions

View File

@ -273,7 +273,8 @@ type Secret struct {
ObjectMeta ObjectMeta
// Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN. // Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN.
// The serialized form of the secret data is a base64 encoded string. // 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,omitempty"` Data map[string][]byte `json:"data,omitempty"`
// Used to facilitate programatic handling of secret data. // Used to facilitate programatic handling of secret data.
@ -398,8 +399,9 @@ To create a pod that uses an ssh key stored as a secret, we first need to create
} }
``` ```
**Note:** The values of secret data are encoded as base64-encoded strings. Newlines are not **Note:** The serialized JSON and YAML values of secret data are encoded as
valid within these strings and must be omitted. base64 strings. Newlines are not valid within these strings and must be
omitted.
Now we can create a pod which references the secret with the ssh key and consumes it in a volume: Now we can create a pod which references the secret with the ssh key and consumes it in a volume:

View File

@ -1330,7 +1330,8 @@ type Secret struct {
ObjectMeta `json:"metadata,omitempty"` ObjectMeta `json:"metadata,omitempty"`
// Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN. // Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN.
// The serialized form of the secret data is a base64 encoded string. // 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,omitempty"` Data map[string][]byte `json:"data,omitempty"`
// Used to facilitate programatic handling of secret data. // Used to facilitate programatic handling of secret data.

View File

@ -1113,7 +1113,8 @@ type Secret struct {
TypeMeta `json:",inline"` TypeMeta `json:",inline"`
// Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN. // Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN.
// The serialized form of the secret data is a base64 encoded string. // 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,omitempty" description:"data contains the secret data. Each key must be a valid DNS_SUBDOMAIN. Each value must be a base64 encoded string"` Data map[string][]byte `json:"data,omitempty" description:"data contains the secret data. Each key must be a valid DNS_SUBDOMAIN. Each value must be a base64 encoded string"`
// Used to facilitate programatic handling of secret data. // Used to facilitate programatic handling of secret data.

View File

@ -1116,7 +1116,8 @@ type Secret struct {
TypeMeta `json:",inline"` TypeMeta `json:",inline"`
// Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN. // Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN.
// The serialized form of the secret data is a base64 encoded string. // 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,omitempty" description:"data contains the secret data. Each key must be a valid DNS_SUBDOMAIN. Each value must be a base64 encoded string"` Data map[string][]byte `json:"data,omitempty" description:"data contains the secret data. Each key must be a valid DNS_SUBDOMAIN. Each value must be a base64 encoded string"`
// Used to facilitate programatic handling of secret data. // Used to facilitate programatic handling of secret data.

View File

@ -1267,7 +1267,8 @@ type Secret struct {
ObjectMeta `json:"metadata,omitempty"` ObjectMeta `json:"metadata,omitempty"`
// Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN. // Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN.
// The serialized form of the secret data is a base64 encoded string. // 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,omitempty" description:"data contains the secret data. Each key must be a valid DNS_SUBDOMAIN. Each value must be a base64 encoded string"` Data map[string][]byte `json:"data,omitempty" description:"data contains the secret data. Each key must be a valid DNS_SUBDOMAIN. Each value must be a base64 encoded string"`
// Used to facilitate programatic handling of secret data. // Used to facilitate programatic handling of secret data.