Skip to content

Commit

Permalink
Run make doc for 1.8.6.
Browse files Browse the repository at this point in the history
  • Loading branch information
jdoliner committed Mar 8, 2019
1 parent 53b5ab3 commit 607c2ce
Show file tree
Hide file tree
Showing 22 changed files with 62 additions and 110 deletions.
2 changes: 1 addition & 1 deletion doc/deployment/amazon_web_services.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ To deploy and interact with Pachyderm, you will need `pachctl`, Pachyderm's comm
$ brew tap pachyderm/tap && brew install pachyderm/tap/pachctl@1.8

# For Linux (64 bit) or Window 10+ on WSL:
$ curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v1.8.5/pachctl_1.8.5_amd64.deb && sudo dpkg -i /tmp/pachctl.deb
$ curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v1.8.6/pachctl_1.8.6_amd64.deb && sudo dpkg -i /tmp/pachctl.deb
```

You can try running `pachctl version --client-only` to verify that `pachctl` has been successfully installed.
Expand Down
2 changes: 1 addition & 1 deletion doc/deployment/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ $ STORAGE_KEY="$(az storage account keys list \
$ brew tap pachyderm/tap && brew install pachyderm/tap/pachctl@1.8

# For Linux (64 bit) or Window 10+ on WSL:
$ curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v1.8.5/pachctl_1.8.5_amd64.deb && sudo dpkg -i /tmp/pachctl.deb
$ curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v1.8.6/pachctl_1.8.6_amd64.deb && sudo dpkg -i /tmp/pachctl.deb
```

You can try running `pachctl version` to check that this worked correctly:
Expand Down
2 changes: 1 addition & 1 deletion doc/deployment/google_cloud_platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ $ gsutil ls
$ brew tap pachyderm/tap && brew install pachyderm/tap/pachctl@1.8

# For Linux (64 bit) or Window 10+ on WSL:
$ curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v1.8.5/pachctl_1.8.5_amd64.deb && sudo dpkg -i /tmp/pachctl.deb
$ curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v1.8.6/pachctl_1.8.6_amd64.deb && sudo dpkg -i /tmp/pachctl.deb
```

You can then run `pachctl version --client-only` to check that the installation was successful.
Expand Down
4 changes: 2 additions & 2 deletions doc/getting_started/local_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@ To reset your kubernetes cluster on Docker For Desktop just click the reset butt
$ brew tap pachyderm/tap && brew install pachyderm/tap/pachctl@1.8

# For Debian based linux (64 bit) or Window 10+ on WSL:
$ curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v1.8.5/pachctl_1.8.5_amd64.deb && sudo dpkg -i /tmp/pachctl.deb
$ curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v1.8.6/pachctl_1.8.6_amd64.deb && sudo dpkg -i /tmp/pachctl.deb

# For all other linux flavors
$ curl -o /tmp/pachctl.tar.gz -L https://github.com/pachyderm/pachyderm/releases/download/v1.8.5/pachctl_1.8.5_linux_amd64.tar.gz && tar -xvf /tmp/pachctl.tar.gz -C /tmp && sudo cp /tmp/pachctl_1.8.5_linux_amd64/pachctl /usr/local/bin
$ curl -o /tmp/pachctl.tar.gz -L https://github.com/pachyderm/pachyderm/releases/download/v1.8.6/pachctl_1.8.6_linux_amd64.tar.gz && tar -xvf /tmp/pachctl.tar.gz -C /tmp && sudo cp /tmp/pachctl_1.8.6_linux_amd64/pachctl /usr/local/bin
```


Expand Down
4 changes: 4 additions & 0 deletions doc/pachctl/pachctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ Access the Pachyderm API.

Environment variables:
PACHD_ADDRESS=<host>:<port>, the pachd server to connect to (e.g. 127.0.0.1:30650).
PACH_CONFIG=<path>, the path where pachctl will attempt to load your pach config.
JAEGER_ENDPOINT=<host>:<port>, the Jaeger server to connect to, if PACH_ENABLE_TRACING is set
PACH_ENABLE_TRACING={true,false}, If true, and JAEGER_ENDPOINT is set, attach a
Jaeger trace to all outgoing RPCs


