From 22f2598e33dc28e91ed8609bbfb6b134113b2f9f Mon Sep 17 00:00:00 2001 From: Austin Abro <37223396+AustinAbro321@users.noreply.github.com> Date: Tue, 27 Feb 2024 16:16:12 -0500 Subject: [PATCH] Chore: fix spelling (#2333) ## Description Downloaded a spell checker ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [X] Other (security config, docs update, etc) ## Checklist before merging - [X] Test, docs, adr added or updated as needed - [X] [Contributor Guide Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow) followed --- docs/0-zarf-overview.md | 2 +- docs/12-contribute-to-zarf/2-testing.md | 2 +- docs/3-create-a-zarf-package/8-vscode.md | 2 +- docs/5-zarf-tutorials/0-creating-a-zarf-package.md | 2 +- docs/5-zarf-tutorials/9-resource-adoption.md | 6 +++--- docs/9-roadmap.md | 2 +- examples/helm-charts/zarf.yaml | 2 +- packages/logging-pgl/pgl-values.yaml | 2 +- src/internal/packager/git/gitea.go | 12 ++++++------ src/internal/packager/helm/utils.go | 2 +- src/pkg/k8s/services.go | 4 ++-- src/pkg/packager/actions.go | 2 +- src/pkg/packager/composer/list.go | 2 +- src/pkg/packager/lint/lint_test.go | 12 ++++++------ src/pkg/packager/sources/oci.go | 2 +- src/pkg/packager/sources/split.go | 2 +- src/pkg/packager/sources/tarball.go | 2 +- src/pkg/packager/sources/url.go | 2 +- src/pkg/packager/sources/validate.go | 2 +- src/pkg/utils/wait.go | 2 +- src/test/packages/25-local-tgz-chart/zarf.yaml | 2 +- 21 files changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/0-zarf-overview.md b/docs/0-zarf-overview.md index 98d2b5f97a..122caaf51e 100644 --- a/docs/0-zarf-overview.md +++ b/docs/0-zarf-overview.md @@ -149,7 +149,7 @@ In this use case, you configure Zarf to initialize a cluster that already exists - Builtin [K9s Dashboard](https://k9scli.io/) for managing a cluster from the terminal - [Mutating Webhook](adr/0005-mutating-webhook.md) to automatically update Kubernetes pod's image path and pull secrets as well as [Flux Git Repository](https://fluxcd.io/docs/components/source/gitrepositories/) URLs and secret references - Builtin [command to find images](./2-the-zarf-cli/100-cli-commands/zarf_dev_find-images.md) and resources from a Helm chart -- Tunneling capability to [connect to Kuberenetes resources](./2-the-zarf-cli/100-cli-commands/zarf_connect.md) without network routing, DNS, TLS or Ingress configuration required +- Tunneling capability to [connect to Kubernetes resources](./2-the-zarf-cli/100-cli-commands/zarf_connect.md) without network routing, DNS, TLS or Ingress configuration required ### 🛠️ Configurable Features diff --git a/docs/12-contribute-to-zarf/2-testing.md b/docs/12-contribute-to-zarf/2-testing.md index e36f8a9b47..f2b129dc3d 100644 --- a/docs/12-contribute-to-zarf/2-testing.md +++ b/docs/12-contribute-to-zarf/2-testing.md @@ -48,7 +48,7 @@ The Zarf binary and built packages are required to be stored in the ./build dire When adding new tests, there are several requirements that must be followed, including: -1. Tests cannont be run in parallel as they utilize the same K8s cluster. +1. Tests cannot be run in parallel as they utilize the same K8s cluster. 2. Each test should begin with the entries below for standardization and test setup/teardown: ```go diff --git a/docs/3-create-a-zarf-package/8-vscode.md b/docs/3-create-a-zarf-package/8-vscode.md index 896c898d3c..73655e9e29 100644 --- a/docs/3-create-a-zarf-package/8-vscode.md +++ b/docs/3-create-a-zarf-package/8-vscode.md @@ -6,7 +6,7 @@ Zarf uses the [Zarf package schema](https://github.com/defenseunicorns/zarf/blob 1. Open VS Code. 2. Install the [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) by RedHat. -3. Open the VS Code command pallete by typing `CTRL/CMD + SHIFT + P`. +3. Open the VS Code command palette by typing `CTRL/CMD + SHIFT + P`. 4. Type `Preferences: Open User Settings (JSON)`into the search bar to open the `settings.json` file. 5. Add the below code to the settings.json config, or modify the existing `yaml.schemas` object to include the Zarf schema. diff --git a/docs/5-zarf-tutorials/0-creating-a-zarf-package.md b/docs/5-zarf-tutorials/0-creating-a-zarf-package.md index e398df6933..c0d90cedd4 100644 --- a/docs/5-zarf-tutorials/0-creating-a-zarf-package.md +++ b/docs/5-zarf-tutorials/0-creating-a-zarf-package.md @@ -37,7 +37,7 @@ metadata: :::tip If you are using an Integrated Development Environment (such as [VS Code](../3-create-a-zarf-package/8-vscode.md)) to create and edit the `zarf.yaml` file, you can install or reference the [`zarf.schema.json`](https://github.com/defenseunicorns/zarf/blob/main/zarf.schema.json) file to get error checking and autocomplete. -Additionally, you can run `zarf dev lint ` to validate aginst the [`zarf.schema.json`](https://github.com/defenseunicorns/zarf/blob/main/zarf.schema.json) +Additionally, you can run `zarf dev lint ` to validate against the [`zarf.schema.json`](https://github.com/defenseunicorns/zarf/blob/main/zarf.schema.json) ::: diff --git a/docs/5-zarf-tutorials/9-resource-adoption.md b/docs/5-zarf-tutorials/9-resource-adoption.md index 4e28d37881..82f83bc6aa 100644 --- a/docs/5-zarf-tutorials/9-resource-adoption.md +++ b/docs/5-zarf-tutorials/9-resource-adoption.md @@ -10,7 +10,7 @@ In this tutorial, you will create a test workload prior to initializing Zarf. A ## Prerequisites -- Prior to this tutorial you'll want to have a working cluster. But unlike our other tutorials you **don't want Zarf initialzed**. +- Prior to this tutorial you'll want to have a working cluster. But unlike our other tutorials you **don't want Zarf initialized**. - Zarf binary installed on your $PATH: ([Installing Zarf](../1-getting-started/index.md#installing-zarf)) @@ -18,7 +18,7 @@ In this tutorial, you will create a test workload prior to initializing Zarf. A [![Tutorial: Adopt Pre-Existing Resources to Manage with Zarf](../.images/tutorials/adoption_thumbnail.png)](https://youtu.be/r3TBpMXtuNY "Adopt Pre-Existing Resources to Manage with Zarf") ## Creating a Test Component -We're going to use the manifests from the [Deploying a Retro Arcade](./3-deploy-a-retro-arcade.md) tutorial for this example. So if you haven't yet, clone the Zarf repository, and navigate to the cloned repository's root directory. +We're going to use the manifests from the [Deploying a Retro Arcade](./3-deploy-a-retro-arcade.md) tutorial for this example. So if you haven't yet, clone the Zarf repository, and navigate to the cloned repository's root directory. 1. Create the dos-games namespace @@ -88,4 +88,4 @@ Again, remember to press `ctrl+c` in your terminal, when you're done with the co ## Conclusion -At this point the dos-game package is managed by Zarf and will behave just like a package initially deployed with Zarf. \ No newline at end of file +At this point the dos-game package is managed by Zarf and will behave just like a package initially deployed with Zarf. diff --git a/docs/9-roadmap.md b/docs/9-roadmap.md index 23cc77f7e2..4110980199 100644 --- a/docs/9-roadmap.md +++ b/docs/9-roadmap.md @@ -31,7 +31,7 @@ We also accept contributions from the community (regardless of where a particula - [ ] - Transfer project and additional repos (`zarf-ui`, `zarf-init-aws`, `setup-zarf`, etc.) to a new GitHub organization. - [ ] - Stabilize features after the consolidation of Q2 - clean up GA milestone in preparation for Q4. - [ ] - Flesh out the extension system for new features / experiments to be more smoothly integrated with Zarf. -- [ ] - Make `zarf init` custom logic defineable in-schema and across all packages. +- [ ] - Make `zarf init` custom logic definable in-schema and across all packages. ### Q4: Post Donation and General Availability diff --git a/examples/helm-charts/zarf.yaml b/examples/helm-charts/zarf.yaml index e43d87beef..d6481b334d 100644 --- a/examples/helm-charts/zarf.yaml +++ b/examples/helm-charts/zarf.yaml @@ -1,7 +1,7 @@ kind: ZarfPackageConfig metadata: name: helm-charts - description: Example showcasing mutiple ways to deploy helm charts + description: Example showcasing multiple ways to deploy helm charts version: 0.0.1 components: diff --git a/packages/logging-pgl/pgl-values.yaml b/packages/logging-pgl/pgl-values.yaml index 44c1f10330..45662d9fa2 100644 --- a/packages/logging-pgl/pgl-values.yaml +++ b/packages/logging-pgl/pgl-values.yaml @@ -2,7 +2,7 @@ grafana: enabled: true adminUser: "zarf-admin" adminPassword: "###ZARF_LOGGING_AUTH###" - # K8s 1.25+ compatibilty until loki stack upgrades the grafana chart to 6.36.1 + # K8s 1.25+ compatibility until loki stack upgrades the grafana chart to 6.36.1 rbac: pspEnabled: false grafana.ini: diff --git a/src/internal/packager/git/gitea.go b/src/internal/packager/git/gitea.go index 222ce3c5e6..f7bd86b00c 100644 --- a/src/internal/packager/git/gitea.go +++ b/src/internal/packager/git/gitea.go @@ -302,18 +302,18 @@ func (g *Git) addReadOnlyUserToRepo(tunnelURL, repo string) error { message.Debugf("git.addReadOnlyUserToRepo()") // Add the readonly user to the repo - addColabBody := map[string]string{ + addCollabBody := map[string]string{ "permission": "read", } - addColabData, err := json.Marshal(addColabBody) + addCollabData, err := json.Marshal(addCollabBody) if err != nil { return err } // Send API request to add a user as a read-only collaborator to a repo - addColabEndpoint := fmt.Sprintf("%s/api/v1/repos/%s/%s/collaborators/%s", tunnelURL, g.Server.PushUsername, repo, g.Server.PullUsername) - addColabRequest, _ := netHttp.NewRequest("PUT", addColabEndpoint, bytes.NewBuffer(addColabData)) - out, _, err := g.DoHTTPThings(addColabRequest, g.Server.PushUsername, g.Server.PushPassword) - message.Debugf("PUT %s:\n%s", addColabEndpoint, string(out)) + addCollabEndpoint := fmt.Sprintf("%s/api/v1/repos/%s/%s/collaborators/%s", tunnelURL, g.Server.PushUsername, repo, g.Server.PullUsername) + addCollabRequest, _ := netHttp.NewRequest("PUT", addCollabEndpoint, bytes.NewBuffer(addCollabData)) + out, _, err := g.DoHTTPThings(addCollabRequest, g.Server.PushUsername, g.Server.PushPassword) + message.Debugf("PUT %s:\n%s", addCollabEndpoint, string(out)) return err } diff --git a/src/internal/packager/helm/utils.go b/src/internal/packager/helm/utils.go index 0ea8d91938..8e1718d725 100644 --- a/src/internal/packager/helm/utils.go +++ b/src/internal/packager/helm/utils.go @@ -64,7 +64,7 @@ func (h *Helm) parseChartValues() (chartutil.Values, error) { func (h *Helm) createActionConfig(namespace string, spinner *message.Spinner) error { // Initialize helm SDK actionConfig := new(action.Configuration) - // Set the setings for the helm SDK + // Set the settings for the helm SDK h.settings = cli.New() // Set the namespace for helm diff --git a/src/pkg/k8s/services.go b/src/pkg/k8s/services.go index 32b1a449ae..929ba88830 100644 --- a/src/pkg/k8s/services.go +++ b/src/pkg/k8s/services.go @@ -78,7 +78,7 @@ func (k *K8s) GetServices(namespace string) (*corev1.ServiceList, error) { // GetServicesByLabel returns a list of matched services given a label and value. To search all namespaces, pass "" in the namespace arg. func (k *K8s) GetServicesByLabel(namespace, label, value string) (*corev1.ServiceList, error) { - // Creat the selector and add the requirement + // Create the selector and add the requirement labelSelector, _ := metav1.LabelSelectorAsSelector(&metav1.LabelSelector{ MatchLabels: Labels{ label: value, @@ -91,7 +91,7 @@ func (k *K8s) GetServicesByLabel(namespace, label, value string) (*corev1.Servic // GetServicesByLabelExists returns a list of matched services given a label. To search all namespaces, pass "" in the namespace arg. func (k *K8s) GetServicesByLabelExists(namespace, label string) (*corev1.ServiceList, error) { - // Creat the selector and add the requirement + // Create the selector and add the requirement labelSelector, _ := metav1.LabelSelectorAsSelector(&metav1.LabelSelector{ MatchExpressions: []metav1.LabelSelectorRequirement{{ Key: label, diff --git a/src/pkg/packager/actions.go b/src/pkg/packager/actions.go index f565bb727a..1a49af931d 100644 --- a/src/pkg/packager/actions.go +++ b/src/pkg/packager/actions.go @@ -55,7 +55,7 @@ func (p *Packager) runAction(defaultCfg types.ZarfComponentActionDefaults, actio return err } - // Mute the output becuase it will be noisy. + // Mute the output because it will be noisy. t := true action.Mute = &t diff --git a/src/pkg/packager/composer/list.go b/src/pkg/packager/composer/list.go index f46235f212..68de4f2e87 100644 --- a/src/pkg/packager/composer/list.go +++ b/src/pkg/packager/composer/list.go @@ -190,7 +190,7 @@ func NewImportChain(head types.ZarfComponent, index int, originalPackageName, ar name := node.ImportName() // 'found' and 'index' are parallel slices. Each element in found[x] corresponds to pkg[index[x]] - // found[0] and pkg[index[0]] would be the same componenet for example + // found[0] and pkg[index[0]] would be the same component for example found := []types.ZarfComponent{} index := []int{} for i, component := range pkg.Components { diff --git a/src/pkg/packager/lint/lint_test.go b/src/pkg/packager/lint/lint_test.go index dcc6488011..a0afd1a8a9 100644 --- a/src/pkg/packager/lint/lint_test.go +++ b/src/pkg/packager/lint/lint_test.go @@ -162,14 +162,14 @@ func TestValidateSchema(t *testing.T) { t.Run("Wrap standalone numbers in bracket", func(t *testing.T) { input := "components12.12.import.path" expected := ".components12.[12].import.path" - acutal := makeFieldPathYqCompat(input) - require.Equal(t, expected, acutal) + actual := makeFieldPathYqCompat(input) + require.Equal(t, expected, actual) }) t.Run("root doesn't change", func(t *testing.T) { input := "(root)" - acutal := makeFieldPathYqCompat(input) - require.Equal(t, input, acutal) + actual := makeFieldPathYqCompat(input) + require.Equal(t, input, actual) }) t.Run("Test composable components", func(t *testing.T) { @@ -227,11 +227,11 @@ func TestValidateSchema(t *testing.T) { } for _, tc := range tests { t.Run(tc.input, func(t *testing.T) { - acutal, err := isPinnedImage(tc.input) + actual, err := isPinnedImage(tc.input) if err != nil { require.EqualError(t, err, tc.err.Error()) } - require.Equal(t, tc.expected, acutal) + require.Equal(t, tc.expected, actual) }) } }) diff --git a/src/pkg/packager/sources/oci.go b/src/pkg/packager/sources/oci.go index 371c53a7b5..92dcac1216 100644 --- a/src/pkg/packager/sources/oci.go +++ b/src/pkg/packager/sources/oci.go @@ -23,7 +23,7 @@ import ( ) var ( - // veryify that OCISource implements PackageSource + // verify that OCISource implements PackageSource _ PackageSource = (*OCISource)(nil) ) diff --git a/src/pkg/packager/sources/split.go b/src/pkg/packager/sources/split.go index 34d736fabb..df5fbd4714 100644 --- a/src/pkg/packager/sources/split.go +++ b/src/pkg/packager/sources/split.go @@ -20,7 +20,7 @@ import ( ) var ( - // veryify that SplitTarballSource implements PackageSource + // verify that SplitTarballSource implements PackageSource _ PackageSource = (*SplitTarballSource)(nil) ) diff --git a/src/pkg/packager/sources/tarball.go b/src/pkg/packager/sources/tarball.go index e65d0b962a..87b01407b3 100644 --- a/src/pkg/packager/sources/tarball.go +++ b/src/pkg/packager/sources/tarball.go @@ -21,7 +21,7 @@ import ( ) var ( - // veryify that TarballSource implements PackageSource + // verify that TarballSource implements PackageSource _ PackageSource = (*TarballSource)(nil) ) diff --git a/src/pkg/packager/sources/url.go b/src/pkg/packager/sources/url.go index 8d65cf6a9c..11f8664302 100644 --- a/src/pkg/packager/sources/url.go +++ b/src/pkg/packager/sources/url.go @@ -18,7 +18,7 @@ import ( ) var ( - // veryify that URLSource implements PackageSource + // verify that URLSource implements PackageSource _ PackageSource = (*URLSource)(nil) ) diff --git a/src/pkg/packager/sources/validate.go b/src/pkg/packager/sources/validate.go index 38e4581b0a..5168efc443 100644 --- a/src/pkg/packager/sources/validate.go +++ b/src/pkg/packager/sources/validate.go @@ -116,7 +116,7 @@ func ValidatePackageIntegrity(loaded *layout.PackagePaths, aggregateChecksum str return fmt.Errorf("unable to validate partial checksums - missing file: %s", rel) } } - // it's okay if we're doing a partial check and the file isn't there as long as the path wasnt loaded + // it's okay if we're doing a partial check and the file isn't there as long as the path wasn't loaded return nil } diff --git a/src/pkg/utils/wait.go b/src/pkg/utils/wait.go index 0c345e8070..ca5c8a1c2d 100644 --- a/src/pkg/utils/wait.go +++ b/src/pkg/utils/wait.go @@ -174,7 +174,7 @@ func waitForNetworkEndpoint(resource, name, condition string, timeout time.Durat continue } - // Success, break out of the swtich statement. + // Success, break out of the switch statement. break } diff --git a/src/test/packages/25-local-tgz-chart/zarf.yaml b/src/test/packages/25-local-tgz-chart/zarf.yaml index 7609b45b45..42158bc7be 100644 --- a/src/test/packages/25-local-tgz-chart/zarf.yaml +++ b/src/test/packages/25-local-tgz-chart/zarf.yaml @@ -1,7 +1,7 @@ kind: ZarfPackageConfig metadata: name: helm-charts-local-tgz - description: Example showcasing mutiple ways to deploy helm charts + description: Example showcasing multiple ways to deploy helm charts version: 0.0.1 components: