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: api/v4/management/cloud-foundry.md
+20-20Lines changed: 20 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,36 +5,36 @@ Integration with [Tanzu Apps Manager](https://techdocs.broadcom.com/us/en/vmware
5
5
When used, this endpoint enables the following additional functionality on Cloud Foundry:
6
6
7
7
* A variant of the [hypermedia](./hypermedia.md) endpoint is registered at `/cloudfoundryapplication`.
8
-
* All endpoints are additionally mapped under the base path `/cloudfoundryapplication`.
8
+
* All endpoints are also mapped under the base path `/cloudfoundryapplication`.
9
9
*[Authentication and authorization](#security) for your Cloud Foundry environment is added to the request pipeline.
10
10
11
11
> [!NOTE]
12
-
> The Cloud Foundry integration will not work unless the [Cloud Foundry Configuration Provider](../configuration/cloud-foundry-provider.md) has also been configured.
12
+
> The Cloud Foundry integration works only when the [Cloud Foundry Configuration Provider](../configuration/cloud-foundry-provider.md) has also been configured.
13
13
14
14
## Configure Settings
15
15
16
16
Typically, no additional configuration is needed. However, the following table describes the configuration settings that you can apply to the Cloud Foundry endpoint.
17
17
Each key must be prefixed with `Management:Endpoints:CloudFoundry`.
18
18
19
19
| Key | Description | Default |
20
-
| --- | --- | --- |
21
-
|`Enabled`| Whether the endpoint is enabled.|`true`|
22
-
|`ID`| The unique ID of the endpoint.|`""`|
23
-
|`Path`| The relative path at which the endpoint is exposed.| same as `ID`|
24
-
|`RequiredPermissions`| Permissions required to access the endpoint, when running on Cloud Foundry.|`Restricted`|
25
-
|`AllowedVerbs`| An array of HTTP verbs the endpoint is exposed at.|`GET`|
26
-
|`ValidateCertificates`| Whether to validate server certificates.|`true`|
27
-
|`ApplicationId`| The ID of the application used in permission checks.||
28
-
|`CloudFoundryApi`| The URL of the Cloud Foundry API.||
20
+
| --- | -----------|------- |
21
+
|`Enabled`| Whether the endpoint is enabled |`true`|
22
+
|`ID`| The unique ID of the endpoint |`""`|
23
+
|`Path`| The relative path at which the endpoint is exposed | same as `ID`|
24
+
|`RequiredPermissions`| Permissions required to access the endpoint when running on Cloud Foundry |`Restricted`|
25
+
|`AllowedVerbs`| An array of HTTP verbs at which the endpoint is exposed |`GET`|
26
+
|`ValidateCertificates`| Whether to validate server certificates |`true`|
27
+
|`ApplicationId`| The ID of the application used in permission checks ||
28
+
|`CloudFoundryApi`| The URL of the Cloud Foundry API ||
29
29
30
30
## Enable HTTP Access
31
31
32
-
The URL path to the endpoint is computed by combining the global `Management:Endpoints:Path` setting together with the `Path` setting described in the preceding section.
32
+
The URL path to the endpoint is computed by combining the global `Management:Endpoints:Path` setting with the `Path` setting described in the preceding section.
33
33
The default path is `/cloudfoundryapplication`.
34
34
35
-
See the [Exposing Endpoints](./using-endpoints.md#exposing-endpoints) and [HTTP Access](./using-endpoints.md#http-access) sections for the overall steps required to enable HTTP access to endpoints in an ASP.NET Core application.
35
+
See the [Exposing Endpoints](./using-endpoints.md#exposing-endpoints) and [HTTP Access](./using-endpoints.md#http-access) sections for the steps required to enable HTTP access to endpoints in an ASP.NET Core application.
36
36
37
-
To add the actuator to the service container, add a [CORS](#cross-origin-resource-sharing) policy, register security middleware and map its route, use the `AddCloudFoundryActuator` extension method.
37
+
To add the actuator to the service container, add a [CORS](#cross-origin-resource-sharing) policy, register security middleware and map its route, and use the `AddCloudFoundryActuator` extension method.
38
38
39
39
Add the following code to `Program.cs` to use the actuator endpoint:
When viewing an application in Apps Manager, HTTP requests are sent directly to application instances with the bearer token of the logged-in user attached.
56
+
When viewing an application in Apps Manager, HTTP requests are sent directly to application instances, with the bearer token of the logged-in user attached.
57
57
The nature of this integration requires the use of Cross Origin Resource Sharing ([CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)).
58
-
The policy defined in Steeltoe intends to limit sharing to the minimum required for the endpoints to function, however there is no way for Steeltoe to discover or even guess at what the origin of an Apps Manager instance could be.
59
-
As such, the default policy will allow any origin, unless the policy is customized. You should consider [customizing the CORS policy](./using-endpoints.md#customizing-the-cors-policy) to be more specific.
58
+
The policy defined in Steeltoe intends to limit sharing to the minimum required for the endpoints to function; however, there is no way for Steeltoe to discover or infer what the origin of an Apps Manager instance could be.
59
+
As such, the default policy allows any origin, unless the policy is customized. You should consider [customizing the CORS policy](./using-endpoints.md#customizing-the-cors-policy) to be more specific.
60
60
61
61
## Security
62
62
@@ -65,7 +65,7 @@ The Cloud Foundry security middleware requires a valid UAA access token to be pr
65
65
Additionally, the security middleware evaluates the token to determine whether the authenticated user has permission to access the management endpoint.
66
66
67
67
> [!NOTE]
68
-
> The Cloud Foundry security middleware is only active when your application is running on Cloud Foundry.
68
+
> The Cloud Foundry security middleware is active only when your application is running on Cloud Foundry.
69
69
70
70
## External access
71
71
@@ -77,5 +77,5 @@ For this reason, all endpoints are exposed by default at `/cloudfoundryapplicati
77
77
In addition, the endpoints may be secured by whatever security mechanism the application itself uses. For more details, see [securing actuators](./using-endpoints.md#securing-endpoints).
78
78
79
79
> [!CAUTION]
80
-
> Applying an authorization policy on `/actuator`will also impact `/cloudfoundryapplication`, which will break the integration with Apps Manager.
81
-
> In order to prevent public access to `/actuator` when running on Cloud Foundry, consider configuring actuators to [use an alternate port](./using-endpoints.md#configure-global-settings).
80
+
> Applying an authorization policy on `/actuator` also has an impact on `/cloudfoundryapplication`, which then breaks the integration with Apps Manager.
81
+
> To prevent public access to `/actuator` when running on Cloud Foundry, consider configuring actuators to [use an alternate port](./using-endpoints.md#configure-global-settings).
Copy file name to clipboardExpand all lines: api/v4/management/health.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -152,7 +152,7 @@ When `ShowComponents` and `ShowDetails` are set to `Always`, or when set to `Whe
152
152
153
153
## Health Groups
154
154
155
-
If you need to check application health based on a subset of health contributors, you can specify the name of the grouping and a comma-separated list of contributors to include:
155
+
If you want to check application health based on a subset of health contributors, you can specify the name of the grouping and a comma-separated list of contributors to include:
Copy file name to clipboardExpand all lines: api/v4/management/prometheus.md
+40-34Lines changed: 40 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,11 @@ The Steeltoe Prometheus endpoint configures the [OpenTelemetry Prometheus Export
6
6
7
7
The Prometheus endpoint does not automatically instrument your application, but does make it easy to export metrics in the Prometheus metrics format, which can be used by tools like [Prometheus Server](https://prometheus.io/) and the [Metric Registrar for Tanzu Platform for Cloud Foundry](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/tanzu-platform-for-cloud-foundry/10-0/tpcf/metric-registrar-index.html).
8
8
9
-
The [Steeltoe Management samples](https://github.com/SteeltoeOSS/Samples/tree/main/Management/src/ActuatorWeb/README.md)can help you understand how to use this tool.
9
+
See the [Steeltoe Management samples](https://github.com/SteeltoeOSS/Samples/tree/main/Management/src/ActuatorWeb/README.md)for more information about using this tool.
10
10
11
11
## Add NuGet Reference
12
12
13
-
To use the Prometheus endpoint, you need to add a reference to the `Steeltoe.Management.Prometheus` NuGet package.
13
+
To use the Prometheus endpoint, add a reference to the `Steeltoe.Management.Prometheus` NuGet package.
14
14
15
15
## Configure Settings
16
16
@@ -26,7 +26,7 @@ Each key must be prefixed with `Management:Endpoints:Prometheus:`.
26
26
|`AllowedVerbs`| An array of HTTP verbs at which the endpoint is exposed |`GET`|
27
27
28
28
> [!NOTE]
29
-
> The `AllowedVerbs` setting is inherited from Steeltoe's`EndpointOptions`, but is not intended to work for the Prometheus exporter, which is only registered to respond to `GET` requests.
29
+
> The `AllowedVerbs` setting is inherited from the Steeltoe `EndpointOptions`, but is not intended to work for the Prometheus exporter, which is only registered to respond to `GET` requests.
### Configuring the request pipeline for Prometheus
50
50
51
51
In addition to the options described in [using endpoints](./using-endpoints.md), `AddPrometheusActuator` exposes an `Action<IApplicationBuilder>?` that can be used to configure the branched request pipeline that is used in the underlying OpenTelemetry package.
52
-
This pipeline would need to be configured if, as an example, you are configuring an authorization policy.
52
+
This pipeline must be configured if, as an example, you are configuring an authorization policy.
[Learn more about ASP.NET Core instrumentation for OpenTelemetry](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/main/src/OpenTelemetry.Instrumentation.AspNetCore)
78
+
FormoreinformationaboutASP.NETCoreinstrumentationfor OpenTelemetry, see the [OpenTelemetry documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/main/src/OpenTelemetry.Instrumentation.AspNetCore).
77
79
78
80
### HttpClient
79
81
80
-
To instrument `HttpClient`s for metrics, start by adding a reference to the `OpenTelemetry.Instrumentation.Http` NuGet package.
82
+
Toinstrument `HttpClient`sformetrics:
81
83
82
-
Next, add the instrumentation to the `MeterProviderBuilder`:
[Learn more about HttpClient instrumentation for OpenTelemetry](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/tree/main/src/OpenTelemetry.Instrumentation.Http)
[Learn more about Runtime Instrumentation for OpenTelemetry .NET](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/tree/main/src/OpenTelemetry.Instrumentation.Runtime)
> For this scenario, configure actuators to [use an alternate port](./using-endpoints.md#configure-global-settings) and use that private network port to offer the metrics.
Copy file name to clipboardExpand all lines: api/v4/management/refresh.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,24 +9,24 @@ The following table describes the configuration settings that you can apply to t
9
9
Each key must be prefixed with `Management:Endpoints:Refresh:`.
10
10
11
11
| Key | Description | Default |
12
-
| --- | --- | --- |
13
-
|`Enabled`| Whether the endpoint is enabled.|`true`|
14
-
|`ID`| The unique ID of the endpoint.|`refresh`|
15
-
|`Path`| The relative path at which the endpoint is exposed.| same as `ID`|
16
-
|`RequiredPermissions`| Permissions required to access the endpoint, when running on Cloud Foundry.|`Restricted`|
17
-
|`AllowedVerbs`| An array of HTTP verbs the endpoint is exposed at.|`POST`|
18
-
|`ReturnConfiguration`| Whether to return the configuration after refresh.|`true`|
12
+
| --- | -----------|------- |
13
+
|`Enabled`| Whether the endpoint is enabled |`true`|
14
+
|`ID`| The unique ID of the endpoint |`refresh`|
15
+
|`Path`| The relative path at which the endpoint is exposed | same as `ID`|
16
+
|`RequiredPermissions`| Permissions required to access the endpoint when running on Cloud Foundry |`Restricted`|
17
+
|`AllowedVerbs`| An array of HTTP verbs at which the endpoint is exposed |`POST`|
18
+
|`ReturnConfiguration`| Whether to return the configuration after refresh |`true`|
19
19
20
20
> [!NOTE]
21
-
> Despite being *possible* to configure this endpoint to respond to `GET` requests,
21
+
> Despite it being *possible* to configure this endpoint to respond to `GET` requests,
22
22
> this is discouraged because it is not a [Safe HTTP Method](https://developer.mozilla.org/en-US/docs/Glossary/Safe/HTTP).
23
23
24
24
## Enable HTTP Access
25
25
26
-
The URL path to the endpoint is computed by combining the global `Management:Endpoints:Path` setting together with the `Path` setting described in the preceding section.
26
+
The URL path to the endpoint is computed by combining the global `Management:Endpoints:Path` setting with the `Path` setting described in the preceding section.
27
27
The default path is `/actuator/refresh`.
28
28
29
-
See the [Exposing Endpoints](./using-endpoints.md#exposing-endpoints) and [HTTP Access](./using-endpoints.md#http-access) sections for the overall steps required to enable HTTP access to endpoints in an ASP.NET Core application.
29
+
See the [Exposing Endpoints](./using-endpoints.md#exposing-endpoints) and [HTTP Access](./using-endpoints.md#http-access) sections for the steps required to enable HTTP access to endpoints in an ASP.NET Core application.
30
30
31
31
To add the actuator to the service container and map its route, use the `AddRefreshActuator` extension method.
0 commit comments