-
Notifications
You must be signed in to change notification settings - Fork 99
Expand file tree
/
Copy pathtemplate_variables.yml
More file actions
366 lines (349 loc) · 34.5 KB
/
Copy pathtemplate_variables.yml
File metadata and controls
366 lines (349 loc) · 34.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
---
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: GTM-MM86KCJ
# Product variables
platform_name: Cloud Foundry
platform_old: Cloud Foundry
platform_code: CF
product_code: CF
product_name_lc: cf
app_runtime_first: Cloud Foundry
app_runtime_full: Cloud Foundry
app_runtime: Cloud Foundry
app_runtime_abbr: Cloud Foundry
app_runtime_abbr_lc: cf
k8s_runtime_first: Cloud Foundry
k8s_runtime_full: Cloud Foundry
k8s_runtime: Cloud Foundry
k8s_runtime_abbr: Cloud Foundry
windows_runtime_first: Cloud Foundry
windows_runtime_full: Cloud Foundry
windows_runtime: Cloud Foundry
windows_runtime_abbr: CF
company_name: Cloud Foundry
# Current version for partials
current_major_version: "10-0"
# Deprecated variables -- replace with current product variables when possible
product_name: Cloud Foundry
product_runtime: Cloud Foundry
product_short: Cloud Foundry
# Book content variables
add_volumes_link: Your admin can add volume services to the deployment.
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 in your platform documentation.
api_endpoint: the URL of the Cloud Controller in your Cloud Foundry instance
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 in your platform documentation.
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">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:
buildpacks_link: <a href="https://docs.cloudfoundry.org/buildpacks/index.html">Buildpacks</a>
cc_logging_default: <p class="note">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_sf_vs_full_header:
concepts_product_model_header:
concepts_product_model_image:
small_footprint_comparison:
concepts_product_model_text: "./overview_model"
console_2: If you have a Cloud Foundry account, use the cf api command or consult your operator 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.
credhub_link: <a href="https://docs.cloudfoundry.org/credhub/index.html">CredHub</a>
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
default_asgs: |-
<h3>Default ASGs</h3>
Cloud Foundry preconfigures two ASGs: `public_networks` and `dns`.
Unless you modify these before your initial deployment, these ASGs are applied by default to all containers in your deployment.
* `public_networks`: This group allows access to public networks, and blocks access to private networks and link local addresses. Cloud
Foundry blocks outgoing traffic to the following IP address ranges by specifically allowing traffic to all other addresses:
* 10.0.0.0 - 10.255.255.255
* 169.254.0.0 - 169.254.255.255
* 172.16.0.0 - 172.31.255.255
* 192.168.0.0 - 192.168.255.255
* `dns`: This group allows access to DNS on port 53 for any IP address. The default ASGs are defined in the `cf-deployment.yml` file as follows:
```
security_group_definitions:
- name: public_networks
rules:
- destination: 0.0.0.0-9.255.255.255
protocol: all
- destination: 11.0.0.0-169.253.255.255
protocol: all
- destination: 169.255.0.0-172.15.255.255
protocol: all
- destination: 172.32.0.0-192.167.255.255
protocol: all
- destination: 192.169.0.0-255.255.255.255
protocol: all
- name: dns
rules:
- destination: 0.0.0.0/0
ports: '53'
protocol: tcp
- destination: 0.0.0.0/0
ports: '53'
protocol: udp
```
Modify the default ASGs to block outbound traffic as necessary for your installation. To see how the ASGs are defined by
default, see the [cf-deployment.yml](https://github.com/cloudfoundry/cf-deployment/blob/main/cf-deployment.yml#L604-L627) file on GitHub.
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">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/05-service-discovery.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">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>
encryption_key: encryption_key_2023_02_20
example_domain_edu: www.example.edu
example_domain_net: www.example.net
example_domain_no_www: .example.co
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">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>"
grant_devs_c2c: edit your BOSH manifest to include the `enable_space_developer_self_service` property in the [cf-networking-release policy-server job](https://github.com/cloudfoundry/cf-networking-release/blob/master/jobs/policy-server/spec) and set that property to `true`
hash_routing_version: Available from cf-deployment v55.2.0, together with cf CLI 8.10.0 and later.
health_monitor_footnote: <a href="https://docs.cloudfoundry.org/running/hm-notifications.html">Configuring Health Monitor Notifications</a>
http2_admin_link: For information about configuring support for HTTP/2 in Cloud Foundry, see <a href="https://docs.cloudfoundry.org/adminguide/supporting-http2.html">Configuring HTTP/2 Support</a>.
http2_support_version: In routing-release v0.224.0 and later, HTTP/2 support is enabled by default.
http_routing: For more information, see [Securing Traffic into Cloud Foundry](../adminguide/securing-traffic.html).
healthcheck_duration: The duration of the health check Service Unavailable response is configurable using the manifest property `router.requested_route_registration_interval_in_seconds`, which defaults to 20 seconds.
info_loc: In your Cloud Foundry deployment manifest
ipsec_note:
keepalive: For more information, see [Keep alive connections](/concepts/http-routing.html#keepalive) in _HTTP Routing_.
keepalive_router: An operator can enable the feature by configuring a non-zero value for the manifest property `router.max_idle_connections`.
known_issues: <a href="http://docs.cloudfoundry.org/running/troubleshooting.html">Troubleshooting Cloud Foundry</a>
lb_health_chk_healthy: <code>router.drain_wait</code>
lb_health_chk_unhealthy: <code>router.load_balancer_healthy_threshold</code>
link_adminguide_buildpack: For more information, see [Managing Custom Buildpacks](../adminguide/buildpacks.html).
link_adminguide_commands: <p class="note">An Org Manager needs explicit admin permissions to perform certain actions. To create a user with admin rights, see <a href="../uaa/uaa-user-management.html">Creating and Managing Users with the UAA CLI (UAAC)</a>.</p>
link_adminguide_domains: For admin-specific commands, see [Managing Domains and Routes](../../adminguide/manage-domains-routes.html).
link_configure_trusted_certificates: For information about providing trusted certificates to applications running on Cloud Foundry, contact your platform operator or see your platform documentation.
log_management:
logg_forwarding: the [Enabling System Log Forwarding](../running/managing-cf/logging-config.html#syslog-forward) section of the _Configuring System Logging_ topic.
logg_scaling: <a href="../running/managing-cf/logging-config.html#scaling">Scaling Loggregator</a> section of the <em>Configuring System Logging</em> topic.
loggregator_arch_link: <a href="https://docs.cloudfoundry.org/loggregator/architecture.html">Loggregator Architecture</a>
loggregator_firehose_link: <a href="../../loggregator/architecture.html">Loggregator Architecture</a>
loggregator_log_cache_link:
loggregator_log_cache_link_syslog_scale: For guidance on scaling, see the [README](https://github.com/cloudfoundry/cf-syslog-drain-release/blob/master/README.md) for the CF Syslog Drain Release repository on GitHub.
manage_iso_seg_link: For information about how to create and manage isolation segments in a Cloud Foundry deployment, see [Managing Isolation Segments](../adminguide/isolation-segments.html).
manifest_vs_cli_asg: You may also define ASGs in your Cloud Foundry deployment manifest, but these definitions only create security groups during first-time installation. To avoid confusion, any such definitions in the manifest should be generic. The cf CLI commands `create-security-group` and `bind-security-group` overwrite ASG definitions from the manifest. Upgrading Cloud Foundry retains ASG definitions made from the CLI and ignores any ASG definitions in the newer manifest.
max_app_size_table: Set in the <code>cc.packages.max_package_size</code> in the manifest
max_app_size: the maximum app file size set in the <code>cc.packages.max_package_size</code> property in the manifest
max_healthcheck_timeout: <code>cc.maximum_health_check_timeout</code> defaults to the maximum of `180` seconds, but your Cloud Foundry operator can set it to a different value.
max_in_flight_header: <h3>Setting max_in_flight values</h3>
max_in_flight_config: For more information, see the [Update Block](https://bosh.io/docs/deployment-manifest.html#update) section of the _Deployment Manifest v1_ topic in the BOSH documentation.
mutual_tls_tcp: <p class="note">If you have mutual TLS app identity verification enabled, you must also enable support for TLS backends with TCP Router via the <code>tcp_router.backend_tls.enabled</code> property, and on Route Emitter via the <code>tcp.enable_tls</code> property..</p>
net_traffic_rules: <a href="http://docs.cloudfoundry.org/concepts/asg.html">network traffic rules</a>
notifications_api_1: For more information about the Notifications Service, see the Notifications API [v1](https://github.com/cloudfoundry-incubator/notifications/blob/master/V1_API.md) or [v2](https://github.com/cloudfoundry-incubator/notifications/blob/master/V2_API.md) documentation.
notifications_link: <a href="../../adminguide/notifications.html">Notification Service</a>
om_resurrector_header:
om_resurrector_text:
or_apps_man2:
per_route_lb_version: Available from cf-deployment v48.1.0, together with cf CLI 8.10.0 and later.
platform_ssh_configuration: Cloud Foundry deployments control SSH access to apps at the Cloud Foundry level. Additionally, Cloud Foundry supports load balancing of SSH sessions. For more information about setting SSH access for your deployment, see [Configuring SSH Access](../../running/config-ssh.html).
pools_link: <a href="https://bosh.io/docs/deployment-basics/">Building a Manifest</a> in the BOSH documentation.
port_limitations: To support WebSockets, the operator must configure the load balancer correctly. Depending on the configuration, clients may have to use a different port for WebSocket connections, such as port 4443, or a different domain name. For more information, see [Supporting WebSockets](../../adminguide/supporting-websockets.html).
port_limitations_1: To support WebSockets, the operator must configure the load balancer correctly. Depending on the configuration, clients may have to use a different port for WebSocket connections, such as port 4443, or a different domain name. For more information, see [Supporting WebSockets](../adminguide/supporting-websockets.html).
private_app_domain: private-domain.example.com
public_host: docs.cloudfoundry.org
pw_policy:
python_cf245only: <strong><a href="https://www.pivotaltracker.com/n/projects/966314/stories/132190561">Required</a> for Cloud Foundry v245 only:</strong>
quota_resource: quota space
recommended_by: Cloud Foundry
resurrector: For more information about the Resurrector, see [Auto-healing Capabilities](https://bosh.io/docs/resurrector.html) in the BOSH documentation.
roles_table: "_oss_roles_table"
rotated_key: encryption_key_2023_02_21
open_service_broker_api: "../open-service-broker/spec"
open_service_broker_api_profile: "../open-service-broker/profile"
open_service_broker_rn: "../open-service-broker/release-notes"
route_services_apps_manager:
route_services_config: <h2><a id='enabling-route-services-in-cloudfoundry'></a>Enabling Route Services in Cloud Foundry </h2>To enable support for route services in a Cloud Foundry deployment, the operator must provide a passphrase used by the Gorouter to encrypt a header that is sent with the request to the route service. The Gorouter uses this header to validate the request sent by the route service to the app route. The passphrase is configured in the cf-release manifest.<br><pre><code>properties<span>:</span><br> router<span>:</span><br> route\_services\_secret<span>:</span> YOUR-SECRET-PASSPHRASE</code></pre><p class="note">The <code>route\_services\_secret</code> property should be a robust passphrase. For more information, see the <a href="https://github.com/cloudfoundry-incubator/routing-release/blob/master/jobs/gorouter/spec">Gorouter spec</a> in the cf-release repository on GitHub.</p>Route service instances should send requests to the value of <code>x-cf-forwarded-url</code>, obeying the scheme. The scheme is <code>https</code> by default. For environments that do not support TLS termination, this property can be set to false.<pre><code>properties<span>:</span><br> router<span>:</span><br> route\_services\_recommend\_https<span>:</span> true</code></pre>The Gorouter only forwards requests to route services over SSL. By default, certificates provided by route services must be signed by a trusted CA. If they are not, the Gorouter rejects the request. In development environments, this concern may be unreasonable. To disable SSL certificate validation, modify the following property<span>:</span><br><pre><code>properties<span>:</span><br> router<span>:</span><br> ssl\_skip\_validation<span>:</span> true</code></pre>
route_services_enabling: |-
<h2>Enabling route services in Cloud Foundry</h2>
To begin support for route services in a Cloud Foundry deployment, you
must provide a passphrase used by the Gorouter to encrypt a header that is sent with
the request to the route service.
The Gorouter uses this header to validate the request sent by the route service to the app route.
The passphrase is configured in the cf-release manifest.
```console
properties
router:
route_services_secret: YOUR-SECRET-PASSPHRASE
```
<p> The <code>route_services_secret</code> property can
be a robust passphrase.</p>
<p>For more information, see the
<a href="https://github.com/cloudfoundry-incubator/routing-release/blob/master/jobs/gorouter/spec">Gorouter spec</a>
in the cf-release repository on GitHub.
</p>
Route service instances can send requests to the value of <code>x-cf-forwarded-url</code>, obeying the scheme.
The scheme is <code>https</code> by default.
For environments that do not support TLS termination, this property can be set to false.
```
properties:
router:
route_services_recommend_https: true
```
The Gorouter only forwards requests to route services over SSL.
By default, certificates provided by route services must be signed by a trusted CA.
If they are not, the Gorouter rejects the request.
In development environments, this concern might be unreasonable.
To deactivate SSL certificate validation, edit the following property:
```
properties:
router:
ssl_skip_validation: true
```
route_services_link: <a href="../devguide/services/route-binding.html">Manage App Requests with Route Services</a>
route_services_require_diego: <p> Route services require Diego. Your deployment must use the Diego architecture or you must enable Diego for your app.</p>
route_services_securing_traffic: For more information about securing traffic into Cloud Foundry, see [Securing Traffic into Cloud Foundry](../adminguide/securing-traffic.html).
route_services: <p class="note">Route services require Diego. Your deployment must use the Diego architecture or you must enable Diego for your app.</p>
saml_provider: Retrieve the name of your SAML provider by opening your Cloud Foundry manifest and recording the value of the `login.saml.providers.provider-name` property.
scale_table: "oss_scale_table"
scaling_ert_db:
scaling_ert:
self_signed: Before following the procedure below, the developer must obtain either the self-signed certificate or the intermediate and CA certificates used to sign the deployment's certificate. The developer can obtain these certificates from the Cloud Foundry operator or from the deployment manifest. For more information about how to retrieve certificates from the deployment manifest, see [Securing Traffic into Cloud Foundry](../adminguide/securing-traffic.html).
services: <a href="http://docs.cloudfoundry.org/services/index.html">services</a>
ssh_marketplace_output: mysql 100mb MySQL databases on demand
ssh_marketplace_step: Run `cf marketplace` to list the marketplace services available.
ssh_service_access_key: <br>{<br>"hostname"<span>:</span> "us-cdbr-iron-east-01.mysql.net",<br>"jdbcUrl"<span>:</span> "jdbc:mysql://us-cdbr-iron-east-03.mysql.net/ad\_b2fca6t49704585d?user=b5136e448be920\u0026password=231f435o05",<br>"name"<span>:</span> "ad\_b2fca6t49704585d",<br>"password"<span>:</span> "231f435o05",<br>"port"<span>:</span> "3306",<br>"uri"<span>:</span> "mysql://b5136e448be920:<span>231f435o05<span>@</span>us-cdbr-iron-east-03.mysql.net</span>:3306/ad\_b2fca6t49704585d?reconnect=true",<br>"username"<span>:</span> "b5136e448be920"<br>}<br>
ssh_service_host: us-cdbr-iron-east-01.mysql.net
ssh_service_plan: 100mb
ssh_service: MySQL
ssl:
setting_rate_limit_cloud_api: <li><a href="../running/rate-limit-cloud-controller-api.html" class="subnav">Rate limit information returned by the Cloud Controller API</a></li>
starting_container_count_maximum: For information about how to configure this setting, see [Configuring Diego for Upgrades](../running/diego-upgrades.html).
suspended_roles_table: "_suspended_org_roles_table"
syslog_forwarding_ref: Syslog forwarding. See <a href="https://docs.cloudfoundry.org/devguide/services/log-management.html">Streaming App Logs to Log Management Services</a>.
tcp_iaas: Configure these IPs as your static IPs in your deployment manifest.
tcp_port_review:
tcp_port: "../adminguide/tcp_modify_ports"
uaa_cli: For more information, see [Creating and Managing Users with the UAA CLI (UAAC)](../../uaa/uaa-user-management.html) and [Orgs, Spaces, Roles, and Permissions](../../concepts/roles.html).
uaa_cred: see the `uaa scim` section
uaa: <a href="http://docs.cloudfoundry.org/adminguide/notifications.html">UAA</a>
understanding_asg_individual_link: the [Create ASGs](https://docs.cloudfoundry.org/concepts/asg.html#asg-individual) section of the _App Security Groups_
upload_custom_buildpacks: You can also use the `cf create-buildpack` command to upload the buildpack into your deployment, making it accessible without the `-b`. Run flag: <pre>cf create-buildpack BUILDPACK PATH POSITION</pre> <p>Where flag:</p> <ul><li><code>BUILDPACK</code> specifies the buildpack name.</li><li><code>PATH</code> specifies the location of the buildpack. <code>PATH</code> can point to a ZIP file, the URL of a ZIP file, or a local directory.</li><li><code>POSITION</code> specifies where to place the buildpack in the detection priority list.</li></ul>
user_org_creation:
v3_cli_versions: The experimental commands described in this topic require the cf CLI v6.32.0 or later and a Cloud Foundry deployment with Cloud Controller API v3.27.0 or later.
warden_garden:
zipkin_enable: zipkin_oss_config
zipkin_enable_link: <p>When Zipkin tracing is enabled in Cloud Foundry, the Gorouter examines the HTTP request headers and performs:</p>
w3c_enable_link: <p>When W3C tracing is enabled in Cloud Foundry, the Gorouter examines the HTTP request headers and performs:</p>
ssl_gorouter_link: <a href="#gorouter_term">Terminating SSL/TLS at the Gorouter only</a>
ssl_lb_gorouter_link: <a href="#lb_and_gorouter_term">Terminating SSL/TLS at the Load Balancer and the Gorouter</a>
ssl_lb_link: <a href="#lb_term">Terminating SSL/TLS at the Load Balancer Only</a>
ssl_haproxy:
tasks_ai:
cf_networking: For more information about how to enable and use container-to-container networking, see [Configuring Container-to-Container Networking](../devguide/deploy-apps/cf-networking.html).<p>When the container-to-container networking feature is disabled, all app-to-app traffic must go through the Gorouter.</p>
isolation_segments_create:
install_isolation_segments: For more information about creating isolation segments, see [Managing Isolation Segments](isolation-segments.html).
isolation_segments_note: <p class="note">The isolation segment name used in the cf CLI command must match the value specified in the <code>placement_tags</code> section of the Diego manifest file. If the names do not match, Cloud Foundry fails to place apps in the isolation segment when apps are started or restarted in the space assigned to the isolation segment.</p>
config_ssh_link: For more information, see <a href="../../running/config-ssh.html">Configuring SSH Access for Cloud Foundry</a>.
all_metrics_links: <ul><li><a href="../running/all_metrics.html">Cloud Foundry Component Metrics</a></li></ul>
ha_ert:
route_services_appsman1:
route_services_appsman2:
user_provided_apps_man:
xfcc_always_forward: This mode is enabled by default or when `router.forwarded_client_cert<span>:</span> always_forward`.
xfcc_mtls_forward: This mode is enabled when `router.forwarded_client_cert<span>:</span> forward`.
xfcc_strip: This mode is enabled when `router.forwarded_client_cert<span>:</span> sanitize_set`.
gorouter_sni: <li>The Gorouter supports SNI and can be configured with multiple certificates, each which may optionally include wildcard and alternative names.
multiple_certs_gorouter: To configure multiple HTTPS certificates for Cloud Foundry, specify those certificate keypairs in the `router.tls_pem` property.
uaa_admin_client_creds: Record the **uaa:admin:client_secret** from your deployment manifest.
tcp_emitter_oauth_creds: Obtain the secret for your `tcp_emitter` OAuth client from your manifest.
tcp_app_domain: tcp-domain.example.com
routing_version: routing-release 0.166.0
gorouter_metrics_link: ../running/all_metrics.html#routing
internal_domain_config: <p class="note">Admins can create internal domains. For more information, see the <a href="https://github.com/cloudfoundry/cf-networking-release/blob/develop/docs/05-service-discovery.md#internal-domains">Internal Domains</a> section in the <code>cf-networking-release</code> repository on GitHub.</p>
r_buildpack: <tr><td><a href="./r/index.html" class="subnav">R</a></td><td><p>R</p></td><td><a href="https://github.com/cloudfoundry/r-buildpack">R source</a></td></tr>
gorouter_client_cert: "gorouter_client_cert_oss"
ssl_termin_gorouter: "ssl_termin_gorouter_oss"
ssl_termin_lb_only: "ssl_termin_lb_only_oss"
ssl_termin_gorouter_lb: "ssl_termin_gorouter_lb_oss"
grootfs_reserved_space: Alternatively, you can set the GrootFS `reserved_space_for_other_jobs_in_mb` property to a higher value.
grootfs_disk_usage_link: For more information about how to calculate GrootFS disk usage in your deployment, see [Examining GrootFS Disk Usage](../adminguide/examining_grootfs_disk.html).
zdt_enable: Use capi-release v0.168.0 or later and deploy the [cc\_deployment\_updater](https://github.com/cloudfoundry/cf-deployment/blob/master/operations/experimental/add-deployment-updater.yml). For this ops file, there are also [external-db](https://github.com/cloudfoundry/cf-deployment/blob/master/operations/experimental/add-deployment-updater-external-db.yml) and [postgres](https://github.com/cloudfoundry/cf-deployment/blob/master/operations/experimental/add-deployment-updater-postgres.yml) variants.
get_auditor_binary: Download the Stack Auditor binary for your OS from [Releases](https://github.com/cloudfoundry/stack-auditor/releases) in the Stack Auditor repository on GitHub.
droplet_config: <code>system_blobstore_ccdroplet_max_staged_droplets_stored</code> property in the Cloud Foundry manifest.
blobstore_link: <a href="../deploying/common/cc-blobstore-config.html">Cloud Controller Blobstore Configuration</a>
capi_sidecar_req: <p class="note">This feature requires that your Cloud Foundry deployment uses capi-release 1.790 or later.</p>
enable_docker_link: To enable Docker support, see the [Enable Docker](../../adminguide/docker.html#enable) section of the _Using Docker in Cloud Foundry_ topic.
nozzle_info_link: see [Scaling Nozzles](log-ops-guide.html#scaling-nozzles) in _Loggregator Guide for CF Operators_.
slow_nozzle_alerts_link: For more information, see the [Slow Nozzle Alerts](../../loggregator/log-ops-guide.html#slow-noz) section of the _Loggregator Guide for Cloud Foundry Operators_ topic.
scaling_nozzles_link: For more information, see the [Scaling Nozzles](../../loggregator/log-ops-guide.html#scaling-nozzles) section of the _Loggregator Guide for Cloud Foundry Operators_ topic.
scaling_loggregator_link: For more information, see [Scaling Loggregator](../../loggregator/log-ops-guide.html#scaling) in _Loggregator Guide for Cloud Foundry Operators_.
using_docker_link: For an explanation of how Docker works in Cloud Foundry, see [Using Docker in Cloud Foundry](../../adminguide/docker.html).
cfdev_link: To deploy a local Cloud Foundry environment for experimentation or debugging purposes, you can use CF Dev. For more information, see <a href="https://github.com/cloudfoundry-incubator/cfdev">CF Dev</a>.
zipkin_tracing_link: For more information about Zipkin tracing, see [Enabling Zipkin Tracing](../adminguide/zipkin_tracing.html).
network_policy_quota: The maximum number of policies that a Space Developer can add in a space is set by the `max_policies_per_app_source` property in the `policy-server` job in the Cloud Foundry deployment manifest. By default, the maximum is 150.
network_policy_quota_config: To change the network policy quota for Space Developers, the Cloud Foundry operator must configure the `max_policies_per_app_source` property, then re-deploy Cloud Foundry.
human_readable_timestamp:
find_metric_name_source_id: see [CF Component Metrics](../running/all_metrics.html) and [UAA Performance Metrics](../uaa/uaa-metrics.html)