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