Skip to content

Commit

Permalink
Merge pull request #3284 from pachyderm/check-for-broken-links
Browse files Browse the repository at this point in the history
Fix various broken links
  • Loading branch information
JoeyZwicker committed Dec 16, 2018
2 parents d9cf693 + 964b66c commit c6d3743
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 11 deletions.
2 changes: 1 addition & 1 deletion doc/enterprise/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ There is a single, hardcoded "admin" group (and no other groups) in Pachyderm.

## Activating access control

First, you will need to make sure that your cluster has Pachyderm Enterprise Edition activated (you can follow [this guide](deployment.md) to activate Enterprise Edition). The status of the Enterprise features can be verified by accessing the Pachyderm dashboard or with `pachctl` as follows:
First, you will need to make sure that your cluster has Pachyderm Enterprise Edition activated (you can follow [this guide](./deployment.html) to activate Enterprise Edition). The status of the Enterprise features can be verified by accessing the Pachyderm dashboard or with `pachctl` as follows:

```
$ pachctl enterprise get-state
Expand Down
2 changes: 1 addition & 1 deletion doc/enterprise/deployment.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Deploying Enterprise Edition

To deploy and use Pachyderm's Enterprise Edition, you simply need to follow [one of our guides to deploy Pachyderm](../deployment/overview.html) and then [activate the Enterprise Edition](#activating-pachyderm-enterprise-edition).
To deploy and use Pachyderm's Enterprise Edition, you simply need to follow [one of our guides to deploy Pachyderm](./deploy_intro.html) and then [activate the Enterprise Edition](#activating-pachyderm-enterprise-edition).

**Note** - Pachyderm's Enterprise dashboard is now deployed by default with Pachyderm. If you wish to deploy without the dashboard please use `pachctl deploy [command] --no-dashboard`

Expand Down
2 changes: 1 addition & 1 deletion doc/getting_started/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ Looking for more in-depth development docs? Check out the Pachyderm fundamentals
- [Getting data out of Pachyderm](../fundamentals/getting_data_out_of_pachyderm.html)
- [Updating pipelines](../fundamentals/updating_pipelines.html)

Need to see different or more advanced Pachyderm examples? You can find a bunch of them [here](../examples/readme.html).
Need to see different or more advanced Pachyderm examples? You can find a bunch of them [here](../examples/examples.html).

**Note** - If you've already got a Kubernetes cluster running or would rather use AWS, GCE or Azure to deploy Pachyderm, check out our [deployment guides](../deployment/deploy_intro.html).
4 changes: 2 additions & 2 deletions doc/getting_started/local_installation.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Local Installation
This guide will walk you through the recommended path to get Pachyderm running locally on OSX or Linux.

If you hit any errors not covered in this guide, check our [troubleshooting](http://pachyderm.readthedocs.io/en/stable/getting_started/troubleshooting.html) docs for common errors, submit an issue on [GitHub](https://github.com/pachyderm/pachyderm), join our [users channel on Slack](http://slack.pachyderm.io/), or email us at [support@pachyderm.io](mailto:support@pachyderm.io) and we can help you right away.
If you hit any errors not covered in this guide, check our [general troubleshooting](../managing_pachyderm/general_troubleshooting.html) docs for common errors, submit an issue on [GitHub](https://github.com/pachyderm/pachyderm), join our [users channel on Slack](http://slack.pachyderm.io/), or email us at [support@pachyderm.io](mailto:support@pachyderm.io) and we can help you right away.

## Prerequisites
- [Minikube](#minikube) (and VirtualBox) or [Docker Desktop (v18.06+)](#dockerdesktop)
- [Minikube](#minikube) (and VirtualBox) or [Docker Desktop (v18.06+)](#docker-desktop)
- [Pachyderm Command Line Interface](#pachctl)

### Minikube
Expand Down
8 changes: 3 additions & 5 deletions doc/managing_pachyderm/general_troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ $kubectl logs po/pachd-1333950811-0sm1p

These logs will likely reveal a misconfiguration in your deploy. For example, you might see, `BucketRegionError: incorrect region, the bucket is not in 'us-west-2' region`. In that case, you've deployed your bucket in a different region than your cluster.

If the error / recourse isn't obvious from the error message, you can now provide the content of the `pachd` logs when getting help in our Slack channel or by opening a [GitHub Issue](github.com/pachyderm/pachyderm/issues/new). Please provide these logs either way as it is extremely helpful in resolving the issue..
If the error / recourse isn't obvious from the error message, you can now provide the content of the `pachd` logs when getting help in our Slack channel or by opening a [GitHub Issue](https://github.com/pachyderm/pachyderm/issues/new). Please provide these logs either way as it is extremely helpful in resolving the issue..

### Pod stuck in `CrashLoopBackoff` - with error attaching volume

Expand Down Expand Up @@ -153,9 +153,7 @@ Any `pachctl put-file` or `pachctl get-file` commands are slow.

#### Recourse

Check if you're using port-forwarding. Port forwarding throttles traffic to ~1MB/s. If you need to do large downloads/uploads you should consider using the `ADDRESS` variable instead to connect directly to your k8s master node. [See this note](./getting_started/other_installation.html?highlight=ADDRESS#usage)

You'll also want to make sure you've allowed ingress access through any firewalls to your k8s cluster.
Check if you're using port-forwarding. Port forwarding throttles traffic to ~1MB/s. If you need to do large downloads/uploads you should consider using the `ADDRESS` variable instead to connect directly to your k8s master node. You'll also want to make sure you've allowed ingress access through any firewalls to your k8s cluster.

---

Expand Down Expand Up @@ -240,4 +238,4 @@ If the state is `CrashLoopBackoff`, you're looking for a descriptive error messa

If the state is `Pending` it's likely the cluster doesn't have enough resources. In this case, you'll see a `could not schedule` type of error message which should describe which resource you're low on. This is more likely to happen if you've set resource requests (cpu/mem/gpu) for your pipelines. In this case, you'll just need to scale up your resources. If you deployed using `kops`, you'll want to do edit the instance group, e.g. `kops edit ig nodes ...` and up the number of nodes. If you didn't use `kops` to deploy, you can use your cloud provider's auto scaling groups to increase the size of your instance group. Either way, it can take up to 10 minutes for the changes to go into effect.

You can read more about autoscaling [here](../cookbook/autoscaling.html)
You can read more about autoscaling [here](./autoscaling.html)
2 changes: 1 addition & 1 deletion doc/managing_pachyderm/sharing_gpu_resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ GPU instances are expensive! You want to make sure that you're utilizing the GPU

# Without configuration

[To deploy a pipeline that relies on GPU](http://docs.pachyderm.io/en/latest/cookbook/tensorflow_gpu.html), you'll already have set the `gpu` resource requirement in the pipeline specification. But Pachyderm workers by default are long lived ... the worker is spun up and waits for new input. That works great for pipelines that are processing a lot of new incoming commits.
[To deploy a pipeline that relies on GPU](../cookbook/gpus.html), you'll already have set the `gpu` resource requirement in the pipeline specification. But Pachyderm workers by default are long lived ... the worker is spun up and waits for new input. That works great for pipelines that are processing a lot of new incoming commits.

For ML workflows, especially during the development cycle, you probably will see lower volume of input commits. Which means that you could have your pipeline workers 'taking' the GPU resource as far as k8s is concerned, but 'idling' as far as you're concerned.

Expand Down

0 comments on commit c6d3743

Please sign in to comment.