From 4f04c12cce7e8f4050ccf80d7f73e2d2891c2724 Mon Sep 17 00:00:00 2001 From: Daniel Whitenack Date: Fri, 27 Jan 2017 13:59:01 -0500 Subject: [PATCH] simple docs for minio support (#1) --- doc/deployment/deploying_on_premises.md | 40 +++++++++++++++++++++++++ doc/index.rst | 1 + 2 files changed, 41 insertions(+) create mode 100644 doc/deployment/deploying_on_premises.md diff --git a/doc/deployment/deploying_on_premises.md b/doc/deployment/deploying_on_premises.md new file mode 100644 index 00000000000..d6a7aca213f --- /dev/null +++ b/doc/deployment/deploying_on_premises.md @@ -0,0 +1,40 @@ +# Deploying on premises + +.. note:: + + The following on premises deployment options are experimental and the related deploy commands will likely change in the next release. We'd love your feedback an how you're using it and what we can improve. info@pachyderm.io. + +This guide will walk you through the recommended current recommended path to test an "on premises" Pachyderm deployment. This will illustrate the use of a privately managed and hosted object store (minio) with a pachyderm cluster. However, for the time being, the following deployment is not scalable. It is hear for illustrative purposes. + +## Prerequisites +- [Minikube](#minikube) (and VirtualBox) +- [Pachyderm Command Line Interface](#pachctl) +- A locally running instance of [Minio](https://www.minio.io/) (e.g., via Docker) + +## Deploy Pachyderm with a Minio Backend +Assuming that you have Minikube running, it's incredibly easy to deploy Pachyderm backed by a locally running Minio object store at `127.0.0.1:9000`. + +```sh +pachctl deploy minio 10.0.2.2:9000 +``` + +This generates a Pachyderm manifest and deploys Pachyderm on Kubernetes. It also instructs Pachyderm to use the Minio instance for the storage backend (note `10.0.2.2` is used here instead of `127.0.0.1`, because minikube is running inside of virtual box). It may take a few minutes for the pachd nodes to be running because it's pulling containers from DockerHub. You can see the cluster status by using `kubectl get all`. + +## Port Forwarding + +The last step is to set up port forwarding so commands you send can reach Pachyderm within the VM. We background this process since port forwarding blocks. + +```shell +$ pachctl port-forward & +``` + +Once port forwarding is complete, pachctl should automatically be connected. Try `pachctl version` to make sure everything is working. + +```shell +$ pachctl version +COMPONENT VERSION +pachctl 1.3.4 +pachd 1.3.4 +``` + +We're good to go! diff --git a/doc/index.rst b/doc/index.rst index df4c24802ed..2c0d5f0613d 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -28,6 +28,7 @@ If you can't find what you're looking for or have a an issue not mentioned here, deployment/analyze_your_data deployment/deploying_on_the_cloud + deployment/deploying_on_premises deployment/inputing_your_data deployment/custom_pipelines deployment/pipeline_spec