Skip to content

Commit 721e550

Browse files
authored
Update configuration schema and links for Steeltoe 4.0.0 (#404)
* Update configuration schema for Steeltoe 4.0.0 * Update Steeltoe code/sample links to matching branches
1 parent b86b54d commit 721e550

File tree

28 files changed

+1976
-2620
lines changed

28 files changed

+1976
-2620
lines changed

docs/articles/steeltoe-3-2-2-adds-kube-service-bindings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ namespace PostgreSql
8686

8787
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.
8888

89-
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.
89+
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.
9090

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

docs/docs/v3/bootstrap/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Application Bootstrapping
22

3-
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.
3+
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.
44

55
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):
66

docs/docs/v3/configuration/config-server-provider.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ public class HomeController : Controller
260260
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.
261261

262262
Logging in the Steeltoe Config Server Client is enabled when an `ILoggerFactory` has been provided.
263-
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:
263+
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:
264264

265265
1. Add a NuGet Package reference to `Steeltoe.Common.Hosting`.
266266
1. Add the hosted service to the service container with this code:

docs/docs/v3/connectors/usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ return Host.CreateDefaultBuilder(args)
100100

101101
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`.
102102
103-
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.
103+
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.
104104
105105
In order to use Steeltoe's Service Bindings for Kubernetes, you need to do the following:
106106

docs/docs/v3/logging/serilog-logger.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
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.
44

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

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

docs/docs/v3/management/health.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ For any group that has been defined, you may access health information from the
125125

126126
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.
127127

128-
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.
128+
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.
129129

130130
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:
131131

docs/docs/v3/messaging/rabbitmq-intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ Alternatively, you could configure the same connection settings using the `Addre
239239
>When specifying addresses as shown above, the `host` and `port` properties are ignored.
240240
If the address uses the `amqps` protocol, SSL support is automatically enabled.
241241

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

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

docs/docs/v3/messaging/rabbitmq-reference.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -515,7 +515,7 @@ We will explore message sending and reception, respectively, in [Sending Message
515515
### Adding Retry Capabilities
516516

517517
You can now configure the `RabbitTemplate` to use a `RetryTemplate` to help with handling problems with broker connectivity.
518-
See the [Steeltoe Retry](https://github.com/SteeltoeOSS/Steeltoe/tree/release/3.2/src/Common/src/Common/Retry) framework for complete information.
518+
See the [Steeltoe Retry](https://github.com/SteeltoeOSS/Steeltoe/tree/3.x/src/Common/src/Common/Retry) framework for complete information.
519519
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.
520520

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

23432343
Similar request-reply methods are also available where the `IMessageConverter` is applied to both the request and reply.
23442344
Those methods are named `ConvertSendAndReceive`.
2345-
See the [`RabbitTemplate`](https://github.com/SteeltoeOSS/Steeltoe/blob/release/3.2/src/Messaging/src/RabbitMQ/Core/RabbitTemplate.cs) code for more detail.
2345+
See the [`RabbitTemplate`](https://github.com/SteeltoeOSS/Steeltoe/blob/3.x/src/Messaging/src/RabbitMQ/Core/RabbitTemplate.cs) code for more detail.
23462346
23472347
Each of the `SendAndReceive` method variants has an overloaded version that takes `CorrelationData`.
23482348
Together with a properly configured connection factory, this enables the receipt of publisher confirms for the send side of the operation.
2349-
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.
2349+
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.
23502350
23512351
You can configure the `RabbitTemplate` with the `NoLocalReplyConsumer` option to control a `noLocal` flag for the reply RabbitMQ Client `BasicConsume()` operation.
23522352
This is `false` by default.
@@ -2467,7 +2467,7 @@ If the reply queue is configured to send rejected messages to a dead letter exch
24672467
To do so, bind a queue to the configured dead letter exchange with a routing key equal to the reply queue's name.
24682468

24692469
See the [RabbitMQ Dead Letter Documentation](https://www.rabbitmq.com/dlx.html) for more information about configuring dead lettering.
2470-
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.
2470+
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.
24712471
24722472
## Configuring the Broker
24732473

@@ -2681,7 +2681,7 @@ var fooExchange = ExchangeBuilder.DirectExchange("foo")
26812681
.Build();
26822682
```
26832683

2684-
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.
2684+
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.
26852685
26862686
The `ExchangeBuilder` creates durable exchanges by default, to be consistent with the simple constructors on the individual `AbstractExchange` classes.
26872687
To make a non-durable exchange with the builder, use `.Durable(false)` before invoking `.Build()`.
@@ -3060,7 +3060,7 @@ Since 2.7.0, rejected messages go to the front of the queue, in a similar manner
30603060

30613061
### Using RabbitTransactionManager
30623062

3063-
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.
3063+
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.
30643064
This transaction manager is an implementation of the [`IPlatformTransactionManager`] interface and should be used with a single RabbitMQ `IConnectionFactory`.
30653065

30663066
>IMPORTANT: This strategy is not able to provide XA transactions - for example, in order to share transactions between messaging and database access.

docs/docs/v4/configuration/config-server-provider.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The Spring Cloud Config Server is an application configuration service that give
66

77
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).
88

9-
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.
9+
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.
1010

1111
## Using the Config Server Provider
1212

@@ -129,7 +129,7 @@ builder.AddConfigServer();
129129

130130
### Bind to Cloud Foundry
131131

132-
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.
132+
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.
133133

134134
1. Create a Config Server instance:
135135

docs/docs/v4/connectors/cosmosdb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,4 +122,4 @@ To retrieve data from CosmosDB in your app, use the following steps:
122122
}
123123
```
124124

125-
A complete sample app that uses `CosmosClient` is provided at https://github.com/SteeltoeOSS/Samples/tree/main/Connectors/src/CosmosDb.
125+
A complete sample app that uses `CosmosClient` is provided at https://github.com/SteeltoeOSS/Samples/tree/4.x/Connectors/src/CosmosDb.

0 commit comments

Comments
 (0)