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

Change absolute paths to relative paths in docs #4698

Merged
merged 1 commit into from
Mar 23, 2023
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/aks-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/antctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -656,7 +656,7 @@ testmulticast-vw7gx5b9 test3-sender-1 0 10

### Showing memberlist state

`antctl` agent command `get memberlist` (or `get ml`) print the state of memberlist cluster of Antrea Agent.
`antctl` agent command `get memberlist` (or `get ml`) prints the state of memberlist cluster of Antrea Agent.

```bash
$ antctl get memberlist
Expand Down
6 changes: 3 additions & 3 deletions docs/contributors/code-generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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`.
Expand All @@ -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.
2 changes: 1 addition & 1 deletion docs/design/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/eks-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ kubectl apply -f https://github.com/antrea-io/antrea/releases/download/<TAG>/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
Expand Down
2 changes: 1 addition & 1 deletion docs/external-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ kubectl apply -f https://github.com/antrea-io/antrea/releases/download/<TAG>/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
Expand Down
2 changes: 1 addition & 1 deletion docs/gke-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/network-flow-visibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ kubectl apply -f https://github.com/antrea-io/antrea/releases/download/<TAG>/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
Expand Down
6 changes: 3 additions & 3 deletions docs/octant-plugin-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -32,7 +32,7 @@ your environment and preference.
kubectl create secret generic octant-kubeconfig --from-file=admin.conf=<path to kubeconfig file> -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
Expand Down
2 changes: 1 addition & 1 deletion docs/prometheus-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/traffic-encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 `<TAG>` (e.g. `v1.3.0`),
Expand Down