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.

Sign up for GitHub

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

Jump to bottom

Re-organize user-facing Windows documentation #5624

Closed
antoninbas opened this issue Oct 27, 2023 · 4 comments
Closed

Re-organize user-facing Windows documentation #5624

antoninbas opened this issue Oct 27, 2023 · 4 comments
Labels
area/OS/windows Issues or PRs related to the Windows operating system. kind/documentation Categorizes issue or PR as related to a documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Milestone
Antrea v2.1 release

Comments

@antoninbas
Copy link
Contributor

antoninbas commented Oct 27, 2023 •
edited
Loading

I believe that the Windows documentation has become very hard for users to follow, due to the 3 supported installation methods, the different version combinations (K8s, containerd) and signed vs unsigned OVS driver. It needs to be improved.

Originally posted by @antoninbas in #5440 (review)

One possibility is to have a dedicated section for each installation method:

  • Running OVS + antrea-agent as Windows services
  • Running OVS as Windows services and antrea-agent as a Pod; really this covers 2 cases
  • Running OVS + antrea-agent as a Pod (recent versions of containerd)

There will be some redundancy, but at least users will be able to pick one installation method and then follow a list of steps, without having to decide for each step whether it applies to their installation method.
@antoninbas antoninbas changed the title Re-organize user-fcing Windows documentation Re-organize user-facing Windows documentation Oct 27, 2023
@antoninbas antoninbas added kind/documentation Categorizes issue or PR as related to a documentation. area/OS/windows Issues or PRs related to the Windows operating system. labels Oct 27, 2023
@antoninbas antoninbas added this to the Antrea v1.15 release milestone Oct 27, 2023
@antoninbas antoninbas added the priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. label Oct 27, 2023
@XinShuYang XinShuYang mentioned this issue Oct 31, 2023
Closed
antoninbas added a commit to antoninbas/antrea that referenced this issue Dec 12, 2023
@antoninbas
Update Windows documentation
621dce1 
The user-facing Windows document is updated as follows:
* containerd will be the onyl supported container runtime on Windows
  Nodes, Docker support (that includes cri-dockerd, Docker Desktop) is
  officially deprecated.
* we split the "Installation as Pod" section into 2 new sections (one
  for containerd, one for Docker).
* installation methods are re-ordered, starting with the recommended /
  most common one: Installation as a Pod for containerd, Installation as
  Windows services, Installation as a Pod for Docker (deprecated).

The main idea is to make the installation instructions clearer and
easier to follow for a "normal" user, deploying the latest Antrea
version on a recent K8s cluster. In this situation, the recommended
installation method is to use antrea-windows-containerd.yml or
antrea-windows-containerd-with-ovs.yml, which leverage HostProcess
Windows Pods.

There is still a lot of room for future improvements. I suggest that for
Antrea v2.0 we drop all references to Docker and kube-proxy from this
document.

The "Antrea Management on Windows" section is also dropped from the
Windows design document, as it was stale information.

For antrea-io#5624 antrea-io#5630

Signed-off-by: Antonin Bas <[email protected]>
@antoninbas antoninbas mentioned this issue Dec 12, 2023
Merged
antoninbas added a commit to antoninbas/antrea that referenced this issue Dec 12, 2023
@antoninbas
Update Windows documentation
ed70a86 
The user-facing Windows document is updated as follows:
* containerd will be the onyl supported container runtime on Windows
  Nodes, Docker support (that includes cri-dockerd, Docker Desktop) is
  officially deprecated.
* we split the "Installation as Pod" section into 2 new sections (one
  for containerd, one for Docker).
* installation methods are re-ordered, starting with the recommended /
  most common one: Installation as a Pod for containerd, Installation as
  Windows services, Installation as a Pod for Docker (deprecated).

The main idea is to make the installation instructions clearer and
easier to follow for a "normal" user, deploying the latest Antrea
version on a recent K8s cluster. In this situation, the recommended
installation method is to use antrea-windows-containerd.yml or
antrea-windows-containerd-with-ovs.yml, which leverage HostProcess
Windows Pods.

There is still a lot of room for future improvements. I suggest that for
Antrea v2.0 we drop all references to Docker and kube-proxy from this
document.

