github.com/pachyderm/pachyderm@v1.13.4/doc/mkdocs-1.11.x.yml (about) 1 site_name: Pachyderm Documentation 2 site_description: A Pachyderm documentation website that provides information on how to use Pachyderm data version control products. 3 site_author: Pachyderm 4 site_url: https://docs.pachyderm.com/ 5 docs_dir: docs/1.11.x 6 site_dir: site/1.11.x 7 8 repo_name: pachyderm/pachyderm 9 repo_url: https://github.com/pachyderm/pachyderm 10 edit_uri: "" 11 12 # Copyright 13 copyright: 'Copyright Pachyderm Inc, 2020' 14 pach_latest_version: '1.11.9' 15 16 17 # Configuration 18 theme: 19 name: pachydermdocs 20 custom_dir: overrides 21 22 # 404 page 23 static_templates: 24 - 404.html 25 include_search_page: false 26 search_index_only: true 27 language: en 28 features: 29 - tabs 30 palette: 31 primary: #4B2A5C 32 accent: #4B2A5C 33 font: 34 text: Roboto 35 code: Roboto Mono 36 favicon: assets/images/favicon-32x32.png 37 icon: 38 logo: material/school 39 40 # Plugins 41 plugins: 42 - search 43 - exclude: 44 - minify: 45 minify_html: true 46 - git-revision-date-localized 47 - macros 48 49 # Customization 50 extra: 51 social: 52 - icon: fontawesome/brands/github 53 link: https://pachdm.com/github 54 - icon: fontawesome/brands/twitter 55 link: https://pachdm.com/twitter 56 - icon: fontawesome/brands/linkedin 57 link: https://pachdm.com/linkedin 58 59 extra_css: 60 - stylesheets/extra.css 61 extra_javascript: 62 - assets/javascripts/extra.js 63 64 # Extensions 65 markdown_extensions: 66 - markdown.extensions.admonition 67 - markdown.extensions.codehilite: 68 guess_lang: false 69 - markdown.extensions.def_list 70 - markdown.extensions.footnotes 71 - markdown.extensions.meta 72 - markdown.extensions.toc: 73 permalink: true 74 - mdx_truly_sane_lists: 75 nested_indent: 2 76 - pymdownx.arithmatex 77 - pymdownx.betterem: 78 smart_enable: all 79 - pymdownx.caret 80 - pymdownx.critic 81 - pymdownx.details 82 - pymdownx.emoji: 83 emoji_index: !!python/name:materialx.emoji.twemoji 84 emoji_generator: !!python/name:materialx.emoji.to_svg 85 - pymdownx.inlinehilite 86 - pymdownx.keys 87 - pymdownx.magiclink 88 - pymdownx.mark 89 - pymdownx.smartsymbols 90 - pymdownx.superfences 91 - pymdownx.tabbed 92 - pymdownx.tasklist: 93 custom_checkbox: true 94 - pymdownx.tilde 95 96 # Page tree 97 nav: 98 - Home: 99 - Welcome: index.md 100 - Contributing: 101 - Setup for Contributors: contributing/setup.md 102 - Gcloud Cluster Setup: contributing/gcloud-setup.md 103 - Repo Layout: contributing/repo-layout.md 104 - Coding Conventions: contributing/coding-conventions.md 105 - Documentation Style Guide: contributing/docs-style-guide.md 106 - Developing Pachyderm in Windows with VSCode: contributing/windows.md 107 - Getting Started: 108 - Overview: getting_started/index.md 109 - Local Installation: getting_started/local_installation.md 110 - Install pachctl Autocompletion: getting_started/install-pachctl-completion.md 111 - Deploy Pachyderm on Windows: getting_started/wsl-deploy.md 112 - Beginner Tutorial: getting_started/beginner_tutorial.md 113 - Concepts: 114 - Overview: concepts/index.md 115 - Versioned Data Concepts: 116 - Overview: concepts/data-concepts/index.md 117 - Repository: concepts/data-concepts/repo.md 118 - Commit: concepts/data-concepts/commit.md 119 - Branch: concepts/data-concepts/branch.md 120 - File: concepts/data-concepts/file.md 121 - Provenance: concepts/data-concepts/provenance.md 122 - History: concepts/data-concepts/history.md 123 - Pipeline Concepts: 124 - Overview: concepts/pipeline-concepts/index.md 125 - Pipeline: 126 - Overview: concepts/pipeline-concepts/pipeline/index.md 127 - Cron: concepts/pipeline-concepts/pipeline/cron.md 128 - Service: concepts/pipeline-concepts/pipeline/service.md 129 - Spout: concepts/pipeline-concepts/pipeline/spout.md 130 - Job: concepts/pipeline-concepts/job.md 131 - Datum: 132 - Overview: concepts/pipeline-concepts/datum/index.md 133 - Glob Patterns: concepts/pipeline-concepts/datum/glob-pattern.md 134 - Datum Processing: concepts/pipeline-concepts/datum/relationship-between-datums.md 135 - Cross and Union: concepts/pipeline-concepts/datum/cross-union.md 136 - Join: concepts/pipeline-concepts/datum/join.md 137 - Datum Processing States: concepts/pipeline-concepts/datum/datum-processing-states.md 138 - Advanced Concepts: 139 - Deferred Processing of Data: concepts/advanced-concepts/deferred_processing.md 140 - Distributed Computing: concepts/advanced-concepts/distributed_computing.md 141 - How-Tos: 142 - Overview: how-tos/index.md 143 - Workflow: 144 - Overview: how-tos/developer-workflow/index.md 145 - Working with Pipelines: how-tos/developer-workflow/working-with-pipelines.md 146 - Build Pipelines: how-tos/developer-workflow/build-pipelines.md 147 - Build Flag: how-tos/developer-workflow/build-flag.md 148 - CI/CD Integration: how-tos/developer-workflow/ci-cd-integration.md 149 - Load Your Data Into Pachyderm: how-tos/load-data-into-pachyderm.md 150 - Export Your Data From Pachyderm: 151 - Overview: how-tos/export-data-out-pachyderm/index.md 152 - Export Your Data with pachctl: how-tos/export-data-out-pachyderm/export-data-pachctl.md 153 - Export Your Data with egress: how-tos/export-data-out-pachyderm/export-data-egress.md 154 - Mount a Repo to a Local Computer: how-tos/export-data-out-pachyderm/mount-repo-to-local-computer.md 155 - Split Data: 156 - Overview: how-tos/splitting-data/index.md 157 - Splitting Data for Distributed Processing: how-tos/splitting-data/splitting.md 158 - Adjusting Data Processing by Splitting Data: how-tos/splitting-data/adjusting_data_processing_w_split.md 159 - Create a Machine Learning Workflow: how-tos/create-ml-workflow.md 160 - Use Pachyderm IDE: 161 - Overview: how-tos/use-pachyderm-ide/index.md 162 - Using the Pachyderm IDE with python-pachyderm: how-tos/use-pachyderm-ide/using-pachyderm-ide.md 163 - Mount a Volume: how-tos/mount-volume.md 164 - Pipeline Operations: 165 - Create a Pipeline: how-tos/create-pipeline.md 166 - Run a Pipeline on a Specific Commit: how-tos/run_pipeline.md 167 - Update a Pipeline: how-tos/updating_pipelines.md 168 - Delete a Pipeline: how-tos/delete-pipeline.md 169 - Monitor Job Progress: how-tos/monitor-job-progress.md 170 - Processing Time-Windowed Data: how-tos/time_windows.md 171 - Use Transactions: how-tos/use-transactions-to-run-multiple-commands.md 172 - Delete Data: how-tos/removing_data_from_pachyderm.md 173 - Ingress and Egress Data from an External Object Store: how-tos/ingressing_from_diff_cloud.md 174 - Skip Failed Datums: how-tos/err_cmd.md 175 - Deploy and Manage: 176 - Overview: deploy-manage/index.md 177 - Deploy Pachyderm: 178 - Overview: deploy-manage/deploy/index.md 179 - Getting Started with Pachyderm Hub: pachub/pachub_getting_started.md 180 - Deploy on GKE: deploy-manage/deploy/google_cloud_platform.md 181 - Deploy on AWS: 182 - Overview: deploy-manage/deploy/amazon_web_services/index.md 183 - Deploy Pachyderm on Amazon EKS: deploy-manage/deploy/amazon_web_services/deploy-eks.md 184 - Deploy Kubernetes with kops: deploy-manage/deploy/amazon_web_services/aws-deploy-kubernetes-kops.md 185 - Deploy Pachyderm on AWS: deploy-manage/deploy/amazon_web_services/aws-deploy-pachyderm.md 186 - Deploy a Pachyderm Cluster with CloudFront: deploy-manage/deploy/amazon_web_services/aws_cloudfront.md 187 - Deploy on Azure: deploy-manage/deploy/azure.md 188 - Deploy on IBM CLoud: deploy-manage/deploy/ibmcloud-openshift.md 189 - Deploy on OpenShift: deploy-manage/deploy/openshift.md 190 - Deploy On-Premises: deploy-manage/deploy/on_premises.md 191 - Deploy Pachyderm IDE: deploy-manage/deploy/deploy-pachyderm-ide.md 192 - Create a Custom Deployment: 193 - Overview: deploy-manage/deploy/deploy_custom/index.md 194 - Before You Begin: deploy-manage/deploy/deploy_custom/deploy_custom_before_you_begin.md 195 - Pachyderm Deployment Manifest: deploy-manage/deploy/deploy_custom/deploy_custom_pachyderm_deployment_manifest.md 196 - Configuring Persistent Disk Parameters: deploy-manage/deploy/deploy_custom/deploy_custom_configuring_persistent_disk_parameters.md 197 - Configuring Object Store: deploy-manage/deploy/deploy_custom/deploy_custom_configuring_object_store.md 198 - Create a Complete Configuration: deploy-manage/deploy/deploy_custom/deploy_custom_complete_example_invocation.md 199 - Additional flags: deploy-manage/deploy/deploy_custom/deploy_custom_additional_flags.md 200 - Additional Customizations: 201 - Import a Kubernetes Context: deploy-manage/deploy/import-kubernetes-context.md 202 - Deploy Pachyderm with TLS: deploy-manage/deploy/deploy_w_tls.md 203 - Deploy in a Custom Namespace: deploy-manage/deploy/namespaces.md 204 - Deploy a Custom Object Store: deploy-manage/deploy/non-cloud-object-stores.md 205 - Configure RBAC: deploy-manage/deploy/rbac.md 206 - Configure Tracing with Jaeger: deploy-manage/deploy/tracing.md 207 - Connect to a Pachyderm cluster: deploy-manage/deploy/connect-to-cluster.md 208 - Configure Environment Variables: deploy-manage/deploy/environment-variables.md 209 - Manage Pachyderm: 210 - Overview: deploy-manage/manage/index.md 211 - Manage Cluster Access: deploy-manage/manage/cluster-access.md 212 - Configure External Access: 213 - Overview: deploy-manage/manage/configure-external-access.md 214 - deploy-manage/manage/expose-pach-ui-ingress.md 215 - Using Pachctl Shell: deploy-manage/manage/pachctl_shell.md 216 - Autoscale your Cluster: deploy-manage/manage/autoscaling.md 217 - Backup and Restore: deploy-manage/manage/backup_restore.md 218 - Storage Use Optimization: deploy-manage/manage/data_management.md 219 - Use GPUs: deploy-manage/manage/gpus.md 220 - Sharing GPU Resources: deploy-manage/manage/sharing_gpu_resources.md 221 - Upgrades and Migrations: 222 - Overview: deploy-manage/manage/upgrades_migrations.md 223 - Migrate to a Major Version: deploy-manage/manage/migrations.md 224 - Upgrade your Cluster: deploy-manage/manage/upgrades.md 225 - Disable Usage Metrics: deploy-manage/manage/disable-metrics.md 226 - Using the S3 Gateway: 227 - Overview: deploy-manage/manage/s3gateway/index.md 228 - Configure the S3 Gateway: deploy-manage/manage/s3gateway/configure-s3client.md 229 - Create an S3-enabled Pipeline: deploy-manage/manage/s3gateway/deploy-s3gateway-sidecar.md 230 - Supported Operations: deploy-manage/manage/s3gateway/supported-operations.md 231 - Unsupported Operations: deploy-manage/manage/s3gateway/unsupported-operations.md 232 - Reference: 233 - Overview: reference/index.md 234 - Pipeline Specification: reference/pipeline_spec.md 235 - Pachyderm Config Specification: reference/config_spec.md 236 - Pachyderm Language Clients: reference/clients.md 237 - S3 Gateway API Reference: reference/s3gateway_api.md 238 - Pachctl Reference: 239 - reference/pachctl/pachctl.md 240 - reference/pachctl/pachctl_auth.md 241 - reference/pachctl/pachctl_auth_activate.md 242 - reference/pachctl/pachctl_auth_check.md 243 - reference/pachctl/pachctl_auth_deactivate.md 244 - reference/pachctl/pachctl_auth_get-auth-token.md 245 - reference/pachctl/pachctl_auth_get-config.md 246 - reference/pachctl/pachctl_auth_get-otp.md 247 - reference/pachctl/pachctl_auth_get.md 248 - reference/pachctl/pachctl_auth_list-admins.md 249 - reference/pachctl/pachctl_auth_login.md 250 - reference/pachctl/pachctl_auth_logout.md 251 - reference/pachctl/pachctl_auth_modify-admins.md 252 - reference/pachctl/pachctl_auth_set-config.md 253 - reference/pachctl/pachctl_auth_set.md 254 - reference/pachctl/pachctl_auth_use-auth-token.md 255 - reference/pachctl/pachctl_auth_whoami.md 256 - reference/pachctl/pachctl_completion.md 257 - reference/pachctl/pachctl_completion_bash.md 258 - reference/pachctl/pachctl_completion_zsh.md 259 - reference/pachctl/pachctl_config.md 260 - reference/pachctl/pachctl_config_delete.md 261 - reference/pachctl/pachctl_config_delete_context.md 262 - reference/pachctl/pachctl_config_get.md 263 - reference/pachctl/pachctl_config_get_active-context.md 264 - reference/pachctl/pachctl_config_get_context.md 265 - reference/pachctl/pachctl_config_get_metrics.md 266 - reference/pachctl/pachctl_config_list.md 267 - reference/pachctl/pachctl_config_list_context.md 268 - reference/pachctl/pachctl_config_set.md 269 - reference/pachctl/pachctl_config_set_active-context.md 270 - reference/pachctl/pachctl_config_set_context.md 271 - reference/pachctl/pachctl_config_set_metrics.md 272 - reference/pachctl/pachctl_config_update.md 273 - reference/pachctl/pachctl_config_update_context.md 274 - reference/pachctl/pachctl_copy.md 275 - reference/pachctl/pachctl_copy_file.md 276 - reference/pachctl/pachctl_create.md 277 - reference/pachctl/pachctl_create_branch.md 278 - reference/pachctl/pachctl_create_pipeline.md 279 - reference/pachctl/pachctl_create_repo.md 280 - reference/pachctl/pachctl_create_secret.md 281 - reference/pachctl/pachctl_debug.md 282 - reference/pachctl/pachctl_debug_binary.md 283 - reference/pachctl/pachctl_debug_dump.md 284 - reference/pachctl/pachctl_debug_pprof.md 285 - reference/pachctl/pachctl_debug_profile.md 286 - reference/pachctl/pachctl_delete.md 287 - reference/pachctl/pachctl_delete_all.md 288 - reference/pachctl/pachctl_delete_branch.md 289 - reference/pachctl/pachctl_delete_commit.md 290 - reference/pachctl/pachctl_delete_file.md 291 - reference/pachctl/pachctl_delete_job.md 292 - reference/pachctl/pachctl_delete_pipeline.md 293 - reference/pachctl/pachctl_delete_repo.md 294 - reference/pachctl/pachctl_delete_secret.md 295 - reference/pachctl/pachctl_delete_transaction.md 296 - reference/pachctl/pachctl_deploy.md 297 - reference/pachctl/pachctl_deploy_amazon.md 298 - reference/pachctl/pachctl_deploy_custom.md 299 - reference/pachctl/pachctl_deploy_export-images.md 300 - reference/pachctl/pachctl_deploy_google.md 301 - reference/pachctl/pachctl_deploy_ide.md 302 - reference/pachctl/pachctl_deploy_import-images.md 303 - reference/pachctl/pachctl_deploy_list-images.md 304 - reference/pachctl/pachctl_deploy_local.md 305 - reference/pachctl/pachctl_deploy_microsoft.md 306 - reference/pachctl/pachctl_deploy_storage.md 307 - reference/pachctl/pachctl_deploy_storage_amazon.md 308 - reference/pachctl/pachctl_deploy_storage_google.md 309 - reference/pachctl/pachctl_deploy_storage_microsoft.md 310 - reference/pachctl/pachctl_diff.md 311 - reference/pachctl/pachctl_diff_file.md 312 - reference/pachctl/pachctl_edit.md 313 - reference/pachctl/pachctl_edit_pipeline.md 314 - reference/pachctl/pachctl_enterprise.md 315 - reference/pachctl/pachctl_enterprise_activate.md 316 - reference/pachctl/pachctl_enterprise_get-state.md 317 - reference/pachctl/pachctl_exit.md 318 - reference/pachctl/pachctl_extract.md 319 - reference/pachctl/pachctl_extract_pipeline.md 320 - reference/pachctl/pachctl_finish.md 321 - reference/pachctl/pachctl_finish_commit.md 322 - reference/pachctl/pachctl_finish_transaction.md 323 - reference/pachctl/pachctl_flush.md 324 - reference/pachctl/pachctl_flush_commit.md 325 - reference/pachctl/pachctl_flush_job.md 326 - reference/pachctl/pachctl_fsck.md 327 - reference/pachctl/pachctl_garbage-collect.md 328 - reference/pachctl/pachctl_get.md 329 - reference/pachctl/pachctl_get_file.md 330 - reference/pachctl/pachctl_get_object.md 331 - reference/pachctl/pachctl_get_tag.md 332 - reference/pachctl/pachctl_glob.md 333 - reference/pachctl/pachctl_glob_file.md 334 - reference/pachctl/pachctl_inspect.md 335 - reference/pachctl/pachctl_inspect_branch.md 336 - reference/pachctl/pachctl_inspect_cluster.md 337 - reference/pachctl/pachctl_inspect_commit.md 338 - reference/pachctl/pachctl_inspect_datum.md 339 - reference/pachctl/pachctl_inspect_file.md 340 - reference/pachctl/pachctl_inspect_job.md 341 - reference/pachctl/pachctl_inspect_pipeline.md 342 - reference/pachctl/pachctl_inspect_repo.md 343 - reference/pachctl/pachctl_inspect_secret.md 344 - reference/pachctl/pachctl_inspect_transaction.md 345 - reference/pachctl/pachctl_list.md 346 - reference/pachctl/pachctl_list_branch.md 347 - reference/pachctl/pachctl_list_commit.md 348 - reference/pachctl/pachctl_list_datum.md 349 - reference/pachctl/pachctl_list_file.md 350 - reference/pachctl/pachctl_list_job.md 351 - reference/pachctl/pachctl_list_pipeline.md 352 - reference/pachctl/pachctl_list_repo.md 353 - reference/pachctl/pachctl_list_secret.md 354 - reference/pachctl/pachctl_list_transaction.md 355 - reference/pachctl/pachctl_logs.md 356 - reference/pachctl/pachctl_mount.md 357 - reference/pachctl/pachctl_port-forward.md 358 - reference/pachctl/pachctl_put.md 359 - reference/pachctl/pachctl_put_file.md 360 - reference/pachctl/pachctl_restart.md 361 - reference/pachctl/pachctl_restart_datum.md 362 - reference/pachctl/pachctl_restore.md 363 - reference/pachctl/pachctl_resume.md 364 - reference/pachctl/pachctl_resume_transaction.md 365 - reference/pachctl/pachctl_run.md 366 - reference/pachctl/pachctl_run_cron.md 367 - reference/pachctl/pachctl_run_pipeline.md 368 - reference/pachctl/pachctl_shell.md 369 - reference/pachctl/pachctl_start.md 370 - reference/pachctl/pachctl_start_commit.md 371 - reference/pachctl/pachctl_start_pipeline.md 372 - reference/pachctl/pachctl_start_transaction.md 373 - reference/pachctl/pachctl_stop.md 374 - reference/pachctl/pachctl_stop_job.md 375 - reference/pachctl/pachctl_stop_pipeline.md 376 - reference/pachctl/pachctl_stop_transaction.md 377 - reference/pachctl/pachctl_subscribe.md 378 - reference/pachctl/pachctl_subscribe_commit.md 379 - reference/pachctl/pachctl_undeploy.md 380 - reference/pachctl/pachctl_unmount.md 381 - reference/pachctl/pachctl_update-dash.md 382 - reference/pachctl/pachctl_update.md 383 - reference/pachctl/pachctl_update_pipeline.md 384 - reference/pachctl/pachctl_update_repo.md 385 - reference/pachctl/pachctl_version.md 386 - Examples: examples/examples.md 387 - Enterprise: 388 - Overview: enterprise/index.md 389 - Features: enterprise/overview.md 390 - Deploy Enterprise Edition: enterprise/deployment.md 391 - Configure Access Controls: 392 - Overview: enterprise/auth/index.md 393 - Enable Access Controls: enterprise/auth/enable-auth.md 394 - Manage Users and Groups: enterprise/auth/manage-users-groups.md 395 - Manage Authentication Config: enterprise/auth/auth-config.md 396 - Configure a SAML Provider: 397 - Overview: enterprise/auth/saml/saml.md 398 - Configure SAML: enterprise/auth/saml/saml_setup.md 399 - Use SAML: enterprise/auth/saml/saml_usage.md 400 - Configure an OIDC Provider: 401 - Overview: enterprise/auth/oidc/index.md 402 - Configure Pachyderm with Keycloak: enterprise/auth/oidc/configure-keycloak.md 403 - Configure Pachyderm with Auth0: enterprise/auth/oidc/configure-auth0.md 404 - Configure Pachyderm with Google OAuth 2.0: enterprise/auth/oidc/configure-google-oidc.md 405 - Advanced Statistics: enterprise/stats.md 406 - Troubleshooting: 407 - Overview: troubleshooting/index.md 408 - General Troubleshooting: troubleshooting/general_troubleshooting.md 409 - Deployment Troubleshooting: troubleshooting/deploy_troubleshooting.md 410 - Pipeline Troubleshooting: troubleshooting/pipeline_troubleshooting.md 411 412 # Google Analytics 413 #google_analytics: 414 # - !!python/object/apply:os.getenv ["UA-158483597-1"] 415 # - auto