Provide default cortex client environment to streamline in-cluster initialisation (#1942)

RobertLucian · web-flow · commit 793bfca088ad · 2021-03-16T03:16:26.000+02:00
diff --git a/cli/cmd/env.go b/cli/cmd/env.go
@@ -99,7 +99,7 @@ var _envListCmd = &cobra.Command{
 				fmt.Print("[]")
 				return
 			}
-			bytes, err := libjson.Marshal(cliConfig.Environments)
+			bytes, err := libjson.Marshal(cliConfig.ConvertToUserFacingCLIConfig())
 			if err != nil {
 				exit.Error(err)
 			}
diff --git a/cli/types/cliconfig/cli_config.go b/cli/types/cliconfig/cli_config.go
@@ -27,6 +27,11 @@ type CLIConfig struct {
 	Environments       []*Environment `json:"environments" yaml:"environments"`
 }
 
+type UserFacingCLIConfig struct {
+	DefaultEnvironment *string        `json:"default_environment" yaml:"default_environment"`
+	Environments       []*Environment `json:"environments" yaml:"environments"`
+}
+
 func (cliConfig *CLIConfig) Validate() error {
 	envNames := strset.New()
 
@@ -50,3 +55,10 @@ func (cliConfig *CLIConfig) Validate() error {
 
 	return nil
 }
+
+func (cliConfig *CLIConfig) ConvertToUserFacingCLIConfig() UserFacingCLIConfig {
+	return UserFacingCLIConfig{
+		DefaultEnvironment: cliConfig.DefaultEnvironment,
+		Environments:       cliConfig.Environments,
+	}
+}
diff --git a/docs/clients/python.md b/docs/clients/python.md
@@ -22,10 +22,11 @@
 ## client
 
 ```python
-client(env: str) -> Client
+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.
 
 **Arguments**:
 
diff --git a/docs/workloads/batch/predictors.md b/docs/workloads/batch/predictors.md
@@ -218,6 +218,7 @@ from cortex_internal.lib.log import logger as cortex_logger
 
 class PythonPredictor:
     def predict(self, payload, batch_id):
+        ...
         cortex_logger.info("completed processing batch", extra={"batch_id": batch_id, "confidence": confidence})
 ```
 
@@ -228,3 +229,19 @@ The dictionary passed in via the `extra` will be flattened by one level. e.g.
 ```
 
 To avoid overriding essential Cortex metadata, please refrain from specifying the following extra keys: `asctime`, `levelname`, `message`, `labels`, and `process`. Log lines greater than 5 MB in size will be ignored.
+
+## Cortex Python client
+
+A default [Cortex Python client](../../clients/python.md#cortex.client.client) environment has been configured for your API. This can be used for deploying/deleting/updating or submitting jobs to your running cluster based on the execution flow of your batch predictor. For example:
+
+```python
+import cortex
+
+class PythonPredictor:
+    def on_job_complete(self):
+        ...
+        # get client pointing to the default environment
+        client = cortex.client()
+        # deploy API in the existing cluster using the artifacts in the previous step
+        client.create_api(...)
+```
diff --git a/docs/workloads/realtime/predictors.md b/docs/workloads/realtime/predictors.md
@@ -476,3 +476,19 @@ The dictionary passed in via the `extra` will be flattened by one level. e.g.
 ```
 
 To avoid overriding essential Cortex metadata, please refrain from specifying the following extra keys: `asctime`, `levelname`, `message`, `labels`, and `process`. Log lines greater than 5 MB in size will be ignored.
+
+## Cortex Python client
+
+A default [Cortex Python client](../../clients/python.md#cortex.client.client) environment has been configured for your API. This can be used for deploying/deleting/updating or submitting jobs to your running cluster based on the execution flow of your predictor. For example:
+
+```python
+import cortex
+
+class PythonPredictor:
+    def __init__(self, config):
+        ...
+        # get client pointing to the default environment
+        client = cortex.client()
+        # get the existing apis in the cluster for something important to you
+        existing_apis = client.list_apis()
+```
diff --git a/docs/workloads/task/definitions.md b/docs/workloads/task/definitions.md
@@ -73,3 +73,19 @@ The dictionary passed in via the `extra` will be flattened by one level. e.g.
 ```
 
 To avoid overriding essential Cortex metadata, please refrain from specifying the following extra keys: `asctime`, `levelname`, `message`, `labels`, and `process`. Log lines greater than 5 MB in size will be ignored.
+
+## Cortex Python client
+
+A default [Cortex Python client](../../clients/python.md#cortex.client.client) environment has been configured for your API. This can be used for deploying/deleting/updating or submitting jobs to your running cluster based on the execution flow of your task. For example:
+
+```python
+import cortex
+
+class Task:
+    def __call__(self, config):
+        ...
+        # get client pointing to the default environment
+        client = cortex.client()
+        # deploy API in the existing cluster as part of your pipeline workflow
+        client.create_api(...)
+```
diff --git a/images/onnx-predictor-cpu/Dockerfile b/images/onnx-predictor-cpu/Dockerfile
@@ -54,9 +54,12 @@ COPY pkg/cortex/serve/init/install-core-dependencies.sh /usr/local/cortex/instal
 RUN chmod +x /usr/local/cortex/install-core-dependencies.sh
 
 COPY pkg/cortex/serve/ /src/cortex/serve
+COPY pkg/cortex/client/ /src/cortex/client
 ENV CORTEX_LOG_CONFIG_FILE /src/cortex/serve/log_config.yaml
 
-RUN pip install --no-deps /src/cortex/serve/
+RUN pip install --no-deps /src/cortex/serve/ && \
+    pip install /src/cortex/client && \
+    rm -r /src/cortex/client
 RUN mv /src/cortex/serve/init/bootloader.sh /etc/cont-init.d/bootloader.sh
 
 ENTRYPOINT ["/init"]
diff --git a/images/onnx-predictor-gpu/Dockerfile b/images/onnx-predictor-gpu/Dockerfile
@@ -54,9 +54,12 @@ COPY pkg/cortex/serve/init/install-core-dependencies.sh /usr/local/cortex/instal
 RUN chmod +x /usr/local/cortex/install-core-dependencies.sh
 
 COPY pkg/cortex/serve/ /src/cortex/serve
+COPY pkg/cortex/client/ /src/cortex/client
 ENV CORTEX_LOG_CONFIG_FILE /src/cortex/serve/log_config.yaml
 
-RUN pip install --no-deps /src/cortex/serve/
+RUN pip install --no-deps /src/cortex/serve/ && \
+    pip install /src/cortex/client && \
+    rm -r /src/cortex/client
 RUN mv /src/cortex/serve/init/bootloader.sh /etc/cont-init.d/bootloader.sh
 
 ENTRYPOINT ["/init"]
diff --git a/images/python-predictor-cpu/Dockerfile b/images/python-predictor-cpu/Dockerfile
@@ -53,9 +53,12 @@ COPY pkg/cortex/serve/init/install-core-dependencies.sh /usr/local/cortex/instal
 RUN chmod +x /usr/local/cortex/install-core-dependencies.sh
 
 COPY pkg/cortex/serve/ /src/cortex/serve
+COPY pkg/cortex/client/ /src/cortex/client
 ENV CORTEX_LOG_CONFIG_FILE /src/cortex/serve/log_config.yaml
 
-RUN pip install --no-deps /src/cortex/serve/
+RUN pip install --no-deps /src/cortex/serve/ && \
+    pip install /src/cortex/client && \
+    rm -r /src/cortex/client
 RUN mv /src/cortex/serve/init/bootloader.sh /etc/cont-init.d/bootloader.sh
 
 ENTRYPOINT ["/init"]
diff --git a/images/python-predictor-gpu/Dockerfile b/images/python-predictor-gpu/Dockerfile
@@ -55,9 +55,12 @@ COPY pkg/cortex/serve/init/install-core-dependencies.sh /usr/local/cortex/instal
 RUN chmod +x /usr/local/cortex/install-core-dependencies.sh
 
 COPY pkg/cortex/serve/ /src/cortex/serve
+COPY pkg/cortex/client/ /src/cortex/client
 ENV CORTEX_LOG_CONFIG_FILE /src/cortex/serve/log_config.yaml
 
-RUN pip install --no-deps /src/cortex/serve/
+RUN pip install --no-deps /src/cortex/serve/ && \
+    pip install /src/cortex/client && \
+    rm -r /src/cortex/client
 RUN mv /src/cortex/serve/init/bootloader.sh /etc/cont-init.d/bootloader.sh
 
 ENTRYPOINT ["/init"]
diff --git a/images/python-predictor-inf/Dockerfile b/images/python-predictor-inf/Dockerfile
@@ -63,9 +63,12 @@ COPY pkg/cortex/serve/init/install-core-dependencies.sh /usr/local/cortex/instal
 RUN chmod +x /usr/local/cortex/install-core-dependencies.sh
 
 COPY pkg/cortex/serve/ /src/cortex/serve
+COPY pkg/cortex/client/ /src/cortex/client
 ENV CORTEX_LOG_CONFIG_FILE /src/cortex/serve/log_config.yaml
 
-RUN pip install --no-deps /src/cortex/serve/
+RUN pip install --no-deps /src/cortex/serve/ && \
+    pip install /src/cortex/client && \
+    rm -r /src/cortex/client
 RUN mv /src/cortex/serve/init/bootloader.sh /etc/cont-init.d/bootloader.sh
 
 ENTRYPOINT ["/init"]
diff --git a/images/tensorflow-predictor/Dockerfile b/images/tensorflow-predictor/Dockerfile
@@ -55,9 +55,12 @@ COPY pkg/cortex/serve/init/install-core-dependencies.sh /usr/local/cortex/instal
 RUN chmod +x /usr/local/cortex/install-core-dependencies.sh
 
 COPY pkg/cortex/serve/ /src/cortex/serve
+COPY pkg/cortex/client/ /src/cortex/client
 ENV CORTEX_LOG_CONFIG_FILE /src/cortex/serve/log_config.yaml
 
-RUN pip install --no-deps /src/cortex/serve/
+RUN pip install --no-deps /src/cortex/serve/ && \
+    pip install /src/cortex/client && \
+    rm -r /src/cortex/client
 RUN mv /src/cortex/serve/init/bootloader.sh /etc/cont-init.d/bootloader.sh
 
 ENTRYPOINT ["/init"]
diff --git a/manager/install.sh b/manager/install.sh
@@ -255,6 +255,12 @@ function write_kubeconfig() {
 }
 
 function setup_configmap() {
+  envsubst < manifests/default_cortex_cli_config.yaml > tmp_cli_config.yaml
+  kubectl -n=default create configmap 'client-config' \
+    --from-file='cli.yaml'=tmp_cli_config.yaml \
+    -o yaml --dry-run=client | kubectl apply -f - >/dev/null
+  rm tmp_cli_config.yaml
+
   kubectl -n=default create configmap 'cluster-config' \
     --from-file='cluster.yaml'=$CORTEX_CLUSTER_CONFIG_FILE \
     -o yaml --dry-run=client | kubectl apply -f - >/dev/null
@@ -272,6 +278,12 @@ function setup_configmap() {
 }
 
 function setup_configmap_gcp() {
+  envsubst < manifests/default_cortex_cli_config.yaml > tmp_cli_config.yaml
+  kubectl -n=default create configmap 'client-config' \
+    --from-file='cli.yaml'=tmp_cli_config.yaml \
+    -o yaml --dry-run=client | kubectl apply -f - >/dev/null
+  rm tmp_cli_config.yaml
+
   kubectl -n=default create configmap 'cluster-config' \
     --from-file='cluster.yaml'=$CORTEX_CLUSTER_CONFIG_FILE \
     -o yaml --dry-run=client | kubectl apply -f - >/dev/null
diff --git a/manager/manifests/default_cortex_cli_config.yaml b/manager/manifests/default_cortex_cli_config.yaml
@@ -0,0 +1,19 @@
+# Copyright 2021 Cortex Labs, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+default_environment: default
+environments:
+- name: default
+  provider: $CORTEX_PROVIDER
+  operator_endpoint: http://operator.default.svc.cluster.local:8888
diff --git a/pkg/cortex/client/cortex/__init__.py b/pkg/cortex/client/cortex/__init__.py
@@ -13,6 +13,7 @@
 # limitations under the License.
 
 import json
+from typing import Optional
 
 from cortex.client import Client
 from cortex.binary import run_cli
@@ -21,7 +22,7 @@
 
 
 @sentry_wrapper
-def client(env: str) -> Client:
+def client(env: Optional[str] = None) -> Client:
     """
     Initialize a client based on the specified environment.
 
@@ -33,13 +34,16 @@ def client(env: str) -> Client:
     """
     environments = env_list()
 
-    found = False
+    if env is None:
+        if not environments["default_environment"]:
+            raise NotFound("no default environment configured")
+        env = environments["default_environment"]
 
-    for environment in environments:
+    found = False
+    for environment in environments["environments"]:
         if environment["name"] == env:
             found = True
             break
-
     if not found:
         raise NotFound(f"can't find environment {env}, create one by calling `cortex.new_client()`")
 
diff --git a/pkg/cortex/client/setup.py b/pkg/cortex/client/setup.py
@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import pathlib
 
 from setuptools import setup, find_packages
 from setuptools.command.install import install
@@ -71,8 +72,10 @@ def run(self):
             f.chmod(f.stat().st_mode | stat.S_IEXEC)
 
 
-with open("README.md") as f:
-    long_description = f.read()
+long_description = ""
+if pathlib.Path("README.md").is_file():
+    with open("README.md") as f:
+        long_description = f.read()
 
 setup(
     name="cortex",
diff --git a/pkg/operator/operator/k8s.go b/pkg/operator/operator/k8s.go
@@ -49,6 +49,7 @@ const (
 const (
 	_specCacheDir                                  = "/mnt/spec"
 	_modelDir                                      = "/mnt/model"
+	_clientConfigDir                               = "/mnt/client"
 	_emptyDirMountPath                             = "/mnt"
 	_emptyDirVolumeName                            = "mnt"
 	_tfServingContainerName                        = "serve"
@@ -605,6 +606,10 @@ func getTaskEnvVars(api *spec.API, container string) []kcore.EnvVar {
 				Name:  "CORTEX_API_SPEC",
 				Value: config.BucketPath(api.Key),
 			},
+			kcore.EnvVar{
+				Name:  "CORTEX_CLI_CONFIG_DIR",
+				Value: _clientConfigDir,
+			},
 		)
 
 		cortexPythonPath := path.Join(_emptyDirMountPath, "project")
@@ -833,6 +838,10 @@ func getEnvVars(api *spec.API, container string) []kcore.EnvVar {
 				Name:  "CORTEX_DEPENDENCIES_SHELL",
 				Value: api.Predictor.Dependencies.Shell,
 			},
+			kcore.EnvVar{
+				Name:  "CORTEX_CLI_CONFIG_DIR",
+				Value: _clientConfigDir,
+			},
 		)
 
 		if api.Kind == userconfig.RealtimeAPIKind {
@@ -1280,6 +1289,16 @@ func baseEnvVars() []kcore.EnvFromSource {
 func DefaultVolumes() []kcore.Volume {
 	var defaultVolumes = []kcore.Volume{
 		k8s.EmptyDirVolume(_emptyDirVolumeName),
+		{
+			Name: "client-config",
+			VolumeSource: kcore.VolumeSource{
+				ConfigMap: &kcore.ConfigMapVolumeSource{
+					LocalObjectReference: kcore.LocalObjectReference{
+						Name: "client-config",
+					},
+				},
+			},
+		},
 	}
 
 	if config.Provider == types.GCPProviderType {
@@ -1299,6 +1318,11 @@ func DefaultVolumes() []kcore.Volume {
 func defaultVolumeMounts() []kcore.VolumeMount {
 	var volumeMounts = []kcore.VolumeMount{
 		k8s.EmptyDirVolumeMount(_emptyDirVolumeName, _emptyDirMountPath),
+		{
+			Name:      "client-config",
+			MountPath: path.Join(_clientConfigDir, "cli.yaml"),
+			SubPath:   "cli.yaml",
+		},
 	}
 
 	if config.Provider == types.GCPProviderType {

Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ var _envListCmd = &cobra.Command{`
`99`	`99`	`fmt.Print("[]")`
`100`	`100`	`return`
`101`	`101`	`}`
`102`		`- bytes, err := libjson.Marshal(cliConfig.Environments)`
	`102`	`+ bytes, err := libjson.Marshal(cliConfig.ConvertToUserFacingCLIConfig())`
`103`	`103`	`if err != nil {`
`104`	`104`	`exit.Error(err)`
`105`	`105`	`}`