Skip to content

Commit

Permalink
Website update for main
Browse files Browse the repository at this point in the history
  • Loading branch information
antrea-bot committed Apr 10, 2024
1 parent b69bac2 commit 3a4d275
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 15 deletions.
9 changes: 5 additions & 4 deletions content/docs/main/docs/antctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,11 @@ running in three different modes:

## Installation

The antctl binary is included in the Antrea Docker image
(`antrea/antrea-ubuntu`) which means that there is no need to install anything
to connect to the Antrea Agent. Simply exec into the antrea-agent container for
the appropriate antrea-agent Pod and run `antctl`:
The antctl binary is included in the Antrea Docker images
(`antrea/antrea-agent-ubuntu`, `antrea/antrea-controller-ubuntu`) which means
that there is no need to install anything to connect to the Antrea Agent. Simply
exec into the antrea-agent container for the appropriate antrea-agent Pod and
run `antctl`:

```bash
kubectl exec -it ANTREA-AGENT_POD_NAME -n kube-system -c antrea-agent -- bash
Expand Down
2 changes: 1 addition & 1 deletion content/docs/main/docs/api-reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -14511,5 +14511,5 @@ <h3 id="system.antrea.io/v1beta1.BundleStatus">BundleStatus
<hr/>
<p><em>
Generated with <code>gen-crd-api-reference-docs</code>
on git commit <code>a262fc9</code>.
on git commit <code>ed325d0</code>.
</em></p>
5 changes: 3 additions & 2 deletions content/docs/main/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,9 @@ If you want to add Windows Nodes to your cluster, please refer to these
Starting with v1.0, Antrea supports arm64 and arm/v7 Nodes. The installation
instructions do not change when some (or all) Linux Nodes in a cluster use an
ARM architecture: the same deployment YAML can be used, as the
`antrea/antrea-ubuntu` Docker image is actually a manifest list with support for
the amd64, arm64 and arm/v7 architectures.
`antrea/antrea-agent-ubuntu` and `antrea/antrea-controller-ubuntu` Docker images
are actually manifest lists with support for the amd64, arm64 and arm/v7
architectures.

Note that while we do run a subset of the Kubernetes conformance tests on both
the arm/v7 and arm64 Docker images (using [k3s](https://k3s.io/) as the
Expand Down
21 changes: 13 additions & 8 deletions content/docs/main/docs/maintainers/antrea-docker-image.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
# Antrea Docker image

The main Antrea Docker image, `antrea/antrea-ubuntu`, is a multi-arch image. The
`antrea/antrea-ubuntu` manifest is a list of three manifests:
`antrea/antrea-ubuntu-amd64`, `antrea/antrea-ubuntu-arm64` and
`antrea/antrea-ubuntu-arm`. Of these three manifests, only the first one is
built and uploaded to Dockerhub by Github workflows defined in the
The main Antrea Docker images (`antrea/antrea-agent-ubuntu` and
`antrea/antrea-controller-ubuntu`) are multi-arch images. For example, the
`antrea/antrea-agent-ubuntu` manifest is a list of three manifests:
`antrea/antrea-agent-ubuntu-amd64`, `antrea/antrea-agent-ubuntu-arm64` and
`antrea/antrea-agent-ubuntu-arm`. Of these three manifests, only the first one
is built and uploaded to Dockerhub by Github workflows defined in the
`antrea-io/antrea` repositories. The other two are built and uploaded by Github
workflows defined in a private repository (`vmware-tanzu/antrea-build-infra`),
to which only the project maintainers have access. These workflows are triggered
every time the `main` branch of `antrea-io/antrea` is updated, as well as every
time a new Antrea Github release is created. They build the
`antrea/antrea-ubuntu-arm64` and `antrea/antrea-ubuntu-arm` Docker images on
native arm64 workers, then create the `antrea/antrea-ubuntu` multi-arch manifest
and push it to Dockerhub. They are also in charge of testing the images in a
`antrea/antrea-agent-ubuntu-arm64` and `antrea/antrea-agent-ubuntu-arm` Docker
images on native arm64 workers, then create the `antrea/antrea-agent-ubuntu`
multi-arch manifest and push it to Dockerhub. The same goes for the controller
images. They are also in charge of testing the images in a
[K3s](https://github.com/k3s-io/k3s) cluster.

## Why do we use a private repository?
Expand All @@ -37,3 +39,6 @@ for a public repository. We believe Github will address the issue eventually and
provide safeguards to enable using self-hosted runners with public
repositories, at which point we will migrate workflows from this repository to
the main Antrea repository.

In the future, we may switch over to ARM hosted Github runners provided by the
CNCF.

0 comments on commit 3a4d275

Please sign in to comment.