Rename app.yaml to cortex.yaml

Author: deliahu

build/test-examples.sh

@@ -19,7 +19,7 @@ set -eou pipefail
 ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")"/.. >/dev/null && pwd)"
 CORTEX="$ROOT/bin/cortex"
 
-for example in $ROOT/examples/*/app.yaml; do
+for example in $ROOT/examples/*/cortex.yaml; do
   timer=1200
   example_base_dir=$(dirname "${example}")
   retry="false"

cli/cmd/deploy.go

@@ -47,7 +47,7 @@ var deployCmd = &cobra.Command{
 
 func deploy(force bool, ignoreCache bool) {
 	root := mustAppRoot()
-	_, err := appNameFromConfig() // Check proper app.yaml
+	_, err := appNameFromConfig() // Check proper cortex.yaml
 	if err != nil {
 		errors.Exit(err)
 	}

cli/cmd/errors.go

@@ -123,6 +123,6 @@ func ErrorFailedToConnect(urlStr string) error {
 func ErrorCliNotInAppDir() error {
 	return Error{
 		Kind:    ErrCliNotInAppDir,
-		message: "your current working directory is not in or under a cortex app directory (identified via a top-level app.yaml file)",
+		message: "your current working directory is not in or under a cortex app directory (identified via a top-level cortex.yaml file)",
 	}
 }

cli/cmd/init.go

@@ -79,7 +79,7 @@ func writeFile(subPath string, content string, root string, createdFiles []strin
 
 func appInitFiles(appName string) map[string]string {
 	return map[string]string{
-		"app.yaml": fmt.Sprintf("- kind: app\n  name: %s\n", appName),
+		"cortex.yaml": fmt.Sprintf("- kind: app\n  name: %s\n", appName),
 
 		"resources/environments.yaml": `## Sample environment:
 #

cli/cmd/lib_config_reader.go

@@ -33,7 +33,7 @@ func appRootOrBlank() string {
 		errors.Exit(err)
 	}
 	for true {
-		if err := files.CheckFile(filepath.Join(dir, "app.yaml")); err == nil {
+		if err := files.CheckFile(filepath.Join(dir, "cortex.yaml")); err == nil {
 			return dir
 		}
 		if dir == "/" {
@@ -91,7 +91,7 @@ func allConfigPaths(root string) []string {
 
 func appNameFromConfig() (string, error) {
 	appRoot := mustAppRoot()
-	return userconfig.ReadAppName(filepath.Join(appRoot, "app.yaml"), "app.yaml")
+	return userconfig.ReadAppName(filepath.Join(appRoot, "cortex.yaml"), "cortex.yaml")
 }
 
 func AppNameFromFlagOrConfig() (string, error) {

docs/applications/advanced/python-packages.md

@@ -4,11 +4,11 @@ Cortex allows you to install additional Python packages that can be made availab
 
 ## PyPI Packages
 
-Cortex looks for a `requirements.txt` file in the top level directory of the app (in the same level as `app.yaml`). All packages listed in `requirements.txt` will be made available to aggregators, transformers, and estimators.
+Cortex looks for a `requirements.txt` file in the top level directory of the app (in the same level as `cortex.yaml`). All packages listed in `requirements.txt` will be made available to aggregators, transformers, and estimators.
 
 ```text
 ./iris/
-├── app.yaml
+├── cortex.yaml
 ├── requirements.txt
 ├── samples.json
 ├── implementations/
@@ -23,7 +23,7 @@ Cortex App Directory
 
 ```text
 ./iris/
-├── app.yaml
+├── cortex.yaml
 ├── samples.json
 ├── implementations/
 ├── resources/

docs/applications/resources/app.md

@@ -1,6 +1,6 @@
 # Application
 
-The app resource is used to group a set of resources into an application that can be deployed as a singular unit. It must be defined in every Cortex application directory in a top-level `app.yaml` file.
+The app resource is used to group a set of resources into an application that can be deployed as a singular unit. It must be defined in every Cortex application directory in a top-level `cortex.yaml` file.
 
 ## Config
 

docs/applications/resources/overview.md

@@ -16,7 +16,7 @@ Cortex applications consist of declarative resource configuration written in YAM
 
 Resources can reference other resources from within their configuration (e.g. when defining input values) by prefixing the other resource's name with an `@` symbol. For example, a model may specify `input: @column1`, which denotes that a resource named "column1" is an input to this model.
 
-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.
+With the exception of the `app` kind (which must be defined in a top-level `cortex.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.
 

docs/tutorial.md

@@ -22,12 +22,12 @@ Our goal is to build a web API that returns the type of iris given its measureme
 
 ```bash
 mkdir iris && cd iris
-touch app.yaml irises.json
+touch cortex.yaml irises.json
 ```
 
-Cortex requires an `app.yaml` file which defines an `app` resource. Other resources may be defined in arbitrarily named YAML files in the the directory which contains `app.yaml` or any subdirectories. For this example, we will define all of our resources in `app.yaml`.
+Cortex requires an `cortex.yaml` file which defines an `app` resource. Other resources may be defined in arbitrarily named YAML files in the the directory which contains `cortex.yaml` or any subdirectories. For this example, we will define all of our resources in `cortex.yaml`.
 
-Add to `app.yaml`:
+Add to `cortex.yaml`:
 
 ```yaml
 - kind: app
@@ -36,7 +36,7 @@ Add to `app.yaml`:
 
 #### Configure data ingestion
 
-Add to `app.yaml`:
+Add to `cortex.yaml`:
 
 ```yaml
 # Environments
@@ -55,7 +55,7 @@ Cortex is able to read from any S3 bucket that your AWS credentials grant access
 
 This configuration will generate a training dataset with the specified columns and train our classifier using the generated dataset. Here we're using a built-in estimator (which uses TensorFlow's [DNNClassifier](https://www.tensorflow.org/api_docs/python/tf/estimator/DNNClassifier)) but Cortex supports any TensorFlow code that adheres to the [tf.estimator API](https://www.tensorflow.org/guide/estimators).
 
-Add to `app.yaml`:
+Add to `cortex.yaml`:
 
 ```yaml
 # Models
@@ -78,7 +78,7 @@ Add to `app.yaml`:
 
 This will make the model available as a live web service that can serve real-time predictions.
 
-Add to `app.yaml`:
+Add to `cortex.yaml`:
 
 ```yaml
 # APIs

examples/external-model/app.yaml renamed to examples/external-model/cortex.yaml

@@ -245,7 +245,7 @@ func ErrorReadConfig() error {
 func ErrorMissingAppDefinition() error {
 	return Error{
 		Kind:    ErrMissingAppDefinition,
-		message: fmt.Sprintf("app.yaml must define an app resource"),
+		message: fmt.Sprintf("cortex.yaml must define an app resource"),
 	}
 }