github.com/pachyderm/pachyderm@v1.13.4/doc/docs/1.10.x/pachub/pachub_getting_started.md (about)

     1  # Getting Started with Pachyderm Hub
     2  
     3  Pachyderm Hub is a platform for data scientists where you can
     4  version-control your data, build analysis pipelines, and
     5  track the provenance of your data science workflow.
     6  
     7  This section walks you through
     8  the steps of creating a cluster in Pachyderm Hub so that
     9  you do not need to worry about the underlying infrastructure
    10  and can get started using Pachyderm right away.
    11  
    12  <!--Follow the steps below to configure your first Pachyderm pipeline or
    13  watch the 2-minute [Getting Started Screencast](../tutorials/screencast-opencv.html).-->
    14  
    15  Pachyderm Hub enables you to preview Pachyderm functionality
    16  free of charge by removing the burden of deploying Pachyderm locally
    17  or in a third-party cloud platform. Currently, Pachyderm Hub is in beta
    18  so clusters cannot be turned into production clusters and should only
    19  be used for easy development and testing. Production-grade functionality
    20  will be supported in later releases.
    21  
    22  !!! note
    23      We'd like to hear your feedback! Let us know what you think
    24      about Pachyderm Hub and help us make it better.
    25      Join our [Slack channel](http://slack.pachyderm.io).
    26  
    27  ## How it Works
    28  
    29  To get started, complete the following steps:
    30  
    31  ![Pachyderm Hub Steps](../assets/images/d_pachub_steps.svg)
    32  
    33  ## Log in
    34  
    35  Pachyderm Hub uses GitHub OAuth as an identity provider. Therefore,
    36  to start using Pachyderm Hub, you need to log in by authorizing
    37  Pachyderm Hub with your GitHub account. If you do not
    38  have a GitHub account yet, create one by following the steps described
    39  in [Join GitHub](https://github.com/join).
    40  
    41  To log in to Pachyderm Hub, complete the following steps:
    42  
    43  1. Go to [hub.pachyderm.com](https://hub.pachyderm.com).
    44  1. Click **Try for free**.
    45  1. Authorize Pachyderm Hub with your GitHub account by typing your
    46     GitHub user name and password.
    47  1. Proceed to [Step 1](#step-1-create-a-cluster).
    48  
    49  ## Step 1: Create a Cluster
    50  
    51  To get started, create a Pachyderm cluster on which your pipelines will run.
    52  A Pachyderm cluster runs on top of the underlying cloud infrastructure.
    53  In Pachyderm Hub, you can create a one-node cluster that you can use for
    54  a limited time.
    55  
    56  To create a Pachyderm cluster, complete the following steps:
    57  
    58  1. If you have not yet done so, log in to Pachyderm Hub.
    59  1. Click **Create cluster**.
    60  1. Type a name for your cluster. For example, `test1`.
    61  1. Click **Create**.
    62  
    63     Your cluster is provisioned instantly!
    64  
    65     ![Pachub cluster](../assets/images/s_pachub_cluster.png)
    66  
    67     **Note:** While Pachyderm maintains a few clusters that are instantly
    68     available, none may be available during periods of high traffic. If
    69     you see your cluster is in a *starting* state, you might have to wait a few
    70     minutes for it to be ready.
    71  
    72  1. Proceed to [Step 2](#step-2-connect-to-your-cluster).
    73  
    74  ## Step 2 - Connect to Your Cluster
    75  
    76  Pachyderm Hub enables you to access your cluster through a command-line
    77  interface (CLI) called `pachctl` and the web interface called the Dashboard.
    78  Although you can perform most simple actions directly in the dashboard,
    79  `pachctl` provides full functionality. Most likely, you will use
    80  `pachctl` for any operation beyond the most basic workflow.
    81  Pachyderm recommends that you use `pachctl` for all data operations and
    82  the dashboard to view your data and graphical representation of your
    83  pipelines.
    84  
    85  After you create a cluster, you need to go to the terminal on your computer
    86  and configure your CLI to connect to your cluster by installing `pachctl`
    87  and configuring your Pachyderm context. For more information about
    88  Pachyderm contexts, see [Connect by using a Pachyderm Context](../../deploy-manage/deploy/connect-to-cluster/#connect-by-using-a-pachyderm-context).
    89  
    90  To set the correct Pachyderm context, you need to use the hostname
    91  of your cluster that is available in the Pachyderm Hub UI under **Connect**.
    92  
    93  !!! note
    94      `kubectl` commands are not supported for the clusters deployed
    95      on Pachyderm Hub.
    96  
    97  To connect to your cluster, complete the following steps:
    98  
    99  1. On your local computer, open a terminal window.
   100  1. Install or upgrade  `pachctl` as described in
   101     [Install pachctl](../../getting_started/local_installation/#install-pachctl).
   102  
   103  1. Verify your `pachctl` version:
   104  
   105     ```shell
   106     pachctl version --client-only
   107     ```
   108  
   109     **System Response:**
   110  
   111     ```shell
   112     1.9.8
   113     ```
   114  
   115  1. Configure a Pachyderm context and log in to your
   116     cluster by using a one-time authentication token:
   117  
   118     1. In the Pachyderm Hub UI, click **Connect** next to your cluster.
   119     1. In your terminal window, copy, paste, and run the commands listed in
   120        the instructions.
   121        These commands create a new Pachyderm context with your cluster
   122        details on your machine.
   123  
   124        **Note:** If you get the following error, that means that your authentication
   125        token has expired:
   126  
   127        ```shell
   128        error authenticating with Pachyderm cluster: /pachyderm_auth/auth-codes/ e14ccfafb35d4768f4a73b2dc9238b365492b88e98b76929d82ef0c6079e0027 not found
   129        ```
   130  
   131        To get a new token, refresh the page. Then, use
   132        the new token to authenticate.
   133  
   134     1. Verify that you have set the correct context:
   135  
   136        ```shell
   137        pachctl config get active-context
   138        ```
   139  
   140        **System Response:**
   141  
   142        ```shell
   143        test-svet-cc0mi51i52
   144        ```
   145  
   146  1. Verify that you can run `pachctl` commands on your cluster:
   147  
   148     1. Create a repo called `test`:
   149  
   150        ```shell
   151        pachctl create repo test
   152        ```
   153  
   154     1. Verify that the repo was created:
   155  
   156        ```shell
   157        pachctl list repo
   158        ```
   159  
   160        **System Response:**
   161  
   162        ```shell
   163        NAME   CREATED       SIZE (MASTER) ACCESS LEVEL
   164        test   3 seconds ago 0B            OWNER
   165        ```
   166  
   167     1. Go to the dashboard and verify that you can see the repo in the
   168        dashboard:
   169  
   170        1. In the Pachyderm Hub UI, click **Dashboard** next to your cluster.
   171        The dashboard opens in a new window.
   172  
   173        ![repo_ready](../assets/images/s_pachub_ready.png)
   174  
   175  ## Next Steps
   176  
   177  Congratulations! You have successfully deployed and configured a Pachyderm
   178  cluster in Pachyderm Hub. Now, you can try out our Beginners tutorial that walks
   179  you through the Pachyderm basics.
   180  
   181  * [Beginner Tutorial](../getting_started/beginner_tutorial.md)