From a72828b32cd82ba49a31ff223e106789663e4c75 Mon Sep 17 00:00:00 2001 From: "Yaroslav O. Halchenko" Date: Thu, 8 May 2025 09:44:58 -0400 Subject: [PATCH 1/7] Add github action to codespell master on push and PRs Signed-off-by: Yaroslav O. Halchenko --- .github/workflows/codespell.yml | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .github/workflows/codespell.yml diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 0000000000..b026c855dd --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,25 @@ +# Codespell configuration is within .codespellrc +--- +name: Codespell + +on: + push: + branches: [master] + pull_request: + branches: [master] + +permissions: + contents: read + +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Annotate locations with typos + uses: codespell-project/codespell-problem-matcher@v1 + - name: Codespell + uses: codespell-project/actions-codespell@v2 From c520717eead78389e52127298d24f5bb1785e033 Mon Sep 17 00:00:00 2001 From: "Yaroslav O. Halchenko" Date: Thu, 8 May 2025 10:27:01 -0400 Subject: [PATCH 2/7] Use more descriptive "trigger" variable name instead of typo-close "ot" that would avoid triggering "codespell" Signed-off-by: Yaroslav O. Halchenko --- pkg/sensors/triggers/email/email_test.go | 32 ++++++++++++------------ pkg/sensors/triggers/slack/slack_test.go | 12 ++++----- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/pkg/sensors/triggers/email/email_test.go b/pkg/sensors/triggers/email/email_test.go index 702104a64f..0e8ad78473 100644 --- a/pkg/sensors/triggers/email/email_test.go +++ b/pkg/sensors/triggers/email/email_test.go @@ -75,15 +75,15 @@ func TestEmailTrigger_FetchResource(t *testing.T) { assert.Nil(t, err) assert.NotNil(t, resource) - ot, ok := resource.(*v1alpha1.EmailTrigger) + trigger, ok := resource.(*v1alpha1.EmailTrigger) assert.Equal(t, true, ok) - assert.Equal(t, "fake-host", ot.Host) - assert.Equal(t, int32(468), ot.Port) - assert.Equal(t, "fake-username", ot.Username) - assert.Equal(t, []string{"fake1@email.com", "fake2@email.com"}, ot.To) - assert.Equal(t, "fake-email", ot.From) - assert.Equal(t, "fake-subject", ot.Subject) - assert.Equal(t, "fake-body", ot.Body) + assert.Equal(t, "fake-host", trigger.Host) + assert.Equal(t, int32(468), trigger.Port) + assert.Equal(t, "fake-username", trigger.Username) + assert.Equal(t, []string{"fake1@email.com", "fake2@email.com"}, trigger.To) + assert.Equal(t, "fake-email", trigger.From) + assert.Equal(t, "fake-subject", trigger.Subject) + assert.Equal(t, "fake-body", trigger.Body) } func TestEmailTrigger_ApplyResourceParameters(t *testing.T) { @@ -125,15 +125,15 @@ func TestEmailTrigger_ApplyResourceParameters(t *testing.T) { assert.Nil(t, err) assert.NotNil(t, resource) - ot, ok := resource.(*v1alpha1.EmailTrigger) + trigger, ok := resource.(*v1alpha1.EmailTrigger) assert.Equal(t, true, ok) - assert.Equal(t, "fake-host", ot.Host) - assert.Equal(t, int32(468), ot.Port) - assert.Equal(t, "fake-username", ot.Username) - assert.Equal(t, []string{"real@email.com", "fake2@email.com"}, ot.To) - assert.Equal(t, "fake-email", ot.From) - assert.Equal(t, "fake-subject", ot.Subject) - assert.Equal(t, "Hi Luke,\n\tHello There.\nThanks,\nObi", ot.Body) + assert.Equal(t, "fake-host", trigger.Host) + assert.Equal(t, int32(468), trigger.Port) + assert.Equal(t, "fake-username", trigger.Username) + assert.Equal(t, []string{"real@email.com", "fake2@email.com"}, trigger.To) + assert.Equal(t, "fake-email", trigger.From) + assert.Equal(t, "fake-subject", trigger.Subject) + assert.Equal(t, "Hi Luke,\n\tHello There.\nThanks,\nObi", trigger.Body) } // Mock Notification Service that returns an error on Send diff --git a/pkg/sensors/triggers/slack/slack_test.go b/pkg/sensors/triggers/slack/slack_test.go index 8cc28ace73..77a3ca9696 100644 --- a/pkg/sensors/triggers/slack/slack_test.go +++ b/pkg/sensors/triggers/slack/slack_test.go @@ -69,10 +69,10 @@ func TestSlackTrigger_FetchResource(t *testing.T) { assert.Nil(t, err) assert.NotNil(t, resource) - ot, ok := resource.(*v1alpha1.SlackTrigger) + trigger, ok := resource.(*v1alpha1.SlackTrigger) assert.Equal(t, true, ok) - assert.Equal(t, "fake-channel", ot.Channel) - assert.Equal(t, "fake-message", ot.Message) + assert.Equal(t, "fake-channel", trigger.Channel) + assert.Equal(t, "fake-message", trigger.Message) } func TestSlackTrigger_ApplyResourceParameters(t *testing.T) { @@ -113,8 +113,8 @@ func TestSlackTrigger_ApplyResourceParameters(t *testing.T) { assert.Nil(t, err) assert.NotNil(t, resource) - ot, ok := resource.(*v1alpha1.SlackTrigger) + trigger, ok := resource.(*v1alpha1.SlackTrigger) assert.Equal(t, true, ok) - assert.Equal(t, "real-channel", ot.Channel) - assert.Equal(t, "real-message", ot.Message) + assert.Equal(t, "real-channel", trigger.Channel) + assert.Equal(t, "real-message", trigger.Message) } From 1ca08bbfc59a0cc0f9dadb5c00157f44a1bfccde Mon Sep 17 00:00:00 2001 From: "Yaroslav O. Halchenko" Date: Thu, 8 May 2025 09:44:58 -0400 Subject: [PATCH 3/7] Add rudimentary codespell config Signed-off-by: Yaroslav O. Halchenko --- .codespellrc | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .codespellrc diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 0000000000..63a9207ae1 --- /dev/null +++ b/.codespellrc @@ -0,0 +1,6 @@ +[codespell] +# Ref: https://github.com/codespell-project/codespell#using-a-config-file +skip = .git*,*.svg,go.sum,.codespellrc +check-hidden = true +ignore-regex = \bBui\b|"bu" +ignore-words-list = aks,ans,notin,oldes From 9e4c39f42a601616c2a9a91470c9acf568b6a71c Mon Sep 17 00:00:00 2001 From: "Yaroslav O. Halchenko" Date: Thu, 8 May 2025 10:28:19 -0400 Subject: [PATCH 4/7] ENH: add 'codespell' Makefile rule Signed-off-by: Yaroslav O. Halchenko --- Makefile | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Makefile b/Makefile index 2bcf509c1b..a9885f74ff 100644 --- a/Makefile +++ b/Makefile @@ -227,3 +227,7 @@ update-manifests-version: .PHONY: checksums checksums: sha256sum ./dist/$(BINARY_NAME)-*.gz | awk -F './dist/' '{print $$1 $$2}' > ./dist/$(BINARY_NAME)-checksums.txt + +.PHONY: codespell +codespell: + codespell From 1139d450004080c52076d339d1d6d83ae22b3d49 Mon Sep 17 00:00:00 2001 From: "Yaroslav O. Halchenko" Date: Thu, 8 May 2025 10:30:46 -0400 Subject: [PATCH 5/7] [DATALAD RUNCMD] run codespell throughout fixing typos automagically (but ignoring overall fail due to ambigous ones) === Do not change lines below === { "chain": [], "cmd": "codespell -w || :", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^ Signed-off-by: Yaroslav O. Halchenko --- CHANGELOG.md | 12 +++++----- api/jsonschema/schema.json | 24 +++++++++---------- api/openapi-spec/swagger.json | 24 +++++++++---------- docs/APIs.md | 8 +++---- docs/eventbus/kafka.md | 6 ++--- docs/eventsources/calendar-catch-up.md | 6 ++--- docs/eventsources/gcp-pubsub.md | 4 ++-- docs/eventsources/setup/azure-service-bus.md | 2 +- docs/quick_start.md | 2 +- docs/sensors/triggers/email-trigger.md | 6 ++--- examples/event-sources/gcp-pubsub.yaml | 2 +- examples/event-sources/resource.yaml | 2 +- examples/rbac/workflow-rbac.yaml | 2 +- examples/sensors/azure-events-hub.yaml | 2 +- hack/update-mocks.sh | 2 +- pkg/apis/events/openapi/openapi_generated.go | 6 ++--- pkg/apis/events/v1alpha1/const.go | 2 +- pkg/apis/events/v1alpha1/eventsource_types.go | 4 ++-- pkg/apis/events/v1alpha1/generated.proto | 6 ++--- pkg/apis/events/v1alpha1/nats_eventbus.go | 2 +- pkg/apis/events/v1alpha1/sensor_types.go | 2 +- pkg/apis/events/v1alpha1/status_types.go | 4 ++-- .../jetstream/sensor/sensor_jetstream.go | 4 ++-- pkg/eventbus/kafka/sensor/kafka_handler.go | 2 +- pkg/eventbus/stan/base/stan.go | 2 +- pkg/eventbus/stan/sensor/trigger_conn.go | 6 ++--- pkg/eventsources/common/naivewatcher/mutex.go | 2 +- pkg/eventsources/common/webhook/types.go | 2 +- pkg/eventsources/events/event-data.go | 2 +- pkg/eventsources/sources/amqp/start.go | 2 +- .../sources/azurequeuestorage/start.go | 2 +- pkg/eventsources/sources/gerrit/start.go | 4 ++-- pkg/eventsources/sources/gerrit/types.go | 8 +++---- pkg/eventsources/sources/gitlab/start.go | 4 ++-- pkg/eventsources/sources/webhook/start.go | 2 +- pkg/metrics/metrics.go | 2 +- pkg/reconciler/cmd/start.go | 2 +- pkg/reconciler/eventbus/installer/nats.go | 4 ++-- pkg/sensors/triggers/aws-lambda/aws-lambda.go | 2 +- pkg/shared/logging/logger.go | 2 +- test/e2e/functional_test.go | 4 ++-- 41 files changed, 94 insertions(+), 94 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bad2e77c7c..88cab9959b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -162,7 +162,7 @@ * [13028fcd](https://github.com/argoproj/argo-events/commit/13028fcd51914a470f2d7e560a7403154b0f1b9a) fix(ci): fix bunch of ci issues (#3292) * [20fd81fb](https://github.com/argoproj/argo-events/commit/20fd81fba02db85c848f52117eef0e6892ff4040) fix:eventsource crash on cast #3238 (#3282) * [789c91ea](https://github.com/argoproj/argo-events/commit/789c91ea48be591130f80afc5c0d906aafc70da3) chore(deps): bump github.com/aws/aws-sdk-go from v1.44.209 => v1.47.11 (#3261) - * [af54701c](https://github.com/argoproj/argo-events/commit/af54701c7a3ab88dca6b007f323c01d107467e96) Fix tuto exemple 02-parameterization/sensor-05.yaml (#3218) + * [af54701c](https://github.com/argoproj/argo-events/commit/af54701c7a3ab88dca6b007f323c01d107467e96) Fix tuto example 02-parameterization/sensor-05.yaml (#3218) * [8fb91d65](https://github.com/argoproj/argo-events/commit/8fb91d657c954560ac9c7b4cdc7ccde494c7731d) chore(deps): bump github.com/slack-go/slack from 0.13.0 to 0.13.1 (#3213) * [213a29ef](https://github.com/argoproj/argo-events/commit/213a29ef86d16f4fe6187933bc64a1f7f263f0f2) chore(deps): bump github.com/xanzy/go-gitlab from 0.106.0 to 0.107.0 (#3212) * [69f705a4](https://github.com/argoproj/argo-events/commit/69f705a4b07b7cbc1ac92ed83cfc77f64dd64204) chore(deps): bump github.com/minio/minio-go/v7 from 7.0.73 to 7.0.74 (#3211) @@ -1585,7 +1585,7 @@ * [6e976052](https://github.com/argoproj/argo-events/commit/6e97605216d15948dedb628cae4f6db1e62c33e7) chore(deps): bump github.com/aws/aws-sdk-go from 1.35.24 to 1.42.50 (#1617) * [ea5b5a5b](https://github.com/argoproj/argo-events/commit/ea5b5a5b12176b1adc0caccf40c1800f9beb7e3f) feat (kafa-es): Implements SCRAM functionality and enables SCRAM-SHA512/256 SASL * [097e87d8](https://github.com/argoproj/argo-events/commit/097e87d8c7e6db7e1036f0159041230fe15bb834) chore(deps): bump actions/setup-go from 2.1.5 to 2.2.0 (#1609) - * [8bea0754](https://github.com/argoproj/argo-events/commit/8bea07540a4541fd51979efe351997fde5c57887) fix: Garabge collection of the ValidatingWebhookConfiguration (#1603) + * [8bea0754](https://github.com/argoproj/argo-events/commit/8bea07540a4541fd51979efe351997fde5c57887) fix: Garbage collection of the ValidatingWebhookConfiguration (#1603) * [54fb550a](https://github.com/argoproj/argo-events/commit/54fb550a080c6ecba73a8bf3ea3b851de6e535b7) chore(deps): bump github.com/eclipse/paho.mqtt.golang (#1570) * [968bddf7](https://github.com/argoproj/argo-events/commit/968bddf77ecba154bb9187a176eb6b35294c9500) chore(deps): bump github.com/go-swagger/go-swagger from 0.25.0 to 0.29.0 (#1555) * [993fb2d1](https://github.com/argoproj/argo-events/commit/993fb2d12e2c69d709d4d33e850768e5ae6ef4a4) username, password authentication doesn't work when AMQPLAIN authentication mechanism is used; instead using PLAIN mechanism: apparently the former is non-standard according to https://www.rabbitmq.com/access-control.html (#1600) @@ -1768,7 +1768,7 @@ * [55a992be](https://github.com/argoproj/argo-events/commit/55a992bed084c7921a87ae1ab434fe995df4f987) fix: correct field name in error message (#1317) * [feeaf5d0](https://github.com/argoproj/argo-events/commit/feeaf5d0420f6949ccaf1904a8dcd58c65a176ac) feat: add eventsource support for Bitbucket Server. Fixes #891 (#1223) * [bd737904](https://github.com/argoproj/argo-events/commit/bd7379042ce2172f9e29f5bb3af6c3f44da7e1d5) fix: Upgrade pkg to v0.10.1 (#1305) - * [c6725a9f](https://github.com/argoproj/argo-events/commit/c6725a9fa313ea29afc19687cb1d102244362cc8) feat(eventsource): gitlab to support mutiple projects (#1297) + * [c6725a9f](https://github.com/argoproj/argo-events/commit/c6725a9fa313ea29afc19687cb1d102244362cc8) feat(eventsource): gitlab to support multiple projects (#1297) * [d19cb22c](https://github.com/argoproj/argo-events/commit/d19cb22c4b67dcd993c362b9c6310f29b035037a) fix(docs): add missing dataKey for examples (#1286) * [181198ae](https://github.com/argoproj/argo-events/commit/181198aeb4c220bddbb64df1dc2a107a64c08976) docs(users): Add WooliesX (#1281) * [fa60ca0c](https://github.com/argoproj/argo-events/commit/fa60ca0c854991b41924416054e51b1e3f86784c) fix trigger dependencies yaml (#1276) @@ -2156,7 +2156,7 @@ * [6f26ae99](https://github.com/argoproj/argo-events/commit/6f26ae999bfd75e3582d9b558d72560f86e5664c) fix: azure eventsource (#789) * [adee1b5b](https://github.com/argoproj/argo-events/commit/adee1b5b2c18c26a176352fd8cabdf451801a5d2) fix: Added/fixed tolerations for CRDs (#787) * [527a45fa](https://github.com/argoproj/argo-events/commit/527a45fa661c4c6d8315a170225e724f26582d44) fix: switch slack lib and stop using deprecated APIs. Fixes #726 (#777) - * [c57bdb69](https://github.com/argoproj/argo-events/commit/c57bdb69926e9156c1af5f7c1f3fb340fac0c1fa) feat: Support re-using existing subscription ID for gcp pubsub (#778) + * [c57bdb69](https://github.com/argoproj/argo-events/commit/c57bdb69926e9156c1af5f7c1f3fb340fac0c1fa) feat: Support reusing existing subscription ID for gcp pubsub (#778) * [1cf98ab4](https://github.com/argoproj/argo-events/commit/1cf98ab45ad1ae189da7a89fd453252f0e8e890b) feat: pulsar event source (#774) * [21f4360f](https://github.com/argoproj/argo-events/commit/21f4360fcfbb97c00fae881f9bd1a9096bac8d6c) feat: Expose metadata for sensors and fix metadata for eventsources (#773) * [c911103d](https://github.com/argoproj/argo-events/commit/c911103db12855147985cff33bb67d0c1c5f9a43) fix(manifests): Fixed namespace in kustomization files (#772) @@ -2188,7 +2188,7 @@ * [2f027680](https://github.com/argoproj/argo-events/commit/2f027680621e8d7696a917764fd12519c757025e) feat: Merge Gateway and EventSource (#735) * [071aedb7](https://github.com/argoproj/argo-events/commit/071aedb71cae0b197a70651384e45c76c476afa2) Updated the sensor base dockerimage to fix vulnerabilities (#731) * [4e8cf29d](https://github.com/argoproj/argo-events/commit/4e8cf29dfe17cae6e9c8b7f119fe81c3abd4aa4a) feat: Sensor-controller and Sensor re-implementation (#723) - * [9a62f30a](https://github.com/argoproj/argo-events/commit/9a62f30a17f966ad44376eec96f6d02241f9fee2) use json log formatter if stdout isnt tty (#699) + * [9a62f30a](https://github.com/argoproj/argo-events/commit/9a62f30a17f966ad44376eec96f6d02241f9fee2) use json log formatter if stdout isn't tty (#699) * [693e2109](https://github.com/argoproj/argo-events/commit/693e2109d33d152175cb38dc63198b9517a2032d) fix: Fix kafka gateway (#704) * [500df0ac](https://github.com/argoproj/argo-events/commit/500df0ac9ffcaaf3e67dd9c5cf691e6be931c931) feat: Replace gatewayName with eventSourceName in Sensor dependencies (#687) * [6aabc5a8](https://github.com/argoproj/argo-events/commit/6aabc5a8905b97a459be7d4a3d96f9f6bd2cdcf6) fix: Updated common.Status to inheritance (#708) @@ -2643,7 +2643,7 @@ ## v0.8 (2019-02-27) * [d5c4871c](https://github.com/argoproj/argo-events/commit/d5c4871c896be955a3e7a70f781acc295be62461) Fix typo in resource-gateway doc (#173) - * [212979c1](https://github.com/argoproj/argo-events/commit/212979c16d20f39e597f5a62def8cfd060f34cb6) modify instalation link (#182) + * [212979c1](https://github.com/argoproj/argo-events/commit/212979c16d20f39e597f5a62def8cfd060f34cb6) modify installation link (#182) * [506cc70a](https://github.com/argoproj/argo-events/commit/506cc70a3b0c851a37e357e3501d06251261aa33) Allow to overwrite variables in Makefile (#181) * [72fc6f2f](https://github.com/argoproj/argo-events/commit/72fc6f2ffe71e0f8a7de0d5dedf4b836a79815f8) Slack gateway (#177) * [e0242e7b](https://github.com/argoproj/argo-events/commit/e0242e7b00f7edc7e0cff314abd3a728ddf3c62b) Update README.md (#179) diff --git a/api/jsonschema/schema.json b/api/jsonschema/schema.json index b0fe278f7f..bfd25926bc 100644 --- a/api/jsonschema/schema.json +++ b/api/jsonschema/schema.json @@ -2752,7 +2752,7 @@ "properties": { "basic": { "$ref": "#/definitions/io.argoproj.events.v1alpha1.BasicAuth", - "description": "Baisc auth with username and password" + "description": "Basic auth with username and password" }, "credential": { "$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector", @@ -3518,7 +3518,7 @@ "description": "If resource is created before the specified time then the event is treated as valid." }, "fields": { - "description": "Fields provide field filters similar to K8s field selector (see https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/). Unlike K8s field selector, it supports arbitrary fileds like \"spec.serviceAccountName\", and the value could be a string or a regex. Same as K8s field selector, operator \"=\", \"==\" and \"!=\" are supported.", + "description": "Fields provide field filters similar to K8s field selector (see https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/). Unlike K8s field selector, it supports arbitrary fields like \"spec.serviceAccountName\", and the value could be a string or a regex. Same as K8s field selector, operator \"=\", \"==\" and \"!=\" are supported.", "items": { "$ref": "#/definitions/io.argoproj.events.v1alpha1.Selector" }, @@ -4518,7 +4518,7 @@ "type": "string" }, "conditionsReset": { - "description": "Criteria to reset the conditons", + "description": "Criteria to reset the conditions", "items": { "$ref": "#/definitions/io.argoproj.events.v1alpha1.ConditionsResetCriteria" }, @@ -5177,7 +5177,7 @@ ] }, "io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyBinding": { - "description": "ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with paramerized resources. ValidatingAdmissionPolicyBinding and parameter CRDs together define how cluster administrators configure policies for clusters.\n\nFor a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don't use params, otherwise N is the number of parameters selected by the binding.\n\nThe CEL expressions of a policy must have a computed CEL cost below the maximum CEL budget. Each evaluation of the policy is given an independent CEL cost budget. Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget.", + "description": "ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with parameterized resources. ValidatingAdmissionPolicyBinding and parameter CRDs together define how cluster administrators configure policies for clusters.\n\nFor a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don't use params, otherwise N is the number of parameters selected by the binding.\n\nThe CEL expressions of a policy must have a computed CEL cost below the maximum CEL budget. Each evaluation of the policy is given an independent CEL cost budget. Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget.", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", @@ -6220,7 +6220,7 @@ ] }, "io.k8s.api.admissionregistration.v1beta1.ValidatingAdmissionPolicyBinding": { - "description": "ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with paramerized resources. ValidatingAdmissionPolicyBinding and parameter CRDs together define how cluster administrators configure policies for clusters.\n\nFor a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don't use params, otherwise N is the number of parameters selected by the binding.\n\nThe CEL expressions of a policy must have a computed CEL cost below the maximum CEL budget. Each evaluation of the policy is given an independent CEL cost budget. Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget.", + "description": "ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with parameterized resources. ValidatingAdmissionPolicyBinding and parameter CRDs together define how cluster administrators configure policies for clusters.\n\nFor a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don't use params, otherwise N is the number of parameters selected by the binding.\n\nThe CEL expressions of a policy must have a computed CEL cost below the maximum CEL budget. Each evaluation of the policy is given an independent CEL cost budget. Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget.", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", @@ -7329,7 +7329,7 @@ "properties": { "maxSurge": { "$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString", - "description": "The maximum number of nodes with an existing available DaemonSet pod that can have an updated DaemonSet pod during during an update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up to a minimum of 1. Default value is 0. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their a new pod created before the old pod is marked as deleted. The update starts by launching new pods on 30% of nodes. Once an updated pod is available (Ready for at least minReadySeconds) the old DaemonSet pod on that node is marked deleted. If the old pod becomes unavailable for any reason (Ready transitions to false, is evicted, or is drained) an updated pod is immediatedly created on that node without considering surge limits. Allowing surge implies the possibility that the resources consumed by the daemonset on any given node can double if the readiness check fails, and so resource intensive daemonsets should take into account that they may cause evictions during disruption." + "description": "The maximum number of nodes with an existing available DaemonSet pod that can have an updated DaemonSet pod during during an update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up to a minimum of 1. Default value is 0. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their a new pod created before the old pod is marked as deleted. The update starts by launching new pods on 30% of nodes. Once an updated pod is available (Ready for at least minReadySeconds) the old DaemonSet pod on that node is marked deleted. If the old pod becomes unavailable for any reason (Ready transitions to false, is evicted, or is drained) an updated pod is immediately created on that node without considering surge limits. Allowing surge implies the possibility that the resources consumed by the daemonset on any given node can double if the readiness check fails, and so resource intensive daemonsets should take into account that they may cause evictions during disruption." }, "maxUnavailable": { "$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString", @@ -7732,7 +7732,7 @@ "description": "TokenRequestSpec contains client provided parameters of a token request.", "properties": { "audiences": { - "description": "Audiences are the intendend audiences of the token. A recipient of a token must identify themself with an identifier in the list of audiences of the token, and otherwise should reject the token. A token issued for multiple audiences may be used to authenticate against any of the audiences listed but implies a high degree of trust between the target audiences.", + "description": "Audiences are the intended audiences of the token. A recipient of a token must identify themself with an identifier in the list of audiences of the token, and otherwise should reject the token. A token issued for multiple audiences may be used to authenticate against any of the audiences listed but implies a high degree of trust between the target audiences.", "items": { "type": "string" }, @@ -13886,7 +13886,7 @@ "properties": { "lastPhaseTransitionTime": { "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time", - "description": "lastPhaseTransitionTime is the time the phase transitioned from one to another and automatically resets to current time everytime a volume phase transitions." + "description": "lastPhaseTransitionTime is the time the phase transitioned from one to another and automatically resets to current time every time a volume phase transitions." }, "message": { "description": "message is a human-readable message indicating details about why the volume is in this state.", @@ -19568,7 +19568,7 @@ "description": "DeviceClassSpec is used in a [DeviceClass] to define what can be allocated and how to configure it.", "properties": { "config": { - "description": "Config defines configuration parameters that apply to each device that is claimed via this class. Some classses may potentially be satisfied by multiple drivers, so each instance of a vendor configuration applies to exactly one driver.\n\nThey are passed to the driver, but are not considered while allocating the claim.", + "description": "Config defines configuration parameters that apply to each device that is claimed via this class. Some classes may potentially be satisfied by multiple drivers, so each instance of a vendor configuration applies to exactly one driver.\n\nThey are passed to the driver, but are not considered while allocating the claim.", "items": { "$ref": "#/definitions/io.k8s.api.resource.v1alpha3.DeviceClassConfiguration" }, @@ -20401,7 +20401,7 @@ "description": "DeviceClassSpec is used in a [DeviceClass] to define what can be allocated and how to configure it.", "properties": { "config": { - "description": "Config defines configuration parameters that apply to each device that is claimed via this class. Some classses may potentially be satisfied by multiple drivers, so each instance of a vendor configuration applies to exactly one driver.\n\nThey are passed to the driver, but are not considered while allocating the claim.", + "description": "Config defines configuration parameters that apply to each device that is claimed via this class. Some classes may potentially be satisfied by multiple drivers, so each instance of a vendor configuration applies to exactly one driver.\n\nThey are passed to the driver, but are not considered while allocating the claim.", "items": { "$ref": "#/definitions/io.k8s.api.resource.v1beta1.DeviceClassConfiguration" }, @@ -22497,7 +22497,7 @@ "description": "SelectableField specifies the JSON path of a field that may be used with field selectors.", "properties": { "jsonPath": { - "description": "jsonPath is a simple JSON path which is evaluated against each custom resource to produce a field selector value. Only JSON paths without the array notation are allowed. Must point to a field of type string, boolean or integer. Types with enum values and strings with formats are allowed. If jsonPath refers to absent field in a resource, the jsonPath evaluates to an empty string. Must not point to metdata fields. Required.", + "description": "jsonPath is a simple JSON path which is evaluated against each custom resource to produce a field selector value. Only JSON paths without the array notation are allowed. Must point to a field of type string, boolean or integer. Types with enum values and strings with formats are allowed. If jsonPath refers to absent field in a resource, the jsonPath evaluates to an empty string. Must not point to metadata fields. Required.", "type": "string" } }, @@ -22607,7 +22607,7 @@ "type": "object" }, "io.k8s.apimachinery.pkg.api.resource.Quantity": { - "description": "Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.\n\nThe serialization format is:\n\n``` \u003cquantity\u003e ::= \u003csignedNumber\u003e\u003csuffix\u003e\n\n\t(Note that \u003csuffix\u003e may be empty, from the \"\" case in \u003cdecimalSI\u003e.)\n\n\u003cdigit\u003e ::= 0 | 1 | ... | 9 \u003cdigits\u003e ::= \u003cdigit\u003e | \u003cdigit\u003e\u003cdigits\u003e \u003cnumber\u003e ::= \u003cdigits\u003e | \u003cdigits\u003e.\u003cdigits\u003e | \u003cdigits\u003e. | .\u003cdigits\u003e \u003csign\u003e ::= \"+\" | \"-\" \u003csignedNumber\u003e ::= \u003cnumber\u003e | \u003csign\u003e\u003cnumber\u003e \u003csuffix\u003e ::= \u003cbinarySI\u003e | \u003cdecimalExponent\u003e | \u003cdecimalSI\u003e \u003cbinarySI\u003e ::= Ki | Mi | Gi | Ti | Pi | Ei\n\n\t(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)\n\n\u003cdecimalSI\u003e ::= m | \"\" | k | M | G | T | P | E\n\n\t(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)\n\n\u003cdecimalExponent\u003e ::= \"e\" \u003csignedNumber\u003e | \"E\" \u003csignedNumber\u003e ```\n\nNo matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.\n\nWhen a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.\n\nBefore serializing, Quantity will be put in \"canonical form\". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:\n\n- No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.\n\nThe sign will be omitted unless the number is negative.\n\nExamples:\n\n- 1.5 will be serialized as \"1500m\" - 1.5Gi will be serialized as \"1536Mi\"\n\nNote that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.\n\nNon-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)\n\nThis format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.", + "description": "Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.\n\nThe serialization format is:\n\n``` \u003cquantity\u003e ::= \u003csignedNumber\u003e\u003csuffix\u003e\n\n\t(Note that \u003csuffix\u003e may be empty, from the \"\" case in \u003cdecimalSI\u003e.)\n\n\u003cdigit\u003e ::= 0 | 1 | ... | 9 \u003cdigits\u003e ::= \u003cdigit\u003e | \u003cdigit\u003e\u003cdigits\u003e \u003cnumber\u003e ::= \u003cdigits\u003e | \u003cdigits\u003e.\u003cdigits\u003e | \u003cdigits\u003e. | .\u003cdigits\u003e \u003csign\u003e ::= \"+\" | \"-\" \u003csignedNumber\u003e ::= \u003cnumber\u003e | \u003csign\u003e\u003cnumber\u003e \u003csuffix\u003e ::= \u003cbinarySI\u003e | \u003cdecimalExponent\u003e | \u003cdecimalSI\u003e \u003cbinarySI\u003e ::= Ki | Mi | Gi | Ti | Pi | Ei\n\n\t(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)\n\n\u003cdecimalSI\u003e ::= m | \"\" | k | M | G | T | P | E\n\n\t(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)\n\n\u003cdecimalExponent\u003e ::= \"e\" \u003csignedNumber\u003e | \"E\" \u003csignedNumber\u003e ```\n\nNo matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.\n\nWhen a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.\n\nBefore serializing, Quantity will be put in \"canonical form\". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:\n\n- No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.\n\nThe sign will be omitted unless the number is negative.\n\nExamples:\n\n- 1.5 will be serialized as \"1500m\" - 1.5Gi will be serialized as \"1536Mi\"\n\nNote that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.\n\nNon-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)\n\nThis format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementers to also use a fixed point implementation.", "type": "string" }, "io.k8s.apimachinery.pkg.apis.meta.v1.APIGroup": { diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json index 4ae468fa35..ada1caec6b 100644 --- a/api/openapi-spec/swagger.json +++ b/api/openapi-spec/swagger.json @@ -2735,7 +2735,7 @@ "type": "object", "properties": { "basic": { - "description": "Baisc auth with username and password", + "description": "Basic auth with username and password", "$ref": "#/definitions/io.argoproj.events.v1alpha1.BasicAuth" }, "credential": { @@ -3502,7 +3502,7 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time" }, "fields": { - "description": "Fields provide field filters similar to K8s field selector (see https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/). Unlike K8s field selector, it supports arbitrary fileds like \"spec.serviceAccountName\", and the value could be a string or a regex. Same as K8s field selector, operator \"=\", \"==\" and \"!=\" are supported.", + "description": "Fields provide field filters similar to K8s field selector (see https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/). Unlike K8s field selector, it supports arbitrary fields like \"spec.serviceAccountName\", and the value could be a string or a regex. Same as K8s field selector, operator \"=\", \"==\" and \"!=\" are supported.", "type": "array", "items": { "$ref": "#/definitions/io.argoproj.events.v1alpha1.Selector" @@ -4496,7 +4496,7 @@ "type": "string" }, "conditionsReset": { - "description": "Criteria to reset the conditons", + "description": "Criteria to reset the conditions", "type": "array", "items": { "$ref": "#/definitions/io.argoproj.events.v1alpha1.ConditionsResetCriteria" @@ -5151,7 +5151,7 @@ ] }, "io.k8s.api.admissionregistration.v1.ValidatingAdmissionPolicyBinding": { - "description": "ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with paramerized resources. ValidatingAdmissionPolicyBinding and parameter CRDs together define how cluster administrators configure policies for clusters.\n\nFor a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don't use params, otherwise N is the number of parameters selected by the binding.\n\nThe CEL expressions of a policy must have a computed CEL cost below the maximum CEL budget. Each evaluation of the policy is given an independent CEL cost budget. Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget.", + "description": "ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with parameterized resources. ValidatingAdmissionPolicyBinding and parameter CRDs together define how cluster administrators configure policies for clusters.\n\nFor a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don't use params, otherwise N is the number of parameters selected by the binding.\n\nThe CEL expressions of a policy must have a computed CEL cost below the maximum CEL budget. Each evaluation of the policy is given an independent CEL cost budget. Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget.", "type": "object", "properties": { "apiVersion": { @@ -6194,7 +6194,7 @@ ] }, "io.k8s.api.admissionregistration.v1beta1.ValidatingAdmissionPolicyBinding": { - "description": "ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with paramerized resources. ValidatingAdmissionPolicyBinding and parameter CRDs together define how cluster administrators configure policies for clusters.\n\nFor a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don't use params, otherwise N is the number of parameters selected by the binding.\n\nThe CEL expressions of a policy must have a computed CEL cost below the maximum CEL budget. Each evaluation of the policy is given an independent CEL cost budget. Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget.", + "description": "ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with parameterized resources. ValidatingAdmissionPolicyBinding and parameter CRDs together define how cluster administrators configure policies for clusters.\n\nFor a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don't use params, otherwise N is the number of parameters selected by the binding.\n\nThe CEL expressions of a policy must have a computed CEL cost below the maximum CEL budget. Each evaluation of the policy is given an independent CEL cost budget. Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget.", "type": "object", "properties": { "apiVersion": { @@ -7303,7 +7303,7 @@ "type": "object", "properties": { "maxSurge": { - "description": "The maximum number of nodes with an existing available DaemonSet pod that can have an updated DaemonSet pod during during an update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up to a minimum of 1. Default value is 0. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their a new pod created before the old pod is marked as deleted. The update starts by launching new pods on 30% of nodes. Once an updated pod is available (Ready for at least minReadySeconds) the old DaemonSet pod on that node is marked deleted. If the old pod becomes unavailable for any reason (Ready transitions to false, is evicted, or is drained) an updated pod is immediatedly created on that node without considering surge limits. Allowing surge implies the possibility that the resources consumed by the daemonset on any given node can double if the readiness check fails, and so resource intensive daemonsets should take into account that they may cause evictions during disruption.", + "description": "The maximum number of nodes with an existing available DaemonSet pod that can have an updated DaemonSet pod during during an update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up to a minimum of 1. Default value is 0. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their a new pod created before the old pod is marked as deleted. The update starts by launching new pods on 30% of nodes. Once an updated pod is available (Ready for at least minReadySeconds) the old DaemonSet pod on that node is marked deleted. If the old pod becomes unavailable for any reason (Ready transitions to false, is evicted, or is drained) an updated pod is immediately created on that node without considering surge limits. Allowing surge implies the possibility that the resources consumed by the daemonset on any given node can double if the readiness check fails, and so resource intensive daemonsets should take into account that they may cause evictions during disruption.", "$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString" }, "maxUnavailable": { @@ -7710,7 +7710,7 @@ ], "properties": { "audiences": { - "description": "Audiences are the intendend audiences of the token. A recipient of a token must identify themself with an identifier in the list of audiences of the token, and otherwise should reject the token. A token issued for multiple audiences may be used to authenticate against any of the audiences listed but implies a high degree of trust between the target audiences.", + "description": "Audiences are the intended audiences of the token. A recipient of a token must identify themself with an identifier in the list of audiences of the token, and otherwise should reject the token. A token issued for multiple audiences may be used to authenticate against any of the audiences listed but implies a high degree of trust between the target audiences.", "type": "array", "items": { "type": "string" @@ -13860,7 +13860,7 @@ "type": "object", "properties": { "lastPhaseTransitionTime": { - "description": "lastPhaseTransitionTime is the time the phase transitioned from one to another and automatically resets to current time everytime a volume phase transitions.", + "description": "lastPhaseTransitionTime is the time the phase transitioned from one to another and automatically resets to current time every time a volume phase transitions.", "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time" }, "message": { @@ -19543,7 +19543,7 @@ "type": "object", "properties": { "config": { - "description": "Config defines configuration parameters that apply to each device that is claimed via this class. Some classses may potentially be satisfied by multiple drivers, so each instance of a vendor configuration applies to exactly one driver.\n\nThey are passed to the driver, but are not considered while allocating the claim.", + "description": "Config defines configuration parameters that apply to each device that is claimed via this class. Some classes may potentially be satisfied by multiple drivers, so each instance of a vendor configuration applies to exactly one driver.\n\nThey are passed to the driver, but are not considered while allocating the claim.", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.resource.v1alpha3.DeviceClassConfiguration" @@ -20376,7 +20376,7 @@ "type": "object", "properties": { "config": { - "description": "Config defines configuration parameters that apply to each device that is claimed via this class. Some classses may potentially be satisfied by multiple drivers, so each instance of a vendor configuration applies to exactly one driver.\n\nThey are passed to the driver, but are not considered while allocating the claim.", + "description": "Config defines configuration parameters that apply to each device that is claimed via this class. Some classes may potentially be satisfied by multiple drivers, so each instance of a vendor configuration applies to exactly one driver.\n\nThey are passed to the driver, but are not considered while allocating the claim.", "type": "array", "items": { "$ref": "#/definitions/io.k8s.api.resource.v1beta1.DeviceClassConfiguration" @@ -22475,7 +22475,7 @@ ], "properties": { "jsonPath": { - "description": "jsonPath is a simple JSON path which is evaluated against each custom resource to produce a field selector value. Only JSON paths without the array notation are allowed. Must point to a field of type string, boolean or integer. Types with enum values and strings with formats are allowed. If jsonPath refers to absent field in a resource, the jsonPath evaluates to an empty string. Must not point to metdata fields. Required.", + "description": "jsonPath is a simple JSON path which is evaluated against each custom resource to produce a field selector value. Only JSON paths without the array notation are allowed. Must point to a field of type string, boolean or integer. Types with enum values and strings with formats are allowed. If jsonPath refers to absent field in a resource, the jsonPath evaluates to an empty string. Must not point to metadata fields. Required.", "type": "string" } } @@ -22581,7 +22581,7 @@ } }, "io.k8s.apimachinery.pkg.api.resource.Quantity": { - "description": "Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.\n\nThe serialization format is:\n\n``` \u003cquantity\u003e ::= \u003csignedNumber\u003e\u003csuffix\u003e\n\n\t(Note that \u003csuffix\u003e may be empty, from the \"\" case in \u003cdecimalSI\u003e.)\n\n\u003cdigit\u003e ::= 0 | 1 | ... | 9 \u003cdigits\u003e ::= \u003cdigit\u003e | \u003cdigit\u003e\u003cdigits\u003e \u003cnumber\u003e ::= \u003cdigits\u003e | \u003cdigits\u003e.\u003cdigits\u003e | \u003cdigits\u003e. | .\u003cdigits\u003e \u003csign\u003e ::= \"+\" | \"-\" \u003csignedNumber\u003e ::= \u003cnumber\u003e | \u003csign\u003e\u003cnumber\u003e \u003csuffix\u003e ::= \u003cbinarySI\u003e | \u003cdecimalExponent\u003e | \u003cdecimalSI\u003e \u003cbinarySI\u003e ::= Ki | Mi | Gi | Ti | Pi | Ei\n\n\t(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)\n\n\u003cdecimalSI\u003e ::= m | \"\" | k | M | G | T | P | E\n\n\t(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)\n\n\u003cdecimalExponent\u003e ::= \"e\" \u003csignedNumber\u003e | \"E\" \u003csignedNumber\u003e ```\n\nNo matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.\n\nWhen a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.\n\nBefore serializing, Quantity will be put in \"canonical form\". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:\n\n- No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.\n\nThe sign will be omitted unless the number is negative.\n\nExamples:\n\n- 1.5 will be serialized as \"1500m\" - 1.5Gi will be serialized as \"1536Mi\"\n\nNote that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.\n\nNon-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)\n\nThis format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.", + "description": "Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.\n\nThe serialization format is:\n\n``` \u003cquantity\u003e ::= \u003csignedNumber\u003e\u003csuffix\u003e\n\n\t(Note that \u003csuffix\u003e may be empty, from the \"\" case in \u003cdecimalSI\u003e.)\n\n\u003cdigit\u003e ::= 0 | 1 | ... | 9 \u003cdigits\u003e ::= \u003cdigit\u003e | \u003cdigit\u003e\u003cdigits\u003e \u003cnumber\u003e ::= \u003cdigits\u003e | \u003cdigits\u003e.\u003cdigits\u003e | \u003cdigits\u003e. | .\u003cdigits\u003e \u003csign\u003e ::= \"+\" | \"-\" \u003csignedNumber\u003e ::= \u003cnumber\u003e | \u003csign\u003e\u003cnumber\u003e \u003csuffix\u003e ::= \u003cbinarySI\u003e | \u003cdecimalExponent\u003e | \u003cdecimalSI\u003e \u003cbinarySI\u003e ::= Ki | Mi | Gi | Ti | Pi | Ei\n\n\t(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)\n\n\u003cdecimalSI\u003e ::= m | \"\" | k | M | G | T | P | E\n\n\t(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)\n\n\u003cdecimalExponent\u003e ::= \"e\" \u003csignedNumber\u003e | \"E\" \u003csignedNumber\u003e ```\n\nNo matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.\n\nWhen a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.\n\nBefore serializing, Quantity will be put in \"canonical form\". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:\n\n- No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.\n\nThe sign will be omitted unless the number is negative.\n\nExamples:\n\n- 1.5 will be serialized as \"1500m\" - 1.5Gi will be serialized as \"1536Mi\"\n\nNote that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.\n\nNon-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)\n\nThis format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementers to also use a fixed point implementation.", "type": "string" }, "io.k8s.apimachinery.pkg.apis.meta.v1.APIGroup": { diff --git a/docs/APIs.md b/docs/APIs.md index 8025ae219f..fd489f3eb0 100644 --- a/docs/APIs.md +++ b/docs/APIs.md @@ -1533,7 +1533,7 @@ AuthStrategy (string alias)

