diff --git a/docs/aks-installation.md b/docs/aks-installation.md index e18d732d50f..fb001f867cb 100644 --- a/docs/aks-installation.md +++ b/docs/aks-installation.md @@ -73,7 +73,7 @@ you can deploy Antrea as follows: ``` To deploy the latest version of Antrea (built from the main branch), use the -checked-in [deployment yaml](/build/yamls/antrea-aks.yml): +checked-in [deployment yaml](../build/yamls/antrea-aks.yml): ```bash kubectl apply -f https://raw.githubusercontent.com/antrea-io/antrea/main/build/yamls/antrea-aks.yml diff --git a/docs/contributors/code-generation.md b/docs/contributors/code-generation.md index 78fdf630c22..2b9f28f2cc3 100644 --- a/docs/contributors/code-generation.md +++ b/docs/contributors/code-generation.md @@ -5,7 +5,7 @@ Antrea uses [protoc](https://github.com/protocolbuffers/protobuf) and [protoc-gen-go]( https://github.com/golang/protobuf) to generate CNI gRPC service code. -If you make any change to [cni.proto](/pkg/apis/cni/v1beta1/cni.proto), you can +If you make any change to [cni.proto](../pkg/apis/cni/v1beta1/cni.proto), you can re-generate the code by invoking `make codegen`. ## Extension API Resources and Custom Resource Definitions @@ -25,7 +25,7 @@ If you make any change to any `types.go`, you can re-generate the code by invoki Antrea uses the [GoMock](https://github.com/golang/mock) framework for its unit tests. If you add or modify interfaces that need to be mocked, please add or update `MOCKGEN_TARGETS` in -[update-codegen-dockerized.sh](/hack/update-codegen-dockerized.sh) accordingly. All the mocks for a +[update-codegen-dockerized.sh](../hack/update-codegen-dockerized.sh) accordingly. All the mocks for a given package will typically be generated in a sub-package called `testing`. For example, the mock code for the interface `Baz` defined in the package `pkg/foo/bar` will be generated to `pkg/foo/bar/testing/mock_bar.go`, and you can import it via `pkg/foo/bar/testing`. @@ -40,5 +40,5 @@ changes. The collection of metrics is done from a running Kind deployment, in order to reflect the current list of metrics which is exposed by Antrea Controller and Agents. -To regenerate the metrics list within the document, use [make-metrics-doc.sh](/hack/make-metrics-doc.sh) +To regenerate the metrics list within the document, use [make-metrics-doc.sh](../hack/make-metrics-doc.sh) with document location as a parameter. diff --git a/docs/design/architecture.md b/docs/design/architecture.md index e5d913caecf..e11e08eb4d2 100644 --- a/docs/design/architecture.md +++ b/docs/design/architecture.md @@ -336,7 +336,7 @@ Antrea Agent DaemonSet, which runs the `ovs-monitor-ipsec` and strongSwan daemons. Antrea now supports only using pre-shared key (PSK) for IKE authentication, and the PSK string must be passed to Antrea Agent using an environment variable - `ANTREA_IPSEC_PSK`. The PSK string can be specified in -the [Antrea IPsec deployment yaml](/build/yamls/antrea-ipsec.yml), which creates +the [Antrea IPsec deployment yaml](../build/yamls/antrea-ipsec.yml), which creates a Kubernetes Secret to save the PSK value and populates it to the `ANTREA_IPSEC_PSK` environment variable of the Antrea Agent container. diff --git a/docs/eks-installation.md b/docs/eks-installation.md index 61b3bd3b9ea..45839528e87 100644 --- a/docs/eks-installation.md +++ b/docs/eks-installation.md @@ -32,7 +32,7 @@ kubectl apply -f https://github.com/antrea-io/antrea/releases/download//ant ``` To deploy the latest version of Antrea (built from the main branch), use the -checked-in [deployment yaml](/build/yamls/antrea-eks.yml): +checked-in [deployment yaml](../build/yamls/antrea-eks.yml): ```bash kubectl apply -f https://raw.githubusercontent.com/antrea-io/antrea/main/build/yamls/antrea-eks.yml diff --git a/docs/external-node.md b/docs/external-node.md index 5f8fd90ff25..5abfe89752f 100644 --- a/docs/external-node.md +++ b/docs/external-node.md @@ -510,7 +510,7 @@ running on an external Node is as follows: - Only `update` permission is given on resource `antreaagentinfos`, and `create` permission is moved to `antrea-controller` -For more details please refer to [vm-agent-rbac.yml](/build/yamls/externalnode/vm-agent-rbac.yml) +For more details please refer to [vm-agent-rbac.yml](../build/yamls/externalnode/vm-agent-rbac.yml) `antrea-agent` reports its status by updating the `antreaagentinfo` resource which is created with the same name as the `ExternalNode`. `antrea-controller` diff --git a/docs/getting-started.md b/docs/getting-started.md index 0ad38f0e699..61bd15d8bf8 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -80,7 +80,7 @@ kubectl apply -f https://github.com/antrea-io/antrea/releases/download//ant ``` To deploy the latest version of Antrea (built from the main branch), use the -checked-in [deployment yaml](/build/yamls/antrea.yml): +checked-in [deployment yaml](../build/yamls/antrea.yml): ```bash kubectl apply -f https://raw.githubusercontent.com/antrea-io/antrea/main/build/yamls/antrea.yml diff --git a/docs/gke-installation.md b/docs/gke-installation.md index 70246ac9fab..5fb3e01466c 100644 --- a/docs/gke-installation.md +++ b/docs/gke-installation.md @@ -91,7 +91,7 @@ you can deploy Antrea as follows: ``` To deploy the latest version of Antrea (built from the main branch), use the -checked-in [deployment yaml](/build/yamls/antrea-gke.yml): +checked-in [deployment yaml](../build/yamls/antrea-gke.yml): ```bash kubectl apply -f https://raw.githubusercontent.com/antrea-io/antrea/main/build/yamls/antrea-gke.yml diff --git a/docs/network-flow-visibility.md b/docs/network-flow-visibility.md index 97148e12d01..c7960d58b2b 100644 --- a/docs/network-flow-visibility.md +++ b/docs/network-flow-visibility.md @@ -238,7 +238,7 @@ kubectl apply -f https://github.com/antrea-io/antrea/releases/download//flo ``` To deploy the latest version of Flow Aggregator Service (built from the main branch), use the -checked-in [deployment yaml](/build/yamls/flow-aggregator.yml): +checked-in [deployment yaml](../build/yamls/flow-aggregator.yml): ```bash kubectl apply -f https://raw.githubusercontent.com/antrea-io/antrea/main/build/yamls/flow-aggregator.yml diff --git a/docs/octant-plugin-installation.md b/docs/octant-plugin-installation.md index 422df267e3a..f781a5d974c 100644 --- a/docs/octant-plugin-installation.md +++ b/docs/octant-plugin-installation.md @@ -15,14 +15,14 @@ antrea-octant-plugin depends on the Antrea monitoring CRDs (AntreaControllerInfo To run Octant together with antrea-octant-plugin, please make sure you have these CRDs defined in you K8s cluster. If Antrea is deployed before antrea-octant-plugin starts by using the standard deployment yaml, these -CRDs should already be added. If not, please refer to [antrea.yaml](/build/yamls/antrea.yml) to +CRDs should already be added. If not, please refer to [antrea.yaml](../build/yamls/antrea.yml) to create these CRDs first. ### Deploy Octant and antrea-octant-plugin as a Pod You can follow the sample below to run Octant and antrea-octant-plugin in Pod. In this example, we expose UI as a NodePort Service for accessing externally. -You can update [antrea-octant.yaml](/build/yamls/antrea-octant.yml) according to +You can update [antrea-octant.yaml](../build/yamls/antrea-octant.yml) according to your environment and preference. 1. Create a secret that contains your kubeconfig. @@ -32,7 +32,7 @@ your environment and preference. kubectl create secret generic octant-kubeconfig --from-file=admin.conf= -n kube-system ``` -2. You can change the sample yaml [build/yamls/antrea-octant.yml](/build/yamls/antrea-octant.yml) +2. You can change the sample yaml [build/yamls/antrea-octant.yml](../build/yamls/antrea-octant.yml) according to your requirements and environment, then apply the yaml to create both Deployment and NodePort Service. ```bash diff --git a/docs/prometheus-integration.md b/docs/prometheus-integration.md index f05826ffc44..bb4a84fd9ba 100644 --- a/docs/prometheus-integration.md +++ b/docs/prometheus-integration.md @@ -122,7 +122,7 @@ relabel_configs: ``` For further reference see the enclosed -[configuration file](/build/yamls/antrea-prometheus.yml). +[configuration file](../build/yamls/antrea-prometheus.yml). The configuration file above can be used to deploy Prometheus Server with scraping configuration for Antrea services. diff --git a/docs/traffic-encryption.md b/docs/traffic-encryption.md index 7930ca9f3a1..fc679cebada 100644 --- a/docs/traffic-encryption.md +++ b/docs/traffic-encryption.md @@ -25,7 +25,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) +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 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 @@ -89,7 +89,7 @@ install WireGuard together with the kernel module on various operating systems. ### Antrea installation -First, download the [Antrea deployment yaml](/build/yamls/antrea.yml). To deploy +First, download the [Antrea deployment yaml](../build/yamls/antrea.yml). To deploy a released version of Antrea, pick a version from the [list of releases](https://github.com/antrea-io/antrea/releases). Note that WireGuard support was added in release 1.3.0, which means you can not pick a release older than 1.3.0. For any given release `` (e.g. `v1.3.0`),