Skip to content
This repository has been archived by the owner on Jul 11, 2023. It is now read-only.

Commit

Permalink
pkg/*: add error codes
Browse files Browse the repository at this point in the history 
Adds error codes related to Ingress and the OSM Injector.

Part of #2866

Signed-off-by: jaellio <[email protected]>
  • Loading branch information
@jaellio
jaellio committed Jul 30, 2021
1 parent 0fc7e5e commit 3e7b1bb
Show file tree
Hide file tree
Showing 10 changed files with 254 additions and 36 deletions.
180 changes: 178 additions & 2 deletions pkg/errcode/errcode.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ const (

// ErrStartingReconcileManager indicates the controller-runtime Manager failed to start
ErrStartingReconcileManager

// ErrStartingIngressClient indicates the Ingress client failed to start
ErrStartingIngressClient
)

// Range 2000-2500 is reserved for errors related to traffic policies
Expand Down Expand Up @@ -102,6 +105,16 @@ const (

// ErrGettingServiceIdentitiesForService indicates the ServiceIdentities associated with a specified MeshService could not be listed
ErrGettingServiceIdentitiesForService

// ErrMarshallingKubernetesResource indicates that a Kubernetes resource could not be marshalled
ErrMarshallingKubernetesResource

// ErrUnmarshallingKubernetesResource indicates that a Kubernetes resource could not be unmarshalled
ErrUnmarshallingKubernetesResource

// ErrGettingSupportedIngressVersions indicates the mapping of Ingress API versions to the corresponding values indicating
// if they are supported could not be configured
ErrGettingSupportedIngressVersions
)

// Range 4000-4100 reserved for errors related to certificate providers
Expand Down Expand Up @@ -293,6 +306,68 @@ const (
ErrSDSCertMismatch
)

// Range 6000-6500 reserved for errors related to the OSM Injector
const (
// ErrMarshallingProtoToYAML indicates a ProtoMessage could not be converted into YAML
ErrMarshallingProtoToYAML ErrCode = iota + 6100

// ErrParsingMutatingWebhookCert indicates the mutating webhook certificate could not be parsed
ErrParsingMutatingWebhookCert

// ErrStartingInjectionWebhookHTTPServer indicates the sidecar injection webhook HTTP server failed to start
ErrStartingInjectionWebhookHTTPServer

// ErrDecodingAdmissionReqBody indicates the admission request received by the mutating webhook could not be decoded
ErrDecodingAdmissionReqBody

// ErrParsingReqTimeout indicates an admission request timeout could not be parsed
ErrParsingReqTimeout

// ErrInvalidAdmissionReqHeader indicates the received admission request's header was invalid
ErrInvalidAdmissionReqHeader

// ErrWritingAdmissionResp indicates the response to an admission request could not be written
ErrWritingAdmissionResp

// ErrNilAdmissionReq indicates the received admission request was nil
ErrNilAdmissionReq

// ErrDetermingPodInjectionEnablement indicates the enablement of a pod for sidecar injection could not be determined
ErrDetermingPodInjectionEnablement

// ErrDetermingNamespaceInjectionEnablement indicates the enablement of a namespace for sidecar injection could not
// be determined
ErrDetermingNamespaceInjectionEnablement

// ErrDeterminingPodPortExclusions indicates the oubound port exclusions for a pod could not be obtained
ErrDeterminingPodPortExclusions

// ErrUpdatingMutatingWebhookCABundle indicates the MutatingWebhookConfiguration could not be patched with the CA Bundle
ErrUpdatingMutatingWebhookCABundle

// ErrReadingAdmissionReqBody indicates the AdmissionRequest body could not be read
ErrReadingAdmissionReqBody

// ErrNilAdmissionReqBody indicates the admissionRequest body was nil
ErrNilAdmissionReqBody
)

// Range 6700-6800 reserved for errors related to the validating webhook
const (
// ErrShuttingDownValidatingWebhookHTTPServer indicates an error occurred when shutting down the validating webhook
// HTTP server
ErrShuttingDownValidatingWebhookHTTPServer ErrCode = iota + 6700

// ErrStartingValidatingWebhookHTTPServer indicates the validating webhook HTTP server failed to start
ErrStartingValidatingWebhookHTTPServer

// ErrUpdatingValidatingWebhookCABundle indicates the MutatingWebhookConfiguration could not be patched with the CA Bundle
ErrUpdatingValidatingWebhookCABundle

// ErrParsingWebhookCert indicates the validating webhook certificate could not be parsed
ErrParsingValidatingWebhookCert
)

// String returns the error code as a string, ex. E1000
func (e ErrCode) String() string {
return fmt.Sprintf("E%d", e)
Expand Down Expand Up @@ -338,8 +413,13 @@ The osm-injector k8s pod resource was not able to be retrieved by the system.
`,

ErrStartingReconcileManager: `
The controller-runtime manager to manage the controller used to reconcile the
sidecar injector's MutatingWebhookConfiguration resource failed to start.
The controller-runtime manager for the MutatingWebhookConfigurartion's
reconciler failed to start.
`,

ErrStartingIngressClient: `
The Ingress client created by the osm-controller to monitor Ingress resources
failed to start.
`,

//
Expand Down Expand Up @@ -452,6 +532,18 @@ The system found 0 endpoints to be reached when the service's FQDN was resolved.

ErrGettingServiceIdentitiesForService: `
The ServiceIdentities associated with a specified MeshService could not be listed.
`,

ErrMarshallingKubernetesResource: `
A Kubernetes resource could not be marshalled.
`,

ErrUnmarshallingKubernetesResource: `
A Kubernetes resource could not be unmarshalled.
`,

ErrGettingSupportedIngressVersions: `
The Ingress API versions supported by the k8s API server could not be obtained.
`,

//
Expand Down Expand Up @@ -724,5 +816,89 @@ The SDS secret does not correspond to a ServiceAccount.
The identity obtained from the SDS certificate request does not match the
identity of the proxy.
The corresponding certificate request was ignored by the system.
`,

//
// Range 6000-6500
//
ErrMarshallingProtoToYAML: `
A protobuf ProtoMessage could not be converted into YAML.
`,

ErrParsingMutatingWebhookCert: `
The mutating webhook certificate could not be parsed.
The mutating webhook HTTP server was not started.
`,

ErrStartingInjectionWebhookHTTPServer: `
The sidecar injection webhook HTTP server failed to start.
`,

ErrDecodingAdmissionReqBody: `
An AdmissionRequest could not be decoded.
`,

ErrParsingReqTimeout: `
The timeout from an AdmissionRequest could not be parsed.
`,

ErrInvalidAdmissionReqHeader: `
The AdmissionRequest's header was invalid. The content type obtained from the
header is not supported.
`,

ErrWritingAdmissionResp: `
The AdmissionResponse could not be written.
`,

ErrNilAdmissionReq: `
The AdmissionRequest was empty.
`,

ErrDetermingPodInjectionEnablement: `
It could not be determined if the pod specified in the AdmissionRequest is
enabled for sidecar injection.
`,

ErrDetermingNamespaceInjectionEnablement: `
It could not be determined if the namespace specified in the
AdmissionRequest is enabled for sidecar injection.
`,

ErrDeterminingPodPortExclusions: `
The port exclusions for a pod could not be obtained.
No port exclusions are added to the init container's spec.
`,

ErrUpdatingMutatingWebhookCABundle: `
The MutatingWebhookConfiguration could not be patched with the CA Bundle.
`,

ErrReadingAdmissionReqBody: `
The AdmissionRequest body could not be read.
`,

ErrNilAdmissionReqBody: `
The AdmissionRequest body was nil.
`,

//
// Range 6700-6800
//
ErrShuttingDownValidatingWebhookHTTPServer: `
An error occurred when shutting down the validating webhook HTTP server.
`,

ErrStartingValidatingWebhookHTTPServer: `
The validating webhook HTTP server failed to start.
`,

ErrUpdatingValidatingWebhookCABundle: `
The ValidatingWebhookConfiguration could not be patched with the CA Bundle.
`,

ErrParsingValidatingWebhookCert: `
The validating webhook certificate could not be parsed.
The validating webhook HTTP server was not started.
`,
}
7 changes: 5 additions & 2 deletions pkg/ingress/client.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
"github.com/openservicemesh/osm/pkg/announcements"
"github.com/openservicemesh/osm/pkg/configurator"
"github.com/openservicemesh/osm/pkg/constants"
"github.com/openservicemesh/osm/pkg/errcode"
"github.com/openservicemesh/osm/pkg/k8s"
"github.com/openservicemesh/osm/pkg/service"
)
Expand All @@ -29,7 +30,8 @@ var candidateVersions = []string{networkingV1.SchemeGroupVersion.String(), netwo
func NewIngressClient(kubeClient kubernetes.Interface, kubeController k8s.Controller, stop chan struct{}, _ configurator.Configurator) (Monitor, error) {
supportedIngressVersions, err := getSupportedIngressVersions(kubeClient.Discovery())
if err != nil {
log.Error().Err(err).Msgf("Error retrieving ingress API versions supported by k8s API server")
log.Error().Err(err).Str(errcode.Kind, errcode.ErrGettingSupportedIngressVersions.String()).
Msgf("Error retrieving ingress API versions supported by k8s API server")
return nil, err
}

Expand Down Expand Up @@ -72,7 +74,8 @@ func NewIngressClient(kubeClient kubernetes.Interface, kubeController k8s.Contro
}

if err := c.run(stop); err != nil {
log.Error().Err(err).Msg("Could not start Kubernetes Ingress client")
log.Error().Err(err).Str(errcode.Kind, errcode.ErrStartingIngressClient.String()).
Msg("Could not start Kubernetes Ingress client")
return nil, err
}

Expand Down
10 changes: 7 additions & 3 deletions pkg/injector/envoy_config.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"github.com/openservicemesh/osm/pkg/configurator"
"github.com/openservicemesh/osm/pkg/constants"
"github.com/openservicemesh/osm/pkg/envoy/bootstrap"
"github.com/openservicemesh/osm/pkg/errcode"
"github.com/openservicemesh/osm/pkg/utils"
"github.com/openservicemesh/osm/pkg/version"
)
Expand Down Expand Up @@ -52,7 +53,8 @@ func getEnvoyConfigYAML(config envoyBootstrapConfigMeta, cfg configurator.Config

configYAML, err := utils.ProtoToYAML(bootstrapConfig)
if err != nil {
log.Error().Err(err).Msgf("Failed to marshal envoy bootstrap config to yaml")
log.Error().Err(err).Str(errcode.Kind, errcode.ErrMarshallingProtoToYAML.String()).
Msgf("Failed to marshal envoy bootstrap config to yaml")
return nil, err
}
return configYAML, nil
Expand Down Expand Up @@ -158,7 +160,8 @@ func getXdsCluster(config envoyBootstrapConfigMeta) (*xds_cluster.Cluster, error
}
pbHTTPProtocolOptions, err := ptypes.MarshalAny(httpProtocolOptions)
if err != nil {
log.Error().Err(err).Msgf("Error marshaling HttpProtocolOptions struct into an anypb.Any message")
log.Error().Err(err).Str(errcode.Kind, errcode.ErrMarshallingXDSResource.String()).
Msgf("Error marshaling HttpProtocolOptions struct into an anypb.Any message")
return nil, err
}

Expand Down Expand Up @@ -198,7 +201,8 @@ func getXdsCluster(config envoyBootstrapConfigMeta) (*xds_cluster.Cluster, error
}
pbUpstreamTLSContext, err := ptypes.MarshalAny(upstreamTLSContext)
if err != nil {
log.Error().Err(err).Msgf("Error marshaling UpstreamTlsContext struct into an anypb.Any message")
log.Error().Err(err).Str(errcode.Kind, errcode.ErrMarshallingXDSResource.String()).
Msgf("Error marshaling UpstreamTlsContext struct into an anypb.Any message")
return nil, err
}

Expand Down
13 changes: 9 additions & 4 deletions pkg/injector/envoy_config_health_probes.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"google.golang.org/protobuf/types/known/structpb"

"github.com/openservicemesh/osm/pkg/envoy"
"github.com/openservicemesh/osm/pkg/errcode"

xds_accesslog_filter "github.com/envoyproxy/go-control-plane/envoy/config/accesslog/v3"
xds_cluster "github.com/envoyproxy/go-control-plane/envoy/config/cluster/v3"
Expand Down Expand Up @@ -138,7 +139,8 @@ func getProbeListener(listenerName, clusterName, newPath string, port int32, ori
}
pbHTTPConnectionManager, err := ptypes.MarshalAny(httpConnectionManager)
if err != nil {
log.Error().Err(err).Msgf("Error marshaling HttpConnectionManager struct into an anypb.Any message")
log.Error().Err(err).Str(errcode.Kind, errcode.ErrMarshallingXDSResource.String()).
Msgf("Error marshaling HttpConnectionManager struct into an anypb.Any message")
return nil, err
}
filterChain = &xds_listener.FilterChain{
Expand Down Expand Up @@ -167,7 +169,8 @@ func getProbeListener(listenerName, clusterName, newPath string, port int32, ori
}
pbTCPProxy, err := ptypes.MarshalAny(tcpProxy)
if err != nil {
log.Error().Err(err).Msgf("Error marshaling TcpProxy struct into an anypb.Any message")
log.Error().Err(err).Str(errcode.Kind, errcode.ErrMarshallingXDSResource.String()).
Msgf("Error marshaling TcpProxy struct into an anypb.Any message")
return nil, err
}
filterChain = &xds_listener.FilterChain{
Expand Down Expand Up @@ -230,7 +233,8 @@ func getVirtualHost(newPath, clusterName, originalProbePath string) *xds_route.V
func getHTTPAccessLog() (*xds_accesslog_filter.AccessLog, error) {
accessLog, err := ptypes.MarshalAny(getStdoutAccessLog())
if err != nil {
log.Error().Err(err).Msg("Error marshalling AccessLog object")
log.Error().Err(err).Str(errcode.Kind, errcode.ErrMarshallingXDSResource.String()).
Msg("Error marshalling AccessLog object")
return nil, err
}
return &xds_accesslog_filter.AccessLog{
Expand All @@ -245,7 +249,8 @@ func getHTTPAccessLog() (*xds_accesslog_filter.AccessLog, error) {
func getTCPAccessLog() (*xds_accesslog_filter.AccessLog, error) {
accessLog, err := ptypes.MarshalAny(getTCPStdoutAccessLog())
if err != nil {
log.Error().Err(err).Msg("Error marshalling tcp AccessLog object")
log.Error().Err(err).Str(errcode.Kind, errcode.ErrMarshallingXDSResource.String()).
Msg("Error marshalling tcp AccessLog object")
return nil, err
}
return &xds_accesslog_filter.AccessLog{
Expand Down
4 changes: 3 additions & 1 deletion pkg/injector/patch.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import (

"github.com/openservicemesh/osm/pkg/constants"
"github.com/openservicemesh/osm/pkg/envoy"
"github.com/openservicemesh/osm/pkg/errcode"
"github.com/openservicemesh/osm/pkg/metricsstore"
)

Expand Down Expand Up @@ -108,7 +109,8 @@ func makePatches(req *admissionv1.AdmissionRequest, pod *corev1.Pod) []jsonpatch
original := req.Object.Raw
current, err := json.Marshal(pod)
if err != nil {
log.Error().Err(err).Msgf("Error marshaling Pod with UID=%s", pod.ObjectMeta.UID)
log.Error().Err(err).Str(errcode.Kind, errcode.ErrMarshallingKubernetesResource.String()).
Msgf("Error marshaling Pod with UID=%s", pod.ObjectMeta.UID)
}
admissionResponse := admission.PatchResponseFromRaw(original, current)
return admissionResponse.Patches
Expand Down
Loading

0 comments on commit 3e7b1bb

Please sign in to comment.