Skip to content

Commit 4052772

Browse files
CopilotTimHess
andcommitted
Fix Hystrix Dashboard→Skunkworks, GemFire page links, TAS SSO→Single Sign-On, restore Metric Registrar link, always post PR comment
Co-authored-by: TimHess <3947063+TimHess@users.noreply.github.com>
1 parent 1a96051 commit 4052772

14 files changed

Lines changed: 33 additions & 33 deletions

File tree

.github/workflows/check-links.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ jobs:
5050
fail: true
5151
jobSummary: true
5252

53-
- name: Comment on PR with broken links
54-
if: failure() && github.event_name == 'pull_request'
53+
- name: Comment on PR with link check results
54+
if: always() && github.event_name == 'pull_request'
5555
uses: mshick/add-pr-comment@v2
5656
with:
5757
message-id: broken-links-check

docs/docs/v2/circuitbreaker/hystrix.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Each Hystrix command also has the ability to create a timeout for any calls that
88

99
Each command has a built-in configurable circuit breaker that stops all requests to failing back-end dependencies when the error percentage passes a threshold. The circuit remains open (broken) for a configurable period of time, and all requests are then sent to the fallback mechanism until the circuit is closed (connected) again.
1010

11-
Hystrix also provides a means to measure command successes, failures, timeouts, short-circuits, and thread rejections. Statistics are gathered for all of these and can optionally be reported to a [Hystrix Dashboard](https://github.com/Netflix/Hystrix/wiki) for monitoring in real-time.
11+
Hystrix also provides a means to measure command successes, failures, timeouts, short-circuits, and thread rejections. Statistics are gathered for all of these and can optionally be reported to a [Hystrix Dashboard](https://github.com/Netflix-Skunkworks/hystrix-dashboard) for monitoring in real-time.
1212

1313
The remaining sections of this chapter describe these features. Also, you should understand that Steeltoe's Hystrix implementation follows the Netflix implementation closely. As a result, its worthwhile to review the [Netflix documentation](https://github.com/Netflix/Hystrix/wiki) in addition to this documentation. Pay particular attention to the [How it Works](https://github.com/Netflix/Hystrix/wiki/How-it-Works) section as it provides a [Flow Chart](https://github.com/Netflix/Hystrix/wiki/How-it-Works#Flow) explaining how a command executes and how the default [Circuit Breaker](https://github.com/Netflix/Hystrix/wiki/How-it-Works#CircuitBreaker) transitions between CLOSED, OPEN and HALF-OPEN states. It also provides details on how the [Bulkhead pattern](https://learn.microsoft.com/azure/architecture/patterns/bulkhead) is implemented using isolation techniques employing [Threads and Thread Pools](https://github.com/Netflix/Hystrix/wiki/How-it-Works#isolation).
1414

@@ -26,7 +26,7 @@ You should also have a good understanding of how the [ASP.NET Core Startup class
2626

2727
In addition to the information below, review the [Netflix Hystrix Wiki](https://github.com/Netflix/Hystrix/wiki). The Steeltoe Hystrix framework implementation aligns closely with the Netflix implementation. Consequently, the Wiki information applies directly to Steeltoe.
2828

29-
If you plan to use the Hystrix Dashboard, you should also spend time understanding the [Netflix Hystrix Dashboard](https://github.com/Netflix/Hystrix/wiki) information on the wiki.
29+
If you plan to use the Hystrix Dashboard, you should also spend time understanding the [Netflix Hystrix Dashboard](https://github.com/Netflix-Skunkworks/hystrix-dashboard) information on the wiki.
3030

3131
To use the Steeltoe framework:
3232

@@ -61,7 +61,7 @@ To add this type of NuGet to your project add something like the following `Pack
6161
</ItemGroup>
6262
```
6363

64-
The second type of NuGet that you need to consider pertains to Hystrix metrics. If you are developing an ASP.NET Core application and plan on using Hystrix metrics and the [Netflix Hystrix Dashboard](https://github.com/Netflix/Hystrix/wiki) then you need to also include the `Steeltoe.CircuitBreaker.Hystrix.MetricsEventsCore` package in your application.
64+
The second type of NuGet that you need to consider pertains to Hystrix metrics. If you are developing an ASP.NET Core application and plan on using Hystrix metrics and the [Netflix Hystrix Dashboard](https://github.com/Netflix-Skunkworks/hystrix-dashboard) then you need to also include the `Steeltoe.CircuitBreaker.Hystrix.MetricsEventsCore` package in your application.
6565

6666
To do this include the following `PackageReference` in your application:
6767

@@ -788,7 +788,7 @@ As HystrixCommands run, they generate metrics and status information on outcomes
788788

789789
With Steeltoe, you can currently choose from two dashboards.
790790

791-
The first is the [Netflix Hystrix Dashboard](https://github.com/Netflix/Hystrix/wiki). This dashboard is appropriate when you are not running your application on Cloud Foundry -- for example, when you are developing and testing your application locally on your desktop.
791+
The first is the [Netflix Hystrix Dashboard](https://github.com/Netflix-Skunkworks/hystrix-dashboard). This dashboard is appropriate when you are not running your application on Cloud Foundry -- for example, when you are developing and testing your application locally on your desktop.
792792

793793
The second is the Spring Cloud Services Hystrix Dashboard. This dashboard was part of the Spring Cloud Services v2 offering and was made available to applications through the normal service instance binding mechanisms on Cloud Foundry.
794794

docs/docs/v2/connectors/gemfire.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
[VMware Tanzu GemFire](https://www.vmware.com/products/app-platform/tanzu-data-intelligence/gemfire) is VMware's distribution of [Apache Geode](https://geode.apache.org/). This connector was built for using GemFire in an application using the [GemFire Native Client](https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-gemfire-native-client/10-4/gf-nc/dotnet-about-client-users-guide.html) on Cloud Foundry. It has not been extensively tested under other deployment configurations, but will be best-effort supported for other situations as well.
66

7-
>WARNING: The GemFire Native Client currently only supports 64 bit applications running on Windows. See [GemFire Native Client System Requirements](https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-gemfire-native-client/10-4/gf-nc/dotnet-about-client-users-guide.html) for more.
7+
>WARNING: The GemFire Native Client currently only supports 64 bit applications running on Windows. See [GemFire Native Client System Requirements](https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-gemfire-native-client/10-4/gf-nc/dotnet-system_requirements.html) for more.
88
99
## Usage
1010

@@ -46,7 +46,7 @@ For example, if you want to set the log-level and connection timeout, use the fo
4646
}
4747
```
4848

49-
Refer to the [GemFire documentation](https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-gemfire-native-client/10-4/gf-nc/dotnet-about-client-users-guide.html) for a more complete list of settings to configure.
49+
Refer to the [GemFire documentation](https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-gemfire-native-client/10-4/gf-nc/dotnet-configuring-sysprops.html) for a more complete list of settings to configure.
5050

5151
### Cloud Foundry
5252

@@ -67,7 +67,7 @@ cf bind-service myApp myPCCService
6767
cf restage myApp
6868
```
6969

70-
If your application fails to [programmatically create regions](https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-gemfire-native-client/10-4/gf-nc/dotnet-about-client-users-guide.html), use the [gfsh CLI](https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-gemfire/10-1/gf/tools_modules-gfsh-chapter_overview.html) to create it. You will need the gfsh url and the cluster operator credentials provided in the service binding:
70+
If your application fails to [programmatically create regions](https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-gemfire-native-client/10-4/gf-nc/dotnet-regions.html), use the [gfsh CLI](https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-gemfire/10-1/gf/tools_modules-gfsh-chapter_overview.html) to create it. You will need the gfsh url and the cluster operator credentials provided in the service binding:
7171

7272
```json
7373
"p-cloudcache": [{

docs/docs/v2/security/jwt-authentication-in-asp.NET-WCF.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Resource Protection using JWT in ASP.NET Core
22

3-
This provider lets you control access to REST resources by using JWT tokens issued by Cloud Foundry Security services (such as [UAA Server](https://github.com/cloudfoundry/uaa) or [TAS Single-Sign-on](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/single-sign-on/1-16/sso/index.html)) in ASP.NET Core, ASP.NET WebAPI and WCF.
3+
This provider lets you control access to REST resources by using JWT tokens issued by Cloud Foundry Security services (such as [UAA Server](https://github.com/cloudfoundry/uaa) or [Single Sign-On](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/single-sign-on/1-16/sso/index.html)) in ASP.NET Core, ASP.NET WebAPI and WCF.
44

55
Other Steeltoe sample applications can help you understand how to use this tool, including:
66

@@ -57,7 +57,7 @@ The Steeltoe sample is set up to read from `appsettings.json`.
5757

5858
### Cloud Foundry
5959

60-
As mentioned earlier. you can use a couple of OAuth2 services (such as UAA Server or TAS SSO) on Cloud Foundry. Rather than explaining how to create and bind OAuth2 services to your app here, we recommend that you read the documentation provided by each of the service providers.
60+
As mentioned earlier. you can use a couple of OAuth2 services (such as UAA Server or Single Sign-On) on Cloud Foundry. Rather than explaining how to create and bind OAuth2 services to your app here, we recommend that you read the documentation provided by each of the service providers.
6161

6262
Regardless of which provider you choose, once the service is bound to your application, the settings are available in `VCAP_SERVICES`.
6363

docs/docs/v2/security/jwt-authentication-in-asp.NET-WebAPI.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Resource Protection using JWT in ASP.NET WebAPI
22

3-
This provider lets you control access to REST resources by using JWT tokens issued by Cloud Foundry Security services (such as [UAA Server](https://github.com/cloudfoundry/uaa) or [TAS Single-Sign-on](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/single-sign-on/1-16/sso/index.html)) in ASP.NET Core, ASP.NET WebAPI and WCF.
3+
This provider lets you control access to REST resources by using JWT tokens issued by Cloud Foundry Security services (such as [UAA Server](https://github.com/cloudfoundry/uaa) or [Single Sign-On](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/single-sign-on/1-16/sso/index.html)) in ASP.NET Core, ASP.NET WebAPI and WCF.
44

55
Other Steeltoe sample applications can help you understand how to use this tool, including:
66

@@ -61,13 +61,13 @@ The Steeltoe sample is set up to read from `appsettings.json`.
6161
6262
### Cloud Foundry
6363

64-
As mentioned earlier, there are two auth services (UAA Server and TAS SSO) on Cloud Foundry. Rather than explaining how to create and bind those services to your app here, we recommend that you read the documentation provided by each of the service providers.
64+
As mentioned earlier, there are two auth services (UAA Server and Single Sign-On) on Cloud Foundry. Rather than explaining how to create and bind those services to your app here, we recommend that you read the documentation provided by each of the service providers.
6565

6666
Regardless of which provider you choose, once the service is bound to your application, the settings are available in `VCAP_SERVICES`.
6767

6868
#### Add Cloud Foundry JwtAuthentication
6969

70-
In order to configure the Cloud Foundry OWIN JWT provider in your application, you will need an [OWIN Startup class](https://learn.microsoft.com/aspnet/aspnet/overview/owin-and-katana/owin-startup-class-detection) if you do not already have one, along with an `IConfigurationRoot` that includes a service binding for UAA or TAS SSO.
70+
In order to configure the Cloud Foundry OWIN JWT provider in your application, you will need an [OWIN Startup class](https://learn.microsoft.com/aspnet/aspnet/overview/owin-and-katana/owin-startup-class-detection) if you do not already have one, along with an `IConfigurationRoot` that includes a service binding for UAA or Single Sign-On.
7171

7272
```csharp
7373
using Owin;

docs/docs/v2/security/jwt-authentication-in-asp.NET-core.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Resource Protection using JWT in ASP.NET Core
22

3-
This provider lets you control access to REST resources by using JWT tokens issued by Cloud Foundry Security services (such as [UAA Server](https://github.com/cloudfoundry/uaa) or [TAS Single-Sign-on](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/single-sign-on/1-16/sso/index.html)) in ASP.NET Core, ASP.NET WebAPI and WCF.
3+
This provider lets you control access to REST resources by using JWT tokens issued by Cloud Foundry Security services (such as [UAA Server](https://github.com/cloudfoundry/uaa) or [Single Sign-On](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/single-sign-on/1-16/sso/index.html)) in ASP.NET Core, ASP.NET WebAPI and WCF.
44

55
Other Steeltoe sample applications can help you understand how to use this tool, including:
66

@@ -68,7 +68,7 @@ The samples and most templates are already set up to read from `appsettings.json
6868

6969
### Cloud Foundry
7070

71-
As mentioned earlier. you can use a couple of OAuth2 services (such as UAA Server or TAS SSO) on Cloud Foundry. Rather than explaining how to create and bind OAuth2 services to your app here, we recommend that you read the documentation provided by each of the service providers.
71+
As mentioned earlier. you can use a couple of OAuth2 services (such as UAA Server or Single Sign-On) on Cloud Foundry. Rather than explaining how to create and bind OAuth2 services to your app here, we recommend that you read the documentation provided by each of the service providers.
7272

7373
Regardless of which provider you choose, once the service is bound to your application, the settings are available in `VCAP_SERVICES`.
7474

docs/docs/v2/security/sso-oauth2.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Single Sign-on with OAuth2
22

3-
Single Sign-on with OAuth 2.0 enables you to leverage existing credentials configured in a [UAA Server](https://github.com/cloudfoundry/uaa) or [TAS Single-Sign-on service](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/single-sign-on/1-16/sso/index.html) for authentication and authorization in ASP.NET Core applications. Single signon functionality for ASP.NET 4.x applications is available with the OpenID Connect provider.
3+
Single Sign-on with OAuth 2.0 enables you to leverage existing credentials configured in a [UAA Server](https://github.com/cloudfoundry/uaa) or [Single Sign-On](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/single-sign-on/1-16/sso/index.html) for authentication and authorization in ASP.NET Core applications. Single signon functionality for ASP.NET 4.x applications is available with the OpenID Connect provider.
44

55
In addition to the Quick Start, you can use other Steeltoe sample applications to help you understand how to use this provider, including:
66

@@ -73,7 +73,7 @@ The Steeltoe OAuth2 security provider options are based on [`Microsoft.AspNetCor
7373

7474
### Cloud Foundry
7575

76-
As mentioned earlier, there are two OAuth-compatible services available on Cloud Foundry. We recommend you read the offical documentation ([UAA Server](https://github.com/cloudfoundry/uaa) and [TAS SSO](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/single-sign-on/1-16/sso/index.html)) or follow the instructions included in the samples for [UAA Server](https://github.com/SteeltoeOSS/Samples/blob/2.x/Security/src/AspDotNetCore/CloudFoundrySingleSignon/README.md) and [TAS SSO](https://github.com/SteeltoeOSS/Samples/blob/2.x/Security/src/AspDotNetCore/CloudFoundrySingleSignon/README-SSO.md) to quickly learn how to create and bind OAuth2 services.
76+
As mentioned earlier, there are two OAuth-compatible services available on Cloud Foundry. We recommend you read the offical documentation ([UAA Server](https://github.com/cloudfoundry/uaa) and [Single Sign-On](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/single-sign-on/1-16/sso/index.html)) or follow the instructions included in the samples for [UAA Server](https://github.com/SteeltoeOSS/Samples/blob/2.x/Security/src/AspDotNetCore/CloudFoundrySingleSignon/README.md) and [Single Sign-On](https://github.com/SteeltoeOSS/Samples/blob/2.x/Security/src/AspDotNetCore/CloudFoundrySingleSignon/README-SSO.md) to quickly learn how to create and bind OAuth2 services.
7777

7878
Regardless of which provider you choose, once the service is bound to your application, the settings are available in `VCAP_SERVICES`.
7979

docs/docs/v2/security/sso-open-id.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Single Sign-on with OpenID Connect
22

3-
Single Sign-on with OpenID Connect enables you to leverage existing credentials configured in a [UAA Server](https://github.com/cloudfoundry/uaa) or [TAS Single-Sign-on service](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/single-sign-on/1-16/sso/index.html) for authentication and authorization in ASP.NET 4.x (via OWIN middleware) and ASP.NET Core applications.
3+
Single Sign-on with OpenID Connect enables you to leverage existing credentials configured in a [UAA Server](https://github.com/cloudfoundry/uaa) or [Single Sign-On](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/single-sign-on/1-16/sso/index.html) for authentication and authorization in ASP.NET 4.x (via OWIN middleware) and ASP.NET Core applications.
44

55
## Usage
66

@@ -79,7 +79,7 @@ This full list of settings can also be configured, though `AuthDomain`, `ClientI
7979
8080
#### Cloud Foundry
8181

82-
As mentioned earlier, there are two ways to use OAuth2 services on Cloud Foundry. We recommend you read the offical documentation ([UAA Server](https://github.com/cloudfoundry/uaa) and [TAS SSO](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/single-sign-on/1-16/sso/index.html)) or follow the instructions included in the samples for [UAA Server](https://github.com/SteeltoeOSS/Samples/blob/2.x/Security/src/AspDotNet4/CloudFoundrySingleSignon/README.md) and [TAS SSO](https://github.com/SteeltoeOSS/Samples/blob/2.x/Security/src/AspDotNet4/CloudFoundrySingleSignon/README-SSO.md) to quickly learn how to create and bind OAuth2 services.
82+
As mentioned earlier, there are two ways to use OAuth2 services on Cloud Foundry. We recommend you read the offical documentation ([UAA Server](https://github.com/cloudfoundry/uaa) and [Single Sign-On](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/single-sign-on/1-16/sso/index.html)) or follow the instructions included in the samples for [UAA Server](https://github.com/SteeltoeOSS/Samples/blob/2.x/Security/src/AspDotNet4/CloudFoundrySingleSignon/README.md) and [Single Sign-On](https://github.com/SteeltoeOSS/Samples/blob/2.x/Security/src/AspDotNet4/CloudFoundrySingleSignon/README-SSO.md) to quickly learn how to create and bind OAuth2 services.
8383

8484
Regardless of which provider you choose, once the service is bound to your application, the settings are available in `VCAP_SERVICES`.
8585

@@ -120,7 +120,7 @@ namespace CloudFoundrySingleSignon
120120
}
121121
```
122122

123-
The `app.UseCloudFoundryOpenIdConnect` method call adds an authentication middleware that has been configured to work with UAA or TAS SSO to the OWIN Request pipeline.
123+
The `app.UseCloudFoundryOpenIdConnect` method call adds an authentication middleware that has been configured to work with UAA or Single Sign-On to the OWIN Request pipeline.
124124

125125
>TIP: This code is commonly refactored into a separate class (for example `Startup.Auth.cs`), particularly when there is additional configuration on the OWIN pipeline.
126126

0 commit comments

Comments
 (0)