github.com/pachyderm/pachyderm@v1.13.4/doc/docs/1.11.x/deploy-manage/deploy/deploy-pachyderm-ide.md (about)

     1  # Deploy the Pachyderm IDE
     2  
     3  !!! note
     4      The Pachyderm IDE is an enterprise feature,
     5      which is also available for testing during
     6      the 14-day free trial.
     7      Contact sales@pachyderm.com for more
     8      information.
     9  
    10  The Pachyderm Integrated Development Environment (IDE) is
    11  an optional extension to Pachyderm clusters that provides a
    12  comprehensive environment for prototyping and deploying
    13  Pachyderm pipelines, as well as introspecting on data in the
    14  Pachyderm version control system. It combines together Jupyter,
    15  JupyterHub, and JupyterLab, which are familiar tools for many data
    16  scientists.
    17  
    18  The following diagram shows the Pachyderm IDE deployment.
    19  
    20  ![JupyterHub and Pachyderm Architecture Overview](../../assets/images/d_jupyterhub-pachyderm-arch.svg)
    21  
    22  In the diagram above, you can see that Pachyderm and JupyterHub are
    23  deployed on the same Kubernetes cluster. You deploy Pachyderm by
    24  using the `pachctl deploy` command as described below. After
    25  deployment, you log in to JupyterHub with your Pachyderm user
    26  and interact with Pachyderm from within the JupyterLab UI by
    27  using `pachctl` or the Pachyderm Python client.
    28  
    29  ## Prerequisites
    30  
    31  Before deploying Pachyderm IDE, configure the following prerequisites:
    32  
    33  * Deploy Pachyderm {{ config.pach_latest_version }} or later as described in
    34  [Deploy Pachyderm](../)
    35  on a supported Kubernetes platforms:
    36  
    37    - Google Kubernetes Engine (GKE)
    38    - Amazon Elastic Container Service (EKS)
    39    - Docker Desktop for Mac
    40    - Minikube
    41  
    42      For more information about JupyterHub requirements for Kubernetes,
    43      see [Zero to JupyterHub with Kubernetes](https://zero-to-jupyterhub.readthedocs.io/en/latest/).
    44  
    45  * Register your Enterprise token as described in
    46  [Activate Pachyderm Enterprise Edition](../../../enterprise/deployment/#activate-pachyderm-enterprise-edition).
    47  
    48  * Enable [Pachyderm Access Controls](../../../enterprise/auth/auth/).
    49  
    50  ## Deploy Pachyderm IDE
    51  
    52  After you deploy Pachyderm and enable authentication,
    53  deploy the Pachyderm IDE by running:
    54  
    55  ```shell
    56  pachctl deploy ide
    57  ```
    58  
    59  Pachyderm deploys and configures JupyterHub and JupyterLab, which
    60  might take some time. 
    61  
    62  ## Log in to Pachyderm IDE
    63  
    64  After you deploy the Pachyderm IDE, you can access the UI
    65  in a web browser through its service IP on port
    66  `80`. To get the service IP address of the Pachyderm IDE,
    67  run the following command:
    68  
    69  * If you have deployed the Pachyderm IDE in a cloud platform, run:
    70  
    71    ```shell
    72    kubectl --namespace=default get svc proxy-public
    73    ```
    74  
    75  * If you have deployed the Pachyderm IDE in Minikube, run:
    76  
    77    ```shell
    78    minikube service proxy-public --url
    79    ```
    80  
    81  Paste the returned address in a browser to access your Pachyderm IDE.
    82  Use your Pachyderm authentication token to log in.
    83  
    84  If you access your Kubernetes cluster through a firewall, verify that
    85  you can access your cluster on port 80. For more information, see
    86  the documentation for your cloud platform in
    87  [Zero to JupyterHub with Kubernetes](https://zero-to-jupyterhub.readthedocs.io/en/latest/create-k8s-cluster.html).
    88  
    89  
    90  !!! note "See Also:"
    91      - [Use Pachyderm IDE](../../how-tos/use-pachyderm-ide/index.md)