github.com/pachyderm/pachyderm@v1.13.4/doc/docs/1.9.x/reference/config_spec.md (about)

     1  # Config Specification
     2  
     3  This document outlines the fields in pachyderm configs. This should act as a
     4  reference. If you wish to change a config value, you should do so via
     5  `pachctl config`.
     6  
     7  ## JSON format
     8  
     9  ```json
    10  {
    11    "user_id": string,
    12    "v2": {
    13      "active_context": string,
    14      "contexts": {
    15        string: {
    16          "source": int,
    17          "pachd_address": string,
    18          "server_cas": string,
    19          "session_token": string,
    20          "active_transaction": string,
    21          "cluster_name": string,
    22          "auth_info": string,
    23          "namspace": string,
    24          "cluster_id": string,
    25          "port_forwarders": {
    26            service_name: int,
    27            ...
    28          }
    29        },
    30        ...
    31      },
    32      "metrics": bool
    33    }
    34  }
    35  ```
    36  
    37  If a field is not set, it will be omitted from JSON entirely. Following is an
    38  example of a simple config:
    39  
    40  ```json
    41  {
    42    "user_id": "514cbe16-e615-46fe-92d9-3156f12885d7",
    43    "v2": {
    44      "active_context": "default",
    45      "contexts": {
    46        "default": {}
    47      },
    48      "metrics": true
    49    }
    50  }
    51  ```
    52  
    53  Following is a walk-through of all the fields.
    54  
    55  ### User ID
    56  
    57  A UUID giving a unique ID for this user for metrics.
    58  
    59  ### Metrics
    60  
    61  Whether metrics is enabled.
    62  
    63  ### Active Context
    64  
    65  `v2.active_context` specifies the name of the currently actively pachyderm
    66  context, as specified in `v2.contexts`.
    67  
    68  ### Contexts
    69  
    70  A map of context names to their configurations. Pachyderm contexts are akin to
    71  kubernetes contexts (and in fact reference the kubernetes context that they're
    72  associated with.)
    73  
    74  #### Source
    75  
    76  An integer that specifies where the config came from. This parameter is for internal use only and
    77  should not be modified.
    78  
    79  #### Pachd Address
    80  
    81  A `host:port` specification for connecting to pachd. If this is set, pachyderm
    82  will directly connect to the cluster, rather than resorting to kubernetes'
    83  port forwarding. If you can set this (because there's no firewall between you
    84  and the cluster), you should, as kubernetes' port forwarder is not designed to
    85  handle large amounts of data.
    86  
    87  #### Server CAs
    88  
    89  Trusted root certificates for the cluster, formatted as a base64-encoded PEM.
    90  This is only set when TLS is enabled.
    91  
    92  #### Session token
    93  
    94  A secret token identifying the current pachctl user within their pachyderm
    95  cluster. This is included in all RPCs sent by pachctl, and used to determine
    96  if pachctl actions are authorized. This is only set when auth is enabled.
    97  
    98  #### Active transaction
    99  
   100  The currently active transaction for batching together pachctl commands. This
   101  can be set or cleared via many of the `pachctl * transaction` commands.
   102  
   103  #### Cluster name
   104  
   105  The name of the underlying Kubernetes cluster, extracted from the Kubernetes
   106  context.
   107  
   108  #### Auth info
   109  
   110  The name of the underlying Kubernetes cluster's auth credentials, extracted
   111  from the Kubernetes context.
   112  
   113  #### Namespace
   114  
   115  The underlying Kubernetes cluster's namespace, extracted from the Kubernetes
   116  context.
   117  
   118  #### Cluster ID
   119  
   120  The pachyderm cluster ID that is used to ensure the operations run on the
   121  expected cluster.
   122  
   123  #### Port forwarders
   124  
   125  A mapping of `service name -> local port`. This field is populated when you run
   126  explicit port forwarding (`pachctl port-forward`), so that subsequent
   127  `pachctl` operations know to use the explicit port forwarder.
   128  
   129  This field is removed when the `pachctl port-forward` operation
   130  completes. You might need to manually delete the field from your
   131  config if the process failed to remove the field automatically.