This is the README for Experimental Ops-files. To learn more about cf-deployment, go to the main README.
- For General Ops-files, check out the Ops-file README.
- For Addons Ops-files that can be applied to manifests or runtime configs, check out the Addons Ops-file README.
- For Backup and Restore Ops-files (for configuring your deployment for use with BBR), checkout the Backup and Restore Ops-files README.
- For Bits Service Ops-files (for configuring your deployment for use with Bits Service), checkout the Bits Service Ops-files README.
- For Community Ops-files, check out the Community Ops-file README.
"Experimental" Ops-file represent configurations that we expect to promote to blessed configuration eventually, meaning that, once the configurations have been sufficiently validated, they will either become default (inlined into the base manifest), or GA'd as an optional feature (promoted from experimental to operations directory). Please follow the ops file workflows
| Name | Purpose | Notes | Currently validated in Release Integration CI pipelines? |
|---|---|---|---|
add-credhub-lb.yml |
[DEPRECATED] Use load balancer to expose external address for CredHub. | NO | |
add-deployment-updater-external-db.yml |
"DEPRECATED because it is inlined in to cf-deployment.yml" |
Requires add-deployment-updater.yml and use-external-dbs.yml |
NO |
add-deployment-updater-postgres.yml |
"DEPRECATED because it is inlined in to cf-deployment.yml" |
Requires add-deployment-updater.yml |
NO |
add-deployment-updater.yml |
"DEPRECATED because it is inlined in to cf-deployment.yml" |
NO | |
add-metric-store.yml |
Add Metric Store node for persistence of metrics from Loggregator* | NO | |
add-syslog-agent.yml |
Add agent to all vms for the purpose of egressing application logs to syslog | YES | |
add-syslog-agent-windows1803.yml |
Add agent to windows1803 Diego cells for the purpose of egressing application logs to syslog | Requires ../windows1803-cell.yml, add-syslog-agent.yml and deploy-forwarder-agent.yml |
NO |
add-system-metrics-agent.yml |
Add agent to all vms with the purpose of egressing system metrics | NO | |
add-system-metrics-agent-windows1803.yml |
Add agent to windows1803 Diego cells for the purpose of egressing system metrics | NO | |
deploy-forwarder-agent.yml |
"DEPRECATED because it is inlined in to cf-deployment.yml" |
YES | |
disable-interpolate-service-bindings.yml |
Disables the interpolation of CredHub service credentials by Cloud Controller. | NO | |
enable-bpm-garden.yml |
Enables the BOSH Process Manager for Garden. | This ops file cannot be deployed in conjunction with enable-oci-phase-1.yml. |
NO |
enable-iptables-logger.yml |
Enables iptables logger. | YES | |
enable-mysql-tls.yml |
DEPRECATED because PXC is now the default database in cf-deployment Enables TLS on the database job, and secures all client database connections. | NO | |
enable-nfs-volume-service-credhub.yml |
DEPRECATED because it is inlined into enable-nfs-volume-service.yml Enables credhub integration for NFS volume services |
NO | |
enable-oci-phase-1.yml |
Configure CC, Diego, and Garden to create app and task containers more efficiently via OCI image specs. | This ops file cannot be deployed in conjunction with rootless-containers.yml. |
NO |
enable-routing-integrity-windows1803.yml |
Enables container proxy on the Windows 1803 Diego Cell rep and configures gorouter to opt into TLS-enabled connections to the backend. |
Warning: this is very experimental Requires ../windows1803-cell.yml |
NO |
enable-routing-integrity-windows2016.yml |
Enables container proxy on the Windows 2016 Diego Cell rep and configures gorouter to opt into TLS-enabled connections to the backend. |
Warning: this is very experimental Requires ../windows2016-cell.yml |
NO |
enable-smb-volume-service.yml |
DEPRECATED: use ../enable-smb-volume-service.yml |
NO | |
enable-suspect-actual-lrp-generation.yml |
"DEPRECATED because it is the default in diego-release" | Configures BBS to create ActualLRPs in a new "Suspect" state. You can find more in-depth information here | |
enable-tls-cloud-controller-postgres.yml |
Enables the usage of TLS to secure the connection between Cloud Controller and its Postgres database | Requires capi-release >= 1.41.0 and use-postgres.yml |
NO |
enable-traffic-to-internal-networks.yml |
Allows traffic from app containers to internal networks. Required to allow applications to communicate with the running CredHub in non-assisted mode. | NO | |
fast-deploy-with-downtime-and-danger.yml |
Risky, but fast. Disable canaries, increase the max number of vms bosh will update simultaneously, and remove serial: true from most instance groups to enable faster, but probably downtimeful, deploys. |
YES | |
infrastructure-metrics.yml |
Add the Prometheus node exporter and Loggregator Prom Scraper to addons. This puts infrastructure metrics into Loggregator's metric stream. | NO | |
migrate-nfsbroker-mysql-to-credhub.yml |
DEPRECATED because inlined into enable-nfs-volume-service-credhub.yml Migrates existing NFS volume services state storage from MySQL to Credhub |
Requires enable-nfs-volume-service-credhub.yml |
NO |
perm-service-with-pxc-release.yml |
"DEPRECATED because the perm-service is incompatible with PXC." | NO | |
perm-service-with-tcp-routing.yml |
"DEPRECATED because the perm-service is incompatible with PXC." | NO | |
perm-service.yml |
"DEPRECATED because the perm-service is incompatible with PXC." | NO | |
rootless-containers.yml |
Enable rootless garden-runc containers. | Requires garden-runc 1.9.5 or later and grootfs 0.27.0 or later. This ops file cannot be deployed in conjunction with enable-oci-phase-1.yml. |
NO |
set-cpu-weight.yml |
CPU shares for each garden container are proportional to its memory limits. | YES | |
use-compiled-releases-windows.yml |
Reverts to source version of releases required for Windows cells | Intended for use with use-compiled-releases.yml and any of windows*-cell.yml |
YES |
use-create-swap-delete-vm-strategy.yml |
Configures the default vm_strategy to be create-swap-delete. |
Requires BOSH director v267.7+ |
NO |
use-logcache-for-cloud-controller-app-stats.yml |
DEPRECATED because the Cloud Controller now uses logcache for app stats by default Configure Cloud Controller to use Log Cache instead of Traffic Controller for app container metrics. | YES | |
use-native-garden-runc-runner.yml |
Configure Garden to not create containers via containerd, using the native runner instead. | NO | |
windows-component-syslog-ca.yml |
Forces windows component syslog to respect only the provided CA for cert validation. | Requires windows-enable-component-syslog.yml. Can also be applied to runtime config, in the manner of the component-syslog-custom-ca.yml addon. The operations in this file are intended to be merged into that one when they graduate from experimental status. This ops file gets all its variables from the same place as that one, though not all are used. |
NO |
windows-enable-component-syslog.yml |
Collocates a job from windows-syslog-release on all windows-based instances to forward job logs in syslog format. | Compatible with both windows2016 and windows2012R2 instances, even at the same time. Can also be applied to runtime config, in the manner of the enable-component-syslog.yml addon. The operations in this file are intended to be merged into that one when they graduate from experimental status. This ops file gets all its variables from the same place as that one, though not all are used. |
NO |