Merge pull request #124300 from walker-tom/update-envfromsource-docs

Update EnvFromSource.Prefix doc to mention Secret as well as ConfigMap
This commit is contained in:
Kubernetes Prow Robot 2025-01-17 08:56:35 -08:00 committed by GitHub
commit 6a65718f8e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 18 additions and 18 deletions

View File

@ -6843,14 +6843,14 @@
] ]
}, },
"io.k8s.api.core.v1.EnvFromSource": { "io.k8s.api.core.v1.EnvFromSource": {
"description": "EnvFromSource represents the source of a set of ConfigMaps", "description": "EnvFromSource represents the source of a set of ConfigMaps or Secrets",
"properties": { "properties": {
"configMapRef": { "configMapRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapEnvSource", "$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapEnvSource",
"description": "The ConfigMap to select from" "description": "The ConfigMap to select from"
}, },
"prefix": { "prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.", "description": "Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.",
"type": "string" "type": "string"
}, },
"secretRef": { "secretRef": {

View File

@ -1957,7 +1957,7 @@
] ]
}, },
"io.k8s.api.core.v1.EnvFromSource": { "io.k8s.api.core.v1.EnvFromSource": {
"description": "EnvFromSource represents the source of a set of ConfigMaps", "description": "EnvFromSource represents the source of a set of ConfigMaps or Secrets",
"properties": { "properties": {
"configMapRef": { "configMapRef": {
"allOf": [ "allOf": [
@ -1968,7 +1968,7 @@
"description": "The ConfigMap to select from" "description": "The ConfigMap to select from"
}, },
"prefix": { "prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.", "description": "Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.",
"type": "string" "type": "string"
}, },
"secretRef": { "secretRef": {

View File

@ -2115,7 +2115,7 @@
"type": "object" "type": "object"
}, },
"io.k8s.api.core.v1.EnvFromSource": { "io.k8s.api.core.v1.EnvFromSource": {
"description": "EnvFromSource represents the source of a set of ConfigMaps", "description": "EnvFromSource represents the source of a set of ConfigMaps or Secrets",
"properties": { "properties": {
"configMapRef": { "configMapRef": {
"allOf": [ "allOf": [
@ -2126,7 +2126,7 @@
"description": "The ConfigMap to select from" "description": "The ConfigMap to select from"
}, },
"prefix": { "prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.", "description": "Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.",
"type": "string" "type": "string"
}, },
"secretRef": { "secretRef": {

View File

@ -1464,7 +1464,7 @@
"type": "object" "type": "object"
}, },
"io.k8s.api.core.v1.EnvFromSource": { "io.k8s.api.core.v1.EnvFromSource": {
"description": "EnvFromSource represents the source of a set of ConfigMaps", "description": "EnvFromSource represents the source of a set of ConfigMaps or Secrets",
"properties": { "properties": {
"configMapRef": { "configMapRef": {
"allOf": [ "allOf": [
@ -1475,7 +1475,7 @@
"description": "The ConfigMap to select from" "description": "The ConfigMap to select from"
}, },
"prefix": { "prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.", "description": "Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.",
"type": "string" "type": "string"
}, },
"secretRef": { "secretRef": {

View File

@ -2263,9 +2263,9 @@ type SecretKeySelector struct {
Optional *bool Optional *bool
} }
// EnvFromSource represents the source of a set of ConfigMaps // EnvFromSource represents the source of a set of ConfigMaps or Secrets
type EnvFromSource struct { type EnvFromSource struct {
// An optional identifier to prepend to each key in the ConfigMap. // Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.
// +optional // +optional
Prefix string Prefix string
// The ConfigMap to select from. // The ConfigMap to select from.

View File

@ -22231,12 +22231,12 @@ func schema_k8sio_api_core_v1_EnvFromSource(ref common.ReferenceCallback) common
return common.OpenAPIDefinition{ return common.OpenAPIDefinition{
Schema: spec.Schema{ Schema: spec.Schema{
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "EnvFromSource represents the source of a set of ConfigMaps", Description: "EnvFromSource represents the source of a set of ConfigMaps or Secrets",
Type: []string{"object"}, Type: []string{"object"},
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"prefix": { "prefix": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.", Description: "Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },

View File

@ -1327,9 +1327,9 @@ message EndpointsList {
repeated Endpoints items = 2; repeated Endpoints items = 2;
} }
// EnvFromSource represents the source of a set of ConfigMaps // EnvFromSource represents the source of a set of ConfigMaps or Secrets
message EnvFromSource { message EnvFromSource {
// An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. // Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.
// +optional // +optional
optional string prefix = 1; optional string prefix = 1;

View File

@ -2437,9 +2437,9 @@ type SecretKeySelector struct {
Optional *bool `json:"optional,omitempty" protobuf:"varint,3,opt,name=optional"` Optional *bool `json:"optional,omitempty" protobuf:"varint,3,opt,name=optional"`
} }
// EnvFromSource represents the source of a set of ConfigMaps // EnvFromSource represents the source of a set of ConfigMaps or Secrets
type EnvFromSource struct { type EnvFromSource struct {
// An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. // Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.
// +optional // +optional
Prefix string `json:"prefix,omitempty" protobuf:"bytes,1,opt,name=prefix"` Prefix string `json:"prefix,omitempty" protobuf:"bytes,1,opt,name=prefix"`
// The ConfigMap to select from // The ConfigMap to select from

View File

@ -595,8 +595,8 @@ func (EndpointsList) SwaggerDoc() map[string]string {
} }
var map_EnvFromSource = map[string]string{ var map_EnvFromSource = map[string]string{
"": "EnvFromSource represents the source of a set of ConfigMaps", "": "EnvFromSource represents the source of a set of ConfigMaps or Secrets",
"prefix": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.", "prefix": "Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.",
"configMapRef": "The ConfigMap to select from", "configMapRef": "The ConfigMap to select from",
"secretRef": "The Secret to select from", "secretRef": "The Secret to select from",
} }