### Options
Expand Down
33 changes: 0 additions & 33 deletions doc/pachctl/pachctl_commit.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
## ./pachctl repo
## ./pachctl debug-binary

Docs for repos.
Return the binary the server is running.

### Synopsis


Repos, short for repository, are the top level data object in Pachyderm.

Repos are created with create-repo.
Return the binary the server is running.

```
./pachctl repo
./pachctl debug-binary
```

### Options inherited from parent commands
Expand Down
29 changes: 29 additions & 0 deletions doc/pachctl/pachctl_debug-pprof.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## ./pachctl debug-pprof

Analyze a profile of pachd in pprof.

### Synopsis


Analyze a profile of pachd in pprof.

```
./pachctl debug-pprof profile
```

### Options

```
--binary-file string File to write the binary to. (default "binary")
-d, --duration duration Duration to run a CPU profile for. (default 1m0s)
--profile-file string File to write the profile to. (default "profile")
```

### Options inherited from parent commands

```
--no-metrics Don't report user metrics for this command
--no-port-forwarding Disable implicit port forwarding
-v, --verbose Output verbose logs
```

Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
## ./pachctl file
## ./pachctl debug-profile

Docs for files.
Return a profile from the server.

### Synopsis


Files are the lowest level data object in Pachyderm.
Return a profile from the server.

Files can be written to started (but not finished) commits with put-file.
Files can be read from finished commits with get-file.
```
./pachctl debug-profile profile
```

### Options

```
./pachctl file
-d, --duration duration Duration to run a CPU profile for. (default 1m0s)
```

