Skip to content

Update docs links #1095

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 1 commit into from
May 31, 2020
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
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ checklist:
- [ ] run `make test` and `make lint`
- [ ] test manually (i.e. build/push all images, restart operator, and re-deploy APIs)
- [ ] update examples
- [ ] update docs and add any new files to `summary.md` (view in [gitbook](https://cortex.dev/v/master) after merging)
- [ ] update docs and add any new files to `summary.md` (view in [gitbook](https://docs.cortex.dev/v/master) after merging)
- [ ] cherry-pick into release branches if applicable
- [ ] alert the dev team if the dev environment changed
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<!-- Delete on release branches -->
<!-- CORTEX_VERSION_README_MINOR -->
[install](https://cortex.dev/install) • [docs](https://cortex.dev) • [examples](https://github.com/cortexlabs/cortex/tree/0.17/examples) • [we're hiring](https://angel.co/cortex-labs-inc/jobs) • [chat with us](https://gitter.im/cortexlabs/cortex)<br><br>
[install](https://docs.cortex.dev/install) • [docs](https://docs.cortex.dev) • [examples](https://github.com/cortexlabs/cortex/tree/0.17/examples) • [we're hiring](https://angel.co/cortex-labs-inc/jobs) • [chat with us](https://gitter.im/cortexlabs/cortex)<br><br>

<!-- Set header Cache-Control=no-cache on the S3 object metadata (see https://help.github.com/en/articles/about-anonymized-image-urls) -->
![Demo](https://d1zqebknpdh033.cloudfront.net/demo/gif/v0.13_2.gif)
Expand Down
2 changes: 1 addition & 1 deletion cli/cmd/lib_aws_creds.go
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ func promptIfNotAdmin(awsClient *aws.Client, disallowPrompt bool) {
}

if !awsClient.IsAdmin() {
warningStr := fmt.Sprintf("warning: your IAM user%s does not have administrator access. This will likely prevent Cortex from installing correctly, so it is recommended to attach the AdministratorAccess policy to your IAM user (or to a group that your IAM user belongs to) via the AWS IAM console. If you'd like, you may provide separate credentials for your cluster to use after it's running (see https://cortex.dev/cluster-management/security for instructions).\n\n", accessKeyMsg)
warningStr := fmt.Sprintf("warning: your IAM user%s does not have administrator access. This will likely prevent Cortex from installing correctly, so it is recommended to attach the AdministratorAccess policy to your IAM user (or to a group that your IAM user belongs to) via the AWS IAM console. If you'd like, you may provide separate credentials for your cluster to use after it's running (see https://docs.cortex.dev/miscellaneous/security for instructions).\n\n", accessKeyMsg)
if disallowPrompt {
fmt.Print(warningStr)
} else {
Expand Down
16 changes: 8 additions & 8 deletions cli/cmd/lib_cluster_config.go
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ func readCachedClusterConfigFile(clusterConfig *clusterconfig.Config, filePath s
func readUserClusterConfigFile(clusterConfig *clusterconfig.Config) error {
errs := cr.ParseYAMLFile(clusterConfig, clusterconfig.UserValidation, _flagClusterConfig)
if errors.HasError(errs) {
return errors.Append(errors.FirstError(errs...), fmt.Sprintf("\n\ncluster configuration schema can be found here: https://www.cortex.dev/v/%s/cluster-management/config", consts.CortexVersionMinor))
return errors.Append(errors.FirstError(errs...), fmt.Sprintf("\n\ncluster configuration schema can be found here: https://docs.cortex.dev/v/%s/cluster-management/config", consts.CortexVersionMinor))
}

return nil
Expand All @@ -89,7 +89,7 @@ func getClusterAccessConfig(disallowPrompt bool) (*clusterconfig.AccessConfig, e
if _flagClusterConfig != "" {
errs := cr.ParseYAMLFile(accessConfig, clusterconfig.AccessValidation, _flagClusterConfig)
if errors.HasError(errs) {
return nil, errors.Append(errors.FirstError(errs...), fmt.Sprintf("\n\ncluster configuration schema can be found here: https://www.cortex.dev/v/%s/cluster-management/config", consts.CortexVersionMinor))
return nil, errors.Append(errors.FirstError(errs...), fmt.Sprintf("\n\ncluster configuration schema can be found here: https://docs.cortex.dev/v/%s/cluster-management/config", consts.CortexVersionMinor))
}
}

Expand Down Expand Up @@ -458,22 +458,22 @@ func confirmInstallClusterConfig(clusterConfig *clusterconfig.Config, awsCreds A
fmt.Printf("cortex will also create an s3 bucket (%s) and a cloudwatch log group (%s)%s\n\n", clusterConfig.Bucket, clusterConfig.LogGroup, privateSubnetMsg)

if clusterConfig.APILoadBalancerScheme == clusterconfig.InternalLoadBalancerScheme {
fmt.Print("warning: you've configured the API load balancer to be internal; you must configure VPC Peering or an API Gateway VPC Link to connect to your APIs (see www.cortex.dev/guides/vpc-peering or www.cortex.dev/guides/api-gateway)\n\n")
fmt.Print("warning: you've configured the API load balancer to be internal; you must configure VPC Peering or an API Gateway VPC Link to connect to your APIs (see https://docs.cortex.dev/guides/vpc-peering or https://docs.cortex.dev/guides/api-gateway)\n\n")
}
if clusterConfig.OperatorLoadBalancerScheme == clusterconfig.InternalLoadBalancerScheme {
fmt.Print("warning: you've configured the operator load balancer to be internal; you must configure VPC Peering to connect your CLI to your cluster operator (see www.cortex.dev/guides/vpc-peering)\n\n")
fmt.Print("warning: you've configured the operator load balancer to be internal; you must configure VPC Peering to connect your CLI to your cluster operator (see https://docs.cortex.dev/guides/vpc-peering)\n\n")
}

if isSpot && clusterConfig.SpotConfig.OnDemandBackup != nil && !*clusterConfig.SpotConfig.OnDemandBackup {
if *clusterConfig.SpotConfig.OnDemandBaseCapacity == 0 && *clusterConfig.SpotConfig.OnDemandPercentageAboveBaseCapacity == 0 {
fmt.Printf("warning: you've disabled on-demand instances (%s=0 and %s=0); spot instances are not guaranteed to be available so please take that into account for production clusters; see https://cortex.dev/v/%s/cluster-management/spot-instances for more information\n\n", clusterconfig.OnDemandBaseCapacityKey, clusterconfig.OnDemandPercentageAboveBaseCapacityKey, consts.CortexVersionMinor)
fmt.Printf("warning: you've disabled on-demand instances (%s=0 and %s=0); spot instances are not guaranteed to be available so please take that into account for production clusters; see https://docs.cortex.dev/v/%s/cluster-management/spot-instances for more information\n\n", clusterconfig.OnDemandBaseCapacityKey, clusterconfig.OnDemandPercentageAboveBaseCapacityKey, consts.CortexVersionMinor)
} else {
fmt.Printf("warning: you've enabled spot instances; spot instances are not guaranteed to be available so please take that into account for production clusters; see https://cortex.dev/v/%s/cluster-management/spot-instances for more information\n\n", consts.CortexVersionMinor)
fmt.Printf("warning: you've enabled spot instances; spot instances are not guaranteed to be available so please take that into account for production clusters; see https://docs.cortex.dev/v/%s/cluster-management/spot-instances for more information\n\n", consts.CortexVersionMinor)
}
}

if !disallowPrompt {
exitMessage := fmt.Sprintf("cluster configuration can be modified via the cluster config file; see https://cortex.dev/v/%s/cluster-management/config for more information", consts.CortexVersionMinor)
exitMessage := fmt.Sprintf("cluster configuration can be modified via the cluster config file; see https://docs.cortex.dev/v/%s/cluster-management/config for more information", consts.CortexVersionMinor)
prompt.YesOrExit("would you like to continue?", "", exitMessage)
}
}
Expand All @@ -482,7 +482,7 @@ func confirmConfigureClusterConfig(clusterConfig clusterconfig.Config, awsCreds
fmt.Println(clusterConfigConfirmaionStr(clusterConfig, awsCreds, awsClient))

if !disallowPrompt {
exitMessage := fmt.Sprintf("cluster configuration can be modified via the cluster config file; see https://cortex.dev/v/%s/cluster-management/config for more information", consts.CortexVersionMinor)
exitMessage := fmt.Sprintf("cluster configuration can be modified via the cluster config file; see https://docs.cortex.dev/v/%s/cluster-management/config for more information", consts.CortexVersionMinor)
prompt.YesOrExit(fmt.Sprintf("your cluster named \"%s\" in %s will be updated according to the configuration above, are you sure you want to continue?", clusterConfig.ClusterName, *clusterConfig.Region), "", exitMessage)
}
}
Expand Down
4 changes: 2 additions & 2 deletions cli/local/validations.go
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,9 @@ func ValidateLocalAPIs(apis []userconfig.API, projectFiles ProjectFiles, awsClie
if len(apisRequiringGPU) > 0 {
if _, ok := dockerClient.Info.Runtimes["nvidia"]; !ok {
if !strings.HasPrefix(strings.ToLower(runtime.GOOS), "linux") {
fmt.Printf("warning: %s will run without gpu access because the nvidia container runtime is not supported on your operating system; see https://cortex.dev/troubleshooting/nvidia-container-runtime-not-found for more information\n\n", s.StrsAnd(apisRequiringGPU.SliceSorted()))
fmt.Printf("warning: %s will run without gpu access because the nvidia container runtime is not supported on your operating system; see https://docs.cortex.dev/troubleshooting/nvidia-container-runtime-not-found for more information\n\n", s.StrsAnd(apisRequiringGPU.SliceSorted()))
} else {
fmt.Printf("warning: %s will run without gpu access because your local machine doesn't have a gpu or the nvidia container runtime is not configured properly; see https://cortex.dev/troubleshooting/nvidia-container-runtime-not-found for more information\n\n", s.StrsAnd(apisRequiringGPU.SliceSorted()))
fmt.Printf("warning: %s will run without gpu access because your local machine doesn't have a gpu or the nvidia container runtime is not configured properly; see https://docs.cortex.dev/troubleshooting/nvidia-container-runtime-not-found for more information\n\n", s.StrsAnd(apisRequiringGPU.SliceSorted()))
}

for i := range apis {
Expand Down
8 changes: 4 additions & 4 deletions docs/cluster-management/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,11 @@ subnet_visibility: public # must be "public" or "private"
nat_gateway: none # must be "none", "single", or "highly_available" (highly_available means one NAT gateway per availability zone)

# whether the API load balancer should be internet-facing or internal (default: "internet-facing")
# note: if using "internal", you must configure VPC Peering or an API Gateway VPC Link to connect to your APIs (see www.cortex.dev/guides/vpc-peering or www.cortex.dev/guides/api-gateway)
# note: if using "internal", you must configure VPC Peering or an API Gateway VPC Link to connect to your APIs (see https://docs.cortex.dev/guides/vpc-peering or https://docs.cortex.dev/guides/api-gateway)
api_load_balancer_scheme: internet-facing # must be "internet-facing" or "internal"

# whether the operator load balancer should be internet-facing or internal (default: "internet-facing")
# note: if using "internal", you must configure VPC Peering to connect your CLI to your cluster operator (see www.cortex.dev/guides/vpc-peering)
# note: if using "internal", you must configure VPC Peering to connect your CLI to your cluster operator (see https://docs.cortex.dev/guides/vpc-peering)
operator_load_balancer_scheme: internet-facing # must be "internet-facing" or "internal"

# CloudWatch log group for cortex (default: <cluster_name>)
Expand All @@ -70,10 +70,10 @@ log_group: cortex
tags: # <string>: <string> map of key/value pairs

# whether to use spot instances in the cluster (default: false)
# see https://cortex.dev/v/master/cluster-management/spot-instances for additional details on spot configuration
# see https://docs.cortex.dev/v/master/cluster-management/spot-instances for additional details on spot configuration
spot: false

# see https://cortex.dev/v/master/guides/subdomain-https-setup for instructions on how to set up HTTPS for APIs
# see https://docs.cortex.dev/v/master/guides/subdomain-https-setup for instructions on how to set up HTTPS for APIs
ssl_certificate_arn: # if empty, APIs will still be accessible via HTTPS (in addition to HTTP), but will not use a trusted certificate
```

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/batch-runner.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ class PythonPredictor:
# If you have changed these values, the number of replicas created will be equal to max_workers / target_replica_concurrency
# (note that the default value of target_replica_concurrency is workers_per_replica * threads_per_worker).
# If max_workers starts to get large, you will also want to set the inference API's max_replica_concurrency to avoid long and imbalanced queue lengths
# Here are the autoscaling docs: https://www.cortex.dev/deployments/autoscaling
# Here are the autoscaling docs: https://docs.cortex.dev/deployments/autoscaling
with ThreadPoolExecutor(max_workers=5) as executor:
results = executor.map(self.make_request, batches)

Expand Down
2 changes: 1 addition & 1 deletion examples/pytorch/answer-generator/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Please refer to the [tutorial](https://cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
Please refer to the [tutorial](https://docs.cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
2 changes: 1 addition & 1 deletion examples/pytorch/image-classifier/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Please refer to the [tutorial](https://cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
Please refer to the [tutorial](https://docs.cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
2 changes: 1 addition & 1 deletion examples/pytorch/iris-classifier/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Please refer to the [tutorial](https://cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
Please refer to the [tutorial](https://docs.cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
2 changes: 1 addition & 1 deletion examples/pytorch/language-identifier/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Please refer to the [tutorial](https://cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
Please refer to the [tutorial](https://docs.cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
2 changes: 1 addition & 1 deletion examples/pytorch/object-detector/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Please refer to the [tutorial](https://cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
Please refer to the [tutorial](https://docs.cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
2 changes: 1 addition & 1 deletion examples/pytorch/reading-comprehender/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Please refer to the [tutorial](https://cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
Please refer to the [tutorial](https://docs.cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
2 changes: 1 addition & 1 deletion examples/pytorch/search-completer/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Please refer to the [tutorial](https://cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
Please refer to the [tutorial](https://docs.cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
2 changes: 1 addition & 1 deletion examples/pytorch/sentiment-analyzer/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Please refer to the [tutorial](https://cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
Please refer to the [tutorial](https://docs.cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
2 changes: 1 addition & 1 deletion examples/pytorch/text-generator/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Please refer to the [tutorial](https://cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
Please refer to the [tutorial](https://docs.cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
2 changes: 1 addition & 1 deletion examples/pytorch/text-summarizer/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Please refer to the [tutorial](https://cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
Please refer to the [tutorial](https://docs.cortex.dev/iris-classifier) to see how to deploy an example with Cortex.

Please refer [here](https://sshleifer.github.io/blog_v2/jupyter/2020/03/12/bart.html) to learn more about BART.
2 changes: 1 addition & 1 deletion examples/sklearn/mpg-estimator/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Please refer to the [tutorial](https://cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
Please refer to the [tutorial](https://docs.cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
2 changes: 1 addition & 1 deletion examples/spacy/entity-recognizer/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Please refer to the [tutorial](https://cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
Please refer to the [tutorial](https://docs.cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
2 changes: 1 addition & 1 deletion examples/tensorflow/image-classifier/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Please refer to the [tutorial](https://cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
Please refer to the [tutorial](https://docs.cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
2 changes: 1 addition & 1 deletion examples/tensorflow/iris-classifier/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Please refer to the [tutorial](https://cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
Please refer to the [tutorial](https://docs.cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
2 changes: 1 addition & 1 deletion examples/tensorflow/sentiment-analyzer/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Please refer to the [tutorial](https://cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
Please refer to the [tutorial](https://docs.cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
2 changes: 1 addition & 1 deletion examples/tensorflow/text-generator/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Please refer to the [tutorial](https://cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
Please refer to the [tutorial](https://docs.cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
2 changes: 1 addition & 1 deletion examples/xgboost/iris-classifier/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Please refer to the [tutorial](https://cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
Please refer to the [tutorial](https://docs.cortex.dev/iris-classifier) to see how to deploy an example with Cortex.
2 changes: 1 addition & 1 deletion manager/check_cortex_version.sh
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ set -e
CORTEX_VERSION=master

if [ "$CORTEX_VERSION" != "$CORTEX_CLI_VERSION" ]; then
echo "error: your CLI version ($CORTEX_CLI_VERSION) doesn't match your Cortex manager image version ($CORTEX_VERSION); please update your CLI by following the instructions at https://www.cortex.dev/install, or update your Cortex manager image by modifying the value for \`image_manager\` in your cluster configuration file (e.g. cluster.yaml) and running \`cortex cluster configure --config cluster.yaml\` (update other image paths in cluster.yaml as well if necessary)"
echo "error: your CLI version ($CORTEX_CLI_VERSION) doesn't match your Cortex manager image version ($CORTEX_VERSION); please update your CLI by following the instructions at https://docs.cortex.dev/install, or update your Cortex manager image by modifying the value for \`image_manager\` in your cluster configuration file (e.g. cluster.yaml) and running \`cortex cluster configure --config cluster.yaml\` (update other image paths in cluster.yaml as well if necessary)"
exit 1
fi
2 changes: 1 addition & 1 deletion pkg/lib/configreader/errors.go
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,6 @@ func ErrorCortexResourceNotAllowed(resourceName string) error {
func ErrorImageVersionMismatch(image, tag, cortexVersion string) error {
return errors.WithStack(&errors.Error{
Kind: ErrImageVersionMismatch,
Message: fmt.Sprintf("the specified image (%s) has a tag (%s) which does not match your Cortex version (%s); please update the image tag, remove the image registry path from your configuration file (to use the default value), or update your CLI by following the instructions at https://www.cortex.dev/install", image, tag, cortexVersion),
Message: fmt.Sprintf("the specified image (%s) has a tag (%s) which does not match your Cortex version (%s); please update the image tag, remove the image registry path from your configuration file (to use the default value), or update your CLI by following the instructions at https://docs.cortex.dev/install", image, tag, cortexVersion),
})
}
2 changes: 1 addition & 1 deletion pkg/lib/k8s/errors.go
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,6 @@ func ErrorParseAnnotation(annotationName string, annotationVal string, desiredTy
func ErrorParseQuantity(qtyStr string) error {
return errors.WithStack(&errors.Error{
Kind: ErrParseQuantity,
Message: fmt.Sprintf("%s: invalid kubernetes quantity, some valid examples are 1, 200m, 500Mi, 2G (see here for more information: https://cortex.dev/v/%s/deployments/compute)", qtyStr, consts.CortexVersionMinor),
Message: fmt.Sprintf("%s: invalid kubernetes quantity, some valid examples are 1, 200m, 500Mi, 2G (see here for more information: https://docs.cortex.dev/v/%s/deployments/compute)", qtyStr, consts.CortexVersionMinor),
})
}
2 changes: 1 addition & 1 deletion pkg/operator/endpoints/errors.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ const (
func ErrorAPIVersionMismatch(operatorVersion string, clientVersion string) error {
return errors.WithStack(&errors.Error{
Kind: ErrAPIVersionMismatch,
Message: fmt.Sprintf("your CLI version (%s) doesn't match your Cortex operator version (%s); please update your cluster by following the instructions at https://www.cortex.dev/cluster-management/update, or update your CLI by following the instructions at https://www.cortex.dev/install", clientVersion, operatorVersion),
Message: fmt.Sprintf("your CLI version (%s) doesn't match your Cortex operator version (%s); please update your cluster by following the instructions at https://docs.cortex.dev/cluster-management/update, or update your CLI by following the instructions at https://docs.cortex.dev/install", clientVersion, operatorVersion),
})
}

Expand Down
Loading