<commit_before>---
template_variables:
  book_title: Cloud Foundry Documentation
  book_title_short: Cloud Foundry Docs
  title: Cloud Foundry Documentation
  title_image: ../images/logo_org.png
  hero_text: Documentation to help you deploy and manage Cloud Foundry
  url_path: https://docs.cloudfoundry.org
  product_link:
  product_url: https://github.com/cloudfoundry/cf-release
  support_link: <a href="https://www.cloudfoundry.org/community/" target="_blank">Get Involved</a>
  support_call_to_action: <a href="https://www.cloudfoundry.org/community/" target="_blank">Get Involved</a>
  support_url: https://www.cloudfoundry.org/community/
  gtm_account_id: <KEY>

# Product variables
  platform_name: Cloud Foundry
  platform_old: Cloud Foundry
  platform_code: CF
  product_name_lc: cf
  app_runtime_full: Cloud Foundry
  app_runtime: CF
  app_runtime_abbr: CF
  app_runtime_abbr_lc: cf
  k8s_runtime_full: Cloud Foundry
  k8s_runtime: CF
  k8s_runtime_abbr: CF
  windows_runtime_full: Cloud Foundry
  windows_runtime: CF
  windows_runtime_abbr: CF
  company_name: Cloud Foundry

# Deprecated variables -- replace with current product variables when possible
  product_name: CF
  product_runtime: Cloud Foundry
  product_short: CF