The "Antrea Management on Windows" section is also dropped from the
Windows design document, as it was stale information.

For antrea-io#5624 antrea-io#5630

Signed-off-by: Antonin Bas <[email protected]>
antoninbas added a commit to antoninbas/antrea that referenced this issue Dec 13, 2023
@antoninbas
Update Windows documentation
fb4be0c 
The user-facing Windows document is updated as follows:
* containerd will be the onyl supported container runtime on Windows
  Nodes, Docker support (that includes cri-dockerd, Docker Desktop) is
  officially deprecated.
* we split the "Installation as Pod" section into 2 new sections (one
  for containerd, one for Docker).
* installation methods are re-ordered, starting with the recommended /
  most common one: Installation as a Pod for containerd, Installation as
  Windows services, Installation as a Pod for Docker (deprecated).

The main idea is to make the installation instructions clearer and
easier to follow for a "normal" user, deploying the latest Antrea
version on a recent K8s cluster. In this situation, the recommended
installation method is to use antrea-windows-containerd.yml or
antrea-windows-containerd-with-ovs.yml, which leverage HostProcess
Windows Pods.

There is still a lot of room for future improvements. I suggest that for
Antrea v2.0 we drop all references to Docker and kube-proxy from this
document.

The "Antrea Management on Windows" section is also dropped from the
Windows design document, as it was stale information.

For antrea-io#5624 antrea-io#5630

Signed-off-by: Antonin Bas <[email protected]>
antoninbas added a commit to antoninbas/antrea that referenced this issue Dec 15, 2023
@antoninbas
Update Windows documentation
25ec2ec 
The user-facing Windows document is updated as follows:
* containerd will be the onyl supported container runtime on Windows
  Nodes, Docker support (that includes cri-dockerd, Docker Desktop) is
  officially deprecated.
* we split the "Installation as Pod" section into 2 new sections (one
  for containerd, one for Docker).
* installation methods are re-ordered, starting with the recommended /
  most common one: Installation as a Pod for containerd, Installation as
  Windows services, Installation as a Pod for Docker (deprecated).

The main idea is to make the installation instructions clearer and
easier to follow for a "normal" user, deploying the latest Antrea
version on a recent K8s cluster. In this situation, the recommended
installation method is to use antrea-windows-containerd.yml or
antrea-windows-containerd-with-ovs.yml, which leverage HostProcess
Windows Pods.

There is still a lot of room for future improvements. I suggest that for
Antrea v2.0 we drop all references to Docker and kube-proxy from this
document.

The "Antrea Management on Windows" section is also dropped from the
Windows design document, as it was stale information.

For antrea-io#5624 antrea-io#5630

Signed-off-by: Antonin Bas <[email protected]>
antoninbas added a commit to antoninbas/antrea that referenced this issue Jan 8, 2024
@antoninbas
Update Windows documentation
9a92066 
The user-facing Windows document is updated as follows:
* containerd will be the onyl supported container runtime on Windows
  Nodes, Docker support (that includes cri-dockerd, Docker Desktop) is
  officially deprecated.
* we split the "Installation as Pod" section into 2 new sections (one
  for containerd, one for Docker).
* installation methods are re-ordered, starting with the recommended /
  most common one: Installation as a Pod for containerd, Installation as
  Windows services, Installation as a Pod for Docker (deprecated).

The main idea is to make the installation instructions clearer and
easier to follow for a "normal" user, deploying the latest Antrea
version on a recent K8s cluster. In this situation, the recommended
installation method is to use antrea-windows-containerd.yml or
antrea-windows-containerd-with-ovs.yml, which leverage HostProcess
Windows Pods.

There is still a lot of room for future improvements. I suggest that for
Antrea v2.0 we drop all references to Docker and kube-proxy from this
document.

The "Antrea Management on Windows" section is also dropped from the
Windows design document, as it was stale information.

For antrea-io#5624 antrea-io#5630

Signed-off-by: Antonin Bas <[email protected]>
antoninbas added a commit to antoninbas/antrea that referenced this issue Jan 8, 2024
@antoninbas
Update Windows documentation
5770b2e 
The user-facing Windows document is updated as follows:
* containerd will be the onyl supported container runtime on Windows
  Nodes, Docker support (that includes cri-dockerd, Docker Desktop) is
  officially deprecated.
