pivotal-cf/docs-pas

docs-pas

This repository houses release notes for TAS (formerly PAS, formerly PCF). Use git branches to switch between different TAS versions.

The master branch has the content for the upcoming major release.

master branch is for TAS v6.0 as of October 2023.

This repository publishes through the docs-book-application-service repository.

As of March 2023, the docs are built in DocWorks (https://docworks.vmware.com/md2docs/projects/all?permalink=bb679e5b-0711-499a-ad91-9bfab102dcff).

Branch map

Branch	TAS version	Doc Link
master	TAS 7.0	TAS v7.0 staging
6.0	TAS 6.0	TAS v6.0
5.0	TAS 5.0	TAS v5.0
4.0	TAS v4.0	TAS v4.0
3.0	TAS v3.0 (EOGS)	TAS v3.0
2.13	TAS v2.13	TAS v2.13
2.12	TAS v2.12 (EOGS)	TAS v2.12
2.11	TAS v2.11	TAS v2.11

docs-pas's Issues

Need to mention what is "secure" with "Secure Endpoint for Metric Registrar"

According to the release note for "Secure Endpoint for Metric Registrar" feature from TAS 2.12, it's not mentioned on what is "secure" with the new feature.

https://docs.pivotal.io/application-service/2-12/release-notes/runtime-rn.html#secure-metric-registrar

TAS for VMs v2.12 allows operators to register a secure endpoint for the Metric Registrar CLI plugin to
ingest app metrics. You can use the cf register-metrics-endpoint command to specify an internal port
in your app when you register the endpoint to the metric registrar.

With this new feature, I see that Endpoint Workers scrape metrics by directly accesing to metric endpoints within TAS internal network rather than accesing via LB/Gorouter from internet side of network as previous behavior. This means "secure." In other words, with this new feature, network traffices including metrics data don't go through internet and malicious third party can't inspect those traffices, which means "secure."

Could you add such brife explanation with the release note for the new feature?

Typo in 6.0 release notes

Describe the bug

Regarding https://github.com/pivotal-cf/docs-pas/blob/8b15d4786a851ee7c63b176ce9938ed477dad626/runtime-rn.html.md.erb#L1824C1-L1824C45:

Operators can continue to Cloud Controller to install cflinuxfs3, if desired.

This sentence doesn't make sense as written. I propose:

Operators can continue to configure Cloud Controller to install cflinuxfs3, if desired.

Reproduction steps

Read TAS 6.0 breaking changes.

Expected behavior

Grammar occurs.

Additional context

No response

Markdown in IS release notes -- in HTML table

Describe the bug

There is Markdown syntax in the HTML tables in the Isolation Segment release notes -- many instances.

Reproduction steps

1. https://docs.vmware.com/en/VMware-Tanzu-Application-Service/3.0/tas-for-vms/segment-rn.html
2. Scroll to Components table
3. Expand any item in Release Notes column.
   ...

Expected behavior

In an HTML table, all formatting must be done in HTML, not Markdown.

don't use ## for headings in the table
use HTML bolding -- not Markdown **

Additional context

I see this in TAS 3,0 and 4.0 tables. I could fix this, but I suspect this may be automated content, and fixing it manually is not time-effective.

Please configure GITBOT

Pivotal provides the Gitbot service to synchronize issues and pull requests made against public GitHub repos with Pivotal Tracker projects.

If you are a Pivotal employee, you can configure Gitbot to sync your GitHub repo to your Pivotal Tracker project with a pull request.

Steps:

• Fork this repo: cfgitbot-config (an ask+cf@ ticket is the fastest way to get read access if you get a 404)
• Add the Toolsmiths-Bots team to have admin access to your repo
• Add the cf-gitbot ([email protected]) user to have owner access to your Pivotal Tracker project
• Add your new repo and or project to config-production.yml file
• Submit a PR, which will get auto-merged if you've done it right

If you are not a pivotal employee, you can request that [email protected] set up the integration for you.

You might also be interested in configuring GitHub's Service Hook for Tracker on your repo so you can link your commits to Tracker stories. You can do this yourself by following the directions at:

https://www.pivotaltracker.com/blog/guide-githubs-service-hook-tracker/

If you do not want to use Pivotal Tracker to manage this GitHub repo, Please add this repo to the Ignored repositories list

If there are any questions, please reach out to [email protected].

TAS `3.0.1` released without release notes

• https://network.pivotal.io/products/elastic-runtime/#/releases/1201902
• https://docs.pivotal.io/application-service/3-0/release-notes/runtime-rn.html
• https://github.com/pivotal-cf/docs-pas/blob/3.0/runtime-rn.html.md.erb

TAS `2.13.12` and `3.0.2` released without release notes published

2.13.12:

• https://network.pivotal.io/products/elastic-runtime/#/releases/1214913
• https://docs.pivotal.io/application-service/2-13/release-notes/runtime-rn.html
• https://github.com/pivotal-cf/docs-pas/blob/2.13/runtime-rn.html.md.erb (present but not published)

3.0.2:

• https://network.pivotal.io/products/elastic-runtime/#/releases/1214907
• https://docs.pivotal.io/application-service/3-0/release-notes/runtime-rn.html
• https://github.com/pivotal-cf/docs-pas/blob/3.0/runtime-rn.html.md.erb (present but not published)

Update release notes for Usage Service

TAS 2.7: #111
TAS 2.9: #112
TAS 2.10: #113
TAS 2.11: #114
TAS 2.12: #115

Known Issues regarding Metrics Registrar 1.2.1

Hi there,

We incorporated version 1.2.1 of Metrics Registrar into TAS 2.7-2.10, which introduced a couple of features and a couple of upgrade-blocking bugs. We reverted it in the subsequent patch release on each affected minor version of TAS, but we want to document the known issues. Making one issue to track all of the associated PRs here.

There are 3 issues to note, and of the three, two are definitely resolved by the revert. It is not entirely clear whether the revert of the metric-registrar bump will fully solve the third, so we left out the "resolved in v2.10.5 and later" message for that one.

Affected Versions:

• TAS 2.7.24: #34
• TAS 2.8.18: #35
• TAS 2.9.12: #36
• TAS 2.10.4: #37