Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore: fix spelling #2333

Merged
merged 3 commits into from
Feb 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/0-zarf-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/12-contribute-to-zarf/2-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/3-create-a-zarf-package/8-vscode.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/5-zarf-tutorials/0-creating-a-zarf-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <directory>` to validate aginst the [`zarf.schema.json`](https://github.com/defenseunicorns/zarf/blob/main/zarf.schema.json)
Additionally, you can run `zarf dev lint <directory>` to validate against the [`zarf.schema.json`](https://github.com/defenseunicorns/zarf/blob/main/zarf.schema.json)

:::

Expand Down
6 changes: 3 additions & 3 deletions docs/5-zarf-tutorials/9-resource-adoption.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ 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))

## Youtube Tutorial
[![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

Expand Down Expand Up @@ -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.
At this point the dos-game package is managed by Zarf and will behave just like a package initially deployed with Zarf.
2 changes: 1 addition & 1 deletion docs/9-roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion examples/helm-charts/zarf.yaml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion packages/logging-pgl/pgl-values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
12 changes: 6 additions & 6 deletions src/internal/packager/git/gitea.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
2 changes: 1 addition & 1 deletion src/internal/packager/helm/utils.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/pkg/k8s/services.go
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion src/pkg/packager/actions.go
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/pkg/packager/composer/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
12 changes: 6 additions & 6 deletions src/pkg/packager/lint/lint_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down Expand Up @@ -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)
})
}
})
Expand Down
2 changes: 1 addition & 1 deletion src/pkg/packager/sources/oci.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import (
)

var (
// veryify that OCISource implements PackageSource
// verify that OCISource implements PackageSource
_ PackageSource = (*OCISource)(nil)
)

Expand Down
2 changes: 1 addition & 1 deletion src/pkg/packager/sources/split.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import (
)

var (
// veryify that SplitTarballSource implements PackageSource
// verify that SplitTarballSource implements PackageSource
_ PackageSource = (*SplitTarballSource)(nil)
)

Expand Down
2 changes: 1 addition & 1 deletion src/pkg/packager/sources/tarball.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import (
)

var (
// veryify that TarballSource implements PackageSource
// verify that TarballSource implements PackageSource
_ PackageSource = (*TarballSource)(nil)
)

Expand Down
2 changes: 1 addition & 1 deletion src/pkg/packager/sources/url.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import (
)

var (
// veryify that URLSource implements PackageSource
// verify that URLSource implements PackageSource
_ PackageSource = (*URLSource)(nil)
)

Expand Down
2 changes: 1 addition & 1 deletion src/pkg/packager/sources/validate.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
}

Expand Down
2 changes: 1 addition & 1 deletion src/pkg/utils/wait.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
}

Expand Down
2 changes: 1 addition & 1 deletion src/test/packages/25-local-tgz-chart/zarf.yaml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down