Skip to content

Commit

Permalink
Fix typos and a 404 link (#5572)
Browse files Browse the repository at this point in the history
Signed-off-by: ceclinux <[email protected]>
  • Loading branch information
ceclinux authored Oct 13, 2023
1 parent c2115fd commit 5c35769
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/antrea-network-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -1774,6 +1774,6 @@ Similar RBAC is applied to the ClusterGroup resource.
matched at the same priority with conflicting actions. It will be the policy writer's
responsibility to identify such ambiguities in rule definitions and avoid potential
nondeterministic rule enforcement results.
- NetworPolicies are connection/flow oriented and stateful. They apply to
- NetworkPolicies are connection/flow oriented and stateful. They apply to
connections, instead of individual packets, which means established connections
won't be blocked by new rules.
2 changes: 1 addition & 1 deletion docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ These are the CRDs currently available in `crd.antrea.io`.

### Other API groups

These are the API group versions which are curently available when using Antrea.
These are the API group versions which are currently available when using Antrea.

| API group | API version | API Service? | Introduced in | Deprecated in / Planned Deprecation | Planned Removal |
|---|---|---|---|---|---|
Expand Down
6 changes: 3 additions & 3 deletions docs/service-loadbalancer.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,11 +237,10 @@ To learn more about MetalLB concepts and functionalities, you can read the
You can run the following commands to install MetalLB using the YAML manifests:

```bash
kubectl apply -f https://raw.githubusercontent.com/metallb/metallb/v0.13.9/manifests/namespace.yaml
kubectl apply -f https://raw.githubusercontent.com/metallb/metallb/v0.13.9/manifests/metallb.yaml
kubectl apply -f https://raw.githubusercontent.com/metallb/metallb/v0.13.11/config/manifests/metallb-native.yaml
```

The commands will deploy MetalLB version 0.13.9 into Namespace
The commands will deploy MetalLB version 0.13.11 into Namespace
`metallb-system`. You can also refer to this [MetalLB installation
guide](https://metallb.universe.tf/installation) for other ways of installing
MetalLB.
Expand Down Expand Up @@ -279,6 +278,7 @@ spec:
addresses:
- 10.10.0.2-10.10.0.10
---
apiVersion: metallb.io/v1beta1
kind: L2Advertisement
metadata:
name: example
Expand Down
6 changes: 3 additions & 3 deletions docs/traffic-encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ WireGuard. Traffic encryption is not supported on Windows Nodes yet.

## IPsec

IPsec encyption works for all tunnel types supported by OVS including Geneve,
IPsec encryption works for all tunnel types supported by OVS including Geneve,
GRE, VXLAN, and STT tunnel.

Note that GRE is not supported for IPv6 clusters (IPv6-only or dual-stack
Expand All @@ -17,7 +17,7 @@ Geneve or VXLAN.
IPsec requires a set of Linux kernel modules. Check the required kernel modules
listed in the [strongSwan documentation](https://wiki.strongswan.org/projects/strongswan/wiki/KernelModules).
Make sure the required kernel modules are loaded on the Kubernetes Nodes before
deploying Antrea with IPsec encyption enabled.
deploying Antrea with IPsec encryption enabled.

If you want to enable IPsec with Geneve, please make sure [this commit](https://github.com/torvalds/linux/commit/34beb21594519ce64a55a498c2fe7d567bc1ca20)
is included in the kernel. For Ubuntu 18.04, kernel version should be at least
Expand All @@ -26,7 +26,7 @@ is included in the kernel. For Ubuntu 18.04, kernel version should be at least
### Antrea installation

You can simply apply the [Antrea IPsec deployment yaml](../build/yamls/antrea-ipsec.yml)
to deploy Antrea with IPsec encyption enabled. To deploy a released version of
to deploy Antrea with IPsec encryption enabled. To deploy a released version of
Antrea, pick a version from the [list of releases](https://github.com/antrea-io/antrea/releases).
Note that IPsec support was added in release 0.3.0, which means you can not
pick a release older than 0.3.0. For any given release `<TAG>` (e.g. `v0.3.0`),
Expand Down
6 changes: 3 additions & 3 deletions docs/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ some_counter 0

In the future, we may introduce the same concept of [hidden
metric](https://kubernetes.io/docs/concepts/cluster-administration/system-metrics/#show-hidden-metrics)
as K8s, as an additional part of the metric lifecyle.
as K8s, as an additional part of the metric lifecycle.

### APIs deprecation policy

Expand All @@ -196,7 +196,7 @@ removal of new versions for this API must respect the ["graceful" upgrade
guarantee](#antrea-upgrade-and-supported-version-skew). The `controlplane` API
(which is exposed using the aggregation layer) is often referred to as an
"internal" API as it is used by the Antrea components to communicate with each
other, and is usually not consummed by end users, e.g. cluster admins. However,
other, and is usually not consumed by end users, e.g. cluster admins. However,
this API may also be used for integration with other software, which is why we
abide to the same deprecation policy as for other more "user-facing" APIs
(e.g. Antrea-native policy CRDs).
Expand Down Expand Up @@ -239,7 +239,7 @@ When introducing a new version of a CRD, [the API deprecation policy should be
followed](#apis-deprecation-policy).

When introducing a CRD, the following rule should be followed in order to avoid
potential dependency cyles (and thus import cycles in Go): if the CRD depends on
potential dependency cycles (and thus import cycles in Go): if the CRD depends on
other object types spread across potentially different versions of
`crd.antrea.io`, the CRD should be defined in a group version greater or equal
to all of these versions. For example, if we want to introduce a new CRD which
Expand Down
2 changes: 1 addition & 1 deletion pkg/agent/interfacestore/interface_cache.go
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ const (
// check previousResult with local cache.
// Host gateway and the default tunnel interfaces are added into cache in node initialization
// phase or retrieved from existing OVS ports.
// An IPsec tunnel interface is added into the cache when IPsec encyption is enabled, and
// An IPsec tunnel interface is added into the cache when IPsec encryption is enabled, and
// NodeRouteController watches a new remote Node from K8s API, and is removed when the remote
// Node is deleted.
// Todo: add periodic task to sync local cache with container veth pair
Expand Down

0 comments on commit 5c35769

Please sign in to comment.