rename user container to main container

DEVELOPMENT.md

@@ -1,4 +1,4 @@
-# Development
+                      # Development
 
 This doc explains how to set up a development environment so you can get started
 [contributing](https://www.knative.dev/contributing/) to `Knative Serving`. Also

pkg/apis/config/defaults.go

@@ -56,9 +56,9 @@ const (
 	// specified by the user, if `name:` is omitted.
 	DefaultInitContainerName = "init-container"
 
-	// DefaultUserContainerName is the default name we give to the container
+	// DefaultMainContainerName is the default name we give to the container
 	// specified by the user, if `name:` is omitted.
-	DefaultUserContainerName = "user-container"
+	DefaultMainContainerName = "user-container"
 
 	// DefaultContainerConcurrency is the default container concurrency. It will be set if ContainerConcurrency is not specified.
 	DefaultContainerConcurrency = 0
@@ -74,7 +74,7 @@ const (
 
 var (
 	DefaultInitContainerNameTemplate = mustParseTemplate(DefaultInitContainerName)
-	DefaultUserContainerNameTemplate = mustParseTemplate(DefaultUserContainerName)
+	DefaultMainContainerNameTemplate = mustParseTemplate(DefaultMainContainerName)
 )
 
 func defaultDefaultsConfig() *Defaults {
@@ -84,7 +84,7 @@ func defaultDefaultsConfig() *Defaults {
 		RevisionResponseStartTimeoutSeconds: DefaultRevisionResponseStartTimeoutSeconds,
 		RevisionIdleTimeoutSeconds:          DefaultRevisionIdleTimeoutSeconds,
 		InitContainerNameTemplate:           DefaultInitContainerNameTemplate,
-		UserContainerNameTemplate:           DefaultUserContainerNameTemplate,
+		MainContainerNameTemplate:           DefaultMainContainerNameTemplate,
 		ContainerConcurrency:                DefaultContainerConcurrency,
 		ContainerConcurrencyMaxLimit:        DefaultMaxRevisionContainerConcurrency,
 		AllowContainerConcurrencyZero:       DefaultAllowContainerConcurrencyZero,
@@ -114,7 +114,7 @@ func NewDefaultsConfigFromMap(data map[string]string) (*Defaults, error) {
 
 	if err := cm.Parse(data,
 		asTemplate("init-container-name-template", &nc.InitContainerNameTemplate),
-		asTemplate("container-name-template", &nc.UserContainerNameTemplate),
+		asTemplate("container-name-template", &nc.MainContainerNameTemplate),
 
 		cm.AsBool("allow-container-concurrency-zero", &nc.AllowContainerConcurrencyZero),
 		asTriState("enable-service-links", &nc.EnableServiceLinks, nil),
@@ -163,7 +163,7 @@ func NewDefaultsConfigFromMap(data map[string]string) (*Defaults, error) {
 			nc.ContainerConcurrency, 0, nc.ContainerConcurrencyMaxLimit, "container-concurrency")
 	}
 	// Check that the templates properly apply to ObjectMeta.
-	if err := nc.UserContainerNameTemplate.Execute(io.Discard, metav1.ObjectMeta{}); err != nil {
+	if err := nc.MainContainerNameTemplate.Execute(io.Discard, metav1.ObjectMeta{}); err != nil {
 		return nil, fmt.Errorf("error executing template: %w", err)
 	}
 	if err := nc.InitContainerNameTemplate.Execute(io.Discard, metav1.ObjectMeta{}); err != nil {
@@ -194,7 +194,7 @@ type Defaults struct {
 
 	InitContainerNameTemplate *ObjectMetaTemplate
 
-	UserContainerNameTemplate *ObjectMetaTemplate
+	MainContainerNameTemplate *ObjectMetaTemplate
 
 	ContainerConcurrency int64
 
@@ -226,9 +226,9 @@ func containerNameFromTemplate(ctx context.Context, tmpl *ObjectMetaTemplate) st
 	return buf.String()
 }
 
-// UserContainerName returns the name of the user container based on the context.
-func (d Defaults) UserContainerName(ctx context.Context) string {
-	return containerNameFromTemplate(ctx, d.UserContainerNameTemplate)
+// MainContainerName returns the name of the user container based on the context.
+func (d Defaults) MainContainerName(ctx context.Context) string {
+	return containerNameFromTemplate(ctx, d.MainContainerNameTemplate)
 }
 
 // InitContainerName returns the name of the init container based on the context.

pkg/apis/config/defaults_test.go

@@ -79,7 +79,7 @@ func TestDefaultsConfiguration(t *testing.T) {
 			RevisionIdleTimeoutSeconds:          123,
 			ContainerConcurrencyMaxLimit:        1984,
 			RevisionCPURequest:                  &oneTwoThree,
-			UserContainerNameTemplate:           mustParseTemplate("{{.Name}}"),
+			MainContainerNameTemplate:           mustParseTemplate("{{.Name}}"),
 			InitContainerNameTemplate:           mustParseTemplate("{{.Name}}"),
 			EnableServiceLinks:                  ptr.Bool(true),
 		},
@@ -103,7 +103,7 @@ func TestDefaultsConfiguration(t *testing.T) {
 			MaxRevisionTimeoutSeconds:           DefaultMaxRevisionTimeoutSeconds,
 			RevisionResponseStartTimeoutSeconds: DefaultRevisionResponseStartTimeoutSeconds,
 			InitContainerNameTemplate:           DefaultInitContainerNameTemplate,
-			UserContainerNameTemplate:           DefaultUserContainerNameTemplate,
+			MainContainerNameTemplate:           DefaultMainContainerNameTemplate,
 			ContainerConcurrencyMaxLimit:        DefaultMaxRevisionContainerConcurrency,
 			AllowContainerConcurrencyZero:       true,
 			EnableServiceLinks:                  ptr.Bool(false),
@@ -119,7 +119,7 @@ func TestDefaultsConfiguration(t *testing.T) {
 			MaxRevisionTimeoutSeconds:           DefaultMaxRevisionTimeoutSeconds,
 			RevisionResponseStartTimeoutSeconds: DefaultRevisionResponseStartTimeoutSeconds,
 			InitContainerNameTemplate:           DefaultInitContainerNameTemplate,
-			UserContainerNameTemplate:           DefaultUserContainerNameTemplate,
+			MainContainerNameTemplate:           DefaultMainContainerNameTemplate,
 			ContainerConcurrencyMaxLimit:        DefaultMaxRevisionContainerConcurrency,
 			AllowContainerConcurrencyZero:       true,
 			EnableServiceLinks:                  nil,
@@ -214,7 +214,7 @@ func TestDefaultsConfiguration(t *testing.T) {
 			ContainerConcurrencyMaxLimit:        DefaultMaxRevisionContainerConcurrency,
 			AllowContainerConcurrencyZero:       DefaultAllowContainerConcurrencyZero,
 			EnableServiceLinks:                  ptr.Bool(false),
-			UserContainerNameTemplate:           mustParseTemplate("{{.Name}}"),
+			MainContainerNameTemplate:           mustParseTemplate("{{.Name}}"),
 			InitContainerNameTemplate:           mustParseTemplate("my-template"),
 		},
 		data: map[string]string{
@@ -235,7 +235,7 @@ func TestDefaultsConfiguration(t *testing.T) {
 			AllowContainerConcurrencyZero:       DefaultAllowContainerConcurrencyZero,
 			EnableServiceLinks:                  ptr.Bool(false),
 			InitContainerNameTemplate:           DefaultInitContainerNameTemplate,
-			UserContainerNameTemplate:           DefaultUserContainerNameTemplate,
+			MainContainerNameTemplate:           DefaultMainContainerNameTemplate,
 		},
 	}}
 
@@ -308,8 +308,8 @@ func TestTemplating(t *testing.T) {
 				Namespace: "guardians",
 			})
 
-			if got, want := def.UserContainerName(ctx), test.want; got != want {
-				t.Errorf("UserContainerName() = %v, wanted %v", got, want)
+			if got, want := def.MainContainerName(ctx), test.want; got != want {
+				t.Errorf("MainContainerName() = %v, wanted %v", got, want)
 			}
 
 			if got, want := def.InitContainerName(ctx), test.want; got != want {

pkg/apis/serving/k8s_validation.go

@@ -387,7 +387,7 @@ func ValidatePodSpec(ctx context.Context, ps corev1.PodSpec) *apis.FieldError {
 	case 0:
 		errs = errs.Also(apis.ErrMissingField("containers"))
 	case 1:
-		errs = errs.Also(ValidateUserContainer(ctx, ps.Containers[0], volumes, port).
+		errs = errs.Also(ValidateMainContainer(ctx, ps.Containers[0], volumes, port).
 			ViaFieldIndex("containers", 0))
 	default:
 		errs = errs.Also(validateContainers(ctx, ps.Containers, volumes, port))
@@ -444,7 +444,7 @@ func validateContainers(ctx context.Context, containers []corev1.Container, volu
 		if len(containers[i].Ports) == 0 {
 			errs = errs.Also(validateSidecarContainer(WithinSidecarContainer(ctx), containers[i], volumes).ViaFieldIndex("containers", i))
 		} else {
-			errs = errs.Also(ValidateUserContainer(WithinUserContainer(ctx), containers[i], volumes, port).ViaFieldIndex("containers", i))
+			errs = errs.Also(ValidateMainContainer(WithinMainContainer(ctx), containers[i], volumes, port).ViaFieldIndex("containers", i))
 		}
 	}
 	return errs
@@ -550,8 +550,8 @@ func validateInitContainer(ctx context.Context, container corev1.Container, volu
 	return errs.Also(validate(WithinInitContainer(ctx), container, volumes))
 }
 
-// ValidateUserContainer validate fields for serving containers
-func ValidateUserContainer(ctx context.Context, container corev1.Container, volumes map[string]corev1.Volume, port corev1.ContainerPort) (errs *apis.FieldError) {
+// ValidateMainContainer validate fields for serving containers
+func ValidateMainContainer(ctx context.Context, container corev1.Container, volumes map[string]corev1.Volume, port corev1.ContainerPort) (errs *apis.FieldError) {
 	// Liveness Probes
 	errs = errs.Also(validateProbe(container.LivenessProbe, &port, true).ViaField("livenessProbe"))
 	// Readiness Probes
@@ -757,12 +757,12 @@ func validateContainerPortBasic(port corev1.ContainerPort) *apis.FieldError {
 	return errs
 }
 
-func validateReadinessProbe(p *corev1.Probe, port *corev1.ContainerPort, isUserContainer bool) *apis.FieldError {
+func validateReadinessProbe(p *corev1.Probe, port *corev1.ContainerPort, isMainContainer bool) *apis.FieldError {
 	if p == nil {
 		return nil
 	}
 
-	errs := validateProbe(p, port, isUserContainer)
+	errs := validateProbe(p, port, isMainContainer)
 
 	if p.PeriodSeconds < 0 {
 		errs = errs.Also(apis.ErrOutOfBoundsValue(p.PeriodSeconds, 0, math.MaxInt32, "periodSeconds"))
@@ -804,7 +804,7 @@ func validateReadinessProbe(p *corev1.Probe, port *corev1.ContainerPort, isUserC
 	return errs
 }
 
-func validateProbe(p *corev1.Probe, port *corev1.ContainerPort, isUserContainer bool) *apis.FieldError {
+func validateProbe(p *corev1.Probe, port *corev1.ContainerPort, isMainContainer bool) *apis.FieldError {
 	if p == nil {
 		return nil
 	}
@@ -819,7 +819,7 @@ func validateProbe(p *corev1.Probe, port *corev1.ContainerPort, isUserContainer
 		handlers = append(handlers, "httpGet")
 		errs = errs.Also(apis.CheckDisallowedFields(*h.HTTPGet, *HTTPGetActionMask(h.HTTPGet))).ViaField("httpGet")
 		getPort := h.HTTPGet.Port
-		if isUserContainer {
+		if isMainContainer {
 			if getPort.StrVal != "" && getPort.StrVal != port.Name {
 				errs = errs.Also(apis.ErrInvalidValue(getPort.String(), "httpGet.port", "Probe port must match container port"))
 			}
@@ -833,7 +833,7 @@ func validateProbe(p *corev1.Probe, port *corev1.ContainerPort, isUserContainer
 		handlers = append(handlers, "tcpSocket")
 		errs = errs.Also(apis.CheckDisallowedFields(*h.TCPSocket, *TCPSocketActionMask(h.TCPSocket))).ViaField("tcpSocket")
 		tcpPort := h.TCPSocket.Port
-		if isUserContainer {
+		if isMainContainer {
 			if tcpPort.StrVal != "" && tcpPort.StrVal != port.Name {
 				errs = errs.Also(apis.ErrInvalidValue(tcpPort.String(), "tcpSocket.port", "Probe port must match container port"))
 			}
@@ -983,12 +983,12 @@ func warnDefaultContainerSecurityContext(_ context.Context, psc *corev1.PodSecur
 
 // This is attached to contexts as they are passed down through a user container
 // being validated.
-type userContainer struct{}
+type mainContainer struct{}
 
-// WithinUserContainer notes on the context that further validation or defaulting
+// WithinMainContainer notes on the context that further validation or defaulting
 // is within the context of a user container in the revision.
-func WithinUserContainer(ctx context.Context) context.Context {
-	return context.WithValue(ctx, userContainer{}, struct{}{})
+func WithinMainContainer(ctx context.Context) context.Context {
+	return context.WithValue(ctx, mainContainer{}, struct{}{})
 }
 
 // This is attached to contexts as they are passed down through a sidecar container

pkg/apis/serving/k8s_validation_test.go

@@ -1492,7 +1492,7 @@ func TestPodSpecFieldRefValidation(t *testing.T) {
 	}
 }
 
-func TestUserContainerValidation(t *testing.T) {
+func TestMainContainerValidation(t *testing.T) {
 	tests := []containerValidationTestCase{
 		{
 			name: "has a lifecycle",
@@ -1961,10 +1961,10 @@ func TestUserContainerValidation(t *testing.T) {
 			}
 			port, err := validateContainersPorts([]corev1.Container{test.c})
 
-			got := err.Also(ValidateUserContainer(ctx, test.c, test.volumes, port))
+			got := err.Also(ValidateMainContainer(ctx, test.c, test.volumes, port))
 			got = got.Filter(apis.ErrorLevel)
 			if diff := cmp.Diff(test.want.Error(), got.Error()); diff != "" {
-				t.Errorf("ValidateUserContainer (-want, +got): \n%s", diff)
+				t.Errorf("ValidateMainContainer (-want, +got): \n%s", diff)
 			}
 		})
 	}

pkg/apis/serving/v1/configuration_defaults_test.go

@@ -72,7 +72,7 @@ func TestConfigurationDefaulting(t *testing.T) {
 					Spec: RevisionSpec{
 						PodSpec: corev1.PodSpec{
 							Containers: []corev1.Container{{
-								Name:           config.DefaultUserContainerName,
+								Name:           config.DefaultMainContainerName,
 								Image:          "busybox",
 								Resources:      defaultResources,
 								ReadinessProbe: defaultProbe,
@@ -107,7 +107,7 @@ func TestConfigurationDefaulting(t *testing.T) {
 						PodSpec: corev1.PodSpec{
 							EnableServiceLinks: ptr.Bool(false),
 							Containers: []corev1.Container{{
-								Name:           config.DefaultUserContainerName,
+								Name:           config.DefaultMainContainerName,
 								Image:          "busybox",
 								Resources:      defaultResources,
 								ReadinessProbe: defaultProbe,
@@ -144,7 +144,7 @@ func TestConfigurationDefaulting(t *testing.T) {
 						PodSpec: corev1.PodSpec{
 							EnableServiceLinks: ptr.Bool(true),
 							Containers: []corev1.Container{{
-								Name:           config.DefaultUserContainerName,
+								Name:           config.DefaultMainContainerName,
 								Image:          "busybox",
 								Resources:      defaultResources,
 								ReadinessProbe: defaultProbe,

pkg/apis/serving/v1/revision_defaults.go

@@ -82,8 +82,8 @@ func (rs *RevisionSpec) SetDefaults(ctx context.Context) {
 	for idx := range rs.PodSpec.InitContainers {
 		containerNames.Insert(rs.PodSpec.InitContainers[idx].Name)
 	}
-	defaultUserContainerName := cfg.Defaults.UserContainerName(ctx)
-	applyDefaultContainerNames(rs.PodSpec.Containers, containerNames, defaultUserContainerName)
+	defaultMainContainerName := cfg.Defaults.MainContainerName(ctx)
+	applyDefaultContainerNames(rs.PodSpec.Containers, containerNames, defaultMainContainerName)
 	defaultInitContainerName := cfg.Defaults.InitContainerName(ctx)
 	applyDefaultContainerNames(rs.PodSpec.InitContainers, containerNames, defaultInitContainerName)
 	for idx := range rs.PodSpec.Containers {
@@ -132,7 +132,7 @@ func (rs *RevisionSpec) applyDefault(ctx context.Context, container *corev1.Cont
 	// If there are multiple containers then default probes will be applied to the container where user specified PORT
 	// default probes will not be applied for non serving containers
 	if len(rs.PodSpec.Containers) == 1 || len(container.Ports) != 0 {
-		rs.applyUserContainerDefaultReadinessProbe(container)
+		rs.applyMainContainerDefaultReadinessProbe(container)
 	}
 	rs.applyReadinessProbeDefaults(container)
 	rs.applyGRPCProbeDefaults(container)
@@ -155,7 +155,7 @@ func (rs *RevisionSpec) applyDefault(ctx context.Context, container *corev1.Cont
 	}
 }
 
-func (*RevisionSpec) applyUserContainerDefaultReadinessProbe(container *corev1.Container) {
+func (*RevisionSpec) applyMainContainerDefaultReadinessProbe(container *corev1.Container) {
 	if container.ReadinessProbe == nil {
 		container.ReadinessProbe = &corev1.Probe{}
 	}