* we split the "Installation as Pod" section into 2 new sections (one
  for containerd, one for Docker).
* installation methods are re-ordered, starting with the recommended /
  most common one: Installation as a Pod for containerd, Installation as
  Windows services, Installation as a Pod for Docker (deprecated).

The main idea is to make the installation instructions clearer and
easier to follow for a "normal" user, deploying the latest Antrea
version on a recent K8s cluster. In this situation, the recommended
installation method is to use antrea-windows-containerd.yml or
antrea-windows-containerd-with-ovs.yml, which leverage HostProcess
Windows Pods.

There is still a lot of room for future improvements. I suggest that for
Antrea v2.0 we drop all references to Docker and kube-proxy from this
document.

The "Antrea Management on Windows" section is also dropped from the
Windows design document, as it was stale information.

For antrea-io#5624 antrea-io#5630

Signed-off-by: Antonin Bas <[email protected]>
antoninbas added a commit to antoninbas/antrea that referenced this issue Jan 8, 2024
@antoninbas
Update Windows documentation
2a5346b 
The user-facing Windows document is updated as follows:
* containerd will be the onyl supported container runtime on Windows
  Nodes, Docker support (that includes cri-dockerd, Docker Desktop) is
  officially deprecated.
* we split the "Installation as Pod" section into 2 new sections (one
  for containerd, one for Docker).
* installation methods are re-ordered, starting with the recommended /
  most common one: Installation as a Pod for containerd, Installation as
  Windows services, Installation as a Pod for Docker (deprecated).

The main idea is to make the installation instructions clearer and
easier to follow for a "normal" user, deploying the latest Antrea
version on a recent K8s cluster. In this situation, the recommended
installation method is to use antrea-windows-containerd.yml or
antrea-windows-containerd-with-ovs.yml, which leverage HostProcess
Windows Pods.

There is still a lot of room for future improvements. I suggest that for
Antrea v2.0 we drop all references to Docker and kube-proxy from this
document.

The "Antrea Management on Windows" section is also dropped from the
Windows design document, as it was stale information.

For antrea-io#5624 antrea-io#5630

Signed-off-by: Antonin Bas <[email protected]>
antoninbas added a commit to antoninbas/antrea that referenced this issue Jan 9, 2024
@antoninbas
Update Windows documentation
5773dad 
The user-facing Windows document is updated as follows:
* containerd will be the onyl supported container runtime on Windows
  Nodes, Docker support (that includes cri-dockerd, Docker Desktop) is
  officially deprecated.
* we split the "Installation as Pod" section into 2 new sections (one
  for containerd, one for Docker).
* installation methods are re-ordered, starting with the recommended /
  most common one: Installation as a Pod for containerd, Installation as
  Windows services, Installation as a Pod for Docker (deprecated).

The main idea is to make the installation instructions clearer and
easier to follow for a "normal" user, deploying the latest Antrea
version on a recent K8s cluster. In this situation, the recommended
installation method is to use antrea-windows-containerd.yml or
antrea-windows-containerd-with-ovs.yml, which leverage HostProcess
Windows Pods.

There is still a lot of room for future improvements. I suggest that for
Antrea v2.0 we drop all references to Docker and kube-proxy from this
document.

The "Antrea Management on Windows" section is also dropped from the
Windows design document, as it was stale information.

For antrea-io#5624 antrea-io#5630

Signed-off-by: Antonin Bas <[email protected]>
antoninbas added a commit to antoninbas/antrea that referenced this issue Jan 12, 2024
@antoninbas
Update Windows documentation
f1b5390 
The user-facing Windows document is updated as follows:
* containerd will be the only supported container runtime on Windows
  Nodes, Docker support (that includes cri-dockerd, Docker Desktop) is
  officially deprecated.
* we split the "Installation as Pod" section into 2 new sections (one
  for containerd, one for Docker).
* installation methods are re-ordered, starting with the recommended /
  most common one: Installation as a Pod for containerd, Installation as
  Windows services, Installation as a Pod for Docker (deprecated).

