Skip to content

Commit

Permalink
Document update of OVS windows binaries distributed by Antrea (#2513)
Browse files Browse the repository at this point in the history
Signed-off-by: Antonin Bas <abas@vmware.com>
  • Loading branch information
antoninbas authored Aug 2, 2021
1 parent fcebf68 commit e5c06dc
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
37 changes: 37 additions & 0 deletions docs/maintainers/updating-ovs-windows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Updating the OVS Windows Binaries

Antrea ships a zip archive with OVS binaries for Windows. The binaries are
hosted on the antrea.io website and updated as needed. This file documents the
procedure to upload a new version of the OVS binaries. The archive is served
from AWS S3, and therefore access to the Antrea S3 account is required for this
procedure.

* We assume that you have already built the OVS binaries (if a custom built is
required), or retrieved them from the official OVS build pipelines. The
binaries must be built in **Release** mode for acceptable performance.

* Name the zip archive appropriately:
`ovs-<OVS VERSION>[-antrea.<BUILD NUM>]-win64.zip`
- the format for `<OVS VERSION>` is `<MAJOR>.<MINOR>.<PATCH>`, with no `v`
prefix.
- the `-antrea.<BUILD NUM>` component is optional but must be provided if this
is not the official build for the referenced OVS version. `<BUILD NUM>`
starts at 1 and is incremented for every new upload corresponding to that
OVS version.

* Generate the SHA256 checksum for the archive.
- place yourself in the directory containing the archive.
- run `sha256sum -b <NAME>.zip > <NAME>.zip.sha256`, where `<NAME>` is
determined by the previous step.

* Upload the archive and SHA256 checksum file to the `ovs/` folder in the
`downloads.antrea.io` S3 bucket. As you upload the files, grant public read
access to them (you can also do it after the upload with the `Make public`
action).

* Validate both public links:
- `https://downloads.antrea.io/ovs/<NAME>.zip`
- `https://downloads.antrea.io/ovs/<NAME>.zip.sha256`

* Update the Antrea Windows documentation and helper scripts as needed,
e.g. `hack/windows/Install-OVS.ps1`.
1 change: 1 addition & 0 deletions hack/.notableofcontents
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ docs/kubernetes-installers.md
docs/maintainers/build-kubemark.md
docs/maintainers/getting-started-gif.md
docs/maintainers/release.md
docs/maintainers/updating-ovs-windows.md
docs/network-requirements.md
docs/noencap-hybrid-modes.md
docs/octant-plugin-installation.md
Expand Down

0 comments on commit e5c06dc

Please sign in to comment.