Skip to content

Commit 308f7f5

Browse files
Yash Tulsianinjbennett
Yash Tulsiani
authored andcommitted
Update readme for consistancy and update scripts
Signed-off-by: Natalie Bennett <[email protected]>
1 parent e08979c commit 308f7f5

File tree

3 files changed

+6
-5
lines changed

3 files changed

+6
-5
lines changed

operations/README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@ This is the README for Ops-files. To learn more about `cf-deployment`, go to the
5151
| [`set-bbs-active-key.yml`](set-bbs-active-key.yml) | Allows a deployer to set the `bbs` active key label by passing a variable `diego_bbs_active_key_label` | |
5252
| [`set-router-static-ips.yml`](set-router-static-ips.yml) | Allows a deployer to set the static IPs for the `router` VMs by passing a variable `router_static_ips` | `router_static_ips` variable must be provided as a compacted YAML array, e.g. `-v router_static_ips=[10.0.16.4,10.0.47.5]` |
5353
| [`stop-skipping-tls-validation.yml`](stop-skipping-tls-validation.yml) | Enforces `TLS` validation for all components which skip it in the base `cf-deployment.yml` manifest. | See the base [README](../README.md#tls) for details. |
54-
| [`use-bosh-dns.yml`](use-bosh-dns.yml) | This ops file has been deprecated and will be removed in the next release. | |
55-
| [`use-bosh-dns-for-containers.yml`](use-bosh-dns-for-containers.yml) | This ops file has been deprecated and will be removed in the next release. | |
56-
| [`use-bosh-dns-for-windows2016-containers.yml`](use-bosh-dns-for-windows2016-containers.yml) | This ops file has been deprecated and will be removed in the next release. | |
57-
| [`use-bosh-dns-rename-network-and-deployment.yml`](use-bosh-dns-rename-network-and-deployment.yml) | This ops file has been deprecated and will be removed in the next release. | |
54+
| [`use-bosh-dns.yml`](use-bosh-dns.yml) | **Deprecated** Kept as empty for backward compatibility. ([bosh-dns-release](https://github.com/cloudfoundry/bosh-dns-release) is now enabled by default) | This ops file will be deleted in cf-deployment v4.0.0 |
55+
| [`use-bosh-dns-for-containers.yml`](use-bosh-dns-for-containers.yml) | **Deprecated** Kept as empty for backward compatibility. ([bosh-dns-release](https://github.com/cloudfoundry/bosh-dns-release) is now enabled by default) | This ops file will be deleted in cf-deployment v4.0.0 |
56+
| [`use-bosh-dns-for-windows2016-containers.yml`](use-bosh-dns-for-windows2016-containers.yml) | **Deprecated** Kept as empty for backward compatibility. ([bosh-dns-release](https://github.com/cloudfoundry/bosh-dns-release) is now enabled by default) | This ops file will be deleted in cf-deployment v4.0.0 |
57+
| [`use-bosh-dns-rename-network-and-deployment.yml`](use-bosh-dns-rename-network-and-deployment.yml) | **Deprecated** Kept as empty for backward compatibility. ([bosh-dns-release](https://github.com/cloudfoundry/bosh-dns-release) is now enabled by default) | This ops file will be deleted in cf-deployment v4.0.0 |
5858
| [`use-blobstore-cdn.yml`](use-blobstore-cdn.yml) | Adds support for accessing the `droplets` and `resource_pool` blobstore buckets via signed urls over a cdn. | This assumes that you are using the same keypair for both buckets. Introduces [new variables](example-vars-files/vars-use-blobstore-cdn.yml) |
5959
| [`use-compiled-releases.yml`](use-compiled-releases.yml) | Instead of having your BOSH Director compile each release, use this ops-file to use pre-compiled releases for a deployment speed improvement. | These releases are compiled against a specific stemcell version that is listed in the opsfile. Note that no Windows releases are currently compiled. |
6060
| [`use-external-blobstore.yml`](use-external-blobstore.yml) | Removes the singleton-blobstore instance group, and adds `fog_connection` properties for components that use the blobstore. **Warning**: this does not migrate data, and will delete any existing singleton-blobstore groups. | This requires an external data store. Introduces [new variables](example-vars-files/vars-use-external-blobstore.yml) for blobstore connection details which will need to be provided at deploy time. |
@@ -63,6 +63,7 @@ This is the README for Ops-files. To learn more about `cf-deployment`, go to the
6363
| [`use-haproxy-public-network.yml`](use-haproxy-public-network.yml) | Puts haproxy instance on a public network with a static IP assigned to it. | Requires `use-haproxy.yml`. This ops file also requires your BOSH cloud-config to have a `vm_extension` called `cf-haproxy-network-properties`, which configures firewall rules to allow public traffic on the necessary ports (You will need to allow at least the default HTTP and HTTPS ports (`80` and `443`), port `4443` for `doppler`, as well as the [port range configured for the TCP Routing](https://github.com/cloudfoundry/cf-deployment/blob/a6983a1b3345cd9f5af0f26d5c10265de0c7851f/cf-deployment.yml#L726)). |
6464
| [`use-latest-stemcell.yml`](use-latest-stemcell.yml) | Use the latest stemcell available on your BOSH director instead of the one in `cf-deployment.yml`. **Caution**: This ops-file should not be used in conjunction with `use-compiled-releases.yml`, since the latter relies on a specific stemcell version being used. | |
6565
| [`use-latest-windows-stemcell.yml`](use-latest-windows-stemcell.yml) | Use the latest `windows2012R2` stemcell available on your BOSH director instead of the one in `windows-cell.yml` | Requires `windows-cell.yml` |
66+
| [`use-log-cache.yml`](use-log-cache.yml) | **Deprecated** Kept as empty for backward compatibility. ([log-cache-release](https://github.com/cloudfoundry/log-cache-release) is now enabled by default) | This ops file will be deleted in cf-deployment v4.0.0 |
6667
| [`use-postgres.yml`](use-postgres.yml) | Replaces the MySQL instance group with a postgres instance group. **Warning**: this will lead to total data loss if applied to an existing deployment with MySQL or removed from an existing deployment with postgres. | |
6768
| [`use-trusted-ca-cert-for-apps.yml`](use-trusted-ca-cert-for-apps.yml) | Injects the CA specified with `trusted_cert_for_apps` into the Diego trusted store | This store determines which CAs will be trusted in the app environment. |
6869
| [`windows-cell.yml`](windows-cell.yml) | Deploys a Windows 2012R2 Diego cell and adds releases necessary for Windows. | **Known issue**: Windows cells deployed to AWS will likely have their disks fill up after ~9 days (depending on load). The bosh-windows team is actively working on a fix for this. Operators who want to deploy windows cells to AWS anyway may want to recreate those cells periodically. |

operations/experimental/README.md

-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ and the ops-files will be removed.
5454
| [`use-compiled-releases-xenial-stemcell.yml`](use-compiled-releases-xenial-stemcell.yml) | Use releases compiled for Xenial stemcell, as opposed to Trusty | Requires `operations/experimental/use-xenial-stemcell.yml` |
5555
| [`use-garden-containerd.yml`](use-garden-containerd.yml) | Configure Garden to create containers via containerd. | |
5656
| [`use-grootfs.yml`](use-grootfs.yml) | Groot is enabled by default. This file is blank to avoid breaking deployment scripts. | |
57-
| [`use-log-cache.yml`](use-log-cache.yml) | **Deprecated** Kept as empty for backward compatibility. ([log-cache-release](https://github.com/cloudfoundry/log-cache-release) is now enabled by default) | Previously: Added the Log Cache Release for logs and metrics. This ops file will be deleted in cf-deployment v4.0.0 |
5857
| [`use-pxc.yml`](use-pxc.yml) | Uses the [pxc-release](https://github.com/cloudfoundry-incubator/pxc-release) instead of the [cf-mysql-release](https://github.com/cloudfoundry/cf-mysql-release/) as the internal mysql database. This ops-file is for clean-installs of cf or for redeploying cf already running pxc. It's not for migrating from cf-mysql-release. | |
5958
| [`use-shed.yml`](use-shed.yml) | Enable deprecated garden-shed on diego cells. | |
6059
| [`use-xenial-stemcell.yml`](use-xenial-stemcell.yml) | Use Ubuntu Xenial as the default stemcell | |

scripts/test-standard-ops.sh

+1
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ test_standard_ops() {
7575
pass "use-bosh-dns-for-containers.yml"
7676
pass "use-bosh-dns-for-windows2016-containers.yml"
7777
pass "use-bosh-dns-rename-network-and-deployment.yml"
78+
check_interpolation "use-log-cache.yml"
7879
popd > /dev/null # operations
7980
popd > /dev/null
8081
exit $exit_code

0 commit comments

Comments
 (0)