-AuthStrategy is the auth strategy of native nats installaion +AuthStrategy is the auth strategy of native nats installation

@@ -13241,7 +13241,7 @@ BasicAuth (Optional)

-Baisc auth with username and password +Basic auth with username and password

@@ -16779,7 +16779,7 @@ value1,value2. Same as K8s label selector, operator “=”, “==”, “!=”, Fields provide field filters similar to K8s field selector (see https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/). -Unlike K8s field selector, it supports arbitrary fileds like +Unlike K8s field selector, it supports arbitrary fields like “spec.serviceAccountName”, and the value could be a string or a regex. Same as K8s field selector, operator “=”, “==” and “!=” are supported.

@@ -21697,7 +21697,7 @@ Pulsar refers to the trigger designed to place messages on Pulsar topic. (Optional)

-Criteria to reset the conditons +Criteria to reset the conditions

diff --git a/docs/eventbus/kafka.md b/docs/eventbus/kafka.md index 33c836ee98..583d6ebf45 100644 --- a/docs/eventbus/kafka.md +++ b/docs/eventbus/kafka.md @@ -26,7 +26,7 @@ for the full specification. ### url -Comma seperated list of kafka broker urls, the kafka broker must be managed +Comma separated list of kafka broker urls, the kafka broker must be managed independently of Argo Events. ### topic @@ -90,7 +90,7 @@ When starting up a new group do we want to start from the oldest event You can enable TLS or SASL authentication, see above for configuration details. You must enable these features in your Kafka Cluster and make -the certifactes/credentials available in a Kubernetes secret. +the certificates/credentials available in a Kubernetes secret. ## Topics @@ -123,7 +123,7 @@ named as follows. ## Horizontal Scaling and Leader Election -Sensors that use a Kafka EventBus can scale horizontally. Specifiying replicas +Sensors that use a Kafka EventBus can scale horizontally. Specifying replicas greater than one will result in all Sensor pods actively processing events. However, an EventSource that uses a Kafka EventBus cannot necessarily be horizontally scaled in an active-active manner, see [EventSource HA](../eventsources/ha.md) diff --git a/docs/eventsources/calendar-catch-up.md b/docs/eventsources/calendar-catch-up.md index 222a834c6f..ba90786590 100644 --- a/docs/eventsources/calendar-catch-up.md +++ b/docs/eventsources/calendar-catch-up.md @@ -1,6 +1,6 @@ -# Calender EventSource Catch Up +# Calendar EventSource Catch Up -Catch-up feature allow Calender eventsources to execute the missed schedules +Catch-up feature allow Calendar eventsources to execute the missed schedules from last run. ## Enable Catch-up for Calendar EventSource @@ -28,7 +28,7 @@ spec: name: test-configmap ``` -Last calender event persisted in configured configmap. Same configmap can be +Last calendar event persisted in configured configmap. Same configmap can be used by multiple events configuration. ```yaml diff --git a/docs/eventsources/gcp-pubsub.md b/docs/eventsources/gcp-pubsub.md index cb7ab72f94..e64ceff18e 100644 --- a/docs/eventsources/gcp-pubsub.md +++ b/docs/eventsources/gcp-pubsub.md @@ -10,10 +10,10 @@ combination. | ----------------------- | ------------------------ | --------------------------------------------------------------------- | | Yes/Yes | Yes/Yes | Validate if given topic matches subscription's topic | | Yes/Yes | Yes/No | Create a subscription with given ID | -| Yes/Yes | No/- | Create or re-use subscription with auto generated subID | +| Yes/Yes | No/- | Create or reuse subscription with auto generated subID | | Yes/No | Yes/No | Create a topic and a subscription with given subID | | Yes/No | Yes/Yes | Invalid | -| Yes/No | No/- | Create a topic, create or re-use subscription w/ auto generated subID | +| Yes/No | No/- | Create a topic, create or reuse subscription w/ auto generated subID | | No/- | Yes/Yes | OK | | No/- | Yes/No | Invalid | diff --git a/docs/eventsources/setup/azure-service-bus.md b/docs/eventsources/setup/azure-service-bus.md index 8200d8bd5f..2302f3c382 100644 --- a/docs/eventsources/setup/azure-service-bus.md +++ b/docs/eventsources/setup/azure-service-bus.md @@ -1,6 +1,6 @@ # Azure Service Bus -Service Bus event-source allows you to consume messages from queus and topics in Azure Service Bus and helps sensor trigger workflows. +Service Bus event-source allows you to consume messages from queues and topics in Azure Service Bus and helps sensor trigger workflows. ## Event Structure diff --git a/docs/quick_start.md b/docs/quick_start.md index a878d61b9d..6774d6f0df 100644 --- a/docs/quick_start.md +++ b/docs/quick_start.md @@ -5,7 +5,7 @@ We are going to set up a sensor and event-source for webhook. The goal is to tri Note: You will need to have [Argo Workflows](https://argoproj.github.io/argo-workflows/) installed to make this work. The Argo Workflow controller will need to be configured to listen for Workflow objects created in `argo-events` namespace. (See [this](https://github.com/argoproj/argo-workflows/blob/master/docs/managed-namespace.md) link.) - The Workflow Controller will need to be installed either in a cluster-scope configuration (i.e. no "--namespaced" argument) so that it has visiblity to all namespaces, or with "--managed-namespace" set to define "argo-events" as a namespace it has visibility to. To deploy Argo Workflows with a cluster-scope configuration you can use this installation yaml file, setting `ARGO_WORKFLOWS_VERSION` with your desired version. A list of versions can be found by viewing [these](https://github.com/argoproj/argo-workflows/tags) project tags in the Argo Workflow GitHub repository. + The Workflow Controller will need to be installed either in a cluster-scope configuration (i.e. no "--namespaced" argument) so that it has visibility to all namespaces, or with "--managed-namespace" set to define "argo-events" as a namespace it has visibility to. To deploy Argo Workflows with a cluster-scope configuration you can use this installation yaml file, setting `ARGO_WORKFLOWS_VERSION` with your desired version. A list of versions can be found by viewing [these](https://github.com/argoproj/argo-workflows/tags) project tags in the Argo Workflow GitHub repository. export ARGO_WORKFLOWS_VERSION=3.5.4 kubectl create namespace argo diff --git a/docs/sensors/triggers/email-trigger.md b/docs/sensors/triggers/email-trigger.md index 6eb188f49f..5d4e1e5d7b 100644 --- a/docs/sensors/triggers/email-trigger.md +++ b/docs/sensors/triggers/email-trigger.md @@ -25,7 +25,7 @@ The Email trigger is used to send a custom email to a desired set of email addre ## Email Trigger -Lets say we want to send an email to a dynamic recepient using a custom email body template. +Lets say we want to send an email to a dynamic recipient using a custom email body template. The custom email body template we are going to use is the following: @@ -44,7 +44,7 @@ where the name has to be substituted with the receiver name from the event. kubectl -n argo-events apply -f https://raw.githubusercontent.com/argoproj/argo-events/stable/examples/sensors/email-trigger.yaml **Note**: Please update `email.port`, `email.host` and `email.username` to that of your SMTP server. - If your SMTP server doesnot require authentication, the `email.username` and `email.smtpPassword` should be ommitted. + If your SMTP server doesnot require authentication, the `email.username` and `email.smtpPassword` should be omitted. 2. Send a http request to the event-source-pod to fire the Email trigger. @@ -94,7 +94,7 @@ The email trigger parameters have the following structure, dataKey: body.emailBody dest: email.body -- `email.to.index` can be used to overwite an email address already specified in the trigger at the provided index. (where index is an integer) +- `email.to.index` can be used to overwrite an email address already specified in the trigger at the provided index. (where index is an integer) - `email.to.-1` can be used to append a new email address to the addresses to which an email will be sent. - `email.from` can be used to specify the from address of the email sent. - `email.body` can be used to specify the body of the email which will be sent. diff --git a/examples/event-sources/gcp-pubsub.yaml b/examples/event-sources/gcp-pubsub.yaml index 1962aa5e8a..dcf77bb570 100644 --- a/examples/event-sources/gcp-pubsub.yaml +++ b/examples/event-sources/gcp-pubsub.yaml @@ -39,7 +39,7 @@ spec: # Deprecated, legacy approach # credentialsFile: "" # ---------------------------------------------------------------------------------------------------------------------- -# followings are example for using Workload Identity +# following are example for using Workload Identity # template: # serviceAccountName: my-sa diff --git a/examples/event-sources/resource.yaml b/examples/event-sources/resource.yaml index 121efc73f1..08488ab216 100644 --- a/examples/event-sources/resource.yaml +++ b/examples/event-sources/resource.yaml @@ -39,7 +39,7 @@ spec: # # fields provide listing options to K8s API to watch objects # fields: -# # It's an extention of https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/. +# # It's an extension of https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/. # # Unlike k8s field selector, any arbitrary field like "spec.serviceAccountName" is supported. # - key: metadata.name # # Supported operations like =, ==, !=. diff --git a/examples/rbac/workflow-rbac.yaml b/examples/rbac/workflow-rbac.yaml index 05ef65855a..98d31a94de 100644 --- a/examples/rbac/workflow-rbac.yaml +++ b/examples/rbac/workflow-rbac.yaml @@ -5,7 +5,7 @@ kind: Role metadata: annotations: workflows.argoproj.io/description: | - Recomended minimum permissions for the `emissary` executor. + Recommended minimum permissions for the `emissary` executor. name: executor rules: - apiGroups: diff --git a/examples/sensors/azure-events-hub.yaml b/examples/sensors/azure-events-hub.yaml index 01c8138aef..1316942726 100644 --- a/examples/sensors/azure-events-hub.yaml +++ b/examples/sensors/azure-events-hub.yaml @@ -39,5 +39,5 @@ spec: parameters: - src: dependencyName: test-dep - dataKey: body.messsage + dataKey: body.message dest: spec.arguments.parameters.0.value diff --git a/hack/update-mocks.sh b/hack/update-mocks.sh index 0b3b3611d7..bf7f18c2d3 100755 --- a/hack/update-mocks.sh +++ b/hack/update-mocks.sh @@ -5,7 +5,7 @@ set -o nounset set -o pipefail source $(dirname $0)/library.sh -header "updaing mocks" +header "updating mocks" ensure_mockery diff --git a/pkg/apis/events/openapi/openapi_generated.go b/pkg/apis/events/openapi/openapi_generated.go index 80d392faea..49c4ffa052 100644 --- a/pkg/apis/events/openapi/openapi_generated.go +++ b/pkg/apis/events/openapi/openapi_generated.go @@ -5213,7 +5213,7 @@ func schema_pkg_apis_events_v1alpha1_NATSAuth(ref common.ReferenceCallback) comm Properties: map[string]spec.Schema{ "basic": { SchemaProps: spec.SchemaProps{ - Description: "Baisc auth with username and password", + Description: "Basic auth with username and password", Ref: ref("github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.BasicAuth"), }, }, @@ -6607,7 +6607,7 @@ func schema_pkg_apis_events_v1alpha1_ResourceFilter(ref common.ReferenceCallback }, "fields": { SchemaProps: spec.SchemaProps{ - Description: "Fields provide field filters similar to K8s field selector (see https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/). Unlike K8s field selector, it supports arbitrary fileds like \"spec.serviceAccountName\", and the value could be a string or a regex. Same as K8s field selector, operator \"=\", \"==\" and \"!=\" are supported.", + Description: "Fields provide field filters similar to K8s field selector (see https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/). Unlike K8s field selector, it supports arbitrary fields like \"spec.serviceAccountName\", and the value could be a string or a regex. Same as K8s field selector, operator \"=\", \"==\" and \"!=\" are supported.", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ @@ -8476,7 +8476,7 @@ func schema_pkg_apis_events_v1alpha1_TriggerTemplate(ref common.ReferenceCallbac }, "conditionsReset": { SchemaProps: spec.SchemaProps{ - Description: "Criteria to reset the conditons", + Description: "Criteria to reset the conditions", Type: []string{"array"}, Items: &spec.SchemaOrArray{ Schema: &spec.Schema{ diff --git a/pkg/apis/events/v1alpha1/const.go b/pkg/apis/events/v1alpha1/const.go index 658151bcbf..94bed7a5f6 100644 --- a/pkg/apis/events/v1alpha1/const.go +++ b/pkg/apis/events/v1alpha1/const.go @@ -211,7 +211,7 @@ const ( MediaTypeYAML string = "application/yaml" ) -// Metrics releated +// Metrics related const ( EventSourceMetricsPort = 7777 SensorMetricsPort = 7777 diff --git a/pkg/apis/events/v1alpha1/eventsource_types.go b/pkg/apis/events/v1alpha1/eventsource_types.go index 8ccfc601c8..91d1e75107 100644 --- a/pkg/apis/events/v1alpha1/eventsource_types.go +++ b/pkg/apis/events/v1alpha1/eventsource_types.go @@ -291,7 +291,7 @@ type ResourceFilter struct { Labels []Selector `json:"labels,omitempty" protobuf:"bytes,2,rep,name=labels"` // Fields provide field filters similar to K8s field selector // (see https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/). - // Unlike K8s field selector, it supports arbitrary fileds like "spec.serviceAccountName", + // Unlike K8s field selector, it supports arbitrary fields like "spec.serviceAccountName", // and the value could be a string or a regex. // Same as K8s field selector, operator "=", "==" and "!=" are supported. // +optional @@ -568,7 +568,7 @@ type NATSEventsSource struct { // NATSAuth refers to the auth info for NATS EventSource type NATSAuth struct { - // Baisc auth with username and password + // Basic auth with username and password // +optional Basic *BasicAuth `json:"basic,omitempty" protobuf:"bytes,1,opt,name=basic"` // Token used to connect diff --git a/pkg/apis/events/v1alpha1/generated.proto b/pkg/apis/events/v1alpha1/generated.proto index 210b95baa9..f412f07f87 100644 --- a/pkg/apis/events/v1alpha1/generated.proto +++ b/pkg/apis/events/v1alpha1/generated.proto @@ -1945,7 +1945,7 @@ message Metadata { // NATSAuth refers to the auth info for NATS EventSource message NATSAuth { - // Baisc auth with username and password + // Basic auth with username and password // +optional optional BasicAuth basic = 1; @@ -2553,7 +2553,7 @@ message ResourceFilter { // Fields provide field filters similar to K8s field selector // (see https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/). - // Unlike K8s field selector, it supports arbitrary fileds like "spec.serviceAccountName", + // Unlike K8s field selector, it supports arbitrary fields like "spec.serviceAccountName", // and the value could be a string or a regex. // Same as K8s field selector, operator "=", "==" and "!=" are supported. // +optional @@ -3318,7 +3318,7 @@ message TriggerTemplate { // +optional optional PulsarTrigger pulsar = 14; - // Criteria to reset the conditons + // Criteria to reset the conditions // +optional repeated ConditionsResetCriteria conditionsReset = 15; diff --git a/pkg/apis/events/v1alpha1/nats_eventbus.go b/pkg/apis/events/v1alpha1/nats_eventbus.go index 3526946af8..6a9d150401 100644 --- a/pkg/apis/events/v1alpha1/nats_eventbus.go +++ b/pkg/apis/events/v1alpha1/nats_eventbus.go @@ -12,7 +12,7 @@ type NATSBus struct { Exotic *NATSConfig `json:"exotic,omitempty" protobuf:"bytes,2,opt,name=exotic"` } -// AuthStrategy is the auth strategy of native nats installaion +// AuthStrategy is the auth strategy of native nats installation type AuthStrategy string // possible auth strategies diff --git a/pkg/apis/events/v1alpha1/sensor_types.go b/pkg/apis/events/v1alpha1/sensor_types.go index 33c94b3c5f..9a0ccc1b18 100644 --- a/pkg/apis/events/v1alpha1/sensor_types.go +++ b/pkg/apis/events/v1alpha1/sensor_types.go @@ -327,7 +327,7 @@ type TriggerTemplate struct { // Pulsar refers to the trigger designed to place messages on Pulsar topic. // +optional Pulsar *PulsarTrigger `json:"pulsar,omitempty" protobuf:"bytes,14,opt,name=pulsar"` - // Criteria to reset the conditons + // Criteria to reset the conditions // +optional ConditionsReset []ConditionsResetCriteria `json:"conditionsReset,omitempty" protobuf:"bytes,15,rep,name=conditionsReset"` // AzureServiceBus refers to the trigger designed to place messages on Azure Service Bus diff --git a/pkg/apis/events/v1alpha1/status_types.go b/pkg/apis/events/v1alpha1/status_types.go index 4f5570cfcb..26bdc79358 100644 --- a/pkg/apis/events/v1alpha1/status_types.go +++ b/pkg/apis/events/v1alpha1/status_types.go @@ -136,7 +136,7 @@ func (s *Status) MarkTrueWithReason(t ConditionType, reason, message string) { s.markTypeStatus(t, corev1.ConditionTrue, reason, message) } -// MarkFalse sets the status of t to fasle +// MarkFalse sets the status of t to false func (s *Status) MarkFalse(t ConditionType, reason, message string) { s.markTypeStatus(t, corev1.ConditionFalse, reason, message) } @@ -146,7 +146,7 @@ func (s *Status) MarkUnknown(t ConditionType, reason, message string) { s.markTypeStatus(t, corev1.ConditionUnknown, reason, message) } -// GetCondition returns the condition of a condtion type +// GetCondition returns the condition of a condition type func (s *Status) GetCondition(t ConditionType) *Condition { for _, c := range s.Conditions { if c.Type == t { diff --git a/pkg/eventbus/jetstream/sensor/sensor_jetstream.go b/pkg/eventbus/jetstream/sensor/sensor_jetstream.go index 3733babac1..8272ef9282 100644 --- a/pkg/eventbus/jetstream/sensor/sensor_jetstream.go +++ b/pkg/eventbus/jetstream/sensor/sensor_jetstream.go @@ -310,7 +310,7 @@ func (stream *SensorJetstream) getTriggerList() (TriggerValue, error) { triggerList := TriggerValue{} err = json.Unmarshal(triggerListJson.Value(), &triggerList) if err != nil { - return nil, fmt.Errorf("errror unmarshalling value %s of key %s: %w", string(triggerListJson.Value()), TriggersKey, err) + return nil, fmt.Errorf("error unmarshalling value %s of key %s: %w", string(triggerListJson.Value()), TriggersKey, err) } return triggerList, nil @@ -347,7 +347,7 @@ func (stream *SensorJetstream) storeTriggerExpression(triggerName string, condit key := getTriggerExpressionKey(triggerName) _, err := stream.keyValueStore.PutString(key, conditionExpression) if err != nil { - return fmt.Errorf("errror storing %s under key %s: %w", conditionExpression, key, err) + return fmt.Errorf("error storing %s under key %s: %w", conditionExpression, key, err) } stream.Logger.Debugf("successfully stored trigger expression under key %s: %s", key, conditionExpression) return nil diff --git a/pkg/eventbus/kafka/sensor/kafka_handler.go b/pkg/eventbus/kafka/sensor/kafka_handler.go index d8d76e4872..d2d2b1faf2 100644 --- a/pkg/eventbus/kafka/sensor/kafka_handler.go +++ b/pkg/eventbus/kafka/sensor/kafka_handler.go @@ -137,7 +137,7 @@ func (h *KafkaHandler) ConsumeClaim(session sarama.ConsumerGroupSession, claim s return fmt.Errorf("unrecognized topic %s or partition %d", claim.Topic(), claim.Partition()) } - // Batch messsages from the claim message channel. A message will + // Batch messages from the claim message channel. A message will // be produced to the batched channel if the max batch size is // reached or the time limit has elapsed, whichever happens // first. Batching helps optimize kafka transactions. diff --git a/pkg/eventbus/stan/base/stan.go b/pkg/eventbus/stan/base/stan.go index 2bb7040f93..3443e76dbf 100644 --- a/pkg/eventbus/stan/base/stan.go +++ b/pkg/eventbus/stan/base/stan.go @@ -33,7 +33,7 @@ func (n *STAN) MakeConnection(clientID string) (*STANConnection, error) { log := n.logger.With("clientID", clientID) conn := &STANConnection{ClientID: clientID, Logger: n.logger} opts := []nats.Option{ - // Do not reconnect here but handle reconnction outside + // Do not reconnect here but handle reconnection outside nats.NoReconnect(), nats.DisconnectErrHandler(func(nc *nats.Conn, err error) { conn.NATSConnected = false diff --git a/pkg/eventbus/stan/sensor/trigger_conn.go b/pkg/eventbus/stan/sensor/trigger_conn.go index 5865627c0e..1d5dbe3670 100644 --- a/pkg/eventbus/stan/sensor/trigger_conn.go +++ b/pkg/eventbus/stan/sensor/trigger_conn.go @@ -226,7 +226,7 @@ func (n *STANTriggerConn) processEventSourceMsg(m *stan.Msg, msgHolder *eventSou // Start a new round if existingMsg, ok := msgHolder.msgs[depName]; ok { if m.Timestamp == existingMsg.timestamp { - // Re-delivered latest messge, update delivery timestamp and return + // Re-delivered latest message, update delivery timestamp and return existingMsg.lastDeliveredTime = now msgHolder.msgs[depName] = existingMsg log.Debugf("Updating timestamp for dependency=%s", depName) @@ -372,7 +372,7 @@ func (mh *eventSourceMessageHolder) getLastResetTime() time.Time { func (mh *eventSourceMessageHolder) setLastResetTime(t time.Time) { { - mh.lock.Lock() // since this can be called asyncronously as part of a ConditionReset, we neeed to lock this code + mh.lock.Lock() // since this can be called asynchronously as part of a ConditionReset, we neeed to lock this code defer mh.lock.Unlock() mh.lastResetTime = t } @@ -380,7 +380,7 @@ func (mh *eventSourceMessageHolder) setLastResetTime(t time.Time) { } func (mh *eventSourceMessageHolder) setResetTimeout(t int64) { - mh.timeoutLock.Lock() // since this can be called asyncronously as part of a ConditionReset, we neeed to lock this code + mh.timeoutLock.Lock() // since this can be called asynchronously as part of a ConditionReset, we neeed to lock this code defer mh.timeoutLock.Unlock() mh.resetTimeout = t } diff --git a/pkg/eventsources/common/naivewatcher/mutex.go b/pkg/eventsources/common/naivewatcher/mutex.go index 07d15dc218..4a6c90a24d 100644 --- a/pkg/eventsources/common/naivewatcher/mutex.go +++ b/pkg/eventsources/common/naivewatcher/mutex.go @@ -38,7 +38,7 @@ func (m *Mutex) TryLock() bool { return true } -// IsLocked returs whether the mutex is locked +// IsLocked returns whether the mutex is locked func (m *Mutex) IsLocked() bool { m.in.RLock() defer m.in.RUnlock() diff --git a/pkg/eventsources/common/webhook/types.go b/pkg/eventsources/common/webhook/types.go index 4c514b41d4..2ced1ab0be 100644 --- a/pkg/eventsources/common/webhook/types.go +++ b/pkg/eventsources/common/webhook/types.go @@ -66,7 +66,7 @@ type Route struct { EventSourceName string // EventName refers to event name EventName string - // active determines whether the route is active and ready to process incoming requets + // active determines whether the route is active and ready to process incoming requests // or it is an inactive route Active bool // data channel to receive data on this endpoint diff --git a/pkg/eventsources/events/event-data.go b/pkg/eventsources/events/event-data.go index 45f7ebbec2..1b37cdbf4b 100644 --- a/pkg/eventsources/events/event-data.go +++ b/pkg/eventsources/events/event-data.go @@ -54,7 +54,7 @@ type AMQPEventData struct { Exchange string `json:"exchange"` // RoutingKey is basic.publish routing key RoutingKey string `json:"routingKey"` - // Body represents the messsage body + // Body represents the message body Body interface{} `json:"body"` // Metadata holds the user defined metadata which will passed along the event payload. Metadata map[string]string `json:"metadata,omitempty"` diff --git a/pkg/eventsources/sources/amqp/start.go b/pkg/eventsources/sources/amqp/start.go index a2679b116a..b079ac72ef 100644 --- a/pkg/eventsources/sources/amqp/start.go +++ b/pkg/eventsources/sources/amqp/start.go @@ -196,7 +196,7 @@ func (el *EventListener) handleOne(amqpEventSource *aev1.AMQPEventSource, msg am } // setDefaults sets the default values in case the user hasn't defined them -// helps also to keep retro-compatibility with current dpeloyments +// helps also to keep retro-compatibility with current deployments func setDefaults(eventSource *aev1.AMQPEventSource) { if eventSource.ExchangeDeclare == nil { eventSource.ExchangeDeclare = &aev1.AMQPExchangeDeclareConfig{ diff --git a/pkg/eventsources/sources/azurequeuestorage/start.go b/pkg/eventsources/sources/azurequeuestorage/start.go index 62e1602aa8..58c506f5f6 100644 --- a/pkg/eventsources/sources/azurequeuestorage/start.go +++ b/pkg/eventsources/sources/azurequeuestorage/start.go @@ -101,7 +101,7 @@ func (el *EventListener) StartListening(ctx context.Context, dispatch func([]byt return nil default: } - log.Info("dequeing messages....") + log.Info("dequeuing messages....") messages, err := queueClient.DequeueMessages(ctx, &azqueue.DequeueMessagesOptions{ NumberOfMessages: &numMessages, VisibilityTimeout: &visibilityTimeout, diff --git a/pkg/eventsources/sources/gerrit/start.go b/pkg/eventsources/sources/gerrit/start.go index 5d98804814..441058db72 100644 --- a/pkg/eventsources/sources/gerrit/start.go +++ b/pkg/eventsources/sources/gerrit/start.go @@ -208,7 +208,7 @@ func (el *EventListener) StartListening(ctx context.Context, dispatch func([]byt } } - // Mitigate race condtions - it might create multiple hooks with same config when replicas > 1 + // Mitigate race conditions - it might create multiple hooks with same config when replicas > 1 randomNum, _ := rand.Int(rand.Reader, big.NewInt(int64(2000))) time.Sleep(time.Duration(randomNum.Int64()) * time.Millisecond) f() @@ -219,7 +219,7 @@ func (el *EventListener) StartListening(ctx context.Context, dispatch func([]byt go func() { // Another kind of race conditions might happen when pods do rolling upgrade - new pod starts // and old pod terminates, if DeleteHookOnFinish is true, the hook will be deleted from gerrit. - // This is a workround to mitigate the race conditions. + // This is a workaround to mitigate the race conditions. logger.Info("starting gerrit hooks manager daemon") ticker := time.NewTicker(60 * time.Second) defer ticker.Stop() diff --git a/pkg/eventsources/sources/gerrit/types.go b/pkg/eventsources/sources/gerrit/types.go index 51e11c9ad0..8e27f6452a 100644 --- a/pkg/eventsources/sources/gerrit/types.go +++ b/pkg/eventsources/sources/gerrit/types.go @@ -72,19 +72,19 @@ type ProjectHookConfigs struct { Events []string `json:"events,omitempty"` // ConnectionTimeout: // Maximum interval of time in milliseconds the plugin waits for a connection to the target instance. - // When not specified, the default value is derrived from global configuration. + // When not specified, the default value is derived from global configuration. ConnectionTimeout string `json:"connectionTimeout,omitempty"` // SocketTimeout: // Maximum interval of time in milliseconds the plugin waits for a response from the target instance once the connection has been established. - // When not specified, the default value is derrived from global configuration. + // When not specified, the default value is derived from global configuration. SocketTimeout string `json:"socketTimeout,omitempty"` // MaxTries: // Maximum number of times the plugin should attempt when posting an event to the target url. Setting this value to 0 will disable retries. - // When not specified, the default value is derrived from global configuration. + // When not specified, the default value is derived from global configuration. MaxTries string `json:"maxTries,omitempty"` // RetryInterval: // The interval of time in milliseconds between the subsequent auto-retries. - // When not specified, the default value is derrived from global configuration. + // When not specified, the default value is derived from global configuration. RetryInterval string `json:"retryInterval,omitempty"` // SslVerify: // When 'true' SSL certificate verification of remote url is performed when payload is delivered, the default value is derived from global configuration. diff --git a/pkg/eventsources/sources/gitlab/start.go b/pkg/eventsources/sources/gitlab/start.go index addad02a2e..caeb820d55 100644 --- a/pkg/eventsources/sources/gitlab/start.go +++ b/pkg/eventsources/sources/gitlab/start.go @@ -284,7 +284,7 @@ func (el *EventListener) StartListening(ctx context.Context, dispatch func([]byt } } - // Mitigate race condtions - it might create multiple hooks with same config when replicas > 1 + // Mitigate race conditions - it might create multiple hooks with same config when replicas > 1 randomNum, _ := rand.Int(rand.Reader, big.NewInt(int64(2000))) time.Sleep(time.Duration(randomNum.Int64()) * time.Millisecond) f() @@ -295,7 +295,7 @@ func (el *EventListener) StartListening(ctx context.Context, dispatch func([]byt go func() { // Another kind of race conditions might happen when pods do rolling upgrade - new pod starts // and old pod terminates, if DeleteHookOnFinish is true, the hook will be deleted from gitlab. - // This is a workround to mitigate the race conditions. + // This is a workaround to mitigate the race conditions. logger.Info("starting gitlab hooks manager daemon") ticker := time.NewTicker(60 * time.Second) defer ticker.Stop() diff --git a/pkg/eventsources/sources/webhook/start.go b/pkg/eventsources/sources/webhook/start.go index 5733547d58..c10dda6439 100644 --- a/pkg/eventsources/sources/webhook/start.go +++ b/pkg/eventsources/sources/webhook/start.go @@ -96,7 +96,7 @@ func (router *Router) HandleRoute(writer http.ResponseWriter, request *http.Requ logger.Info("a request received, processing it...") if !route.Active { - logger.Info("endpoint is not active, wont't process the request") + logger.Info("endpoint is not active, won't process the request") sharedutil.SendErrorResponse(writer, "endpoint is inactive") return } diff --git a/pkg/metrics/metrics.go b/pkg/metrics/metrics.go index e57eab0bb0..704420ae60 100644 --- a/pkg/metrics/metrics.go +++ b/pkg/metrics/metrics.go @@ -120,7 +120,7 @@ func NewMetrics(namespace string) *Metrics { actionDuration: prometheus.NewSummaryVec(prometheus.SummaryOpts{ Namespace: prefix, Name: "action_duration_milliseconds", - Help: "Summary of durations of trigging actions. https://argoproj.github.io/argo-events/metrics/#argo_events_action_duration_milliseconds", + Help: "Summary of durations of triggering actions. https://argoproj.github.io/argo-events/metrics/#argo_events_action_duration_milliseconds", ConstLabels: prometheus.Labels{ labelNamespace: namespace, }, diff --git a/pkg/reconciler/cmd/start.go b/pkg/reconciler/cmd/start.go index 5ac0d93410..40fba68ce4 100644 --- a/pkg/reconciler/cmd/start.go +++ b/pkg/reconciler/cmd/start.go @@ -80,7 +80,7 @@ func Start(eventsOpts ArgoEventsControllerOpts) { } kubeClient := kubernetes.NewForConfigOrDie(restConfig) - // Readyness probe + // Readiness probe if err := mgr.AddReadyzCheck("readiness", healthz.Ping); err != nil { logger.Fatalw("Unable add a readiness check", zap.Error(err)) } diff --git a/pkg/reconciler/eventbus/installer/nats.go b/pkg/reconciler/eventbus/installer/nats.go index 3edbeaa8c0..37f3d7d554 100644 --- a/pkg/reconciler/eventbus/installer/nats.go +++ b/pkg/reconciler/eventbus/installer/nats.go @@ -65,7 +65,7 @@ func NewNATSInstaller(client client.Client, eventBus *v1alpha1.EventBus, config } } -// Install creats a StatefulSet and a Service for NATS +// Install creates a StatefulSet and a Service for NATS func (i *natsInstaller) Install(ctx context.Context) (*v1alpha1.BusConfig, error) { natsObj := i.eventBus.Spec.NATS if natsObj == nil || natsObj.Native == nil { @@ -546,7 +546,7 @@ streaming { } // buildServerAuthSecret builds a secret for NATS auth config -// Parameter - authStrategy: will be added to annoations +// Parameter - authStrategy: will be added to annotations // Parameter - secret // Example: // diff --git a/pkg/sensors/triggers/aws-lambda/aws-lambda.go b/pkg/sensors/triggers/aws-lambda/aws-lambda.go index 5891d155ec..4a3209e52f 100644 --- a/pkg/sensors/triggers/aws-lambda/aws-lambda.go +++ b/pkg/sensors/triggers/aws-lambda/aws-lambda.go @@ -80,7 +80,7 @@ func (t *AWSLambdaTrigger) FetchResource(ctx context.Context) (interface{}, erro func (t *AWSLambdaTrigger) ApplyResourceParameters(events map[string]*v1alpha1.Event, resource interface{}) (interface{}, error) { resourceBytes, err := json.Marshal(resource) if err != nil { - return nil, fmt.Errorf("failed to marshal the aws lamda trigger resource, %w", err) + return nil, fmt.Errorf("failed to marshal the aws lambda trigger resource, %w", err) } parameters := t.Trigger.Template.AWSLambda.Parameters if parameters != nil { diff --git a/pkg/shared/logging/logger.go b/pkg/shared/logging/logger.go index 601f6e4b35..ad9d649a0e 100644 --- a/pkg/shared/logging/logger.go +++ b/pkg/shared/logging/logger.go @@ -64,7 +64,7 @@ func FromContext(ctx context.Context) *zap.SugaredLogger { return NewArgoEventsLogger() } -// Returns logger conifg depending on the log level +// Returns logger config depending on the log level func ConfigureLogLevelLogger(logLevel string) zap.Config { logConfig := zap.NewProductionConfig() switch logLevel { diff --git a/test/e2e/functional_test.go b/test/e2e/functional_test.go index 716e938ebf..aa6e917171 100644 --- a/test/e2e/functional_test.go +++ b/test/e2e/functional_test.go @@ -439,7 +439,7 @@ func (s *FunctionalSuite) TestAtLeastOnce() { w1.Then().ExpectEventSourcePodLogContains(LogPublishEventSuccessful, util.PodLogCheckOptionWithCount(1)) w2.Then().ExpectSensorPodLogContains("Making a http request...") - time.Sleep(5 * time.Second) // make sure we defintely attempt to trigger + time.Sleep(5 * time.Second) // make sure we definitely attempt to trigger w2.DeleteSensor() time.Sleep(10 * time.Second) @@ -487,7 +487,7 @@ func (s *FunctionalSuite) TestAtMostOnce() { w1.Then().ExpectEventSourcePodLogContains(LogPublishEventSuccessful, util.PodLogCheckOptionWithCount(1)) w2.Then().ExpectSensorPodLogContains("Making a http request...") - time.Sleep(5 * time.Second) // make sure we defintely attempt to trigger + time.Sleep(5 * time.Second) // make sure we definitely attempt to trigger w2.DeleteSensor() time.Sleep(10 * time.Second) From 90ae19f1ae5ecbc1cf6628f53ef617f8d7237c79 Mon Sep 17 00:00:00 2001 From: "Yaroslav O. Halchenko" Date: Thu, 8 May 2025 10:32:05 -0400 Subject: [PATCH 6/7] Fix table formatting Signed-off-by: Yaroslav O. Halchenko --- docs/eventsources/gcp-pubsub.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/eventsources/gcp-pubsub.md b/docs/eventsources/gcp-pubsub.md index e64ceff18e..fc104ec781 100644 --- a/docs/eventsources/gcp-pubsub.md +++ b/docs/eventsources/gcp-pubsub.md @@ -6,16 +6,16 @@ GCP PubSub event source can listen to a PubSub with given `topic`, or `subscriptionID`. Here is the logic with different `topic` and `subscriptionID` combination. -| Topic Provided/Existing | Sub ID Provided/Existing | Actions | -| ----------------------- | ------------------------ | --------------------------------------------------------------------- | -| Yes/Yes | Yes/Yes | Validate if given topic matches subscription's topic | -| Yes/Yes | Yes/No | Create a subscription with given ID | +| Topic Provided/Existing | Sub ID Provided/Existing | Actions | +| ----------------------- | ------------------------ | -------------------------------------------------------------------- | +| Yes/Yes | Yes/Yes | Validate if given topic matches subscription's topic | +| Yes/Yes | Yes/No | Create a subscription with given ID | | Yes/Yes | No/- | Create or reuse subscription with auto generated subID | -| Yes/No | Yes/No | Create a topic and a subscription with given subID | -| Yes/No | Yes/Yes | Invalid | +| Yes/No | Yes/No | Create a topic and a subscription with given subID | +| Yes/No | Yes/Yes | Invalid | | Yes/No | No/- | Create a topic, create or reuse subscription w/ auto generated subID | -| No/- | Yes/Yes | OK | -| No/- | Yes/No | Invalid | +| No/- | Yes/Yes | OK | +| No/- | Yes/No | Invalid | ## Workload Identity From babe1516ded5fec8a78238ca64feeb9f639c1169 Mon Sep 17 00:00:00 2001 From: "Yaroslav O. Halchenko" Date: Thu, 8 May 2025 10:33:24 -0400 Subject: [PATCH 7/7] [DATALAD RUNCMD] chore: run codespell throughout fixing a few new typos automagically === Do not change lines below === { "chain": [], "cmd": "codespell -w -w -i 3 -C 4", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^ Signed-off-by: Yaroslav O. Halchenko --- CHANGELOG.md | 6 +++--- docs/sensors/triggers/email-trigger.md | 4 ++-- examples/event-sources/calendar.yaml | 2 +- pkg/eventbus/common/structs.go | 2 +- pkg/eventbus/stan/sensor/trigger_conn.go | 4 ++-- pkg/eventsources/sources/resource/start_test.go | 2 +- pkg/reconciler/eventbus/installer/nats.go | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 88cab9959b..c54c5c942b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -451,7 +451,7 @@ * [f7fe87f5](https://github.com/argoproj/argo-events/commit/f7fe87f5a57660c8e5ea6bc6d6df49e60f5afd70) chore(deps): bump google.golang.org/api from 0.139.0 to 0.141.0 (#2801) * [4785345a](https://github.com/argoproj/argo-events/commit/4785345a534a7081f6d62766078c7ed2c298feb6) chore(deps): bump github.com/antonmedv/expr from 1.15.1 to 1.15.2 (#2803) * [7dc0ccf4](https://github.com/argoproj/argo-events/commit/7dc0ccf4e05fff65f11a1dfb7bd18474367614c1) chore(deps): bump docker/setup-buildx-action from 2 to 3 (#2799) - * [f5ce1ef6](https://github.com/argoproj/argo-events/commit/f5ce1ef689d17e2328247146a20d37b09a9200cb) fix: Eventsource resourse label selector operators not working (#2795) + * [f5ce1ef6](https://github.com/argoproj/argo-events/commit/f5ce1ef689d17e2328247146a20d37b09a9200cb) fix: Eventsource resource label selector operators not working (#2795) * [f335fc24](https://github.com/argoproj/argo-events/commit/f335fc24e8a3ab2c37a34eb01b4b181ad71501fe) chore(deps): bump google.golang.org/api from 0.136.0 to 0.139.0 (#2791) * [d647c844](https://github.com/argoproj/argo-events/commit/d647c8441d665fc5e8ed90d6e02922d7af8f3592) chore(deps): bump actions/checkout from 3 to 4 (#2792) * [a5d9e9a5](https://github.com/argoproj/argo-events/commit/a5d9e9a5ec05339cd8b28e1980b13d309fbf93cc) chore(deps): bump github.com/xanzy/go-gitlab from 0.90.0 to 0.91.1 (#2788) @@ -697,7 +697,7 @@ * [62be2408](https://github.com/argoproj/argo-events/commit/62be2408dc7b63fca533cc28107ad490efff650a) chore(deps): bump github.com/minio/minio-go/v7 from 7.0.45 to 7.0.46 (#2398) * [d75aa6fc](https://github.com/argoproj/argo-events/commit/d75aa6fc4242b78c93c30737637d78a38f668c24) NATS event data - add header field (#2396) * [9a0759d4](https://github.com/argoproj/argo-events/commit/9a0759d47f0dcf54dbc097b7e08c865846920470) fix: fix bug in evaluation of filters with filtersLogicalOperator=or (#2374) - * [1428cae9](https://github.com/argoproj/argo-events/commit/1428cae94225107eabf08b7297a50402c93e393c) Implement multiple partions usage in Kafka trigger (#2360) + * [1428cae9](https://github.com/argoproj/argo-events/commit/1428cae94225107eabf08b7297a50402c93e393c) Implement multiple partitions usage in Kafka trigger (#2360) * [3cbcd720](https://github.com/argoproj/argo-events/commit/3cbcd7200d2bf7588dd1b562ac7a6fe5c9e882e9) chore(deps): bump github.com/aws/aws-sdk-go from 1.44.162 to 1.44.171 (#2387) * [29da45b5](https://github.com/argoproj/argo-events/commit/29da45b595bc4b2a1b0210a188ad0aa1108a7e33) chore(deps): bump github.com/nats-io/nats.go from 1.21.0 to 1.22.1 (#2381) * [6fa130ec](https://github.com/argoproj/argo-events/commit/6fa130ec31ee5c06a142f991549479b6796f9b49) chore(deps): bump github.com/slack-go/slack from 0.12.0 to 0.12.1 (#2379) @@ -1047,7 +1047,7 @@ * [ae5abfc2](https://github.com/argoproj/argo-events/commit/ae5abfc27217773a9583c2cbdb53cc4f1765ea1d) chore(deps): bump github.com/minio/minio-go/v7 from 7.0.45 to 7.0.46 (#2398) * [0da2dfe3](https://github.com/argoproj/argo-events/commit/0da2dfe3e811a9bfbc9118e65f745dd2abf1072a) NATS event data - add header field (#2396) * [ff524af8](https://github.com/argoproj/argo-events/commit/ff524af8366acaec033998f5692e842ad516a95d) fix: fix bug in evaluation of filters with filtersLogicalOperator=or (#2374) - * [eeae3da9](https://github.com/argoproj/argo-events/commit/eeae3da976f5f735e698f66eb44d06ff9a728251) Implement multiple partions usage in Kafka trigger (#2360) + * [eeae3da9](https://github.com/argoproj/argo-events/commit/eeae3da976f5f735e698f66eb44d06ff9a728251) Implement multiple partitions usage in Kafka trigger (#2360) * [a0ef3c24](https://github.com/argoproj/argo-events/commit/a0ef3c24eb960539a73c157dfdab65f6fcbc8f55) chore(deps): bump github.com/aws/aws-sdk-go from 1.44.162 to 1.44.171 (#2387) * [c650f05b](https://github.com/argoproj/argo-events/commit/c650f05bdbf82abb54e9e1e5a8af6d26b2f1997f) chore(deps): bump github.com/nats-io/nats.go from 1.21.0 to 1.22.1 (#2381) * [8565b135](https://github.com/argoproj/argo-events/commit/8565b135fd79220b8457cf13b013e98943c28ab3) chore(deps): bump github.com/slack-go/slack from 0.12.0 to 0.12.1 (#2379) diff --git a/docs/sensors/triggers/email-trigger.md b/docs/sensors/triggers/email-trigger.md index 5d4e1e5d7b..0eee899452 100644 --- a/docs/sensors/triggers/email-trigger.md +++ b/docs/sensors/triggers/email-trigger.md @@ -12,7 +12,7 @@ The Email trigger is used to send a custom email to a desired set of email addre kubectl create secret generic smtp-secret --from-literal=password=$SMTP_PASSWORD - **Note**: If your SMTP server doesnot require authentication this step can be skipped. + **Note**: If your SMTP server does not require authentication this step can be skipped. 4. Create a webhook event-source. @@ -44,7 +44,7 @@ where the name has to be substituted with the receiver name from the event. kubectl -n argo-events apply -f https://raw.githubusercontent.com/argoproj/argo-events/stable/examples/sensors/email-trigger.yaml **Note**: Please update `email.port`, `email.host` and `email.username` to that of your SMTP server. - If your SMTP server doesnot require authentication, the `email.username` and `email.smtpPassword` should be omitted. + If your SMTP server does not require authentication, the `email.username` and `email.smtpPassword` should be omitted. 2. Send a http request to the event-source-pod to fire the Email trigger. diff --git a/examples/event-sources/calendar.yaml b/examples/event-sources/calendar.yaml index a379eba8f5..990a97ec46 100644 --- a/examples/event-sources/calendar.yaml +++ b/examples/event-sources/calendar.yaml @@ -35,7 +35,7 @@ spec: # schedule-in-specific-timezone: # # creates an event every 20 seconds # interval: "20s" -# # metadata containes key-value pairs that will be send to the sensor with each event payload +# # metadata contains key-value pairs that will be send to the sensor with each event payload # # whatever you put here is blindly delivered to sensor. # # access in resourceParameters or templateParameters via the path metadata.hello # metadata: diff --git a/pkg/eventbus/common/structs.go b/pkg/eventbus/common/structs.go index e79418bb1d..b6c943849a 100644 --- a/pkg/eventbus/common/structs.go +++ b/pkg/eventbus/common/structs.go @@ -4,7 +4,7 @@ import ( eventbusv1alpha1 "github.com/argoproj/argo-events/pkg/apis/events/v1alpha1" ) -// Auth contains the auth infor for event bus +// Auth contains the auth info for event bus type Auth struct { Strategy eventbusv1alpha1.AuthStrategy Credential *AuthCredential diff --git a/pkg/eventbus/stan/sensor/trigger_conn.go b/pkg/eventbus/stan/sensor/trigger_conn.go index 1d5dbe3670..0d672e4e85 100644 --- a/pkg/eventbus/stan/sensor/trigger_conn.go +++ b/pkg/eventbus/stan/sensor/trigger_conn.go @@ -372,7 +372,7 @@ func (mh *eventSourceMessageHolder) getLastResetTime() time.Time { func (mh *eventSourceMessageHolder) setLastResetTime(t time.Time) { { - mh.lock.Lock() // since this can be called asynchronously as part of a ConditionReset, we neeed to lock this code + mh.lock.Lock() // since this can be called asynchronously as part of a ConditionReset, we need to lock this code defer mh.lock.Unlock() mh.lastResetTime = t } @@ -380,7 +380,7 @@ func (mh *eventSourceMessageHolder) setLastResetTime(t time.Time) { } func (mh *eventSourceMessageHolder) setResetTimeout(t int64) { - mh.timeoutLock.Lock() // since this can be called asynchronously as part of a ConditionReset, we neeed to lock this code + mh.timeoutLock.Lock() // since this can be called asynchronously as part of a ConditionReset, we need to lock this code defer mh.timeoutLock.Unlock() mh.resetTimeout = t } diff --git a/pkg/eventsources/sources/resource/start_test.go b/pkg/eventsources/sources/resource/start_test.go index 207ccc590b..d7d9e5256b 100644 --- a/pkg/eventsources/sources/resource/start_test.go +++ b/pkg/eventsources/sources/resource/start_test.go @@ -206,7 +206,7 @@ func TestLabelSelector(t *testing.T) { t.Errorf("matched %v", invalidL) } }) - // Test doesnot exist operator + // Test does not exist operator t.Run("Test operator !", func(t *testing.T) { r, err := LabelSelector([]v1alpha1.Selector{{ Key: "key", diff --git a/pkg/reconciler/eventbus/installer/nats.go b/pkg/reconciler/eventbus/installer/nats.go index 37f3d7d554..3a79c3c725 100644 --- a/pkg/reconciler/eventbus/installer/nats.go +++ b/pkg/reconciler/eventbus/installer/nats.go @@ -114,7 +114,7 @@ func (i *natsInstaller) Install(ctx context.Context) (*v1alpha1.BusConfig, error return busConfig, nil } -// Uninstall deletes those objects not handeled by cascade deletion. +// Uninstall deletes those objects not handled by cascade deletion. func (i *natsInstaller) Uninstall(ctx context.Context) error { return i.uninstallPVCs(ctx) }