Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/v2/connectors/gemfire.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ cf bind-service myApp myPCCService
cf restage myApp
```

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-geode-native-docs-dotnet-regions-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:
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-geode-native-docs-dotnet-regions-regions.html), use the [gfsh CLI](https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-gemfire/10-3/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:

```json
"p-cloudcache": [{
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/v2/connectors/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ cf bind-service myApp myMySqlService
cf restage myApp
```

>NOTE: The preceding commands assume you use [Tanzu for MySQL](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/tanzu-mysql-tanzu-platform/10-1/mysql-tp/index.html), provided by Tanzu Platform. If you use a different service, you must adjust the `create-service` command to fit your environment.
>NOTE: The preceding commands assume you use [Tanzu for MySQL](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/tanzu-mysql-tanzu-platform/11-0/mysql-tp/index.html), provided by Tanzu Platform. If you use a different service, you must adjust the `create-service` command to fit your environment.

Version 2.1.1+ of this connector works with the [Open Service Broker for Azure](https://github.com/Azure/open-service-broker-azure) (archived). Be sure to set `mysql:client:urlEncodedCredentials` to `true` as this broker may provide credentials that have been URL Encoded.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/v2/fileshares/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Steeltoe's `WindowsNetworkFileShare` provides a simplified experience for interacting with SMB file shares by making [P/Invoke calls](https://learn.microsoft.com/cpp/dotnet/how-to-call-native-dlls-from-managed-code-using-pinvoke) to underlying Windows APIs, specifically to `mpr.dll`. For more background on SMB, see [Microsoft's SMB documentation](https://learn.microsoft.com/windows/win32/fileio/microsoft-smb-protocol-and-cifs-protocol-overview)

Network shares are not the most cloud-native way to deal with files. For new development consider exploring message queues, caches, blob stores, and/or NoSQL stores. The alternatives offer greater resiliency and decoupling from backing services. With that said, sometimes the alternatives aren't viable. We're not here to judge you. For .NET applications deployed to Microsoft Windows Servers, Steeltoe provides a stepping stone towards cloud-native in the form of the `WindowsNetworkFileShare`. For applications deployed to Linux hosts on TAS, [volume services](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/10-3/eart/services-using-vol-services.html) is available.
Network shares are not the most cloud-native way to deal with files. For new development consider exploring message queues, caches, blob stores, and/or NoSQL stores. The alternatives offer greater resiliency and decoupling from backing services. With that said, sometimes the alternatives aren't viable. We're not here to judge you. For .NET applications deployed to Microsoft Windows Servers, Steeltoe provides a stepping stone towards cloud-native in the form of the `WindowsNetworkFileShare`. For applications deployed to Linux hosts on TAS, [volume services](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/11-0/eart/services-using-vol-services.html) is available.
2 changes: 1 addition & 1 deletion docs/docs/v2/logging/dynamic-logging-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This logging provider is a wrapper around the [Microsoft Console Logging](https://github.com/aspnet/Logging) provider. This wrapper allows for querying the currently defined loggers and their levels as well as then modifying the levels dynamically at runtime.

For more information on how to use [Apps Manager](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/10-3/eart/dev-console.html) on Cloud Foundry for viewing and modifying logging levels, see the Using Actuators with Apps Manager section of the Tanzu Platform documentation.
For more information on how to use [Apps Manager](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/11-0/eart/dev-console.html) on Cloud Foundry for viewing and modifying logging levels, see the Using Actuators with Apps Manager section of the Tanzu Platform documentation.

> NOTE: The Apps Manager integration involves sending the fully-qualified logger name over HTTP. Avoid using colons in the name of a logger to prevent invalid HTTP Requests.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/v2/logging/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Steeltoe adds a Logging provider to the set of available logging packages in order to support the Steeltoe Management Logger endpoint.

When used with the Steeltoe Logger Management endpoint, this package enables dynamically changing the logging levels for running applications with the [Apps Manager](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/10-3/eart/dev-console.html) on Cloud Foundry.
When used with the Steeltoe Logger Management endpoint, this package enables dynamically changing the logging levels for running applications with the [Apps Manager](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/11-0/eart/dev-console.html) on Cloud Foundry.
2 changes: 1 addition & 1 deletion docs/docs/v2/management/dump.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Steeltoe thread dump endpoint can be used to generate a snapshot of information about all the threads in your application. That snapshot includes several bits of information for each thread, including the thread's state, a stack trace, any monitor locks held by the thread, any monitor locks the thread is waiting on, and other details.

>NOTE: At this time, thread dumps are only possible on the Windows operating system. When integrating with the [Apps Manager](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/10-3/eart/dev-console.html), you will not have the ability to obtain thread dumps from apps running on Linux cells.
>NOTE: At this time, thread dumps are only possible on the Windows operating system. When integrating with the [Apps Manager](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/11-0/eart/dev-console.html), you will not have the ability to obtain thread dumps from apps running on Linux cells.

## Configure Settings

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/v2/management/heapdump.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Steeltoe heap dump endpoint can be used to generate and download a mini-dump of your application. The mini-dump can then be read into Visual Studio for analysis.

>NOTE: At this time, dumps are only possible on the Windows operating system. When integrating with the [Apps Manager](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/10-3/eart/dev-console.html), you will not have the ability to obtain dumps from apps running on Linux cells. For older versions of Apps Manager, there was a bug where the heap dump filename ends with the `.hprof` extension instead of the usual `.dmp` extension. This may cause problems when opening the dump with Visual Studio or some other diagnostic tool. As a workaround, you can rename the file to use the `.dmp` extension. Furthermore, heap dumps from Steeltoe are always gzipped and are expected to be returned with a `.gz` on the end. If the file you receive does not include `.gz`, you should manually change the extension to `.dmp.gz` and unzip the file before attempting to open it, or else you are likely to receive a compatibility error.
>NOTE: At this time, dumps are only possible on the Windows operating system. When integrating with the [Apps Manager](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/11-0/eart/dev-console.html), you will not have the ability to obtain dumps from apps running on Linux cells. For older versions of Apps Manager, there was a bug where the heap dump filename ends with the `.hprof` extension instead of the usual `.dmp` extension. This may cause problems when opening the dump with Visual Studio or some other diagnostic tool. As a workaround, you can rename the file to use the `.dmp` extension. Furthermore, heap dumps from Steeltoe are always gzipped and are expected to be returned with a `.gz` on the end. If the file you receive does not include `.gz`, you should manually change the extension to `.dmp.gz` and unzip the file before attempting to open it, or else you are likely to receive a compatibility error.

## Configure Settings

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/v2/management/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ dotnet add package Steeltoe.Management.ExporterCore --version 2.*

The Metrics Forwarder for TAS (discontinued) is a service that allows apps to emit metrics to the [Loggregator](https://docs.cloudfoundry.org/loggregator/architecture.html) system and consume those metrics from the [Loggregator Firehose](https://docs.cloudfoundry.org/loggregator/architecture.html#-loggregator-firehose-architecture).

You can interact with the service through the Cloud Foundry Command Line Interface (cf CLI), [Apps Manager](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/10-3/eart/dev-console.html), and an HTTP API. See the Tanzu Platform documentation for details on how to use the service in your application.
You can interact with the service through the Cloud Foundry Command Line Interface (cf CLI), [Apps Manager](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/11-0/eart/dev-console.html), and an HTTP API. See the Tanzu Platform documentation for details on how to use the service in your application.

Metrics Forwarder for TAS (discontinued) enables users to do the following:

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/v2/management/prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ dotnet add package Steeltoe.Management.EndpointCore --version 2.*

## Cloud Foundry Forwarder

The Metrics Forwarder for TAS is no longer supported on Tanzu Application Service (TAS) v2.5 and later. To emit custom metrics on PAS v2.5 or later, use the [Metric Registrar](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/10-3/eart/metric-registrar-index.html) to emit metrics to [Loggregator](https://docs.cloudfoundry.org/loggregator/architecture.html).
The Metrics Forwarder for TAS is no longer supported on Tanzu Application Service (TAS) v2.5 and later. To emit custom metrics on PAS v2.5 or later, use the [Metric Registrar](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/11-0/eart/metric-registrar-index.html) to emit metrics to [Loggregator](https://docs.cloudfoundry.org/loggregator/architecture.html).

To register your endpoint for metrics collection install the metrics-registrar plugin and use it to register your endpoint.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/v2/management/using-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The following table describes the available Steeltoe management endpoints that c

Each endpoint has an associated ID. When you want to expose that endpoint over HTTP, that ID is used in the mapped URL that exposes the endpoint. For example, the `health` endpoint below is mapped to `/health`.

>NOTE: When you want to integrate with the [Apps Manager](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/10-3/eart/dev-console.html), you need to configure the global management path prefix to be `/cloudfoundryapplication`. To do so, add `management:endpoints:path=/cloudfoundryapplication` to your configuration.
>NOTE: When you want to integrate with the [Apps Manager](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/11-0/eart/dev-console.html), you need to configure the global management path prefix to be `/cloudfoundryapplication`. To do so, add `management:endpoints:path=/cloudfoundryapplication` to your configuration.

## Add NuGet References

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/v2/security/credhub-api-client.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CredHub API Client

[CredHub](https://github.com/cloudfoundry/credhub) manages credentials such as passwords, certificates, certificate authorities, ssh keys, rsa keys, and other arbitrary values. Steeltoe provides the `CredHubBase` library for interacting with the [CredHub API](https://docs.cloudfoundry.org/api/credhub/version/main/) and provides the `CredHubCore` library for making that client library simpler to use in ASP.NET Core applications. Cloud Foundry is not required for the CredHub server or client but is used in this documentation as the hosting environment. You may wish to review the documentation for [CredHub on Tanzu Platform](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/10-3/eart/credhub-index.html). If you do not already have a UAA user to use for this test, you will need to use the UAA command line tool to establish some security credentials for the sample app. Choose one of the provided `credhub-setup` scripts in the folder `samples/Security/scripts` to target your Cloud Foundry environment and create a UAA client with permissions to read and write in CredHub.
[CredHub](https://github.com/cloudfoundry/credhub) manages credentials such as passwords, certificates, certificate authorities, ssh keys, rsa keys, and other arbitrary values. Steeltoe provides the `CredHubBase` library for interacting with the [CredHub API](https://docs.cloudfoundry.org/api/credhub/version/main/) and provides the `CredHubCore` library for making that client library simpler to use in ASP.NET Core applications. Cloud Foundry is not required for the CredHub server or client but is used in this documentation as the hosting environment. You may wish to review the documentation for [CredHub on Tanzu Platform](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/11-0/eart/credhub-index.html). If you do not already have a UAA user to use for this test, you will need to use the UAA command line tool to establish some security credentials for the sample app. Choose one of the provided `credhub-setup` scripts in the folder `samples/Security/scripts` to target your Cloud Foundry environment and create a UAA client with permissions to read and write in CredHub.

>NOTE: If you choose to change the values for `UAA_CLIENT_ID` or `UAA_CLIENT_SECRET`, be sure to update the credentials in appsettings.json

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/v3/connectors/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ cf bind-service myApp myMySqlService
cf restage myApp
```

>The preceding commands assume you use [Tanzu for MySQL](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/tanzu-mysql-tanzu-platform/10-1/mysql-tp/index.html), provided by Tanzu Platform. If you use a different service, you must adjust the `create-service` command to fit your environment.
>The preceding commands assume you use [Tanzu for MySQL](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/tanzu-mysql-tanzu-platform/11-0/mysql-tp/index.html), provided by Tanzu Platform. If you use a different service, you must adjust the `create-service` command to fit your environment.

This connector also works with the [Open Service Broker for Azure](https://github.com/Azure/open-service-broker-azure) (archived).

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/v3/fileshares/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Steeltoe's `WindowsNetworkFileShare` provides a simplified experience for interacting with SMB file shares by making [P/Invoke calls](https://learn.microsoft.com/cpp/dotnet/how-to-call-native-dlls-from-managed-code-using-pinvoke) to underlying Windows APIs, specifically to `mpr.dll`. For more background on SMB, see [Microsoft's SMB documentation](https://learn.microsoft.com/windows/win32/fileio/microsoft-smb-protocol-and-cifs-protocol-overview)

Network shares are not the most cloud-native way to deal with files. For new development, consider exploring message queues, caches, blob stores, and NoSQL stores. The alternatives offer greater resiliency and decoupling from backing services. That said, sometimes the alternatives are not viable. For .NET applications deployed to Microsoft Windows Servers, Steeltoe provides a stepping stone towards cloud-native in the form of the `WindowsNetworkFileShare`. For applications deployed to Linux hosts on TAS, [volume services](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/10-3/eart/services-using-vol-services.html) are available.
Network shares are not the most cloud-native way to deal with files. For new development, consider exploring message queues, caches, blob stores, and NoSQL stores. The alternatives offer greater resiliency and decoupling from backing services. That said, sometimes the alternatives are not viable. For .NET applications deployed to Microsoft Windows Servers, Steeltoe provides a stepping stone towards cloud-native in the form of the `WindowsNetworkFileShare`. For applications deployed to Linux hosts on TAS, [volume services](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/11-0/eart/services-using-vol-services.html) are available.
2 changes: 1 addition & 1 deletion docs/docs/v3/management/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ In addition, the following settings can be used to set the application and servi

### Tanzu Application Service (TAS for VMs)

To emit custom metrics on TAS for VMs v2.5 or later, use the [Metric Registrar](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/10-3/eart/metric-registrar-index.html) to emit metrics to [Loggregator](https://docs.cloudfoundry.org/loggregator/architecture.html).
To emit custom metrics on TAS for VMs v2.5 or later, use the [Metric Registrar](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/11-0/eart/metric-registrar-index.html) to emit metrics to [Loggregator](https://docs.cloudfoundry.org/loggregator/architecture.html).

To register your endpoint for metrics collection, install the metrics-registrar plugin and use it to register your endpoint:

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/v3/management/threaddump.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Steeltoe thread dump endpoint can be used to generate a snapshot of information about all the threads in your application. That snapshot includes several bits of information for each thread, including the thread's state, a stack trace, any monitor locks held by the thread, any monitor locks the thread is waiting on, and other details.

>NOTE: At this time, thread dumps are only possible on the Windows operating system. When integrating with the [Apps Manager](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/10-3/eart/dev-console.html), you will not have the ability to obtain thread dumps from apps running on Linux cells.
>NOTE: At this time, thread dumps are only possible on the Windows operating system. When integrating with the [Apps Manager](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/elastic-application-runtime/11-0/eart/dev-console.html), you will not have the ability to obtain thread dumps from apps running on Linux cells.

## Configure Settings

Expand Down
Loading
Loading