Skip to content

Commit 70c40bb

Browse files
authored
[DOC] Update supported platforms (#517)
1 parent 9b73a77 commit 70c40bb

File tree

4 files changed

+43
-20
lines changed

4 files changed

+43
-20
lines changed

README.md

Lines changed: 13 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -31,26 +31,19 @@ state and over time move to full "production readiness".
3131
The following table has the general readiness state, the table below
3232
covers individual newer features separately.
3333

34-
| Platform | Kubernetes version | ArangoDB version | ArangoDB K8s Operator Version | State | Production ready | Remarks |
35-
|----------------------|--------------------|------------------|-------------------------------|-------|------------------|-----------------------|
36-
| Google GKE | 1.12 | >= 3.3.13 | | Runs | Yes | Don't use micro nodes |
37-
| Google GKE | 1.13 | >= 3.3.13 | | Runs | Yes | Don't use micro nodes |
38-
| Amazon EKS | 1.11 | >= 3.3.13 | | Runs | Yes | |
39-
| Pivotal PKS | 1.11 | >= 3.3.13 | | Runs | Yes | |
40-
| IBM Cloud | 1.11 | >= 3.4.5 | >= 0.3.11 | Runs | Yes | |
41-
| IBM Cloud | 1.12 | >= 3.4.5 | >= 0.3.11 | Runs | Yes | |
42-
| IBM Cloud | 1.13 | >= 3.4.6.1 | >= 0.3.11 | Runs | Yes | |
43-
| Amazon & Kops | 1.10 | >= 3.3.13 | | Runs | No | |
44-
| Azure AKS | 1.10 | >= 3.3.13 | | Runs | No | |
45-
| OpenShift | 1.10 | >= 3.3.13 | | Runs | No | |
46-
| Bare metal (kubeadm) | 1.10 | >= 3.3.13 | | Runs | Yes | |
47-
| Bare metal (kubeadm) | 1.11 | >= 3.3.13 | | Runs | Yes | |
48-
| Bare metal (kubeadm) | 1.12 | >= 3.3.13 | | Runs | In progress | |
49-
| Bare metal (kubeadm) | 1.13 | >= 3.3.13 | | Runs | Yes | |
50-
| Bare metal (kubeadm) | 1.14 | >= 3.3.13 | | Runs | In progress | |
51-
| Minikube | 1.10 | >= 3.3.13 | | Runs | Not intended | |
52-
| Docker for Mac Edge | 1.10 | >= 3.3.13 | | Runs | Not intended | |
53-
| Scaleway Kubernetes | 1.10 | >= 3.3.13 | ? | No | | |
34+
| Platform | Kubernetes Version | ArangoDB Version | ArangoDB Operator Version | State | Remarks | Provider Remarks |
35+
|---------------------|--------------------|------------------|---------------------------|-------------|-----------------------|------------------------------------|
36+
| Google GKE | 1.14 | >= 3.3.13 | | Production | Don't use micro nodes | |
37+
| Google GKE | 1.15 | >= 3.3.13 | | Production | Don't use micro nodes | |
38+
| Azure AKS | 1.14 | >= 3.3.13 | | Production | | |
39+
| Azure AKS | 1.15 | >= 3.3.13 | | Production | | |
40+
| Amazon EKS | 1.14 | >= 3.3.13 | | Production | | [Amazon EKS](./docs/providers/eks) |
41+
| IBM Cloud | 1.14 | >= 3.4.6.1 | >= 0.3.11 | Production | | |
42+
| OpenShift | 3.11 | >= 3.3.13 | | Production | | |
43+
| OpenShift | 4.2 | >= 3.3.13 | | In Progress | | |
44+
| BareMetal (kubeadm) | 1.14 | >= 3.3.13 | | Production | | |
45+
| Minikube | 1.14 | >= 3.3.13 | | Devel Only | | |
46+
| Other | 1.14 | >= 3.3.13 | | Devel Only | | |
5447

5548
Feature-wise production readiness table:
5649

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@
33
- [Tutorial](https://www.arangodb.com/docs/stable/tutorials-kubernetes.html)
44
- [Documentation](https://www.arangodb.com/docs/stable/deployment-kubernetes.html)
55
- [Design documents](./design/README.md)
6+
- [Providers](./providers/README.md)

docs/providers/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Supported Providers
2+
3+
- [Amazon EKS](./eks/README.md)

docs/providers/eks/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Amazon AWS Remarks
2+
3+
## Elastic Block Storage
4+
5+
Documentation:
6+
- [AWS EBS Volume Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html)
7+
8+
Remarks:
9+
- It is recommended to use at least GP2 (can be IO1) volume type for ArangoDeployment PV.
10+
- GP2 Volume IOPS is mostly based on storage size. If bigger load is expected use bigger volumes.
11+
- GP2 Volume supports burst mode. In case load in ArangoDeployment is expected only periodically you can use
12+
smaller GP2 Volumes to save costs.
13+
- AWS EBS support resizing of Volume. Volume size can be changed during lifetime, but it requires pod to be recreated.
14+
15+
## LoadBalancer
16+
17+
Documentation:
18+
- [AWS LB Annotations](https://kubernetes.io/docs/concepts/cluster-administration/cloud-providers/#load-balancers)
19+
20+
Remarks:
21+
- AWS LB in TCP mode is able to resend request in case of timeout while waiting for response from Coordinator/DBServer.
22+
This can break some POST requests, like data insertion. To change default value, set to 60s,
23+
you can set annotation for ArangoDeployment LoadBalancer service.
24+
```
25+
kubectl annotate --overwrite service/<ArangoDeployment name>-ea service.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout=<value is seconds, max 15 min>
26+
```

0 commit comments

Comments
 (0)