From 9f9f5ba73a4bcfb766085c349dffdde15ce32135 Mon Sep 17 00:00:00 2001 From: Qianbo Huai Date: Mon, 6 Jun 2022 15:52:05 -0700 Subject: [PATCH] fix spelling errors (#48) Signed-off-by: Qianbo Huai --- .../crds/numaflow.numaproj.io_interstepbufferservices.yaml | 4 ++-- config/install.yaml | 4 ++-- controllers/pipeline/validate.go | 4 ++-- docs/APIs.md | 4 ++-- pkg/apis/numaflow/v1alpha1/generated.proto | 4 ++-- pkg/apis/numaflow/v1alpha1/jetstream_buffer_service.go | 4 ++-- pkg/isb/redis/read.go | 2 +- pkg/isb/redis/write.go | 2 +- pkg/sources/kafka/metrics.go | 4 ++-- 9 files changed, 16 insertions(+), 16 deletions(-) diff --git a/config/base/crds/numaflow.numaproj.io_interstepbufferservices.yaml b/config/base/crds/numaflow.numaproj.io_interstepbufferservices.yaml index a6d24783ce..e65054bc5e 100644 --- a/config/base/crds/numaflow.numaproj.io_interstepbufferservices.yaml +++ b/config/base/crds/numaflow.numaproj.io_interstepbufferservices.yaml @@ -1253,7 +1253,7 @@ spec: type: object encryption: description: Whether encrypt the data at rest, defaults to false - Enabling encryption might impact the performace, see https://docs.nats.io/running-a-nats-service/nats_admin/jetstream_admin/encryption_at_rest + Enabling encryption might impact the performance, see https://docs.nats.io/running-a-nats-service/nats_admin/jetstream_admin/encryption_at_rest for the detail Toggling the value will impact encypting/decrypting existing messages. type: boolean @@ -2181,7 +2181,7 @@ spec: type: array tls: description: Whether enable TLS, defaults to false Enabling TLS - might impact the performace + might impact the performance type: boolean tolerations: description: If specified, the pod's tolerations. diff --git a/config/install.yaml b/config/install.yaml index 610eae4197..7287100d23 100644 --- a/config/install.yaml +++ b/config/install.yaml @@ -1252,7 +1252,7 @@ spec: type: object encryption: description: Whether encrypt the data at rest, defaults to false - Enabling encryption might impact the performace, see https://docs.nats.io/running-a-nats-service/nats_admin/jetstream_admin/encryption_at_rest + Enabling encryption might impact the performance, see https://docs.nats.io/running-a-nats-service/nats_admin/jetstream_admin/encryption_at_rest for the detail Toggling the value will impact encypting/decrypting existing messages. type: boolean @@ -2180,7 +2180,7 @@ spec: type: array tls: description: Whether enable TLS, defaults to false Enabling TLS - might impact the performace + might impact the performance type: boolean tolerations: description: If specified, the pod's tolerations. diff --git a/controllers/pipeline/validate.go b/controllers/pipeline/validate.go index d325531f29..f5b887faee 100644 --- a/controllers/pipeline/validate.go +++ b/controllers/pipeline/validate.go @@ -49,11 +49,11 @@ func ValidatePipeline(pl *dfv1.Pipeline) error { } if len(sources) == 0 { - return fmt.Errorf("pipeline has no source, at lease one vertex with 'source' defined is requried") + return fmt.Errorf("pipeline has no source, at lease one vertex with 'source' defined is required") } if len(sinks) == 0 { - return fmt.Errorf("pipeline has no sink, at lease one vertex with 'sink' defined is requried") + return fmt.Errorf("pipeline has no sink, at lease one vertex with 'sink' defined is required") } for k, u := range udfs { diff --git a/docs/APIs.md b/docs/APIs.md index d4970e6703..2c85e85e84 100644 --- a/docs/APIs.md +++ b/docs/APIs.md @@ -1612,7 +1612,7 @@ fields under “otBucket” include “maxValueSize”, “history”, “ttl” (Optional)

Whether encrypt the data at rest, defaults to false Enabling encryption -might impact the performace, see +might impact the performance, see https://docs.nats.io/running-a-nats-service/nats_admin/jetstream_admin/encryption_at_rest for the detail Toggling the value will impact encypting/decrypting existing messages. @@ -1627,7 +1627,7 @@ existing messages. (Optional)

Whether enable TLS, defaults to false Enabling TLS might impact the -performace +performance

diff --git a/pkg/apis/numaflow/v1alpha1/generated.proto b/pkg/apis/numaflow/v1alpha1/generated.proto index 89cf4f63d7..56bae2bbc6 100644 --- a/pkg/apis/numaflow/v1alpha1/generated.proto +++ b/pkg/apis/numaflow/v1alpha1/generated.proto @@ -447,13 +447,13 @@ message JetStreamBufferService { optional string bufferConfig = 18; // Whether encrypt the data at rest, defaults to false - // Enabling encryption might impact the performace, see https://docs.nats.io/running-a-nats-service/nats_admin/jetstream_admin/encryption_at_rest for the detail + // Enabling encryption might impact the performance, see https://docs.nats.io/running-a-nats-service/nats_admin/jetstream_admin/encryption_at_rest for the detail // Toggling the value will impact encypting/decrypting existing messages. // +optional optional bool encryption = 19; // Whether enable TLS, defaults to false - // Enabling TLS might impact the performace + // Enabling TLS might impact the performance // +optional optional bool tls = 20; } diff --git a/pkg/apis/numaflow/v1alpha1/jetstream_buffer_service.go b/pkg/apis/numaflow/v1alpha1/jetstream_buffer_service.go index 19b8b19ad3..4be0735bc2 100644 --- a/pkg/apis/numaflow/v1alpha1/jetstream_buffer_service.go +++ b/pkg/apis/numaflow/v1alpha1/jetstream_buffer_service.go @@ -93,12 +93,12 @@ type JetStreamBufferService struct { // +optional BufferConfig *string `json:"bufferConfig,omitempty" protobuf:"bytes,18,opt,name=bufferConfig"` // Whether encrypt the data at rest, defaults to false - // Enabling encryption might impact the performace, see https://docs.nats.io/running-a-nats-service/nats_admin/jetstream_admin/encryption_at_rest for the detail + // Enabling encryption might impact the performance, see https://docs.nats.io/running-a-nats-service/nats_admin/jetstream_admin/encryption_at_rest for the detail // Toggling the value will impact encypting/decrypting existing messages. // +optional Encryption bool `json:"encryption,omitempty" protobuf:"bytes,19,opt,name=encryption"` // Whether enable TLS, defaults to false - // Enabling TLS might impact the performace + // Enabling TLS might impact the performance // +optional TLS bool `json:"tls,omitempty" protobuf:"bytes,20,opt,name=tls"` } diff --git a/pkg/isb/redis/read.go b/pkg/isb/redis/read.go index 05fec63071..8c09481e24 100644 --- a/pkg/isb/redis/read.go +++ b/pkg/isb/redis/read.go @@ -226,7 +226,7 @@ func (br *BufferRead) Read(_ context.Context, count int64) ([]*isb.ReadMessage, return messages, fmt.Errorf("XReadGroup failed, %w", err) } - // NOTE: If all messages have been delivered and acknowleged, the XREADGROUP 0-0 call returns an empty + // NOTE: If all messages have been delivered and acknowledged, the XREADGROUP 0-0 call returns an empty // list of messages in the stream. At this point we want to read everything from last delivered which would be > if len(xstreams) == 1 && len(xstreams[0].Messages) == 0 { br.log.Infow("We have delivered and acknowledged all PENDING msgs, setting checkBacklog to false") diff --git a/pkg/isb/redis/write.go b/pkg/isb/redis/write.go index 6783d2c328..c8c7353996 100644 --- a/pkg/isb/redis/write.go +++ b/pkg/isb/redis/write.go @@ -116,7 +116,7 @@ func (bw *BufferWrite) refreshWriteInfo(ctx context.Context) { } } -// trim is used to explicity call TRIM on buffer being full +// trim is used to explicitly call TRIM on buffer being full func (bw *BufferWrite) trim(_ context.Context) { ctx := clients.RedisContext bw.log.Infow("Explicit trim on MINID", zap.String("MINID", bw.minId.Load())) diff --git a/pkg/sources/kafka/metrics.go b/pkg/sources/kafka/metrics.go index 8594f26b97..a78e0fa25a 100644 --- a/pkg/sources/kafka/metrics.go +++ b/pkg/sources/kafka/metrics.go @@ -12,11 +12,11 @@ var kafkaSourceReadCount = promauto.NewCounterVec(prometheus.CounterOpts{ Help: "Total number of messages Read", }, []string{"vertex", "pipeline"}) -// kafkaSourceAckCount is used to indicate the number of messages Acknowleged +// kafkaSourceAckCount is used to indicate the number of messages Acknowledged var kafkaSourceAckCount = promauto.NewCounterVec(prometheus.CounterOpts{ Subsystem: "kafka_source", Name: "ack_total", - Help: "Total number of messages Acknowleged", + Help: "Total number of messages Acknowledged", }, []string{"vertex", "pipeline"}) // kafkaSourceOffsetAckErrors is used to indicate the number of errors while reading from kafka source with offsets