Skip to content

Commit

Permalink
Fix automatically found typos and related spelling
Browse files Browse the repository at this point in the history
Found and fixed using the following command:
codespell -f -H -S .git,_artifacts,*.sum -L
aks,witht,geting,ot,intepreted -C0 -i0 -w

Additionally did kubernetes -> Kubernetes in exp/api/v1beta1
and 'to to' -> 'to'.

Signed-off-by: Mateusz Gozdek <[email protected]>
  • Loading branch information
invidian committed May 3, 2022
1 parent 194722a commit 4824dbc
Show file tree
Hide file tree
Showing 32 changed files with 56 additions and 57 deletions.
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,20 +34,20 @@ If you're new to the project and want to help, but don't know where to start, we
1. See the [Development Guide](https://capz.sigs.k8s.io/developers/development.html) for more instructions on setting up your environment and testing changes locally.
3. Submit a pull request.
1. All PRs should be labeled with one of the following kinds
- `/kind feature` for PRs releated to adding new features/tests
- `/kind bug` for PRs releated to bug fixes and patches
- `/kind api-change` for PRs releated to adding, removing, or otherwise changing an API
- `/kind cleanup` for PRs releated to code refactoring and cleanup
- `/kind feature` for PRs related to adding new features/tests
- `/kind bug` for PRs related to bug fixes and patches
- `/kind api-change` for PRs related to adding, removing, or otherwise changing an API
- `/kind cleanup` for PRs related to code refactoring and cleanup
- `/kind deprecation` for PRs related to a feature/enhancement marked for deprecation.
- `/kind design` for PRs releated to design proposals
- `/kind documentation` for PRs releated to documentation
- `/kind failing-test` for PRs releated to to a consistently or frequently failing test.
- `/kind design` for PRs related to design proposals
- `/kind documentation` for PRs related to documentation
- `/kind failing-test` for PRs related to a consistently or frequently failing test.
- `/kind flake` for PRs related to a flaky test.
- `/kind other` for PRs releated to updating dependencies, minor changes or other
- `/kind other` for PRs related to updating dependencies, minor changes or other
2. If the PR requires additional action from users switching to a new release, include the string "action required" in the PR release-notes.
3. All code changes must be covered by unit tests and E2E tests.
4. All new features should come with user documentation.
4. Once the PR has been reviewed and is ready to be merged, commits should be [squashed](https://github.com/kubernetes/community/blob/master/contributors/guide/github-workflow.md#squash-commits).
4. Once the PR has been reviewed and is ready to be merged, commits should be [squashed](https://github.com/kubernetes/community/blob/master/contributors/guide/github-workflow.md#squash-commits).
1. Ensure that commit message(s) are be meaningful and commit history is readable.

All changes must be code reviewed. Coding conventions and standards are explained in the official [developer docs](https://github.com/kubernetes/community/tree/master/contributors/devel). Expect reviewers to request that you avoid common [go style mistakes](https://github.com/golang/go/wiki/CodeReviewComments) in your PRs.
Expand Down
2 changes: 1 addition & 1 deletion api/v1alpha4/conditions_consts.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ const (
WaitingForClusterInfrastructureReason = "WaitingForClusterInfrastructure"
// WaitingForBootstrapDataReason used when machine is waiting for bootstrap data to be ready before proceeding.
WaitingForBootstrapDataReason = "WaitingForBootstrapData"
// BootstrapSucceededCondition reports the result of the execution of the boostrap data on the machine.
// BootstrapSucceededCondition reports the result of the execution of the bootstrap data on the machine.
BootstrapSucceededCondition = "BoostrapSucceeded"
// BootstrapInProgressReason is used to indicate the bootstrap data has not finished executing.
BootstrapInProgressReason = "BootstrapInProgress"
Expand Down
2 changes: 1 addition & 1 deletion api/v1beta1/azurecluster_validation_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -588,7 +588,7 @@ func TestValidateSubnetCIDR(t *testing.T) {
},
},
{
name: "subnet cidr in atleast one vnet's range in case of multiple vnet cidr blocks",
name: "subnet cidr in at least one vnet's range in case of multiple vnet cidr blocks",
vnetCidrBlocks: []string{"10.0.0.0/8", "11.0.0.0/8"},
subnetCidrBlocks: []string{"10.1.0.0/16", "10.0.0.0/16", "11.1.0.0/16"},
wantErr: false,
Expand Down
2 changes: 1 addition & 1 deletion api/v1beta1/conditions_consts.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ const (
WaitingForClusterInfrastructureReason = "WaitingForClusterInfrastructure"
// WaitingForBootstrapDataReason used when machine is waiting for bootstrap data to be ready before proceeding.
WaitingForBootstrapDataReason = "WaitingForBootstrapData"
// BootstrapSucceededCondition reports the result of the execution of the boostrap data on the machine.
// BootstrapSucceededCondition reports the result of the execution of the bootstrap data on the machine.
BootstrapSucceededCondition clusterv1.ConditionType = "BootstrapSucceeded"
// BootstrapInProgressReason is used to indicate the bootstrap data has not finished executing.
BootstrapInProgressReason = "BootstrapInProgress"
Expand Down
2 changes: 1 addition & 1 deletion azure/scope/cluster_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2112,7 +2112,7 @@ func TestFailureDomains(t *testing.T) {
},
},
{
name: "Mutiple failure domains present in azure cluster status",
name: "Multiple failure domains present in azure cluster status",
expectFailureDomains: []string{"failure-domain-id-1", "failure-domain-id-2", "failure-domain-id-3"},
clusterName: "my-cluster",
azureClusterStatus: infrav1.AzureClusterStatus{
Expand Down
2 changes: 1 addition & 1 deletion azure/scope/identity.go
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ func createAzureIdentityWithBindings(ctx context.Context, azureIdentity *infrav1
}

// AzureIdentity and AzureIdentityBinding will no longer have an OwnerRef starting from capz release v0.5.0 because of the following:
// In Kubenetes v1.20+, if the garbage collector detects an invalid cross-namespace ownerReference, or a cluster-scoped dependent with
// In Kubernetes v1.20+, if the garbage collector detects an invalid cross-namespace ownerReference, or a cluster-scoped dependent with
// an ownerReference referencing a namespaced kind, a warning Event with a reason of OwnerRefInvalidNamespace and an involvedObject
// of the invalid dependent is reported. You can check for that kind of Event by running kubectl get events -A --field-selector=reason=OwnerRefInvalidNamespace.

Expand Down
2 changes: 1 addition & 1 deletion azure/scope/machinepoolmachine.go
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ func (s *MachinePoolMachineScope) UpdateStatus(ctx context.Context) error {
}

if err != nil && !apierrors.IsNotFound(err) {
return errors.Wrap(err, "failed to to get node by providerID or object reference")
return errors.Wrap(err, "failed to get node by providerID or object reference")
}

if node != nil {
Expand Down
2 changes: 1 addition & 1 deletion azure/scope/machinepoolmachine_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ func TestMachineScope_UpdateStatus(t *testing.T) {
mockNodeGetter.EXPECT().GetNodeByProviderID(gomock2.AContext(), FakeProviderID).Return(nil, errors.New("boom"))
return nil, ampm
},
Err: "failed to to get node by providerID or object reference: boom",
Err: "failed to get node by providerID or object reference: boom",
},
{
Name: "should not mark AMPM ready if node is not ready",
Expand Down
2 changes: 1 addition & 1 deletion azure/services/bastionhosts/azurebastion_spec.go
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ func (s *AzureBastionSpec) OwnerResourceName() string {
}

// Parameters returns the parameters for the bastion host.
func (s *AzureBastionSpec) Parameters(existing interface{}) (paramteres interface{}, err error) {
func (s *AzureBastionSpec) Parameters(existing interface{}) (parameters interface{}, err error) {
if existing != nil {
if _, ok := existing.(network.BastionHost); !ok {
return nil, errors.Errorf("%T is not a network.BastionHost", existing)
Expand Down
2 changes: 1 addition & 1 deletion azure/services/natgateways/natgateways.go
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ func (s *Service) Reconcile(ctx context.Context) error {
if err == nil {
natGateway, ok := result.(network.NatGateway)
if !ok {
// Return out of loop since this would be an unexepcted fatal error
// Return out of loop since this would be an unexpected fatal error
resultingErr = errors.Errorf("created resource %T is not a network.NatGateway", result)
break
}
Expand Down
2 changes: 1 addition & 1 deletion azure/services/scalesetvms/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ func (ac *azureClient) GetResultIfDone(ctx context.Context, future *infrav1.Futu
VirtualMachineScaleSetVMsDeleteFuture: future,
}
default:
return compute.VirtualMachineScaleSetVM{}, errors.Errorf("unknown furture type %q", future.Type)
return compute.VirtualMachineScaleSetVM{}, errors.Errorf("unknown future type %q", future.Type)
}

done, err := genericFuture.DoneWithContext(ctx, ac.scalesetvms)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ spec:
type: string
nodeResourceGroupName:
description: NodeResourceGroupName is the name of the resource group
containining cluster IaaS resources. Will be populated to default
containing cluster IaaS resources. Will be populated to default
in webhook.
type: string
resourceGroupName:
Expand Down Expand Up @@ -368,7 +368,7 @@ spec:
type: string
nodeResourceGroupName:
description: NodeResourceGroupName is the name of the resource group
containining cluster IaaS resources. Will be populated to default
containing cluster IaaS resources. Will be populated to default
in webhook.
type: string
resourceGroupName:
Expand Down Expand Up @@ -693,7 +693,7 @@ spec:
type: string
nodeResourceGroupName:
description: NodeResourceGroupName is the name of the resource group
containining cluster IaaS resources. Will be populated to default
containing cluster IaaS resources. Will be populated to default
in webhook.
type: string
resourceGroupName:
Expand Down
16 changes: 8 additions & 8 deletions docs/book/src/developers/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ Install [Helm](https://helm.sh/docs/intro/install/):
- `choco install kubernetes-helm` on Windows
- [Install Instruction](https://helm.sh/docs/intro/install/#from-source-linux-macos) on Linux

You would require installation of Helm for succesfully setting up Tilt.
You would require installation of Helm for successfully setting up Tilt.

### Using Tilt

Expand Down Expand Up @@ -371,8 +371,8 @@ export WORKER_MACHINE_COUNT=2
export KUBERNETES_VERSION="v1.22.1"

# Identity secret.
export AZURE_CLUSTER_IDENTITY_SECRET_NAME="cluster-identity-secret"
export CLUSTER_IDENTITY_NAME="cluster-identity"
export AZURE_CLUSTER_IDENTITY_SECRET_NAME="cluster-identity-secret"
export CLUSTER_IDENTITY_NAME="cluster-identity"
export AZURE_CLUSTER_IDENTITY_SECRET_NAMESPACE="default"

# Generate SSH key.
Expand All @@ -392,7 +392,7 @@ or the use of `envsubst` to replace these values

##### Creating the cluster

⚠️ Make sure you followed the previous two steps to build the dev image and set the required environment variables before proceding.
⚠️ Make sure you followed the previous two steps to build the dev image and set the required environment variables before proceeding.

Ensure dev environment has been reset:

Expand Down Expand Up @@ -435,7 +435,7 @@ defer done()
```

The code above creates a context with a new span stored in the context.Context value bag. If a span already existed in
the `ctx` arguement, then the new span would take on the parentID of the existing span, otherwise the new span
the `ctx` argument, then the new span would take on the parentID of the existing span, otherwise the new span
becomes a "root span", one that does not have a parent. The span is also created with labels, or tags, which
provide metadata about the span and can be used to query in many distributed tracing systems.

Expand Down Expand Up @@ -492,7 +492,7 @@ You can optionally set the following variables:
|----------------------------|---------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|
| `E2E_CONF_FILE` | The path of the [E2E configuration file](https://cluster-api.sigs.k8s.io/developer/e2e.html#defining-an-e2e-config-file). | `${GOPATH}/src/sigs.k8s.io/cluster-api-provider-azure/test/e2e/config/azure-dev.yaml` |
| `SKIP_CLEANUP` | Set to `true` if you do not want the bootstrap and workload clusters to be cleaned up after running E2E tests. | `false` |
| `SKIP_CREATE_MGMT_CLUSTER` | Skip management cluster creation. If skipping managment cluster creation you must specify `KUBECONFIG` and `SKIP_CLEANUP` | `false` |
| `SKIP_CREATE_MGMT_CLUSTER` | Skip management cluster creation. If skipping management cluster creation you must specify `KUBECONFIG` and `SKIP_CLEANUP` | `false` |
| `LOCAL_ONLY` | Use Kind local registry and run the subset of tests which don't require a remotely pushed controller image. | `true` |
| `REGISTRY` | Registry to push the controller image. | `capzci.azurecr.io/ci-e2e` |
| `CLUSTER_NAME` | Name of an existing workload cluster. Must be set to run specs against existing workload cluster. Use in conjunction with `SKIP_CREATE_MGMT_CLUSTER`, `GINKGO_FOCUS`, `CLUSTER_NAMESPACE` and `KUBECONFIG`. Must specify **only one** e2e spec to run against with `GINKGO_FOCUS` such as `export GINKGO_FOCUS=Creating.a.VMSS.cluster.with.a.single.control.plane.node`. |
Expand Down Expand Up @@ -532,7 +532,7 @@ With the following environment variables defined, CAPZ runs `./scripts/ci-build-
|-------------------------|------------|
| `AZURE_STORAGE_ACCOUNT` | Your Azure storage account name |
| `AZURE_STORAGE_KEY` | Your Azure storage key |
| `JOB_NAME` | `test` (an enviroment variable used by CI, can be any non-empty string) |
| `JOB_NAME` | `test` (an environment variable used by CI, can be any non-empty string) |
| `LOCAL_ONLY` | `false` |
| `REGISTRY` | Your Registry |
| `TEST_K8S` | `true` |
Expand All @@ -558,7 +558,7 @@ You can optionally set the following variables:
| `EXP_MACHINE_POOL` | Use [Machine Pool](../topics/machinepools.md) for worker machines. |
| `TEST_WINDOWS` | Build a cluster that has Windows worker nodes. |
| `REGISTRY` | Registry to push any custom k8s images or cloud provider images built. |
| `CLUSTER_TEMPLATE` | Use a custom cluster template. By default, the script will choose the appropriate cluster template based on existing environment variabes. |
| `CLUSTER_TEMPLATE` | Use a custom cluster template. By default, the script will choose the appropriate cluster template based on existing environment variables. |

You can also customize the configuration of the CAPZ cluster (assuming that `SKIP_CREATE_WORKLOAD_CLUSTER` is not set). See [Customizing the cluster deployment](#customizing-the-cluster-deployment) for more details.

Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/developers/kubernetes-developers.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export AZURE_STORAGE_ACCOUNT=<AzureStorageAccount>
export AZURE_STORAGE_KEY=<AzureStorageKey>
export REGISTRY=<Registry>
export TEST_K8S="true"
export JOB_NAME="test" # an enviroment variable used by CI, can be any non-empty string
export JOB_NAME="test" # an environment variable used by CI, can be any non-empty string

source ./scripts/ci-build-kubernetes.sh
```
Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/topics/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ The Windows HostProcess Container feature is Alpha for Kubernetes v1.22 and Beta

Current requirements:

- Kuberentes 1.22+
- Kubernetes 1.22+
- containerd 1.6+
- `WindowsHostProcessContainers` feature-gate (Alpha for v1.22) turned on for kube-apiserver and kubelet if using Kubernetes 1.22

Expand Down
4 changes: 2 additions & 2 deletions docs/proposals/20201214-bootstrap-failure-detection.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ For more info see https://docs.microsoft.com/en-us/azure/service-bus-messaging/

#### Pub Sub Cons:
- Complicated, lots of additional moving pieces:
- Might have to write our own OS-specific tools to consume bootstrap logs and publish them, and those tools would be installed by additional VM Extentions, or add'l cloud-init configuration
- Might have to write our own OS-specific tools to consume bootstrap logs and publish them, and those tools would be installed by additional VM Extensions, or add'l cloud-init configuration
- Add’l IaaS cost

### Option 3: Azure Custom Script Extensions
Expand Down Expand Up @@ -133,7 +133,7 @@ At a very high level, this is what we want our capz-named Azure VM Extension to
- Again, we assume using a common exit code for all failure states is acceptable for the initial scope of this work
- Set appropriate AzureMachine (and possibly Machine?) conditions

VM Boot Diagnostics should be used in conjunction with the extension. The VM extension provides a simple pass/fail signal that can be used by CAPZ to set conditions and indicate bootstrap status. Boot Diagnostics can provide a quick look at what went wrong to the user by displaying cloud-init logs without needing to SSH into the VM. In the future, boot diagnostics might even used to stream logs programatically at the AzureMachine level.
VM Boot Diagnostics should be used in conjunction with the extension. The VM extension provides a simple pass/fail signal that can be used by CAPZ to set conditions and indicate bootstrap status. Boot Diagnostics can provide a quick look at what went wrong to the user by displaying cloud-init logs without needing to SSH into the VM. In the future, boot diagnostics might even used to stream logs programmatically at the AzureMachine level.


## Questions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -316,5 +316,5 @@ This is not mutually exclusive with the proposal above. In fact, it might be a g

## <a name='ImplementationHistory'></a>Implementation History

- 2020/12/04: Inital POC [PR](https://github.com/kubernetes-sigs/cluster-api-provider-azure/pull/1067) for AzureMachinePool opened
- 2020/12/04: Initial POC [PR](https://github.com/kubernetes-sigs/cluster-api-provider-azure/pull/1067) for AzureMachinePool opened
- 2021/07/16: Initial proposal
2 changes: 1 addition & 1 deletion exp/api/v1alpha3/azuremanagedcontrolplane_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ type AzureManagedControlPlaneSpec struct {
ResourceGroupName string `json:"resourceGroupName"`

// NodeResourceGroupName is the name of the resource group
// containining cluster IaaS resources. Will be populated to default
// containing cluster IaaS resources. Will be populated to default
// in webhook.
NodeResourceGroupName string `json:"nodeResourceGroupName"`

Expand Down
2 changes: 1 addition & 1 deletion exp/api/v1alpha4/azuremanagedcontrolplane_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ type AzureManagedControlPlaneSpec struct {
ResourceGroupName string `json:"resourceGroupName"`

// NodeResourceGroupName is the name of the resource group
// containining cluster IaaS resources. Will be populated to default
// containing cluster IaaS resources. Will be populated to default
// in webhook.
// +optional
NodeResourceGroupName string `json:"nodeResourceGroupName,omitempty"`
Expand Down
2 changes: 1 addition & 1 deletion exp/api/v1beta1/azuremanagedcontrolplane_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ type AzureManagedControlPlaneSpec struct {
ResourceGroupName string `json:"resourceGroupName"`

// NodeResourceGroupName is the name of the resource group
// containining cluster IaaS resources. Will be populated to default
// containing cluster IaaS resources. Will be populated to default
// in webhook.
// +optional
NodeResourceGroupName string `json:"nodeResourceGroupName,omitempty"`
Expand Down
3 changes: 1 addition & 2 deletions exp/api/v1beta1/azuremanagedcontrolplane_webhook_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ func TestValidatingWebhook(t *testing.T) {
expectErr: true,
},
{
name: "not following the kuberntes Version pattern",
name: "not following the Kubernetes Version pattern",
amcp: AzureManagedControlPlane{
Spec: AzureManagedControlPlaneSpec{
DNSServiceIP: pointer.StringPtr("192.168.0.0"),
Expand Down Expand Up @@ -631,7 +631,6 @@ func TestAzureManagedControlPlane_ValidateUpdate(t *testing.T) {
Spec: AzureManagedControlPlaneSpec{
Version: "v1.18.0",
AADProfile: &AADProfile{

Managed: false,
AdminGroupObjectIDs: []string{
"616077a8-5db7-4c98-b856-b34619afg75h",
Expand Down
Loading

0 comments on commit 4824dbc

Please sign in to comment.