The main idea is to make the installation instructions clearer and
easier to follow for a "normal" user, deploying the latest Antrea
version on a recent K8s cluster. In this situation, the recommended
installation method is to use antrea-windows-containerd.yml or
antrea-windows-containerd-with-ovs.yml, which leverage HostProcess
Windows Pods.

There is still a lot of room for future improvements. I suggest that for
Antrea v2.0 we drop all references to Docker and kube-proxy from this
document.

The "Antrea Management on Windows" section is also dropped from the
Windows design document, as it was stale information.

For antrea-io#5624 antrea-io#5630

Signed-off-by: Antonin Bas <[email protected]>
antoninbas added a commit to antoninbas/antrea that referenced this issue Jan 16, 2024
@antoninbas
Update Windows documentation
4a4a447 
The user-facing Windows document is updated as follows:
* containerd will be the only supported container runtime on Windows
  Nodes, Docker support (that includes cri-dockerd, Docker Desktop) is
  officially deprecated.
* we split the "Installation as Pod" section into 2 new sections (one
  for containerd, one for Docker).
* installation methods are re-ordered, starting with the recommended /
  most common one: Installation as a Pod for containerd, Installation as
  Windows services, Installation as a Pod for Docker (deprecated).

The main idea is to make the installation instructions clearer and
easier to follow for a "normal" user, deploying the latest Antrea
version on a recent K8s cluster. In this situation, the recommended
installation method is to use antrea-windows-containerd.yml or
antrea-windows-containerd-with-ovs.yml, which leverage HostProcess
Windows Pods.

There is still a lot of room for future improvements. I suggest that for
Antrea v2.0 we drop all references to Docker and kube-proxy from this
document.

The "Antrea Management on Windows" section is also dropped from the
Windows design document, as it was stale information.

For antrea-io#5624 antrea-io#5630

Signed-off-by: Antonin Bas <[email protected]>
antoninbas added a commit that referenced this issue Jan 17, 2024
@antoninbas
Update Windows documentation (#5789)
913884b 
The user-facing Windows document is updated as follows:
* containerd will be the only supported container runtime on Windows
  Nodes, Docker support (that includes cri-dockerd, Docker Desktop) is
  officially deprecated.
* we split the "Installation as Pod" section into 2 new sections (one
  for containerd, one for Docker).
* installation methods are re-ordered, starting with the recommended /
  most common one: Installation as a Pod for containerd, Installation as
  Windows services, Installation as a Pod for Docker (deprecated).

The main idea is to make the installation instructions clearer and
easier to follow for a "normal" user, deploying the latest Antrea
version on a recent K8s cluster. In this situation, the recommended
installation method is to use antrea-windows-containerd.yml or
antrea-windows-containerd-with-ovs.yml, which leverage HostProcess
Windows Pods.

There is still a lot of room for future improvements. I suggest that for
Antrea v2.0 we drop all references to Docker and kube-proxy from this
document.

The "Antrea Management on Windows" section is also dropped from the
Windows design document, as it was stale information.

For #5624 #5630

Signed-off-by: Antonin Bas <[email protected]>
@antoninbas
Copy link
Contributor Author

antoninbas commented Jan 17, 2024 •
edited by luolanzone
Loading

Some progress was made here for v1.15 in #5789, and the documentation was re-organized to be more user-friendly and clearly identify the recommended installation method.
Remaining items to be taken care of for v1.16 / v2.0:

Moving the issue to v1.16 milestone.

@github-actions GitHub Actions
Copy link
Contributor

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment, or this will be closed in 90 days

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 17, 2024
@antoninbas antoninbas removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 18, 2024
@antoninbas
Copy link
Contributor Author

As of today, there is only one item left (see #5624 (comment)), which we will address post v2.0 release.

@antoninbas antoninbas mentioned this issue May 24, 2024
Closed
@luolanzone
Copy link
Contributor

Looks like all items are resolved now, close this issue.
@antoninbas @XinShuYang please double check if there is anything left, you can reopen or create a new issue. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/OS/windows Issues or PRs related to the Windows operating system. kind/documentation Categorizes issue or PR as related to a documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Projects
None yet
Milestone
Antrea v2.1 release
Development

No branches or pull requests
2 participants
@antoninbas @luolanzone