Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
oilbeater committed Jan 9, 2020
1 parent 2392aff commit a5d339b
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 13 deletions.
8 changes: 3 additions & 5 deletions docs/high-available.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,10 @@ Change the replicas to 3, and add NODE_IPS environment var points to node that h
value: 192.168.55.10, 192.168.55.11, 192.168.55.12
```

When using cluster mode, only the leader ovsdb pod will be ready and serve requests, other pod will be waiting to become a leader.

```bash
ovn-central-fbdbd9d4d-jv8cr 0/1 Running 0 19h # waiting to become a leader
ovn-central-fbdbd9d4d-pgvhl 0/1 Running 0 19h # waiting to become a leader
ovn-central-fbdbd9d4d-jv8cr 1/1 Running 0 19h # waiting to become a leader
ovn-central-fbdbd9d4d-pgvhl 1/1 Running 0 19h # waiting to become a leader
ovn-central-fbdbd9d4d-rk2c7 1/1 Running 0 19h # the leader now
```

More detail about ovsdb cluster mode please refer to [this link](http://docs.openvswitch.org/en/latest/ref/ovsdb.7/#clustered-database-service-model)
More detail about ovsdb cluster mode please refer to [this link](http://docs.openvswitch.org/en/latest/ref/ovsdb.7/#clustered-database-service-model)
10 changes: 5 additions & 5 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,19 @@ Kube-OVN includes two parts:
`kubectl label node <Node on which to deploy OVN DB> kube-ovn/role=master`
2. Install Kube-OVN related CRDs

`kubectl apply -f https://raw.githubusercontent.com/alauda/kube-ovn/v0.10.0/yamls/crd.yaml`
`kubectl apply -f https://raw.githubusercontent.com/alauda/kube-ovn/v0.10.2/yamls/crd.yaml`
3. Install native OVS and OVN components:

`kubectl apply -f https://raw.githubusercontent.com/alauda/kube-ovn/v0.10.0/yamls/ovn.yaml`
`kubectl apply -f https://raw.githubusercontent.com/alauda/kube-ovn/v0.10.2/yamls/ovn.yaml`
4. Install the Kube-OVN Controller and CNI plugins:

`kubectl apply -f https://raw.githubusercontent.com/alauda/kube-ovn/v0.10.0/yamls/kube-ovn.yaml`
`kubectl apply -f https://raw.githubusercontent.com/alauda/kube-ovn/v0.10.2/yamls/kube-ovn.yaml`

That's all! You can now create some pods and test connectivity.

For high-available ovn db, see [high available](high-available.md)

If you want to enable IPv6 on default subnet and node subnet, please apply https://raw.githubusercontent.com/alauda/kube-ovn/v0.10.0/yamls/kube-ovn-ipv6.yaml on Step 3.
If you want to enable IPv6 on default subnet and node subnet, please apply https://raw.githubusercontent.com/alauda/kube-ovn/v0.10.2/yamls/kube-ovn-ipv6.yaml on Step 3.

## More Configuration

Expand Down Expand Up @@ -82,7 +82,7 @@ You can use `--default-cidr` flags below to config default Pod CIDR or create a
1. Remove Kubernetes resources:
```bash
wget https://raw.githubusercontent.com/alauda/kube-ovn/v0.10.0/dist/images/cleanup.sh
wget https://raw.githubusercontent.com/alauda/kube-ovn/v0.10.2/dist/images/cleanup.sh
bash cleanup.sh
```
Expand Down
2 changes: 1 addition & 1 deletion docs/ipv6.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Through Kube-OVN does support both protocol subnets coexist in a cluster, Kubernetes control plan now only support one protocol. So you will lost some ability like probe and service discovery if you use a protocol other than the kubernetes control plan. We recommend you use only one same ip protocol that same with kubernetes control plan.

To enable IPv6 support you need to modify the installation yaml to specify the default subnet and node subnet cidrBlock and gateway with a ipv6 format. You can apply this [v6 version yaml](https://raw.githubusercontent.com/alauda/kube-ovn/v0.10.0/yamls/kube-ovn-ipv6.yaml) at [installation step 3](install.md#to-install) for a quick start.
To enable IPv6 support you need to modify the installation yaml to specify the default subnet and node subnet cidrBlock and gateway with a ipv6 format. You can apply this [v6 version yaml](https://raw.githubusercontent.com/alauda/kube-ovn/v0.10.2/yamls/kube-ovn-ipv6.yaml) at [installation step 3](install.md#to-install) for a quick start.
4 changes: 2 additions & 2 deletions docs/webhook.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Webhook

Kube-OVN supports allocation static IP addresss along with dynamical addresss which means we should hold static IP addresses don't allow others using it.
Kube-OVN supports allocation static IP addresses along with dynamical addresses which means we should hold static IP addresses don't allow others using it.

## Pre-request

Expand Down Expand Up @@ -76,4 +76,4 @@ spec:
```bash
# kubectl create -f deployment2.yaml
Error from server (overlap): error when creating "deployment2.yaml": admission webhook "pod-ip-validaing.kube-ovn.io" denied the request: overlap
```
```

0 comments on commit a5d339b

Please sign in to comment.