Permalink
Browse files

Update docs

  • Loading branch information...
ospillinger committed Feb 12, 2019
1 parent 645a77b commit e06bd21271b1283b2c5b37d8f7bb194ba86ccdb3
Showing with 42 additions and 43 deletions.
  1. +2 −1 README.md
  2. +0 −31 cortex.sh
  3. +16 −0 docs/applications/resources/overview.md
  4. +3 −1 docs/operator/install.md
  5. +4 −1 docs/operator/uninstall.md
  6. +10 −2 docs/quick-start.md
  7. +7 −7 docs/summary.md
@@ -1,4 +1,5 @@
<img src='https://quirky-newton-6bd132.netlify.com/img/common/logo.png' height='88'>
<img src='https://s3-us-west-2.amazonaws.com/cortex-public/logo.png' height='88'>


<br>

@@ -183,12 +183,6 @@ function install_kubernetes_tools() {
install_aws_iam_authenticator
install_eksctl
install_kubectl

echo
echo "You can now spin up an EKS cluster using the command below (see eksctl.io for more configuration options):"
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 2 t3.medium AWS instances. Cortex may not run successfully on clusters with less compute resources."
}

function uninstall_operator() {
@@ -205,31 +199,6 @@ function uninstall_operator() {
else
echo "The Cortex operator is not installed on your Kubernetes cluster"
fi

echo
echo "Command to spin down your Kubernetes cluster:"
echo " eksctl delete cluster --name=cortex"
echo
echo "Command to remove Kubernetes tools:"
echo " ./cortex.sh uninstall kubernetes-tools"
echo
echo "Command to delete the bucket used by Cortex:"
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 --region us-west-2"
echo
echo "Command to uninstall the Cortex CLI:"
echo " ./cortex.sh uninstall cli"

if [[ -f /usr/local/bin/aws ]]; then
echo -e "\nCommand to uninstall the AWS CLI:"
if [ $(id -u) = 0 ]; then
echo " rm -rf /usr/local/aws && rm /usr/local/bin/aws && rm -rf ~/.aws"
else
echo " sudo rm -rf /usr/local/aws && sudo rm /usr/local/bin/aws && rm -rf ~/.aws"
fi
fi
}

function uninstall_cli() {
@@ -16,3 +16,19 @@ Cortex applications consist of declarative resource configuration written in YAM
With the exception of the `app` kind (which must be defined in a top-level `app.yaml` file), resources may be defined in any YAML file within your Cortex application folder or any subdirectories.

The `cortex deploy` command will validate all resource configuration and attempt to create the requested state on the cluster.

# Execution pipeline

Cortex processes resources in the following order:

1. Raw Columns
2. Aggregates
3. Transformed Columns
4. Models
5. APIs

If resource configuration changes, Cortex attempts to reuse cached resources whenever possible.

Below is an example execution DAG encompassing all possible resource dependencies:

<img src='https://s3-us-west-2.amazonaws.com/cortex-public/dag.png'>
@@ -40,7 +40,7 @@ eksctl create cluster --name=cortex --nodes=2 --node-type=t3.medium # this take

## Operator

The operator installation is configurable. For a full list of configuration options please refer to the [operator config](config.md) documentation.
The Cortex operator is a service that runs on Kubernetes, translates declarative configuration into workloads, and orchestrates those workloads on the cluster. Its installation is configurable. For a full list of configuration options please refer to the [operator config](config.md) documentation.

```bash
# Install the Cortex operator
@@ -49,6 +49,8 @@ The operator installation is configurable. For a full list of configuration opti

## CLI

The CLI runs on developer machines (e.g. your laptop) and communicates with the operator.

```bash
# Install the Cortex CLI
./cortex.sh install cli
@@ -26,7 +26,7 @@ chmod +x cortex.sh
./cortex.sh uninstall cli
```

## Delete AWS data
## AWS

```bash
# Set AWS credentials
@@ -38,6 +38,9 @@ aws s3 rb s3://<bucket-name> --force
# Delete the log group
aws logs delete-log-group --log-group-name cortex --region us-west-2
# Uninstall the AWS CLI (if you used cortex.sh to install it)
sudo rm -rf /usr/local/aws && sudo rm /usr/local/bin/aws && rm -rf ~/.aws
```

## Kubernetes
@@ -21,7 +21,15 @@ Jump to [Deploy the application](#deploy-the-application).

## Build a machine learning application

Let's build and deploy a classifier using the famous [Iris Data Set](https://archive.ics.uci.edu/ml/datasets/iris)!
Let's build and deploy a classifier using the famous [Iris Data Set](https://archive.ics.uci.edu/ml/datasets/iris)! Below are a few samples of iris data:

|sepal_length|speal_width|petal_length|petal_width|class|
|:---:|:---:|:---:|:---:|:---|
|5.1|3.5|1.4|0.2|Iris-setosa|
|7.0|3.2|4.7|1.4|Iris-versicolor|
|6.3|3.3|6.0|2.5|Iris-virginica|

Our goal is to build a web API that returns the type of iris given its measurements.

#### Initialize the application

@@ -343,7 +351,7 @@ Define a sample in `irises.json`:
}
```

Run the prediction:
When the API is ready, run the prediction like so:

```bash
cortex predict classifier irises.json
@@ -3,21 +3,15 @@
* [Read Me](../README.md)
* [Install](operator/install.md)
* [Quick Start](quick-start.md)
* [Application Overview](applications/resources/overview.md)
* [CLI Commands](operator/cli.md)
* [Examples](https://github.com/cortexlabs/cortex/tree/master/examples) <!-- CORTEX_VERSION_MINOR -->
* [FAQ](faq.md)

## Operator

* [Config](operator/config.md)
* [Security](operator/security.md)
* [Uninstall](operator/uninstall.md)

## Applications

### Resources

* [Overview](applications/resources/overview.md)
* [Application](applications/resources/app.md)
* [Environments](applications/resources/environments.md)
* [Data Types](applications/resources/data-types.md)
@@ -40,3 +34,9 @@

* [Templates](applications/advanced/templates.md)
* [Compute](applications/advanced/compute.md)

## Operator

* [Config](operator/config.md)
* [Security](operator/security.md)
* [Uninstall](operator/uninstall.md)

0 comments on commit e06bd21

Please sign in to comment.