Skip to content

Update docs #1994

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Mar 24, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@

[Website](https://www.cortex.dev) • [Slack](https://community.cortex.dev) • [Docs](https://docs.cortex.dev)

<br>

# Deploy, manage, and scale machine learning models in production
# Deploy machine learning models to production

Cortex is a cloud native model serving platform for machine learning engineering teams.

Expand Down Expand Up @@ -36,6 +34,8 @@ $ cortex deploy apis.yaml
all APIs are ready!
```

<br>

## Manage

* Create A/B tests and shadow pipelines with configurable traffic splitting.
Expand All @@ -51,11 +51,13 @@ image-classifier batch 64
video-analyzer async 16
```

<br>

## Scale

* Configure workload and cluster autoscaling to efficiently handle large-scale production workloads.
* Create clusters with different types of instances for different types of workloads.
* Spend less on cloud infrastructure by letting Cortex manage spot or preemptible instances.
* Spend less on cloud infrastructure by letting Cortex manage spot instances.

```text
$ cortex cluster info
Expand Down
3 changes: 0 additions & 3 deletions dev/generate_cli_md.sh
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,6 @@ commands=(
"cluster configure"
"cluster down"
"cluster export"
"cluster-gcp up"
"cluster-gcp info"
"cluster-gcp down"
"env configure"
"env list"
"env default"
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
**Please view our documentation at [docs.cortex.dev](https://docs.cortex.dev)**
**Please read our documentation at [docs.cortex.dev](https://docs.cortex.dev)**
63 changes: 6 additions & 57 deletions docs/clients/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Flags:
-e, --env string environment to use
-f, --force override the in-progress api update
-y, --yes skip prompts
-o, --output string output format: one of pretty|json (default "pretty")
-o, --output string output format: one of json (default "pretty")
-h, --help help for deploy
```

Expand All @@ -27,7 +27,7 @@ Usage:
Flags:
-e, --env string environment to use
-w, --watch re-run the command every 2 seconds
-o, --output string output format: one of pretty|json (default "pretty")
-o, --output string output format: one of json (default "pretty")
-v, --verbose show additional information (only applies to pretty output format)
-h, --help help for get
```
Expand Down Expand Up @@ -57,7 +57,7 @@ Usage:
Flags:
-e, --env string environment to use
-f, --force override the in-progress api update
-o, --output string output format: one of pretty|json (default "pretty")
-o, --output string output format: one of json (default "pretty")
-h, --help help for patch
```

Expand All @@ -72,7 +72,7 @@ Usage:
Flags:
-e, --env string environment to use
-f, --force override the in-progress api update
-o, --output string output format: one of pretty|json (default "pretty")
-o, --output string output format: one of json (default "pretty")
-h, --help help for refresh
```

Expand All @@ -88,7 +88,7 @@ Flags:
-e, --env string environment to use
-f, --force delete the api without confirmation
-c, --keep-cache keep cached data for the api
-o, --output string output format: one of pretty|json (default "pretty")
-o, --output string output format: one of json (default "pretty")
-h, --help help for delete
```

Expand Down Expand Up @@ -170,57 +170,6 @@ Flags:
-h, --help help for export
```

## cluster-gcp up

```text
spin up a cluster on gcp

Usage:
cortex cluster-gcp up [CLUSTER_CONFIG_FILE] [flags]

Flags:
-e, --configure-env string name of environment to configure (default "gcp")
-y, --yes skip prompts
-h, --help help for up
```

## cluster-gcp info

```text
get information about a cluster

Usage:
cortex cluster-gcp info [flags]

Flags:
-c, --config string path to a cluster configuration file
-n, --name string name of the cluster
-p, --project string gcp project id
-z, --zone string gcp zone of the cluster
-e, --configure-env string name of environment to configure
-d, --debug save the current cluster state to a file
-y, --yes skip prompts
-h, --help help for info
```

## cluster-gcp down

```text
spin down a cluster

Usage:
cortex cluster-gcp down [flags]

Flags:
-c, --config string path to a cluster configuration file
-n, --name string name of the cluster
-p, --project string gcp project id
-z, --zone string gcp zone of the cluster
-y, --yes skip prompts
--keep-volumes keep cortex provisioned persistent volumes
-h, --help help for down
```

## env configure

```text
Expand All @@ -243,7 +192,7 @@ Usage:
cortex env list [flags]

Flags:
-o, --output string output format: one of pretty|json (default "pretty")
-o, --output string output format: one of json (default "pretty")
-h, --help help for list
```

Expand Down
2 changes: 1 addition & 1 deletion docs/clients/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ By default, the Cortex CLI is installed at `/usr/local/bin/cortex`. To install t

## Changing the CLI/client configuration directory

By default, the Cortex CLI/client creates a directory at `~/.cortex/` and uses it to store environment configuration. To use a different directory, export the `CORTEX_CLI_CONFIG_DIR` environment variable before running any `cortex` commands.
By default, the CLI/client creates a directory at `~/.cortex/` and uses it to store environment configuration. To use a different directory, export the `CORTEX_CLI_CONFIG_DIR` environment variable before running any `cortex` commands.
11 changes: 5 additions & 6 deletions docs/clients/python.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Python API
# Python client

* [cortex](#cortex)
* [client](#client)
Expand All @@ -25,8 +25,7 @@
client(env: str = None) -> Client
```

Initialize a client based on the specified environment.
If no environment name is passed, it will attempt using the default environment.
Initialize a client based on the specified environment. If no environment is specified, it will attempt to use the default environment.

**Arguments**:

Expand All @@ -43,17 +42,17 @@ If no environment name is passed, it will attempt using the default environment.
new_client(name: str, operator_endpoint: str) -> Client
```

Create a new environment to connect to an existing Cortex Cluster, and initialize a client to deploy and manage APIs on that cluster.
Create a new environment to connect to an existing cluster, and initialize a client to deploy and manage APIs on that cluster.

**Arguments**:

- `name` - Name of the environment to create.
- `operator_endpoint` - The endpoint for the operator of your Cortex Cluster. You can get this endpoint by running the CLI command `cortex cluster info` for an AWS provider or `cortex cluster-gcp info` for a GCP provider.
- `operator_endpoint` - The endpoint for the operator of your Cortex cluster. You can get this endpoint by running the CLI command `cortex cluster info`.


**Returns**:

Cortex client that can be used to deploy and manage APIs on a Cortex Cluster.
Cortex client that can be used to deploy and manage APIs on a cluster.

## env\_list

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Setting up kubectl
# Setting up `kubectl`

## Install kubectl
## Install `kubectl`

Follow these [instructions](https://kubernetes.io/docs/tasks/tools/install-kubectl).

Expand All @@ -16,13 +16,13 @@ aws --version # should be >= 1.16
aws configure
```

## Update kubeconfig
## Update `kubeconfig`

```bash
aws eks update-kubeconfig --name=<cluster_name> --region=<region>
```

## Test kubectl
## Test `kubectl`

```bash
kubectl get pods
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Private Docker registry

## Install and configure kubectl
## Configuring `kubectl`

Follow the instructions for [AWS](aws/kubectl.md) or [GCP](gcp/kubectl.md).
Follow the instructions [here](kubectl.md).

## Setting credentials

Expand Down
81 changes: 0 additions & 81 deletions docs/clusters/aws/multi-instance-type.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/clusters/aws/security.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/clusters/gcp/credentials.md

This file was deleted.

Loading