Emily CLI Documentation

Release-v3.0.6

Emily combines the powers of Python and Docker to build stable and consistent machine learning and datascience python environments. Emily is useful for large cross-team project development as well as for simply running a single jupyter notebook or python script.

Download emily@latest
See earlier versions
buildopenenvironmentconfigurationserversdeploymentdeploylistmountunmountstopdroploginlogoutdoctorupdatewhoamitelemetryloguninstall
addremove
composekubernetes
$ emily configuration add kubernetes [options]

Add Kubernetes configurations to your project.

$ emily configuration add kubernetes

? Emily: Choose a project(Use arrow keys, confirm with ENTER) … > M9VHKD - my-project
AB82JD - movie-recommender · M9VHKD - my-project
√ Emily: Please enter the configuration name:
· staging√ Emily: Please enter the name of the repo to host your image on:
· johnsmith/my-image? Emily: Are you using a private Docker hub repository?(y/N) · NoEmily: Kubernetes configuration "staging" added to project my-project
(M9VHKD)

Created:

- /my/projects/my-project/configurations/staging/deployment.yml
- /my/projects/my-project/configurations/staging/namespace.yml
- /my/projects/my-project/configurations/staging/network.yml
- /my/projects/my-project/configurations/staging/service.yml
- /my/projects/my-project/configurations/staging/kubernetes.settings.json

Kubernetes base configuration

The emily configuration add kubernetes command adds the base Kubernetes configuration to your project. The configuration adds the basic files required for running the project inside a Kubernetes cluster.

The --repo flag is required to specify the name of the repository where the service image should be hosted. For example, if you want to host your image on DockerHub, specify the flag as follows:

$ emily configuration add kubernetes
--repo your-dockerhub-username/your-image-name

If your DockerHub repository is private, remember to pass the --private flag (or alternatively --no-private to avoid the prompt). When this flag is passed, you will be prompted to authenticate against DockerHub when deploying your service.

If, instead of DockerHub, you're using Azure Kubernetes Service and an Azure Container Registry as the registry, you can specify the repository as subject to your container registry:

$ emily configuration add kubernetes
--repo myregistry.azurecr.io/my-image

    Options

  • -h,--help

    Display help for command

  • -r,--repo<repo>

    Full name of repository, e.g. johnsmith/my-image or myregistry.azurecr.io/my-image.

  • -ho,--host<host>

    The host to listen on.

  • -p,--port<port>

    The port the API is hosted at.

  • -pr,--private(--no-private)

    Use a private Docker Hub repository for hosting the image.

  • -n,--namespace<namespace>

    The Kubernetes namespace to deploy your service on. (default: default)

  • -rp,--replicas<replicas>

    The number of pods to deploy for your Kubernetes service. (default: 1)

  • -rm,--request-memory<request-memory>

    Amount of memory requested by the container.

  • -rc,--request-cpu<request-cpu>

    Amount of CPU power requested by the container.

  • -lm,--limit-memory<limit-memory>

    Limit on the memory used by the container.

  • -lr,--limit-cpu<limit-cpu>

    Limit on the CPU power used by the container.

  • -sn,--service-name<service-name>

    Name of your service when deployed to Kubernetes.

  • -n,--name<name>

    The name of the configuration

  • -p,--project<project>

    The project to manage configurations for.

  • -s,--silent

    Execute Emily silently. (default: false)

  • -u,--update(--no-update)

    Prompt for update if newer version found. (default: true)

  • -vb,--verbose

    Print detailed information while running commands.