Minor style changes to the tutorial
-# Red Sky OPS - ELK tutorial
+# Red Sky Ops - ELK tutorial
## Prerequisites
Ensure you have the latest version of [Kustomize](https://github.com/kubernetes-sigs/kustomize/releases) installed (currently version 3.0.2).
-Make sure you are connected to the cluster of your choice (We use a small cluster on GKE for this tutorial) and have [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) installed.
+Make sure you are connected to the cluster of your choice (we will use a small cluster on GKE for this tutorial) and have [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) installed.
-Download the latest `redskyctl` binary [GitHub](https://github.com/redskyops/k8s-experiment/releases) to your /usr/local/bin folder.
+Download the latest `redskyctl` binary from [GitHub](https://github.com/redskyops/k8s-experiment/releases) to your `/usr/local/bin` folder.
## Setting up the Experiment
-In examples/tutorial you can see the experiment.yaml for this experiment, as well as the /config that's necessary for some ELK components and metric logging.
-Feel free to edit the parameter ranges in the experiment.yaml, and change the experiment name (make sure to avoid conflicts if you are running multiple experiments). You can also use this file as a template for a custom experiment for your specific application.
+In `/examples/tutorial/` you can see the `experiment.yaml` for this experiment, as well as the `config/` that's necessary for some ELK components and metric logging.
+Feel free to edit the parameter ranges in the `experiment.yaml`, and change the experiment name (make sure to avoid conflicts if you are running multiple experiments). You can also use this file as a template for a custom experiment for your specific application.
## Running the Experiment
-First, we need to install redskyctl in the cluster:
+First, we need to install the Red Sky manager in the cluster using the `redskyctl` tool:
```
$ redskyctl init
```
-From the /examples/tutorial folder, apply the required configuration to the cluster:
+From the `/examples/tutorial` folder, apply the required configuration to the cluster (note that `kubectl apply -k .` may not work due to requirements on newer Kustomize features):
```
$ kustomize build | kubectl apply -f -
@@ -35,8 +35,7 @@ To start the experiment, apply it to the cluster:
$ kubectl apply -f experiment.yaml
```
-In the Enterprise version of Red Sky, `redskyctl` will start creating trials automatically.
-To manually suggest trial configurations use:
+In the Enterprise version of Red Sky, `redskyctl` will start creating trials automatically. To manually suggest trial configurations use:
```
$ redskyctl suggest --name elk --interactive
@@ -47,8 +46,7 @@ and `redskyctl` will launch your trial.
## Monitoring the Experiment
-Both `trials` and `experiments` are created as kube objects.
-You can see the assignments and results of your trials using:
+Both `trials` and `experiments` are created as customer Kubernetes object kinds. You can see the assignments and results of your trials using:
```
$ kubectl get trials
@@ -60,7 +58,7 @@ And list your experiments using:
$ kubectl get experiments
```
-You can also view their respective yamls by applying the -o yaml flag as usual.
+You can also view their full representations by applying the `-o yaml` option as usual.
More experiment monitoring options will be coming shortly!
