docs: Updates based on feedback

pull/5030/head
Dan Heath 2 years ago
parent a092610fd9
commit aefbab83fb

@ -38,7 +38,7 @@ All responses return empty bodies. `GET /health` does not support any input.
## Check the health endpoint using `wget`
The Boundary Enterprise Docker image includes `wget`. It is also available to HCP Boundary users. You can use it to check the health endpoint.
The Boundary Docker image includes `wget`. You can use it to check the health endpoint. Enterprise and Community edition users can check the health of controllers and workers. HCP Boundary users can check the health of their self-managed workers.
Use the following command to check a worker's status to determine if it is healthy:
@ -49,7 +49,7 @@ $ wget -q -O - http://localhost:9203/health?worker_info=1 | grep -c 'READY'
- `-q` - Prints the response instead of saving it to a file.
- `-0` - Allows Boundary to pass the worker's URL.
If the command prints 1 to `stdout` or exits with exit code 0, it means the worker is healthy. Exit code > 0, is unhealthy
If the command prints 1 to `stdout` or exits with exit code 0, it means the worker is healthy. If the exit code is greater than 0, the worker is unhealthy.
You can also use the following command without `grep -c 'READY'` to print a more verbose response that includes the worker's state, active session count, and connection state:

@ -36,7 +36,7 @@ description: |-
Docker image no longer contains <code>curl</code>
</td>
<td style={{verticalAlign: 'middle'}}>
As of version 0.16.3 and later, the <code>curl</code> binary is no longer included in the published Docker container image for Boundary Enterprise. The image now includes <code>wget</code>, which you can alternatively use to check the health endpoint for a worker. If your workflow depends on having <code>curl</code> in the image, you can dynamically install it using <code>apk</code>.
As of version 0.16.3 and later, the <code>curl</code> binary is no longer included in the published Docker container image for Boundary. The image now includes <code>wget</code>, which you can alternatively use to check the health endpoint for a worker. If your workflow depends on having <code>curl</code> in the image, you can dynamically install it using <code>apk</code>.
<br /><br />
Learn more:&nbsp; <a href="#known-issues-and-breaking-changes">Known issues and breaking changes </a>
</td>
@ -257,7 +257,7 @@ description: |-
Docker image no longer contains <code>curl</code>
</td>
<td style={{verticalAlign: 'middle'}}>
As of version 0.16.3 and later, the <code>curl</code> binary is no longer included in the published Docker container image for Boundary Enterprise.
As of version 0.16.3 and later, the <code>curl</code> binary is no longer included in the published Docker container image for Boundary.
<br /><br />
The image now includes <code>wget</code>. You can use <code>wget</code> to check the health endpoint for workers.
<br /><br />

@ -36,7 +36,7 @@ description: |-
Docker image no longer contains <code>curl</code>
</td>
<td style={{verticalAlign: 'middle'}}>
As of version 0.17.1 and later, the <code>curl</code> binary is no longer included in the published Docker container image for Boundary Enterprise. The image now includes <code>wget</code>, which you can alternatively use to check the health endpoint for a worker. If your workflow depends on having <code>curl</code> in the image, you can dynamically install it using <code>apk</code>.
As of version 0.17.1 and later, the <code>curl</code> binary is no longer included in the published Docker container image for Boundary. The image now includes <code>wget</code>, which you can alternatively use to check the health endpoint for a worker. If your workflow depends on having <code>curl</code> in the image, you can dynamically install it using <code>apk</code>.
<br /><br />
Learn more:&nbsp; <a href="#known-issues-and-breaking-changes">Known issues and breaking changes </a>
</td>
@ -166,7 +166,7 @@ description: |-
Docker image no longer contains <code>curl</code>
</td>
<td style={{verticalAlign: 'middle'}}>
As of version 0.17.1 and later, the <code>curl</code> binary is no longer included in the published Docker container image for Boundary Enterprise.
As of version 0.17.1 and later, the <code>curl</code> binary is no longer included in the published Docker container image for Boundary.
<br /><br />
The image now includes <code>wget</code>. You can use <code>wget</code> to check the health endpoint for workers.
<br /><br />

Loading…
Cancel
Save