# Book content variables
  add_volumes_link: For more information, see [Adding Volume Services to your Deployment](../../running/deploy-vol-services.html).
  admin_read_only_role: "<ul><li><strong>Admin Read-Only</strong>: Read-only access to all Cloud Controller API resources. Assigned the <code>cloud_controller.admin_read_only</code> scope in UAA.</li></ul>"
  admin_role: "<ul><li><strong>Admin</strong>: Perform operational actions on all orgs and spaces using the Cloud Controller API. Assigned the <code>cloud_controller.admin</code> scope in UAA.</li></ul>"
  admin: Cloud Foundry administrator
  api_endpoint_book: For more information, see [Identifying your Cloud Foundry API Endpoint and Version](http://docs.cloudfoundry.org/running/cf-api-endpoint.html).
  api_endpoint: <a href="http://docs.cloudfoundry.org/running/cf-api-endpoint.html">the URL of the Cloud Controller in your Cloud Foundry instance</a>
  api_v1_format: <a href="http://docs.cloudfoundry.org/services/api-v1.html">v1 format</a>
  api_v2_format: <a href="http://docs.cloudfoundry.org/services/api.html">v2 format</a>
  api_version: To determine your Cloud Controller API version, see [Identifying your Cloud Foundry API Endpoint and Version](http://docs.cloudfoundry.org/running/cf-api-endpoint.html).
  app_domain: shared-domain.example.com
  app_healthcheck_timeout: In Cloud Foundry, the default timeout is 60 seconds and the default maximum configurable timeout is 180 seconds. Your Cloud Foundry operator can set other values for these defaults.
  app_logging_footnote: <a href="https://docs.cloudfoundry.org/devguide/deploy-apps/streaming-logs.html">App Logging in Cloud Foundry</a>
  app_sec_group_desc:  <code>description</code>   |This is an optional field that contains useful text for operators to manage security group rules. This field is available in Cloud Foundry v238 and later.
  app_sec_groups_default: Only allowing outbound connections to public addresses from app containers. This is the original default. Admins can change this behavior by configuring ASGs.
  app_sec_groups_link: For more information about ASGs, see [App Security Groups](../adminguide/app-sec-groups.html).
  app_sec_groups: <a href="http://docs.cloudfoundry.org/concepts/asg.html">App Security Groups</a>
  asg_notifications_prereq:
  az: availability zones
  azs:
  azure_deploy: For more information, see [Preparing to Deploy on Azure](../../deploying/azure/index.html).
  bbr_ert:
  bbr_space:
  bbr_rn_intro:
  bbr_rn_compatibility:
  billing_manager_role_note: <p class="note"><strong>Note</strong>&#58; The Billing Manager role is only relevant for Cloud Foundry environments deployed with a billing engine.</p>
  billing_manager_role: "<ul><li><strong>Org Billing Managers</strong>: Create and manage billing account and payment information.</li></ul>"
  blobstore_kb:
  cc_logging_default: <p class="note"><strong>Note</strong><span>:</span> By default, Cloud Foundry does not enable Cloud Controller request logging. To enable this feature, you must set the <code>cc.security_event_logging.enabled</code> property in your Cloud Foundry manifest to <code>true</code> and redeploy.</p>
  cfdot_kb: When logged into a VM hosting an app, you can use tools like the Cloud Foundry Diego Operator Toolkit (cfdot) to run app status diagnostics. For more information, see the [cfdot](https://github.com/cloudfoundry/cfdot) repository on GitHub and the [cfdot CLI](https://docs.cloudfoundry.org/running/monitoring-test.html#cfdot) section of the _Monitoring and Testing Diego Components_ topic.
  cipher_suites: You can override the default cipher suites by changing the `router.cipher_suites` and `router.min_tls_version` BOSH manifest properties.
  cli_download: https://github.com/cloudfoundry/cli#downloads
  cli_v6: <a href="http://docs.cloudfoundry.org/cf-cli/getting-started.html">Getting Started with the cf CLI</a>
  Cloud Foundry has used two architectures for managing application containers:
  cloud_controller_dea_agent:
  cloud_controller_dea_algorithm:
  cloud_controller_logging: For more information about how Cloud Foundry aggregates and streams logs and metrics, see [Overview of Logging and Metrics](../../loggregator/data-sources.html).
  collector_singleton: The singleton Collector and Compilation components do not affect platform availability.
  concepts_product_model_header:
  concepts_product_model_image:
  concepts_product_model_text: "./overview_model"
  console_2: If you have a Cloud Foundry account, see [Identifying your Cloud Foundry API Endpoint and Version](http://docs.cloudfoundry.org/running/cf-api-endpoint.html) to determine the URL of the Cloud Controller in your Cloud Foundry instance. Click **Manage Cloud...** to add this URL to your Cloud Foundry account. Validate the account and continue through the wizard.
  console_links:
  contact_support:
  container_metrics: "This property is set to true by default in your [BOSH release](https://github.com/cloudfoundry/cf-syslog-drain-release/blob/v6.x/jobs/adapter/spec#L61-L66).<br><br><br>  Once `scalablesyslog.adapter.metrics_to_syslog_enabled` is set to `true`, run the following cf CLI command to include container metrics in your syslog drain:<pre>cf drain APP-NAME DRAIN-URL --type metrics --drain-name YOUR-SYSLOG-DRAIN</pre>Where:<br> <ul><li><code>APP-NAME</code> is your app name.</li> <li><code>YOUR-SYSLOG-DRAIN</code> is the name of your syslog drain.</li><li><code>DRAIN-URL</code> is the URL of your syslog drain.</li></ul>"
  container_network_link: For information about administering container-to-container network policies, see <a href="../devguide/deploy-apps/cf-networking.html">Configuring Container-to-Container Networking</a>.
  cookies_shared_domain_1:
  cookies_shared_domain_2: For an app using a shared domain such as `example.com`, a cookie set to use the highest domain has a `Domain` attribute of `.example.com` in its HTTP response header.
  cse_id: 005804290371689664731:9jhxguhn8dy
  custom_load_balancer:
  custom_services: If you are interested in building services for Cloud Foundry and making them available to end users, see <a href="http://docs.cloudfoundry.org/services/index.html">Services</a>.
  custom_stack_nav_link: "* <a href=\"/running/custom-stack.html\" class=\"subnav\">Adding a Custom Stack</a><br />"
  custom_stack: You can also build your own custom stack. For more information, see [Adding a Custom Stack](../../running/custom-stack.html).
  dea_diego_table_row:
  dea_diego_version: Diego architecture
  dev_console_1:
  dev_console_2: CLI
  dev_console_3:
  dev_console_4:
  dev_console_5:
  dev_console_note:
  diego_architecture: This topic provides an overview of the structure and components of Diego, the container management system for Cloud Foundry.
  diego_deploy: To deploy Diego, see the [Cloud Foundry Diego (BOSH release)](https://github.com/cloudfoundry-incubator/diego-release) repository on GitHub.
  diego_ssh_link: <a href="../diego/ssh-conceptual.html">Diego SSH package</a>
  disable_custom_buildpacks_note: Operators can choose to disable custom buildpacks in an entire deployment. For more information, see the [Disabling Custom Buildpacks](../adminguide/buildpacks.html#disabling-custom-buildpacks) section of the _Managing Custom Buildpacks_ topic.
  disable_custom_buildpacks: You can disable custom buildpacks for an entire deployment by adding <code>disable_custom_buildpacks<span>:</span> true</code> in your Cloud Foundry manifest under `properties.cc`.
  disable_custom: <h2> <a id='disabling-custom-buildpacks'></a>Disabling Custom Buildpacks </h2> Operators can choose to disable custom buildpacks. For more information, see the [Disabling Custom Buildpacks](../adminguide/buildpacks.html#disabling-custom-buildpacks) section of the _Managing Custom Buildpacks_ topic.
  docker_auth: To run Docker containers, Cloud Foundry needs the ability to access Docker registries using a Certificate Authority. To configure this access, see [Installing Certificates on VMs](ttps://bosh.io/docs/trusted-certs.html) in the BOSH documentation.
  domain_name: cloudfoundry.org
  domains_shared_domains:
  ecr_support_cf_12_1: <p class="note"><strong>Note</strong>&#58; This feature is only available in <code>cf-deployment</code> v12.1.0 and later.</p>
  email_notifications:
  enable_c2c_discovery: include the [`enable\_service\_discovery`](https://github.com/cloudfoundry/cf-deployment/blob/master/operations/enable-service-discovery.yml) ops file in your Cloud Foundry deployment, as described in [CF App Service Discovery](https://github.com/cloudfoundry/cf-networking-release/blob/develop/docs/app-sd.md) in the cf-networking-release repository on GitHub
  enable_syslog_drain: For more information, see [Configuring System Logging](../running/managing-cf/logging-config.html) and [Using Log Management Services](../devguide/services/log-management.html).
  enable_syslog_forwarding_link: <p class="note"><strong>Note</strong>&#58; For this procedure to work, you must enable system log forwarding. For more information, see the <a href="https://docs.cloudfoundry.org/running/managing-cf/logging-config.html#syslog-forward">Enabling System Log Forwarding</a> section of the <em>Configuring System Logging</em> topic.</p>
  example_domain_edu: www.example.edu
  example_domain_net: www.example.net
  example_domain_no_www: .example.com
  example_domain_org: www.example.org
  example_domain: www.example.com
  example_ip_1: 192.0.2.1
  example_ip_2: 198.51.100.1
  example_ip_3: 203.0.113.1
  external_ips: external IP addresses
  external_vol_win_note: <p class="note"><strong>Note:</strong> NFS and SMB volume services are available for Linux cells only. These services are not available for Windows cells.</p>
  ga_account_id: UA-22181585-2
  gen_GSG:
  global_auditor_role:  "<ul><li><strong>Global Auditor</strong>: Read-only access to all Cloud Controller API resources except for secrets, such as environment variables. The Global Auditor role cannot access those values. Assigned the <code>cloud_controller.global_auditor</code> scope in UAA.</li></ul>"<commit_msg>[#172625010]adds blank var note for external_vol_smb<commit_after>---
template_variables:
  book_title: Cloud Foundry Documentation
  book_title_short: Cloud Foundry Docs
  title: Cloud Foundry Documentation
  title_image: ../images/logo_org.png
  hero_text: Documentation to help you deploy and manage Cloud Foundry
  url_path: https://docs.cloudfoundry.org
  product_link:
  product_url: https://github.com/cloudfoundry/cf-release
  support_link: <a href="https://www.cloudfoundry.org/community/" target="_blank">Get Involved</a>
  support_call_to_action: <a href="https://www.cloudfoundry.org/community/" target="_blank">Get Involved</a>
  support_url: https://www.cloudfoundry.org/community/
  gtm_account_id: <KEY>

# Product variables
  platform_name: Cloud Foundry
  platform_old: Cloud Foundry
  platform_code: CF
  product_name_lc: cf
  app_runtime_full: Cloud Foundry
  app_runtime: CF
  app_runtime_abbr: CF
  app_runtime_abbr_lc: cf
  k8s_runtime_full: Cloud Foundry
  k8s_runtime: CF
  k8s_runtime_abbr: CF
  windows_runtime_full: Cloud Foundry
  windows_runtime: CF
  windows_runtime_abbr: CF
  company_name: Cloud Foundry

# Deprecated variables -- replace with current product variables when possible
  product_name: CF
  product_runtime: Cloud Foundry
  product_short: CF

# Book content variables
  add_volumes_link: For more information, see [Adding Volume Services to your Deployment](../../running/deploy-vol-services.html).
  admin_read_only_role: "<ul><li><strong>Admin Read-Only</strong>: Read-only access to all Cloud Controller API resources. Assigned the <code>cloud_controller.admin_read_only</code> scope in UAA.</li></ul>"
  admin_role: "<ul><li><strong>Admin</strong>: Perform operational actions on all orgs and spaces using the Cloud Controller API. Assigned the <code>cloud_controller.admin</code> scope in UAA.</li></ul>"
  admin: Cloud Foundry administrator
  api_endpoint_book: For more information, see [Identifying your Cloud Foundry API Endpoint and Version](http://docs.cloudfoundry.org/running/cf-api-endpoint.html).
  api_endpoint: <a href="http://docs.cloudfoundry.org/running/cf-api-endpoint.html">the URL of the Cloud Controller in your Cloud Foundry instance</a>
  api_v1_format: <a href="http://docs.cloudfoundry.org/services/api-v1.html">v1 format</a>
  api_v2_format: <a href="http://docs.cloudfoundry.org/services/api.html">v2 format</a>
  api_version: To determine your Cloud Controller API version, see [Identifying your Cloud Foundry API Endpoint and Version](http://docs.cloudfoundry.org/running/cf-api-endpoint.html).
  app_domain: shared-domain.example.com
  app_healthcheck_timeout: In Cloud Foundry, the default timeout is 60 seconds and the default maximum configurable timeout is 180 seconds. Your Cloud Foundry operator can set other values for these defaults.
  app_logging_footnote: <a href="https://docs.cloudfoundry.org/devguide/deploy-apps/streaming-logs.html">App Logging in Cloud Foundry</a>
  app_sec_group_desc:  <code>description</code>   |This is an optional field that contains useful text for operators to manage security group rules. This field is available in Cloud Foundry v238 and later.
  app_sec_groups_default: Only allowing outbound connections to public addresses from app containers. This is the original default. Admins can change this behavior by configuring ASGs.
  app_sec_groups_link: For more information about ASGs, see [App Security Groups](../adminguide/app-sec-groups.html).
  app_sec_groups: <a href="http://docs.cloudfoundry.org/concepts/asg.html">App Security Groups</a>
  asg_notifications_prereq:
  az: availability zones
  azs:
  azure_deploy: For more information, see [Preparing to Deploy on Azure](../../deploying/azure/index.html).
  bbr_ert:
  bbr_space:
  bbr_rn_intro:
  bbr_rn_compatibility:
  billing_manager_role_note: <p class="note"><strong>Note</strong>&#58; The Billing Manager role is only relevant for Cloud Foundry environments deployed with a billing engine.</p>
  billing_manager_role: "<ul><li><strong>Org Billing Managers</strong>: Create and manage billing account and payment information.</li></ul>"
  blobstore_kb:
  cc_logging_default: <p class="note"><strong>Note</strong><span>:</span> By default, Cloud Foundry does not enable Cloud Controller request logging. To enable this feature, you must set the <code>cc.security_event_logging.enabled</code> property in your Cloud Foundry manifest to <code>true</code> and redeploy.</p>
  cfdot_kb: When logged into a VM hosting an app, you can use tools like the Cloud Foundry Diego Operator Toolkit (cfdot) to run app status diagnostics. For more information, see the [cfdot](https://github.com/cloudfoundry/cfdot) repository on GitHub and the [cfdot CLI](https://docs.cloudfoundry.org/running/monitoring-test.html#cfdot) section of the _Monitoring and Testing Diego Components_ topic.
  cipher_suites: You can override the default cipher suites by changing the `router.cipher_suites` and `router.min_tls_version` BOSH manifest properties.
  cli_download: https://github.com/cloudfoundry/cli#downloads
  cli_v6: <a href="http://docs.cloudfoundry.org/cf-cli/getting-started.html">Getting Started with the cf CLI</a>
  Cloud Foundry has used two architectures for managing application containers:
  cloud_controller_dea_agent:
  cloud_controller_dea_algorithm:
  cloud_controller_logging: For more information about how Cloud Foundry aggregates and streams logs and metrics, see [Overview of Logging and Metrics](../../loggregator/data-sources.html).
  collector_singleton: The singleton Collector and Compilation components do not affect platform availability.
  concepts_product_model_header:
  concepts_product_model_image:
  concepts_product_model_text: "./overview_model"
  console_2: If you have a Cloud Foundry account, see [Identifying your Cloud Foundry API Endpoint and Version](http://docs.cloudfoundry.org/running/cf-api-endpoint.html) to determine the URL of the Cloud Controller in your Cloud Foundry instance. Click **Manage Cloud...** to add this URL to your Cloud Foundry account. Validate the account and continue through the wizard.
  console_links:
  contact_support:
  container_metrics: "This property is set to true by default in your [BOSH release](https://github.com/cloudfoundry/cf-syslog-drain-release/blob/v6.x/jobs/adapter/spec#L61-L66).<br><br><br>  Once `scalablesyslog.adapter.metrics_to_syslog_enabled` is set to `true`, run the following cf CLI command to include container metrics in your syslog drain:<pre>cf drain APP-NAME DRAIN-URL --type metrics --drain-name YOUR-SYSLOG-DRAIN</pre>Where:<br> <ul><li><code>APP-NAME</code> is your app name.</li> <li><code>YOUR-SYSLOG-DRAIN</code> is the name of your syslog drain.</li><li><code>DRAIN-URL</code> is the URL of your syslog drain.</li></ul>"
  container_network_link: For information about administering container-to-container network policies, see <a href="../devguide/deploy-apps/cf-networking.html">Configuring Container-to-Container Networking</a>.
  cookies_shared_domain_1:
  cookies_shared_domain_2: For an app using a shared domain such as `example.com`, a cookie set to use the highest domain has a `Domain` attribute of `.example.com` in its HTTP response header.
  cse_id: 005804290371689664731:9jhxguhn8dy
  custom_load_balancer:
  custom_services: If you are interested in building services for Cloud Foundry and making them available to end users, see <a href="http://docs.cloudfoundry.org/services/index.html">Services</a>.
  custom_stack_nav_link: "* <a href=\"/running/custom-stack.html\" class=\"subnav\">Adding a Custom Stack</a><br />"
  custom_stack: You can also build your own custom stack. For more information, see [Adding a Custom Stack](../../running/custom-stack.html).
  dea_diego_table_row:
  dea_diego_version: Diego architecture
  dev_console_1:
  dev_console_2: CLI
  dev_console_3:
  dev_console_4:
  dev_console_5:
  dev_console_note:
  diego_architecture: This topic provides an overview of the structure and components of Diego, the container management system for Cloud Foundry.
  diego_deploy: To deploy Diego, see the [Cloud Foundry Diego (BOSH release)](https://github.com/cloudfoundry-incubator/diego-release) repository on GitHub.
  diego_ssh_link: <a href="../diego/ssh-conceptual.html">Diego SSH package</a>
  disable_custom_buildpacks_note: Operators can choose to disable custom buildpacks in an entire deployment. For more information, see the [Disabling Custom Buildpacks](../adminguide/buildpacks.html#disabling-custom-buildpacks) section of the _Managing Custom Buildpacks_ topic.
  disable_custom_buildpacks: You can disable custom buildpacks for an entire deployment by adding <code>disable_custom_buildpacks<span>:</span> true</code> in your Cloud Foundry manifest under `properties.cc`.
  disable_custom: <h2> <a id='disabling-custom-buildpacks'></a>Disabling Custom Buildpacks </h2> Operators can choose to disable custom buildpacks. For more information, see the [Disabling Custom Buildpacks](../adminguide/buildpacks.html#disabling-custom-buildpacks) section of the _Managing Custom Buildpacks_ topic.
  docker_auth: To run Docker containers, Cloud Foundry needs the ability to access Docker registries using a Certificate Authority. To configure this access, see [Installing Certificates on VMs](ttps://bosh.io/docs/trusted-certs.html) in the BOSH documentation.
  domain_name: cloudfoundry.org
  domains_shared_domains:
  ecr_support_cf_12_1: <p class="note"><strong>Note</strong>&#58; This feature is only available in <code>cf-deployment</code> v12.1.0 and later.</p>
  email_notifications:
  enable_c2c_discovery: include the [`enable\_service\_discovery`](https://github.com/cloudfoundry/cf-deployment/blob/master/operations/enable-service-discovery.yml) ops file in your Cloud Foundry deployment, as described in [CF App Service Discovery](https://github.com/cloudfoundry/cf-networking-release/blob/develop/docs/app-sd.md) in the cf-networking-release repository on GitHub
  enable_syslog_drain: For more information, see [Configuring System Logging](../running/managing-cf/logging-config.html) and [Using Log Management Services](../devguide/services/log-management.html).
  enable_syslog_forwarding_link: <p class="note"><strong>Note</strong>&#58; For this procedure to work, you must enable system log forwarding. For more information, see the <a href="https://docs.cloudfoundry.org/running/managing-cf/logging-config.html#syslog-forward">Enabling System Log Forwarding</a> section of the <em>Configuring System Logging</em> topic.</p>
  example_domain_edu: www.example.edu
  example_domain_net: www.example.net
  example_domain_no_www: .example.com
  example_domain_org: www.example.org
  example_domain: www.example.com
  example_ip_1: 192.0.2.1
  example_ip_2: 198.51.100.1
  example_ip_3: 203.0.113.1
  external_ips: external IP addresses
  external_vol_smb_note:
  external_vol_win_note: <p class="note"><strong>Note:</strong> NFS and SMB volume services are available for Linux cells only. These services are not available for Windows cells.</p>
  ga_account_id: UA-22181585-2
  gen_GSG:
  global_auditor_role:  "<ul><li><strong>Global Auditor</strong>: Read-only access to all Cloud Controller API resources except for secrets, such as environment variables. The Global Auditor role cannot access those values. Assigned the <code>cloud_controller.global_auditor</code> scope in UAA.</li></ul>"
{'fraction_non_alphanumeric': 0.09725269902571755, 'fraction_numerical': 0.009523391556218732, 'mean_word_length': 5.402641191345884, 'pattern_counts': {'":': 0, '<': 239, '<?xml version=': 0, '>': 239, 'https://': 28, 'lorem ipsum': 0, 'www.': 16, 'xml': 0}, 'pii_count': 6, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5498867', 'n_tokens_mistral': 6957, 'n_tokens_neox': 6704, 'n_words': 2093}