diff --git a/docs/source/examples/docker-containers.rst b/docs/source/examples/docker-containers.rst index 408a53a6185..41a5e13a027 100644 --- a/docs/source/examples/docker-containers.rst +++ b/docs/source/examples/docker-containers.rst @@ -18,6 +18,10 @@ SkyPilot can run a container either as a task, or as the runtime environment of Running Containers as Tasks --------------------------- +.. note:: + + On Kubernetes, running Docker runtime in a pod is not recommended. Instead, :ref:`use your container as a runtime environment `. + SkyPilot can run containerized applications directly as regular tasks. The default VM images provided by SkyPilot already have the Docker runtime pre-configured. To launch a containerized application, you can directly invoke :code:`docker run` in the :code:`run` section of your task. @@ -173,6 +177,10 @@ Any GPUs assigned to the task will be automatically mapped to your Docker contai Private Registries ^^^^^^^^^^^^^^^^^^ +.. note:: + + These instructions do not apply if you use SkyPilot to launch on Kubernetes clusters. Instead, see :ref:`Using Images from Private Repositories in Kubernetes` for more. + When using this mode, to access Docker images hosted on private registries, you can provide the registry authentication details using :ref:`task environment variables `: diff --git a/docs/source/reference/kubernetes/kubernetes-getting-started.rst b/docs/source/reference/kubernetes/kubernetes-getting-started.rst index 51d8bf57565..4f87c8a6ee7 100644 --- a/docs/source/reference/kubernetes/kubernetes-getting-started.rst +++ b/docs/source/reference/kubernetes/kubernetes-getting-started.rst @@ -119,6 +119,8 @@ Once your cluster administrator has :ref:`setup a Kubernetes cluster `_ for more. +.. _kubernetes-custom-images-private-repos: + Using Images from Private Repositories ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ To use images from private repositories (e.g., Private DockerHub, Amazon ECR, Google Container Registry), create a `secret `_ in your Kubernetes cluster and edit your :code:`~/.sky/config.yaml` to specify the secret like so: