Skip to content

Commit

Permalink
Merge pull request #3670 from pachyderm/move-s3gateway-docs
Browse files Browse the repository at this point in the history
Moved s3gateway docs to enterprise section
  • Loading branch information
ysimonson committed Apr 29, 2019
2 parents e3df807 + 4e1d898 commit 58a8a3c
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
3 changes: 3 additions & 0 deletions doc/enterprise/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,6 @@ Pachyderm Enterprise Edition gives data scientists advanced insights into their

With Pachyderm Enterprise, cluster admins don't have to rely solely on command line tools and language libraries to configure and control Pachyderm. With new versions of our UI you can control, scale, and configure Pachyderm interactively.

## S3Gateway

Pachyderm Enterprise Edition includes the s3gateway, an S3-like API for interacting with PFS content. With it, you can interact with PFS content with tools and libraries built to work with S3.
11 changes: 4 additions & 7 deletions doc/fundamentals/s3gateway.md → doc/enterprise/s3gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,12 @@ with PFS through its gRPC interface instead.

## Connecting to the s3gateway

You can start the s3gateway locally by running `pachctl s3gateway`. Then point
your browser or favorite s3 tool at `http://localhost:30600`. The s3gateway
also runs in the background on your pachyderm cluster, which you can reach via
The s3gateway runs in your cluster, and can be reached via
`http://<cluster ip>:30600`.

**Note:** A third way to access the s3gateway is using the explicit port
forwarder (`pachctl port-forward`). However, we don't recommend it, as
kubernetes' port forwarder incurs overhead, and does not recover well from
broken connections.
Alternatively, you can use port forwarding to connect to the cluster.
However, we don't recommend it, as kubernetes' port forwarder incurs overhead,
and does not recover well from broken connections.

## Supported operations

Expand Down
2 changes: 1 addition & 1 deletion doc/fundamentals/getting_data_into_pachyderm.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ about these clients [here](../reference/clients.html).

We support an HTTP API that offers a subset of S3's functionality. With this,
you can use existing tools or libraries that work with object stores, such as
minio. [See the s3gateway docs for more information](./s3gateway.html).
minio. [See the s3gateway docs for more information](../enterprise/s3gateway.html).

### The Pachyderm Dashboard

Expand Down
2 changes: 1 addition & 1 deletion doc/fundamentals/getting_data_out_of_pachyderm.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ Although `pachctl` and `egress` provide easy ways to interact with data in Pachy
- Mount versioned data from the distributed file system via `pachctl mount ...` (a feature best suited for experimentation and testing).
- If you're on Pachyderm Enterprise, you can use the s3gateway, which allows
you to reuse existing tools or libraries that work with object stores.
[See the s3gateway docs for more information](./s3gateway.html).
[See the s3gateway docs for more information](../enterprise/s3gateway.html).
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ Note: if you are using a Pachyderm version < 1.4, you can find relevant docs `he
fundamentals/updating_pipelines
fundamentals/distributed_computing
fundamentals/incrementality
fundamentals/s3gateway

.. toctree::
:maxdepth: 1
Expand All @@ -45,6 +44,7 @@ Note: if you are using a Pachyderm version < 1.4, you can find relevant docs `he
enterprise/deployment
enterprise/auth
enterprise/stats
enterprise/s3gateway

.. toctree::
:maxdepth: 1
Expand Down

0 comments on commit 58a8a3c

Please sign in to comment.