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/articles/steeltoe-3-2-2-adds-kube-service-bindings.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ namespace PostgreSql

Running your application on a Kubernetes platform which supports the [Kubernetes Service Binding](https://github.com/servicebinding/spec) specification you should see configuration key/values appear in your applications configuration.

As an added feature, the Steeltoe team has added integration with the [Steeltoe Connectors](https://github.com/SteeltoeOSS/Steeltoe/tree/release/3.2/src/Connectors) library. This integration enables the Steeltoe Connectors library to pick up and use the configuration data built by the Kubernetes provider.
As an added feature, the Steeltoe team has added integration with the [Steeltoe Connectors](https://github.com/SteeltoeOSS/Steeltoe/tree/3.x/src/Connectors) library. This integration enables the Steeltoe Connectors library to pick up and use the configuration data built by the Kubernetes provider.

This feature is not enabled by default. To enable it you must edit your `appsettings.json` file and add the following configuration.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/v3/bootstrap/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Application Bootstrapping

In order to improve the Steeltoe developer experience, Steeltoe 3.1.0 added this new feature that allows the configuration of most Steeltoe components with a single line of code in your application. The package is named [`Steeltoe.Bootstrap.Autoconfig`](https://github.com/SteeltoeOSS/Steeltoe/tree/release/3.2/src/Bootstrap/src/Autoconfig), and it works by applying the same extensions that are already included in Steeltoe packages to automatically wire up each of those components.
In order to improve the Steeltoe developer experience, Steeltoe 3.1.0 added this new feature that allows the configuration of most Steeltoe components with a single line of code in your application. The package is named [`Steeltoe.Bootstrap.Autoconfig`](https://github.com/SteeltoeOSS/Steeltoe/tree/3.x/src/Bootstrap/src/Autoconfig), and it works by applying the same extensions that are already included in Steeltoe packages to automatically wire up each of those components.

Applications running on .NET Core 3.1+ and .NET 5.0+ are supported. Get started by adding a reference to the Autoconfig package (you may want to add other Steeltoe references at this point too, see [the table below](#supported-steeltoe-packages) for the full list of what's supported now):

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/v3/configuration/config-server-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ public class HomeController : Controller
Out of the box, configuration providers in .NET do not have access to the same logging infrastructure that is available to the rest of the application.

Logging in the Steeltoe Config Server Client is enabled when an `ILoggerFactory` has been provided.
Starting with version 3.2.0, when no `ILoggerFactory` is provided, Steeltoe automatically configures [UpgradableBootstrapLoggerFactory](https://github.com/SteeltoeOSS/Steeltoe/blob/release/3.2/src/Common/src/Common/Logging/UpgradableBootstrapLoggerFactory.cs). This `ILoggerFactory` can be automatically replaced by the runtime logging infrastructure after the application starts with a couple extra steps:
Starting with version 3.2.0, when no `ILoggerFactory` is provided, Steeltoe automatically configures [UpgradableBootstrapLoggerFactory](https://github.com/SteeltoeOSS/Steeltoe/blob/3.x/src/Common/src/Common/Logging/UpgradableBootstrapLoggerFactory.cs). This `ILoggerFactory` can be automatically replaced by the runtime logging infrastructure after the application starts with a couple extra steps:

1. Add a NuGet Package reference to `Steeltoe.Common.Hosting`.
1. Add the hosted service to the service container with this code:
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/v3/connectors/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ return Host.CreateDefaultBuilder(args)

While enhanced support will be provided in the next major version of Steeltoe, preliminary support for the [Service Binding Specification for Kubernetes](https://github.com/servicebinding/spec) was [added in the 3.2.2 release](../../../articles/steeltoe-3-2-2-adds-kube-service-bindings.md) with a new `IConfigurationProvider`.

The current version of `Steeltoe.Extensions.Configuration.Kubernetes.ServiceBinding` can read [many types of bindings](https://github.com/SteeltoeOSS/Steeltoe/blob/release/3.2/src/Configuration/src/Kubernetes.ServiceBinding/PostProcessors.cs) into configuration and will transform the bindings for MongoDb, MySQL, PostgreSQL, RabbitMQ and Redis into the formats required to work automatically with Steeltoe Connectors.
The current version of `Steeltoe.Extensions.Configuration.Kubernetes.ServiceBinding` can read [many types of bindings](https://github.com/SteeltoeOSS/Steeltoe/blob/3.x/src/Configuration/src/Kubernetes.ServiceBinding/PostProcessors.cs) into configuration and will transform the bindings for MongoDb, MySQL, PostgreSQL, RabbitMQ and Redis into the formats required to work automatically with Steeltoe Connectors.

In order to use Steeltoe's Service Bindings for Kubernetes, you need to do the following:

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

This logging provider extends the dynamic logging provider with [Serilog](https://serilog.net/). This allows logger levels configured via Serilog to be queried and modified at runtime via the loggers endpoint.

The source code for the Serilog Dynamic Logger can be found [here](https://github.com/SteeltoeOSS/steeltoe/tree/release/3.2/src/Logging/src/).
The source code for the Serilog Dynamic Logger can be found [here](https://github.com/SteeltoeOSS/steeltoe/tree/3.x/src/Logging/src).

A sample working project can be found [here](https://github.com/SteeltoeOSS/Samples/tree/3.x/Management/src/CloudFoundry).

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/v3/management/health.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ For any group that has been defined, you may access health information from the

Applications deployed on Kubernetes can provide information about their internal state with [Container Probes](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes). Depending on your [Kubernetes configuration](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/), the kubelet will call those probes and react to the result.

Steeltoe provides an [`ApplicationAvailability`](https://github.com/SteeltoeOSS/Steeltoe/blob/release/3.2/src/Common/src/Common/Availability/ApplicationAvailability.cs) class for managing various types of application state. Out of the box support is provided for Liveness and Readiness, where each are exposed in a corresponding `IHealthContributor` and Health Group.
Steeltoe provides an [`ApplicationAvailability`](https://github.com/SteeltoeOSS/Steeltoe/blob/3.x/src/Common/src/Common/Availability/ApplicationAvailability.cs) class for managing various types of application state. Out of the box support is provided for Liveness and Readiness, where each are exposed in a corresponding `IHealthContributor` and Health Group.

In order to change the health contributors that are included in either of the two default groups, use the same style of configuration seen above. Please note that this will _replace_ the default groupings, so if you would like to _add_ an `IHealthContributor` you will need to include the original entry. These entries demonstrate including disk space in both groups:

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/v3/messaging/rabbitmq-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ Alternatively, you could configure the same connection settings using the `Addre
>When specifying addresses as shown above, the `host` and `port` properties are ignored.
If the address uses the `amqps` protocol, SSL support is automatically enabled.

See [`RabbitOptions`](https://github.com/SteeltoeOSS/Steeltoe/blob/release/3.2/src/Messaging/src/RabbitMQ/Config/RabbitOptions.cs) for more of the supported options.
See [`RabbitOptions`](https://github.com/SteeltoeOSS/Steeltoe/blob/3.x/src/Messaging/src/RabbitMQ/Config/RabbitOptions.cs) for more of the supported options.

>TIP: See [Understanding AMQP, the protocol used by RabbitMQ](https://www.rabbitmq.com/tutorials/amqp-concepts.html) for more details.

Expand Down
12 changes: 6 additions & 6 deletions docs/docs/v3/messaging/rabbitmq-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -515,7 +515,7 @@ We will explore message sending and reception, respectively, in [Sending Message
### Adding Retry Capabilities

You can now configure the `RabbitTemplate` to use a `RetryTemplate` to help with handling problems with broker connectivity.
See the [Steeltoe Retry](https://github.com/SteeltoeOSS/Steeltoe/tree/release/3.2/src/Common/src/Common/Retry) framework for complete information.
See the [Steeltoe Retry](https://github.com/SteeltoeOSS/Steeltoe/tree/3.x/src/Common/src/Common/Retry) framework for complete information.
The following is only one example that uses a [Polly](http://www.thepollyproject.org/) based retry policy, which makes three tries before throwing the exception to the caller.

```csharp
Expand Down Expand Up @@ -2342,11 +2342,11 @@ Those methods are quite useful for request-reply scenarios, since they handle th

Similar request-reply methods are also available where the `IMessageConverter` is applied to both the request and reply.
Those methods are named `ConvertSendAndReceive`.
See the [`RabbitTemplate`](https://github.com/SteeltoeOSS/Steeltoe/blob/release/3.2/src/Messaging/src/RabbitMQ/Core/RabbitTemplate.cs) code for more detail.
See the [`RabbitTemplate`](https://github.com/SteeltoeOSS/Steeltoe/blob/3.x/src/Messaging/src/RabbitMQ/Core/RabbitTemplate.cs) code for more detail.

Each of the `SendAndReceive` method variants has an overloaded version that takes `CorrelationData`.
Together with a properly configured connection factory, this enables the receipt of publisher confirms for the send side of the operation.
See [Template Publisher Confirms and Returns](#template-publisher-confirms-and-returns) and the [`RabbitTemplate`](https://github.com/SteeltoeOSS/Steeltoe/blob/release/3.2/src/Messaging/src/RabbitMQ/Core/RabbitTemplate.cs) code for more detail.
See [Template Publisher Confirms and Returns](#template-publisher-confirms-and-returns) and the [`RabbitTemplate`](https://github.com/SteeltoeOSS/Steeltoe/blob/3.x/src/Messaging/src/RabbitMQ/Core/RabbitTemplate.cs) code for more detail.

You can configure the `RabbitTemplate` with the `NoLocalReplyConsumer` option to control a `noLocal` flag for the reply RabbitMQ Client `BasicConsume()` operation.
This is `false` by default.
Expand Down Expand Up @@ -2467,7 +2467,7 @@ If the reply queue is configured to send rejected messages to a dead letter exch
To do so, bind a queue to the configured dead letter exchange with a routing key equal to the reply queue's name.

See the [RabbitMQ Dead Letter Documentation](https://www.rabbitmq.com/dlx.html) for more information about configuring dead lettering.
You can also take a look at the [FixedReplyQueueDeadLetterTest](https://github.com/SteeltoeOSS/Steeltoe/blob/release/3.2/src/Messaging/test/RabbitMQ.Test/Core/FixedReplyQueueDeadLetterTest.cs) test case for an example.
You can also take a look at the [FixedReplyQueueDeadLetterTest](https://github.com/SteeltoeOSS/Steeltoe/blob/3.x/src/Messaging/test/RabbitMQ.Test/Core/FixedReplyQueueDeadLetterTest.cs) test case for an example.

## Configuring the Broker

Expand Down Expand Up @@ -2681,7 +2681,7 @@ var fooExchange = ExchangeBuilder.DirectExchange("foo")
.Build();
```

See the code for [QueueBuilder](https://github.com/SteeltoeOSS/Steeltoe/blob/release/3.2/src/Messaging/src/RabbitMQ/Config/QueueBuilder.cs) and [ExchangeBuilder](https://github.com/SteeltoeOSS/Steeltoe/blob/release/3.2/src/Messaging/src/RabbitMQ/Config/ExchangeBuilder.cs) for more information.
See the code for [QueueBuilder](https://github.com/SteeltoeOSS/Steeltoe/blob/3.x/src/Messaging/src/RabbitMQ/Config/QueueBuilder.cs) and [ExchangeBuilder](https://github.com/SteeltoeOSS/Steeltoe/blob/3.x/src/Messaging/src/RabbitMQ/Config/ExchangeBuilder.cs) for more information.

The `ExchangeBuilder` creates durable exchanges by default, to be consistent with the simple constructors on the individual `AbstractExchange` classes.
To make a non-durable exchange with the builder, use `.Durable(false)` before invoking `.Build()`.
Expand Down Expand Up @@ -3060,7 +3060,7 @@ Since 2.7.0, rejected messages go to the front of the queue, in a similar manner

### Using RabbitTransactionManager

The [RabbitTransactionManager](https://github.com/SteeltoeOSS/Steeltoe/blob/release/3.2/src/Messaging/src/RabbitMQ/Transaction/RabbitTransactionManager.cs) is the only `IPlatformTransactionManager` supported at this point.
The [RabbitTransactionManager](https://github.com/SteeltoeOSS/Steeltoe/blob/3.x/src/Messaging/src/RabbitMQ/Transaction/RabbitTransactionManager.cs) is the only `IPlatformTransactionManager` supported at this point.
This transaction manager is an implementation of the [`IPlatformTransactionManager`] interface and should be used with a single RabbitMQ `IConnectionFactory`.

>IMPORTANT: This strategy is not able to provide XA transactions - for example, in order to share transactions between messaging and database access.
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/v4/configuration/config-server-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Spring Cloud Config Server is an application configuration service that give

To gain a better understanding of the Spring Cloud Config Server, you should read the [Spring Cloud Config documentation](https://spring.io/projects/spring-cloud-config).

In addition to the Quick Start provided later, you can refer to the [Steeltoe ConfigurationProviders](https://github.com/SteeltoeOSS/Samples/tree/main/Configuration/src/ConfigurationProviders) sample application when you need to understand how to use this provider.
In addition to the Quick Start provided later, you can refer to the [Steeltoe ConfigurationProviders](https://github.com/SteeltoeOSS/Samples/tree/4.x/Configuration/src/ConfigurationProviders) sample application when you need to understand how to use this provider.

## Using the Config Server Provider

Expand Down Expand Up @@ -129,7 +129,7 @@ builder.AddConfigServer();

### Bind to Cloud Foundry

When you want to use a Config Server on Cloud Foundry and you have installed [Spring Cloud Services](https://github.com/SteeltoeOSS/Samples/blob/main/CommonTasks.md#provision-sccs-on-cloud-foundry), you can create and bind an instance of it to your application by using the Cloud Foundry CLI.
When you want to use a Config Server on Cloud Foundry and you have installed [Spring Cloud Services](https://github.com/SteeltoeOSS/Samples/blob/4.x/CommonTasks.md#provision-sccs-on-cloud-foundry), you can create and bind an instance of it to your application by using the Cloud Foundry CLI.

1. Create a Config Server instance:

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/v4/connectors/cosmosdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,4 +122,4 @@ To retrieve data from CosmosDB in your app, use the following steps:
}
```

A complete sample app that uses `CosmosClient` is provided at https://github.com/SteeltoeOSS/Samples/tree/main/Connectors/src/CosmosDb.
A complete sample app that uses `CosmosClient` is provided at https://github.com/SteeltoeOSS/Samples/tree/4.x/Connectors/src/CosmosDb.
2 changes: 1 addition & 1 deletion docs/docs/v4/connectors/microsoft-sql-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ you can inject it and use it in a controller or view:
}
```

A complete sample app that uses Entity Framework Core with SQL Server is provided at https://github.com/SteeltoeOSS/Samples/tree/main/Connectors/src/SqlServerEFCore.
A complete sample app that uses Entity Framework Core with SQL Server is provided at https://github.com/SteeltoeOSS/Samples/tree/4.x/Connectors/src/SqlServerEFCore.

## Cloud Foundry

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/v4/connectors/mongodb.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The remainder of this topic assumes that you are familiar with the basic concept

To use this connector:

1. Create a MongoDB server instance or use a [docker container](https://github.com/SteeltoeOSS/Samples/blob/main/CommonTasks.md#mongodb).
1. Create a MongoDB server instance or use a [docker container](https://github.com/SteeltoeOSS/Samples/blob/4.x/CommonTasks.md#mongodb).
1. Add NuGet references to your project.
1. Configure your connection string in `appsettings.json`.
1. Initialize the Steeltoe Connector at startup.
Expand Down Expand Up @@ -98,7 +98,7 @@ builder.AddMongoDb();
}
```

A complete sample app that uses `IMongoClient` is provided at https://github.com/SteeltoeOSS/Samples/tree/main/Connectors/src/MongoDb.
A complete sample app that uses `IMongoClient` is provided at https://github.com/SteeltoeOSS/Samples/tree/4.x/Connectors/src/MongoDb.

## Cloud Foundry

Expand Down Expand Up @@ -131,4 +131,4 @@ You can create and bind an instance to your application by using the Cloud Found
This Connector supports the [Service Binding Specification for Kubernetes](https://github.com/servicebinding/spec).
It can be used through the [Services Toolkit](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-application-platform/1-12/tap/services-toolkit-install-services-toolkit.html).

For details on how to use this, see the instructions at https://github.com/SteeltoeOSS/Samples/tree/main/Connectors/src/MongoDb#running-on-tanzu-platform-for-kubernetes.
For details on how to use this, see the instructions at https://github.com/SteeltoeOSS/Samples/tree/4.x/Connectors/src/MongoDb#running-on-tanzu-platform-for-kubernetes.
8 changes: 4 additions & 4 deletions docs/docs/v4/connectors/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The remainder of this topic assumes that you are familiar with the basic concept

To use this connector:

1. Create a MySQL server instance or use a [docker container](https://github.com/SteeltoeOSS/Samples/blob/main/CommonTasks.md#mysql).
1. Create a MySQL server instance or use a [docker container](https://github.com/SteeltoeOSS/Samples/blob/4.x/CommonTasks.md#mysql).
1. Add NuGet references to your project.
1. Configure your connection string in `appsettings.json`.
1. Initialize the Steeltoe Connector at startup.
Expand Down Expand Up @@ -90,7 +90,7 @@ public class HomeController : Controller
}
```

A complete sample app that uses `MySqlConnection` is provided at https://github.com/SteeltoeOSS/Samples/tree/main/Connectors/src/MySql.
A complete sample app that uses `MySqlConnection` is provided at https://github.com/SteeltoeOSS/Samples/tree/4.x/Connectors/src/MySql.

### Use Entity Framework Core

Expand Down Expand Up @@ -146,7 +146,7 @@ you can inject it and use it in a controller or view:
}
```

A complete sample app that uses Entity Framework Core with MySQL is provided at https://github.com/SteeltoeOSS/Samples/tree/main/Connectors/src/MySqlEFCore.
A complete sample app that uses Entity Framework Core with MySQL is provided at https://github.com/SteeltoeOSS/Samples/tree/4.x/Connectors/src/MySqlEFCore.

## Cloud Foundry

Expand Down Expand Up @@ -181,4 +181,4 @@ You can create and bind an instance to your application by using the Cloud Found
This Connector supports the [Service Binding Specification for Kubernetes](https://github.com/servicebinding/spec).
It can be used through the [Services Toolkit](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-application-platform/1-12/tap/services-toolkit-install-services-toolkit.html).

For details on how to use this, see the instructions at https://github.com/SteeltoeOSS/Samples/tree/main/Connectors/src/MySql#running-on-tanzu-platform-for-kubernetes.
For details on how to use this, see the instructions at https://github.com/SteeltoeOSS/Samples/tree/4.x/Connectors/src/MySql#running-on-tanzu-platform-for-kubernetes.
Loading