Permalink
Browse files

Update docs

  • Loading branch information...
ospillinger committed Feb 7, 2019
1 parent 594b1a8 commit 108e8a954dd39c57711af3396106f330344fac1e
@@ -2,7 +2,7 @@

<br>

[Install](https://docs.cortexlabs.com/cortex/install) • [Quick Start](https://docs.cortexlabs.com/cortex/quick-start) • [Docs](https://docs.cortexlabs.com/cortex) • <!-- CORTEX_VERSION_MINOR_STABLE -->[Examples](https://github.com/cortexlabs/cortex/tree/0.1/examples) • [FAQ](https://docs.cortexlabs.com/cortex/faq) • [Discord](https://discord.gg/q2CFGPe)
[Install](https://docs.cortexlabs.com/cortex/install) • [Quick Start](https://docs.cortexlabs.com/cortex/quick-start) • [Docs](https://docs.cortexlabs.com/cortex) • <!-- CORTEX_VERSION_MINOR_STABLE -->[Examples](https://github.com/cortexlabs/cortex/tree/0.1/examples) • [FAQ](https://docs.cortexlabs.com/cortex/faq) • [Gitter](https://gitter.im/cortexlabs/cortex)

<br>

@@ -183,9 +183,9 @@ function install_kubernetes_tools() {

echo
echo "You can now spin up a EKS cluster using the command below (see eksctl.io for more configuration options):"
echo " eksctl create cluster --name=cortex --nodes=3 --node-type=t3.small # this takes ~20 minutes"
echo " eksctl create cluster --name=cortex --nodes=2 --node-type=t3.medium # this takes ~20 minutes"
echo
echo "Note: we recommend a minimum cluster size of 3 t3.small AWS instances. Cortex may not run successfully on clusters with less compute resources."
echo "Note: we recommend a minimum cluster size of 2 t3.medium AWS instances. Cortex may not run successfully on clusters with less compute resources."
}

function uninstall_operator() {
@@ -210,7 +210,7 @@ function uninstall_operator() {
echo " aws s3 rb s3://<bucket-name> --force"
echo
echo "Command to delete the log group used by Cortex:"
echo " aws logs delete-log-group --log-group-name cortex"
echo " aws logs delete-log-group --log-group-name cortex --region us-west-2"
echo
echo "Command to uninstall the cortex CLI:"
echo " ./cortex.sh uninstall cli"
@@ -1489,11 +1489,13 @@ function check_dep_kubectl() {
fi

JSONPATH='{range .items[*]}{@.metadata.name}:{range @.status.conditions[*]}{@.type}={@.status};{end}{end}'
set +e
GET_NODES_OUTPUT=$(kubectl get nodes -o jsonpath="$JSONPATH" 2>/dev/null)
if [ $? -ne 0 ]; then
echo "error: kubectl is not properly configured to connect with your cluster. If you are using eksctl, you can run \`eksctl utils write-kubeconfig --name=cortex\` to configure kubectl."
exit 1
fi
set -e
NUM_NODES_READY=$(echo $GET_NODES_OUTPUT | tr ';' "\n" | grep "Ready=True" | wc -l)
if ! [[ $NUM_NODES_READY -ge 1 ]]; then
echo "error: your cluster has no registered nodes"
File renamed without changes.
@@ -24,7 +24,7 @@ export AWS_SECRET_ACCESS_KEY=***

Cortex runs on Kubernetes. Please make sure you have a Kubernetes cluster running before installing Cortex. We support versions 1.10 and 1.11.

**We recommend a minimum cluster size of 3 [t3.small](https://aws.amazon.com/ec2/instance-types) AWS instances. Cortex may not run successfully on clusters with less compute resources.**
**We recommend a minimum cluster size of 2 [t3.medium](https://aws.amazon.com/ec2/instance-types) AWS instances. Cortex may not run successfully on clusters with less compute resources.**

If you don't already have a Kubernetes cluster, [eksctl](https://eksctl.io) is a simple tool to create and manage one:

@@ -33,7 +33,7 @@ If you don't already have a Kubernetes cluster, [eksctl](https://eksctl.io) is a
./cortex.sh install kubernetes-tools
# Spin up an EKS cluster (see eksctl.io for more configuration options)
eksctl create cluster --name=cortex --nodes=3 --node-type=t3.small # this takes ~20 minutes
eksctl create cluster --name=cortex --nodes=2 --node-type=t3.medium # this takes ~20 minutes
```

## Operator
@@ -37,7 +37,7 @@ export AWS_SECRET_ACCESS_KEY=***
aws s3 rb s3://<bucket-name> --force
# Delete the log group
aws logs delete-log-group --log-group-name cortex
aws logs delete-log-group --log-group-name cortex --region us-west-2
```

## Kubernetes
@@ -3,7 +3,7 @@
## Prerequisites

1. AWS account
2. Kubernetes cluster running Cortex ([installation instructions](install.md))
2. Kubernetes cluster running Cortex ([installation instructions](operator/install.md))
3. Cortex CLI

## TL;DR
@@ -1,9 +1,9 @@
# Summary

* [Read Me](../README.md)
* [Install](install.md)
* [Install](operator/install.md)
* [Quick Start](quick-start.md)
* [CLI Commands](cli.md)
* [CLI Commands](operator/cli.md)
* [Examples](https://github.com/cortexlabs/cortex/tree/master/examples) <!-- CORTEX_VERSION_MINOR -->
* [FAQ](faq.md)

0 comments on commit 108e8a9

Please sign in to comment.