Documentation updates

This commit is contained in:
Raj Chaudhuri committed 2024-07-19 08:54:16 +05:30
1 parent b0477a25ff
commit 32ad2a1b02
2 files changed
+18 -6

No files matched your search

+2 -2
View File
@@ -1,4 +1,4 @@
# ReWeave - an effort to keep Weave Net alive # Weave Net
This repository contains a fork of Weave Net, the first product developed by Weaveworks. Since Weaveworks has shut down, this repo aims to continue maintaining Weave Net, and to publish releases regularly. This repository contains a fork of Weave Net, the first product developed by Weaveworks. Since Weaveworks has shut down, this repo aims to continue maintaining Weave Net, and to publish releases regularly.
@@ -7,7 +7,7 @@ This repository contains a fork of Weave Net, the first product developed by Wea
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/rajch/weave?include_prereleases)](https://github.com/rajch/weave/releases) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/rajch/weave?include_prereleases)](https://github.com/rajch/weave/releases)
[![Unique CVE count in all images](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Frajch%2Fweave%2Fmaster%2Freweave%2Fscans%2Fbadge.json&label=CVE%20count "The number of unique CVEs reported by scanning all images")](reweave/scans/report.md) [![Unique CVE count in all images](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Frajch%2Fweave%2Fmaster%2Freweave%2Fscans%2Fbadge.json&label=CVE%20count "The number of unique CVEs reported by scanning all images")](reweave/scans/report.md)
The history of the ReWeave effort can be found in [HISTORY.md](HISTORY.md). The history of the fork can be found in [HISTORY.md](HISTORY.md).
## Using Weave Net on Kubernetes ## Using Weave Net on Kubernetes
+16 -4
View File
@@ -13,11 +13,19 @@ Install Weave Net by running the following:
sudo curl -L https://reweave.azurewebsites.net/get-weave -o /usr/local/bin/weave sudo curl -L https://reweave.azurewebsites.net/get-weave -o /usr/local/bin/weave
sudo chmod a+x /usr/local/bin/weave sudo chmod a+x /usr/local/bin/weave
~~If you are on OSX and you are using Docker Machine ensure that a VM is running and configured The URL https://reweave.azurewebsites.net/get-weave, is provided by the companion project [weave-endpoint](https://github.com/rajch/weave-endpoint). You can also fetch a particular version of Weave Net by specifying a `?version=` query string, like this:
sudo curl -L https://reweave.azurewebsites.net/get-weave -o /usr/local/bin/weave?version=v2.8.3
Supported versions start from 2.8.2, the first release since forking from weaveworks/weave.
> **Note:** The following information is obsolete, and included only for historical reference.
>
> If you are on OSX and you are using Docker Machine ensure that a VM is running and configured
before downloading Weave Net. To set up a VM see [the Docker Machine before downloading Weave Net. To set up a VM see [the Docker Machine
documentation](https://docs.docker.com/installation/mac/#from-your-shell) or refer to ["Part 1: Launching Weave Net with Docker Machine"](https://web.archive.org/web/20231002233731/https://www.weave.works/guides/part-1-launching-weave-net-with-docker-machine/). documentation](https://docs.docker.com/installation/mac/#from-your-shell) or refer to ["Part 1: Launching Weave Net with Docker Machine"](https://web.archive.org/web/20231002233731/https://www.weave.works/guides/part-1-launching-weave-net-with-docker-machine/).
>
After your VM is setup with Docker Machine, Weave Net can be launched directly from the OSX host.~~ > After your VM is setup with Docker Machine, Weave Net can be launched directly from the OSX host.
Weave Net respects the environment variable `DOCKER_HOST`, so that you can run and control a Weave Network locally on a remote host. See [Using The Weave Docker API Proxy]({{ '/tasks/weave-docker-api/using-proxy' | relative_url }}). Weave Net respects the environment variable `DOCKER_HOST`, so that you can run and control a Weave Network locally on a remote host. See [Using The Weave Docker API Proxy]({{ '/tasks/weave-docker-api/using-proxy' | relative_url }}).
@@ -25,6 +33,8 @@ With Weave Net downloaded onto your VMs or hosts, you are ready to launch a Weav
### Quick Start Screencast ### Quick Start Screencast
> **Note:** The screencast uses an old download URL, `https://git.io/weave`. This still serves an old version of Weave Net, and should not be used any more. Instead, `https://reweave.azurewebsites.net/get-weave` should be used.
<a href="https://youtu.be/kihQCCT1ykE" target="_blank"> <a href="https://youtu.be/kihQCCT1ykE" target="_blank">
<img src="hello-screencast.png" alt="Click to watch the screencast" /> <img src="hello-screencast.png" alt="Click to watch the screencast" />
</a> </a>
@@ -48,7 +58,7 @@ To disable this check, run the following before launching Weave Net:
export CHECKPOINT_DISABLE=1 export CHECKPOINT_DISABLE=1
**Note:** Weaveworks does not maintain these servers any more. Weave Net will make the call and silently fail. This will not affect normal operations. Still, it is recommended to set the `CHECKPOINT_DISABLE` variable as shown above. This feature will be removed from the community-supported Weave Net in the near future. > **Note:** Weaveworks does not maintain these servers any more. Weave Net will make the call and silently fail. This will not affect normal operations. Still, it is recommended to set the `CHECKPOINT_DISABLE` variable as shown above. Starting from v2.8.2, the `CHECKPOINT_DISABLE` variable is set by default. This feature will be removed from the community-supported Weave Net in the near future.
### Guides for Specific Platforms ### Guides for Specific Platforms
@@ -64,6 +74,8 @@ full speed of the underlying network.
To make encryption in fast datapath work on Google Cloud Platform, see To make encryption in fast datapath work on Google Cloud Platform, see
[here]({{ '/faq#ports' | relative_url }}). [here]({{ '/faq#ports' | relative_url }}).
> **Note:** The community that currently maintains Weave Net lacks the manpower and resources to support specific platforms at the moment. We would welcome any help.
**See Also** **See Also**
* [Launching Weave Net]({{ '/install/using-weave' | relative_url }}) * [Launching Weave Net]({{ '/install/using-weave' | relative_url }})