Merge pull request #3 from mesosphere/nick-updates

Fleshing out more of the docs
mesosphere · Sep 8, 2017 · 6d9d6c9 · 6d9d6c9
2 parents 003e9ca + f4744b7
commit 6d9d6c9
Show file tree

Hide file tree

Showing 8 changed files with 68 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -188,3 +188,7 @@ Endpoints:		9.0.2.5:53
 Session Affinity:	None
 Events:			<none>
 ```
+
+## Documents
+
+For more details, please see the [docs folder](docs)
diff --git a/docs/aws.md b/docs/aws.md
@@ -1,3 +1,39 @@
-TODO
+# AWS Cluster
 
-Add details about using AWS creds, choosing the platform, and necessary permisisons
+The easiest way to get started on AWS is by setting environment variables with your access keys.
+
+```
+export AWS_ACCESS_KEY_ID=<YOUR ACCESS KEY>
+export AWS_SECRET_ACCESS_KEY=<YOUR SECRET KEY>
+```
+
+You can then pass the platform variable to the `launch-dcos` command
+
+```
+make docker
+# You are now in a container.
+make launch-dcos PLATFORM=aws 
+# Launches DC/OS cluster. The cluster provisioning will take ~15 minutes.  
+make setup-cli 
+# Configures the DC/OS CLI and kubectl.
+make install 
+# Installs kubernetes on your cluster. Takes ~2 minutes.
+make kubectl-tunnel PLATFORM=aws 
+# Creates a ssh tunnel to a node-agent for APIServer access.
+# Make sure the API Server and Kubelets are up by running:
+
+kubectl get nodes
+
+# If you see a result like this, everything is working properly, and you are now running Kubernetes on DC/OS.
+
+NAME                                   STATUS    AGE       VERSION
+kube-node-0-kubelet.kubernetes.mesos   Ready     13s       v1.7.5 
+kube-node-1-kubelet.kubernetes.mesos   Ready     13s       v1.7.5 
+kube-node-2-kubelet.kubernetes.mesos   Ready     13s       v1.7.5 
+
+make uninstall 
+# Uninstalls kubernetes.
+make destroy-dcos 
+# Deletes the DC/OS cluster.
+```
+```
diff --git a/docs/existing_cluster.md b/docs/existing_cluster.md
@@ -1,7 +1,9 @@
-If you already have a DC/OS 1.10+ cluster, Kubernetes is publicly available in the Universe.
+# Existing Cluster
+
+If you already have a DC/OS 1.10+ cluster, Kubernetes is publicly available in the Catalog.  Please ensure your cluster satisfies the minimum [resource requirements](resource-requirements.md)
 
 ```
-dcos package install kubernetes
+dcos package install beta-kubernetes
 ```
 
-This will create a 3 node Kubernetes cluster via DC/OS
+This will create a 3 node Kubernetes cluster via DC/OS.  
diff --git a/docs/gce-service-account.md b/docs/gce-service-account.md
@@ -0,0 +1,12 @@
+# Google Cloud Platform Service Account
+
+A service account represents a Google Cloud service identity, such as code running on Compute Engine VMs.
+
+To retrive the credential file from Google Cloud, request a key
+
+```
+gcloud iam service-accounts keys create key.json --iam-account=nick-960@cool-project-781.iam.gserviceaccount.com
+
+```
+
+Note the location of this downloaded key as you will use it to provision a GCE cluster.
diff --git a/docs/gce_permissions.md b/docs/gce_permissions.md
diff --git a/docs/gce_service_account.md b/docs/gce_service_account.md
diff --git a/docs/limitations.md b/docs/limitations.md
@@ -0,0 +1,6 @@
+Kubernetes on DC/OS is currently in Beta and has the following known limitations.
+
+* Package upgrades are not supported
+* One Kubernetes cluster can be run on a given DC/OS cluster
+* Strict security mode in DC/OS Enterprise is not supported
+* You cannot reach Kubernetes services from nodes not running kube-proxy
diff --git a/docs/resource-requirements.md b/docs/resource-requirements.md
@@ -0,0 +1,3 @@
+# Resource Requirements
+
+Your cluster must have at least 3 private nodes for the default configuration with: 6 CPU | 5654 MB MEM | 615 MB Disk.