Skip to content

Commit 83071d8

Browse files
[#185473625]
1 parent 7c7549e commit 83071d8

5 files changed

+22
-22
lines changed

dev-workflow.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ The following topics can help you learn the necessary background information to
2929

3030
* [Reference](./reference.html) provides language references for tile elements such as the Service Broker API and the Properties list for tile configuration.
3131

32-
* [Tanzu ISV partner program contact information](./contacts.html)<!--฿ If this file is a partial, do not use relative links. ฿--> lists contacts to learn more about the VMware Tanzu ISV Partner Program or request our help with your integration project, and explains where you can contribute to this documentation.
32+
* [Tanzu ISV partner program contact information](./contacts.html) lists contacts to learn more about the VMware Tanzu ISV Partner Program or request our help with your integration project, and explains where you can contribute to this documentation.

managed.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To integrate your service at this level, you configure to learn about stemcells,
2424
### <a id="managed-mvp"></a> Minimal viable product
2525

2626
Minimal Viable Product (MVP) version of a managed service be a single, shared service instance, and don't yet
27-
worry too much about High Availability of this instance. This integration level is mostly about getting the BOSH packaging, deployment, and monitoring working
27+
worry too much about high availability of this instance. This integration level is mostly about getting the BOSH packaging, deployment, and monitoring working
2828
correctly.
2929

3030
### <a id="managed-ha"></a> High availability

migrating-syslog-configuration.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ By enabling the Ops Manager syslog feature, Ops Manager:
4646
<td><code>transport_protocol</code></td>
4747
<td>string</td>
4848
<td>No</td>
49-
<td>The transport protocol used to send syslog messages to the server.
49+
<td>The transport protocol used to send syslog entriess to the server.
5050
<br>Valid values are <code>tcp</code> and <code>udp</code>. Defaults to <code>tcp</code></td>
5151
</tr>
5252
<tr>

nozzle.html.md.erb

+16-16
Original file line numberDiff line numberDiff line change
@@ -135,25 +135,25 @@ The events channel receives the following six types of events.
135135
* _LogMessage_ represents a log entry for an individual app.
136136
* _ContainerMetric_ represents application container information. For example, memory used.
137137

138-
For the full details on events, see
138+
For the full details about events, see
139139
[dropsonde protocol](https://github.com/cloudfoundry/dropsonde-protocol/tree/master/events)
140140
in GitHub.
141141

142-
The above events show how this data targets two different personae:
142+
These events show how this data targets two different personae:
143143
platform operators and app developers. Keep this in mind when designing an integration.
144144

145-
The `doppler.firehose` scope gets nozzle data for *every* app and the platform.
145+
The `doppler.firehose` scope recieves nozzle data for *every* app and the platform.
146146
Any filtering based on the event payload is the nozzle implementor's responsibility.
147147
An advanced integration can combine a
148148
[service broker](service-brokers.html) with a nozzle to:
149149

150150
* App developers can opt in to logging (implementing filtering in the nozzle)
151-
* Establish [SSO](https://docs.cloudfoundry.org/services/dashboard-sso.html) exchange for authentication so that developers only can access logs for their space's apps
151+
* Establish [Cloud Foundry documentation](https://docs.cloudfoundry.org/services/dashboard-sso.html) exchange for authentication so that developers only can access logs for their space's apps
152152

153153
For a full working example (suitable as an integration starting point),
154154
see [firehose-nozzle](https://github.com/cf-platform-eng/firehose-nozzle).
155155

156-
### <a id="deploy"></a> Deploy a Nozzle
156+
### <a id="deploy"></a> Deploy a nozzle
157157

158158
After you have built a nozzle, you can deploy it as a managed service or as an app.
159159

@@ -164,7 +164,7 @@ You can also deploy the nozzle as an app on <%= vars.app_runtime_abbr %>. Visit
164164
[section on pushed apps](tile-generator.html#pushed-applications)
165165
for more details.
166166

167-
### <a id="examples"></a> Example Nozzles
167+
### <a id="examples"></a> Example nozzles
168168

169169
There are several open source examples you can use
170170
as a reference for building your nozzle.
@@ -196,19 +196,19 @@ another real world implementation.
196196

197197
## <a id="syslog-format-pcf"></a> Log Format for <%= vars.app_runtime_abbr %> Components
198198

199-
The standard log format for <%= vars.app_runtime_abbr %> adheres to the [RFC-5424 syslog protocol](https://tools.ietf.org/html/rfc5424), with log messages formatted as follows:
199+
The standard log format for <%= vars.app_runtime_abbr %> adheres to the [RFC-5424 syslog protocol](https://tools.ietf.org/html/rfc5424), with log entriess formatted as follows:
200200

201201
`<${PRI}>${VERSION} ${TIMESTAMP} ${HOST_IP} ${APP_NAME} ${PROD_ID} ${MSG_ID} ${SD-ELEMENT-instance} ${MESSAGE}`
202202

203-
The [Syslog Message Elements table](#syslog-elements) immediately below describes each element of the log, and the [Structured Instance Data Format](#sd-element) table describes the contents of the structured data element that carries Cloud Foundry VM instance information.
203+
The [Syslog entries Elements table](#syslog-elements) describes each element of the log, and the [Structured Instance Data Format](#sd-element) table describes the contents of the structured data element that carries Cloud Foundry VM instance information.
204204

205-
### <a id="syslog-elements"></a> Syslog Message Elements
205+
### <a id="syslog-elements"></a> Syslog entries Elements
206206

207-
This table describes each element of a standard <%= vars.app_runtime_abbr %> syslog message.
207+
This table describes each element of a standard <%= vars.app_runtime_abbr %> syslog entries.
208208

209209
<table id='syslog-elements-table' border="1" class="nice" >
210210
<tr>
211-
<th>Syslog Message Element</th>
211+
<th>Syslog entries Element</th>
212212
<th>Meaning or Value</th>
213213
</tr><tr>
214214
<td><code>${PRI}</code></td>
@@ -221,7 +221,7 @@ This table describes each element of a standard <%= vars.app_runtime_abbr %> sys
221221
<td><a href="https://tools.ietf.org/html/rfc5424#section-9.1"><code>1</code></a></td>
222222
</tr><tr>
223223
<td><code>${TIMESTAMP}</code></td>
224-
<td><p>The <a href="https://tools.ietf.org/html/rfc5424#section-9.1">timestamp</a> of when the log message is forwarded; typically slightly after it was generated. Example: <code>2017-07-24T05:14:15.000003Z</code></p></td>
224+
<td><p>The <a href="https://tools.ietf.org/html/rfc5424#section-9.1">timestamp</a> of when the log entry is forwarded (typically slightly after it was generated). Example: <code>2017-07-24T05:14:15.000003Z</code></p></td>
225225
</tr><tr>
226226
<td><code>${HOST_IP}</code></td>
227227
<td><a href="https://tools.ietf.org/html/rfc5424#section-6.2.4">Internal IP address</a> of origin server</td>
@@ -238,19 +238,19 @@ This table describes each element of a standard <%= vars.app_runtime_abbr %> sys
238238
<td>The <a href="https://tools.ietf.org/html/rfc5424#section-6.2.6">Process ID</a> of the syslog process doing the forwarding. If this is not easily available, default to <code>-</code> (hyphen) to indicate unknown.</td>
239239
</tr><tr>
240240
<td><code>${MSG_ID}</code></td>
241-
<td>The <a href="https://tools.ietf.org/html/rfc5424#section-6.2.7">type</a> of log message. If this is not easily available, default to <code>-</code> (hyphen) to indicate unknown.</td>
241+
<td>The <a href="https://tools.ietf.org/html/rfc5424#section-6.2.7">type</a> of log entries. If this is not easily available, default to <code>-</code> (hyphen) to indicate unknown.</td>
242242
</tr><tr>
243243
<td><code>${SD-ELEMENT-instance}</code></td>
244-
<td>Structured data (SD) relevant to <%= vars.app_runtime_abbr %> about the <a href="https://tools.ietf.org/html/rfc5424#section-6.3.1">source instance (VM)</a> that originates the log message. See the <a href="#sd-element">Structured Instance Data Format table</a> below for content and format.</td>
244+
<td>Structured data (SD) relevant to <%= vars.app_runtime_abbr %> about the <a href="https://tools.ietf.org/html/rfc5424#section-6.3.1">source instance (VM)</a> that originates the log entries. See the <a href="#sd-element">Structured Instance Data Format table</a> below for content and format.</td>
245245
</tr><tr>
246246
<td><code>${MESSAGE}</code></td>
247-
<td>The log message itself, ideally in JSON</td>
247+
<td>The log entries itself, ideally in JSON</td>
248248
</tr>
249249
</table>
250250

251251
### <a id="severity"></a> RFC-5424 Severity Codes
252252

253-
<%= vars.app_runtime_abbr %> components generate log messages with the following severity levels. The most common severity level is `13`.
253+
<%= vars.app_runtime_abbr %> components generate log entries with the following severity levels. The most common severity level is `13`.
254254

255255
<table id='severity-table' border="1" class="nice" >
256256
<tr>

property-template-references.html.md.erb

+3-3
Original file line numberDiff line numberDiff line change
@@ -165,10 +165,10 @@ The table that follows describes the accessors you can use to retrieve informati
165165
| Accessor | Description |
166166
| -------- | ----------- |
167167
| `ca_certificate` | Provides the root CA certificate that signs the Director VM |
168-
| `trusted_certificates` | Provides a list of certificates that the Director applies to all VMs. |
168+
| `trusted_certificates` | Provides a list of certificates that the Director applies to all VMs |
169169
| `http_proxy` | Provides the comma-separated values (CSV) that are entered when Ops Manager traffic is directed to an HTTP Proxy |
170170
| `https_proxy` | Provides the CSVs that are entered when Ops Manager traffic is directed to an HTTPS Proxy |
171-
| `no_proxy` | Provides the CSVs that should not go through a proxy |
171+
| `no_proxy` | Provides the CSVs that must not go through a proxy |
172172
| `instance_types_catalog` | Provides a list of all available VM types. Includes custom VM types |
173173
| `restricted_view_api_access_credentials` | Provides a payload for a UAA client to make read-only non-credential requests against Ops Manager. The payload includes `uaa_client_name`, `uaa_client_secret`, `hostname`, and `port`. |
174174
| `iaas_type` | Provides the type of the infrastructure: `google`, `aws`, `azure`, `vsphere`, or `openstack` |
@@ -185,7 +185,7 @@ The table that describes the accessors you can use to retrieve information about
185185
| `password` | Provides the password for the BOSH Director VM |
186186
| `ntp_servers` | Provides a list of Network Time Protocol (NTP) servers that the BOSH Director deploys |
187187
| `ca_public_key` | Provides the public key that is used to sign the BOSH Director VM |
188-
| `hostname` | Provides the hostname for the BOSH Director VM |
188+
| `hostname` | Provides the host name for the BOSH Director VM |
189189
| `tld` | Returns the string `bosh` as the top-level domain (TLD) of the BOSH Director |
190190
| `metrics_server_enabled` | Returns `true` if the `system-metrics-server` job is included in the manifest.<br>For information about the job, see <a href="https://bosh.io/jobs/system-metrics-server?source=github.com/cloudfoundry/bosh-system-metrics-server-release">system-metrics-server job</a> in the BOSH documentation. |
191191
| `bosh_metrics_forwarder_client_name` | Provides the BOSH Metrics Forwarder client name |

0 commit comments

Comments
 (0)