-
Notifications
You must be signed in to change notification settings - Fork 568
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOC]Add missing pachctl docs (#3878)
* Changed pachctl.rst to index.rst * Added pachctl docs * Added missing files
- Loading branch information
Showing
137 changed files
with
450 additions
and
390 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,23 @@ | ||
# pachctl | ||
## pachctl | ||
|
||
`pachctl` is the command line interface for Pachyderm. To install `pachctl`, follow | ||
the [Getting Started](../getting_started/local_installation.html) instructions. | ||
|
||
## Synopsis | ||
|
||
### Synopsis | ||
|
||
|
||
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_TRACE is set | ||
PACH_TRACE={true,false}, If true, and JAEGER_ENDPOINT is set, attach a | ||
Jaeger trace to any outgoing RPCs | ||
|
||
```bash | ||
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_TRACE is set | ||
PACH_TRACE={true,false}, If true, and JAEGER_ENDPOINT is set, attach a | ||
Jaeger trace to any outgoing RPCs | ||
``` | ||
|
||
## Options | ||
### Options | ||
|
||
``` | ||
--no-metrics Don't report user metrics for this command | ||
--no-port-forwarding Disable implicit port forwarding | ||
-v, --verbose Output verbose logs | ||
-v, --verbose Output verbose logs | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
## pachctl config | ||
|
||
Manages the pachyderm config. | ||
|
||
### Synopsis | ||
|
||
|
||
Gets/sets pachyderm config values. | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-v, --verbose Output verbose logs | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
## pachctl config delete | ||
|
||
|
||
|
||
### Synopsis | ||
|
||
|
||
|
||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-v, --verbose Output verbose logs | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
## pachctl config delete context | ||
|
||
Deletes a context. | ||
|
||
### Synopsis | ||
|
||
|
||
Deletes a context. | ||
|
||
``` | ||
pachctl config delete context | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-v, --verbose Output verbose logs | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
## pachctl config get | ||
|
||
|
||
|
||
### Synopsis | ||
|
||
|
||
|
||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-v, --verbose Output verbose logs | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
## pachctl config get active-context | ||
|
||
Gets the currently active context. | ||
|
||
### Synopsis | ||
|
||
|
||
Gets the currently active context. | ||
|
||
``` | ||
pachctl config get active-context | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-v, --verbose Output verbose logs | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
## pachctl config get context | ||
|
||
Gets a context. | ||
|
||
### Synopsis | ||
|
||
|
||
Gets the config of a context by its name. | ||
|
||
``` | ||
pachctl config get context | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-v, --verbose Output verbose logs | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
## pachctl config get metrics | ||
|
||
Gets whether metrics are enabled. | ||
|
||
### Synopsis | ||
|
||
|
||
Gets whether metrics are enabled. | ||
|
||
``` | ||
pachctl config get metrics | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-v, --verbose Output verbose logs | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
## pachctl config list | ||
|
||
|
||
|
||
### Synopsis | ||
|
||
|
||
|
||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-v, --verbose Output verbose logs | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
## pachctl config list context | ||
|
||
Lists contexts. | ||
|
||
### Synopsis | ||
|
||
|
||
Lists contexts. | ||
|
||
``` | ||
pachctl config list context | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-v, --verbose Output verbose logs | ||
``` | ||
|
Oops, something went wrong.