### Options inherited from parent commands
Expand Down
1 change: 1 addition & 0 deletions doc/pachctl/pachctl_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Deploy a Pachyderm cluster.
--local-roles Use namespace-local roles instead of cluster roles. Ignored if --no-rbac is set.
--log-level string The level of log messages to print options are, from least to most verbose: "error", "info", "debug". (default "info")
--namespace string Kubernetes namespace to deploy Pachyderm to. (default "default")
--new-hash-tree-flag (feature flag) Do not set, used for testing
--no-dashboard Don't deploy the Pachyderm UI alongside Pachyderm (experimental).
--no-expose-docker-socket Don't expose the Docker socket to worker containers. This limits the privileges of workers which prevents them from automatically setting the container's working dir and user.
--no-guaranteed Don't use guaranteed QoS for etcd and pachd deployments. Turning this on (turning guaranteed QoS off) can lead to more stable local clusters (such as a on Minikube), it should normally be used for production clusters.
Expand Down
1 change: 1 addition & 0 deletions doc/pachctl/pachctl_deploy_amazon.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ Deploy a Pachyderm cluster running on AWS. Arguments are:
--local-roles Use namespace-local roles instead of cluster roles. Ignored if --no-rbac is set.
--log-level string The level of log messages to print options are, from least to most verbose: "error", "info", "debug". (default "info")
--namespace string Kubernetes namespace to deploy Pachyderm to. (default "default")
--new-hash-tree-flag (feature flag) Do not set, used for testing
--no-dashboard Don't deploy the Pachyderm UI alongside Pachyderm (experimental).
--no-expose-docker-socket Don't expose the Docker socket to worker containers. This limits the privileges of workers which prevents them from automatically setting the container's working dir and user.
--no-guaranteed Don't use guaranteed QoS for etcd and pachd deployments. Turning this on (turning guaranteed QoS off) can lead to more stable local clusters (such as a on Minikube), it should normally be used for production clusters.
Expand Down
1 change: 1 addition & 0 deletions doc/pachctl/pachctl_deploy_custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ If <object store backend> is "s3", then the arguments are:
--local-roles Use namespace-local roles instead of cluster roles. Ignored if --no-rbac is set.
--log-level string The level of log messages to print options are, from least to most verbose: "error", "info", "debug". (default "info")
--namespace string Kubernetes namespace to deploy Pachyderm to. (default "default")
--new-hash-tree-flag (feature flag) Do not set, used for testing
--no-dashboard Don't deploy the Pachyderm UI alongside Pachyderm (experimental).
--no-expose-docker-socket Don't expose the Docker socket to worker containers. This limits the privileges of workers which prevents them from automatically setting the container's working dir and user.
--no-guaranteed Don't use guaranteed QoS for etcd and pachd deployments. Turning this on (turning guaranteed QoS off) can lead to more stable local clusters (such as a on Minikube), it should normally be used for production clusters.
Expand Down
1 change: 1 addition & 0 deletions doc/pachctl/pachctl_deploy_export-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Export a tarball (to stdout) containing all of the images in a deployment.
--local-roles Use namespace-local roles instead of cluster roles. Ignored if --no-rbac is set.
--log-level string The level of log messages to print options are, from least to most verbose: "error", "info", "debug". (default "info")
--namespace string Kubernetes namespace to deploy Pachyderm to. (default "default")
--new-hash-tree-flag (feature flag) Do not set, used for testing
--no-dashboard Don't deploy the Pachyderm UI alongside Pachyderm (experimental).
--no-expose-docker-socket Don't expose the Docker socket to worker containers. This limits the privileges of workers which prevents them from automatically setting the container's working dir and user.
--no-guaranteed Don't use guaranteed QoS for etcd and pachd deployments. Turning this on (turning guaranteed QoS off) can lead to more stable local clusters (such as a on Minikube), it should normally be used for production clusters.
Expand Down
1 change: 1 addition & 0 deletions doc/pachctl/pachctl_deploy_google.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Arguments are:
--local-roles Use namespace-local roles instead of cluster roles. Ignored if --no-rbac is set.
--log-level string The level of log messages to print options are, from least to most verbose: "error", "info", "debug". (default "info")
--namespace string Kubernetes namespace to deploy Pachyderm to. (default "default")
--new-hash-tree-flag (feature flag) Do not set, used for testing
--no-dashboard Don't deploy the Pachyderm UI alongside Pachyderm (experimental).
--no-expose-docker-socket Don't expose the Docker socket to worker containers. This limits the privileges of workers which prevents them from automatically setting the container's working dir and user.
--no-guaranteed Don't use guaranteed QoS for etcd and pachd deployments. Turning this on (turning guaranteed QoS off) can lead to more stable local clusters (such as a on Minikube), it should normally be used for production clusters.
Expand Down
1 change: 1 addition & 0 deletions doc/pachctl/pachctl_deploy_import-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Import a tarball (from stdin) containing all of the images in a deployment and p
--local-roles Use namespace-local roles instead of cluster roles. Ignored if --no-rbac is set.
--log-level string The level of log messages to print options are, from least to most verbose: "error", "info", "debug". (default "info")
--namespace string Kubernetes namespace to deploy Pachyderm to. (default "default")
--new-hash-tree-flag (feature flag) Do not set, used for testing
--no-dashboard Don't deploy the Pachyderm UI alongside Pachyderm (experimental).
--no-expose-docker-socket Don't expose the Docker socket to worker containers. This limits the privileges of workers which prevents them from automatically setting the container's working dir and user.
--no-guaranteed Don't use guaranteed QoS for etcd and pachd deployments. Turning this on (turning guaranteed QoS off) can lead to more stable local clusters (such as a on Minikube), it should normally be used for production clusters.
Expand Down
1 change: 1 addition & 0 deletions doc/pachctl/pachctl_deploy_list-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Output the list of images in a deployment.
--local-roles Use namespace-local roles instead of cluster roles. Ignored if --no-rbac is set.
--log-level string The level of log messages to print options are, from least to most verbose: "error", "info", "debug". (default "info")
--namespace string Kubernetes namespace to deploy Pachyderm to. (default "default")
--new-hash-tree-flag (feature flag) Do not set, used for testing
--no-dashboard Don't deploy the Pachyderm UI alongside Pachyderm (experimental).
--no-expose-docker-socket Don't expose the Docker socket to worker containers. This limits the privileges of workers which prevents them from automatically setting the container's working dir and user.
--no-guaranteed Don't use guaranteed QoS for etcd and pachd deployments. Turning this on (turning guaranteed QoS off) can lead to more stable local clusters (such as a on Minikube), it should normally be used for production clusters.
Expand Down
1 change: 1 addition & 0 deletions doc/pachctl/pachctl_deploy_local.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Deploy a single-node Pachyderm cluster with local metadata storage.
--local-roles Use namespace-local roles instead of cluster roles. Ignored if --no-rbac is set.
--log-level string The level of log messages to print options are, from least to most verbose: "error", "info", "debug". (default "info")
--namespace string Kubernetes namespace to deploy Pachyderm to. (default "default")
--new-hash-tree-flag (feature flag) Do not set, used for testing
--no-dashboard Don't deploy the Pachyderm UI alongside Pachyderm (experimental).
--no-expose-docker-socket Don't expose the Docker socket to worker containers. This limits the privileges of workers which prevents them from automatically setting the container's working dir and user.
--no-guaranteed Don't use guaranteed QoS for etcd and pachd deployments. Turning this on (turning guaranteed QoS off) can lead to more stable local clusters (such as a on Minikube), it should normally be used for production clusters.
Expand Down
1 change: 1 addition & 0 deletions doc/pachctl/pachctl_deploy_microsoft.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Deploy a Pachyderm cluster running on Microsoft Azure. Arguments are:
--local-roles Use namespace-local roles instead of cluster roles. Ignored if --no-rbac is set.
--log-level string The level of log messages to print options are, from least to most verbose: "error", "info", "debug". (default "info")
--namespace string Kubernetes namespace to deploy Pachyderm to. (default "default")
--new-hash-tree-flag (feature flag) Do not set, used for testing
--no-dashboard Don't deploy the Pachyderm UI alongside Pachyderm (experimental).
--no-expose-docker-socket Don't expose the Docker socket to worker containers. This limits the privileges of workers which prevents them from automatically setting the container's working dir and user.
--no-guaranteed Don't use guaranteed QoS for etcd and pachd deployments. Turning this on (turning guaranteed QoS off) can lead to more stable local clusters (such as a on Minikube), it should normally be used for production clusters.
Expand Down
1 change: 1 addition & 0 deletions doc/pachctl/pachctl_deploy_storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ particular backend, run "pachctl deploy storage <backend>"
--local-roles Use namespace-local roles instead of cluster roles. Ignored if --no-rbac is set.
--log-level string The level of log messages to print options are, from least to most verbose: "error", "info", "debug". (default "info")
--namespace string Kubernetes namespace to deploy Pachyderm to. (default "default")
--new-hash-tree-flag (feature flag) Do not set, used for testing
--no-dashboard Don't deploy the Pachyderm UI alongside Pachyderm (experimental).
--no-expose-docker-socket Don't expose the Docker socket to worker containers. This limits the privileges of workers which prevents them from automatically setting the container's working dir and user.
--no-guaranteed Don't use guaranteed QoS for etcd and pachd deployments. Turning this on (turning guaranteed QoS off) can lead to more stable local clusters (such as a on Minikube), it should normally be used for production clusters.
Expand Down
31 changes: 0 additions & 31 deletions doc/pachctl/pachctl_job.md

This file was deleted.

28 changes: 0 additions & 28 deletions doc/pachctl/pachctl_pipeline.md

This file was deleted.

2 changes: 1 addition & 1 deletion doc/release_instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ Which will create a release like `v1.2.3-2342345aefda9879e87ad`
Which can be installed like:

```
$ curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v1.8.5/pachctl_1.8.5_amd64.deb && sudo dpkg -i /tmp/pachctl.deb
$ curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v1.8.6/pachctl_1.8.6_amd64.deb && sudo dpkg -i /tmp/pachctl.deb
```

Or for mac/brew:
Expand Down

0 comments on commit 607c2ce

Please sign in to comment.