From 01af45d14ab92c0f64e548670155218fa58f9699 Mon Sep 17 00:00:00 2001 From: email Date: Mon, 31 Jul 2017 13:23:01 +0200 Subject: [PATCH] update docs --- docs/weave.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/weave.md b/docs/weave.md index 28e4c996d..2332e5b60 100644 --- a/docs/weave.md +++ b/docs/weave.md @@ -3,60 +3,60 @@ Weave Weave 2.0.1 is supported by kubespray -Weave be use with [**consensus**](https://www.weave.works/docs/net/latest/ipam/#initialization) mode (default mode) and [**seed**](https://www.weave.works/docs/net/latest/ipam/#initialization) mode +Weave uses [**consensus**](https://www.weave.works/docs/net/latest/ipam/#initialization) mode (default mode) and [**seed**](https://www.weave.works/docs/net/latest/ipam/#initialization) mode. -In kubespray, Weave encryption for all communication is supported +Weave encryption is supported for all communication -* For use Weave encryption, it's necessary to specify password (if no password specify, no encrytion) +* To use Weave encryption, specify a strong password (if no password, no encrytion) ``` # In file ./inventory/group_vars/k8s-cluster.yml weave_password: EnterPasswordHere ``` -This password is use in environment variable in weave container. So it's impossible to see it somewhere +This password is used to set an environment variable inside weave container. -Weave is deploy by kubernetes with daemonSet +Weave is deployed by kubespray using daemonSet * Check the status of Weave containers ``` -# On k8s master +# From client kubectl -n kube-system get pods | grep weave ``` -* Check status of weave (connection,encryption ...) +* Check status of weave (connection,encryption ...) for each node ``` -# On node +# On nodes curl http://127.0.0.1:6784/status ``` -* Check parameters of weave +* Check parameters of weave for each node ``` -# On node +# On nodes ps -aux | grep weaver ``` ### Consensus mode (default mode) -This mode is to fixed cluster +This mode is best to use on static size cluster ### Seed mode -This mode is to dynamic cluster +This mode is best to use on dynamic size cluster -the seed mode allows multi clouds simultaneously and also hybrid on premise/cloud clusters +The seed mode also allows multi-clouds and hybrid on-premise/cloud clusters deployement. -* Change consensus mode to seed mode +* Switch from consensus mode to seed mode ``` # In file ./inventory/group_vars/k8s-cluster.yml weave_mode_seed: true ``` -This two variables are use to have automaticaly dynamic cluster (**/!\ do not manually change these values**) +These two variables are only used when `weave_mode_seed` is set to `true` (**/!\ do not manually change these values**) ``` # In file ./inventory/group_vars/k8s-cluster.yml @@ -64,10 +64,10 @@ weave_seed: uninitialized weave_peers: uninitialized ``` -The first variable, `weave_seed`, allows to save the first or firsts nodes of the weave network +The first variable, `weave_seed`, saves the firsts nodes of the weave network -The seconde variable, `weave_peers`, allows to save IP of all nodes of the weave network +The seconde variable, `weave_peers`, saves IP of all nodes of the weave network -these two variables allows to connecte a new node to the weave network. this new node need to know the first node (seed) and list of IP to all node of network +These two variables are used to connect a new node to the weave network. The new node needs to know the firsts nodes (seed) and the list of IPs of all nodes. -For reset these variables set there values to `uninitialized` \ No newline at end of file +To reset these variables and reset the weave network set them to `uninitialized` \ No newline at end of file