You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: dev-workflow.html.md.erb
+1-1
Original file line number
Diff line number
Diff line change
@@ -29,4 +29,4 @@ The following topics can help you learn the necessary background information to
29
29
30
30
* [Reference](./reference.html) provides language references for tile elements such as the Service Broker API and the Properties list for tile configuration.
31
31
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.
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
The above events show how this data targets two different personae:
142
+
These events show how this data targets two different personae:
143
143
platform operators and app developers. Keep this in mind when designing an integration.
144
144
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.
146
146
Any filtering based on the event payload is the nozzle implementor's responsibility.
147
147
An advanced integration can combine a
148
148
[service broker](service-brokers.html) with a nozzle to:
149
149
150
150
* 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
152
152
153
153
For a full working example (suitable as an integration starting point),
154
154
see [firehose-nozzle](https://github.com/cf-platform-eng/firehose-nozzle).
155
155
156
-
### <aid="deploy"></a> Deploy a Nozzle
156
+
### <aid="deploy"></a> Deploy a nozzle
157
157
158
158
After you have built a nozzle, you can deploy it as a managed service or as an app.
159
159
@@ -164,7 +164,7 @@ You can also deploy the nozzle as an app on <%= vars.app_runtime_abbr %>. Visit
164
164
[section on pushed apps](tile-generator.html#pushed-applications)
165
165
for more details.
166
166
167
-
### <aid="examples"></a> Example Nozzles
167
+
### <aid="examples"></a> Example nozzles
168
168
169
169
There are several open source examples you can use
170
170
as a reference for building your nozzle.
@@ -196,19 +196,19 @@ another real world implementation.
196
196
197
197
## <aid="syslog-format-pcf"></a> Log Format for <%=vars.app_runtime_abbr%> Components
198
198
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:
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.
204
204
205
-
### <aid="syslog-elements"></a> Syslog Message Elements
205
+
### <aid="syslog-elements"></a> Syslog entries Elements
206
206
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.
<td><p>The <ahref="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 <ahref="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>
225
225
</tr><tr>
226
226
<td><code>${HOST_IP}</code></td>
227
227
<td><ahref="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
238
238
<td>The <ahref="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>
239
239
</tr><tr>
240
240
<td><code>${MSG_ID}</code></td>
241
-
<td>The <ahref="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 <ahref="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>
242
242
</tr><tr>
243
243
<td><code>${SD-ELEMENT-instance}</code></td>
244
-
<td>Structured data (SD) relevant to <%=vars.app_runtime_abbr%> about the <ahref="https://tools.ietf.org/html/rfc5424#section-6.3.1">source instance (VM)</a> that originates the log message. See the <ahref="#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 <ahref="https://tools.ietf.org/html/rfc5424#section-6.3.1">source instance (VM)</a> that originates the log entries. See the <ahref="#sd-element">Structured Instance Data Format table</a> below for content and format.</td>
245
245
</tr><tr>
246
246
<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>
248
248
</tr>
249
249
</table>
250
250
251
251
### <aid="severity"></a> RFC-5424 Severity Codes
252
252
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`.
Copy file name to clipboardexpand all lines: property-template-references.html.md.erb
+3-3
Original file line number
Diff line number
Diff line change
@@ -165,10 +165,10 @@ The table that follows describes the accessors you can use to retrieve informati
165
165
| Accessor | Description |
166
166
| -------- | ----------- |
167
167
| `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 |
169
169
| `http_proxy` | Provides the comma-separated values (CSV) that are entered when Ops Manager traffic is directed to an HTTP Proxy |
170
170
| `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 |
172
172
| `instance_types_catalog` | Provides a list of all available VM types. Includes custom VM types |
173
173
| `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`. |
174
174
| `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
185
185
| `password` | Provides the password for the BOSH Director VM |
186
186
| `ntp_servers` | Provides a list of Network Time Protocol (NTP) servers that the BOSH Director deploys |
187
187
| `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 |
189
189
| `tld` | Returns the string `bosh` as the top-level domain (TLD) of the BOSH Director |
190
190
| `metrics_server_enabled` | Returns `true` if the `system-metrics-server` job is included in the manifest.<br>For information about the job, see <ahref="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. |
191
191
| `bosh_metrics_forwarder_client_name` | Provides the BOSH Metrics Forwarder client name |
0 commit comments