Skip to content

Commit ec72b87

Browse files
author
Lars Maier
authored
Merge pull request #310 from arangodb/documentation/2018-12-04
Docs: Formatting
2 parents 06d4af4 + 5fed513 commit ec72b87

File tree

3 files changed

+48
-31
lines changed

3 files changed

+48
-31
lines changed

docs/Manual/Tutorials/Kubernetes/AKS.md

+37-24
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,27 @@
77
* [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli-apt?view=azure-cli-latest)
88

99
## Deploy cluster
10+
1011
* In Azure dashboard choose **Create a resource**
1112
* Choose **Kubernetes Service**
1213

1314
## Cluster basics (version >=1.10)
15+
1416
![basics](./aks-create-basics.png)
1517

1618
## Cluster authentication (Enable RBAC)
19+
1720
![basics](./aks-create-auth.png)
1821

1922
## Wait for cluster to be created
23+
2024
![basics](./aks-create-valid.png)
2125

2226
## Move to control using `kubectl`
2327

24-
* Login to Azure using CLI
25-
```
28+
- Login to Azure using CLI
29+
30+
```
2631
$ az login
2732
[
2833
{
@@ -38,42 +43,49 @@
3843
}
3944
}
4045
]
41-
```
46+
```
47+
48+
- Get AKS credentials to merge with local config, using resource group and
49+
cluster names used for above deployment
4250

43-
* Get AKS credentials to merge with local config, using resource group and cluster names used for above deployment
44-
```
45-
$ az aks get-credentials --resource-group clifton --name ArangoDB
46-
```
51+
```
52+
$ az aks get-credentials --resource-group clifton --name ArangoDB
53+
```
4754

48-
* Verify successful merge
49-
```
55+
- Verify successful merge
56+
57+
```
5058
$ kubectl get svc
5159
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
5260
kubernetes ClusterIP 10.0.0.1 <none> 443/TCP 38m
53-
```
61+
```
62+
63+
- Initialize `helm`
5464

55-
* Initialise `helm`
56-
```
65+
```
5766
$ kubectl create serviceaccount --namespace kube-system tiller
5867
serviceaccount/tiller created
59-
```
60-
```
68+
```
69+
70+
```
6171
$ kubectl create clusterrolebinding tiller-cluster-rule \
6272
--clusterrole=cluster-admin --serviceaccount=kube-system:tiller
6373
clusterrolebinding.rbac.authorization.k8s.io/tiller-cluster-rule created
64-
```
65-
```
74+
```
75+
76+
```
6677
$ helm init --service-account tiller
67-
$HELM_HOME has been configured at /home/kaveh/.helm.
78+
$HELM_HOME has been configured at /home/xxx/.helm.
6879
...
6980
Happy Helming!
7081
7182
Tiller (the Helm server-side component) has been
7283
installed into your Kubernetes Cluster.
73-
```
84+
```
85+
86+
- Deploy ArangoDB operator
7487

75-
* Deploy ArabgoDB operator
76-
```
88+
```
7789
$ helm install \
7890
github.com/arangodb/kube-arangodb/releases/download/X.X.X/kube-arangodb.tgz
7991
NAME: orderly-hydra
@@ -83,9 +95,10 @@
8395
...
8496
See https://docs.arangodb.com/devel/Manual/Tutorials/Kubernetes/
8597
for how to get started.
86-
```
98+
```
99+
100+
- Deploy ArangoDB cluster
87101

88-
* Deploy ArangoDB cluster
89-
```
102+
```
90103
$ kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/master/examples/simple-cluster.yaml
91-
```
104+
```

docs/Manual/Tutorials/Kubernetes/EKS.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ $ aws --version
2323

2424
### Configure AWS client
2525

26-
Refer to the [documentation](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) to accordingly fill in the below with your credentials.
26+
Refer to the [AWS documentation](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html)
27+
to accordingly fill in the below with your credentials.
2728
Pay special attention to the correct region information to find your cluster next.
2829

2930
```
@@ -75,7 +76,8 @@ $ kubectl get nodes
7576
### Create worker Stack
7677

7778
On Amazon EKS, we need to launch worker nodes, as the cluster has none.
78-
Open Amazon's [cloud formation console](https://console.aws.amazon.com/cloudformation/) and choose `Create Stack` by specifying this S3 template URL:
79+
Open Amazon's [cloud formation console](https://console.aws.amazon.com/cloudformation/)
80+
and choose `Create Stack` by specifying this S3 template URL:
7981

8082
```
8183
https://amazon-eks.s3-us-west-2.amazonaws.com/cloudformation/2018-08-30/amazon-eks-nodegroup.yaml
@@ -85,7 +87,9 @@ https://amazon-eks.s3-us-west-2.amazonaws.com/cloudformation/2018-08-30/amazon-e
8587

8688
### Worker stack details
8789

88-
Pay good attention to details here. If your input is not complete, your worker nodes are either not spawned or you won't be able to integrate the workers into your kubernetes cluster.
90+
Pay good attention to details here. If your input is not complete, your worker
91+
nodes are either not spawned or you won't be able to integrate the workers
92+
into your kubernetes cluster.
8993

9094
**Stack name**: Choose a name for your stack. For example ArangoDB-stack
9195

@@ -101,7 +105,7 @@ Pay good attention to details here. If your input is not complete, your worker n
101105

102106
**NodeInstanceType**: Choose an instance type for your worker nodes. For this test we went with the default `t2.medium` instances.
103107

104-
**NodeImageId**: Dependent on the region, there are two image Ids for boxes with and wothout GPU support.
108+
**NodeImageId**: Dependent on the region, there are two image Ids for boxes with and without GPU support.
105109

106110
| Region | without GPU | with GPU |
107111
|-----------|-----------------------|-----------------------|
@@ -180,7 +184,7 @@ $ kubectl create clusterrolebinding tiller-cluster-rule \
180184
--clusterrole=cluster-admin --serviceaccount=kube-system:tiller
181185
clusterrolebinding.rbac.authorization.k8s.io/tiller-cluster-rule created
182186
```
183-
* Initialise `helm`
187+
* Initialize `helm`
184188
```
185189
$ helm init --service-account tiller
186190
$HELM_HOME has been configured at ~/.helm.

docs/Manual/Tutorials/Kubernetes/GKE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Click on `CREATE CLUSTER`.
1515

1616
In the form that follows, enter information as seen in the screenshot below.
1717

18-
![create a cluser](./gke-create-cluster.png)
18+
![create a cluster](./gke-create-cluster.png)
1919

20-
We've succesfully ran clusters with 4 `1 vCPU` nodes or 3 `2 vCPU` nodes.
20+
We have successfully ran clusters with 4 `1 vCPU` nodes or 3 `2 vCPU` nodes.
2121
Smaller node configurations will likely lead to unschedulable `Pods`.
2222

2323
Once you click `Create`, you'll return to the list of clusters and your

0 commit comments

Comments
 (0)