Skip to content

Commit

Permalink
Merge pull request #1383 from cherrycl/issue-1382
Browse files Browse the repository at this point in the history
fix: Replace release version 3.2 with 4.0
  • Loading branch information
cloudxxx8 authored Oct 23, 2024
2 parents 5d8585e + 54b3d87 commit f2be343
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 21 deletions.
4 changes: 2 additions & 2 deletions docs_src/api/core/Ch-APICoreConfigurationAndRegistry.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

EdgeX uses the 3rd party Consul microservice as the implementations for Configuration and Registry. The RESTful APIs are provided by Consul directly, and several communities supply Consul client libraries for different programming languages, including Go (official), Python, Java, PHP, Scala, Erlang/OTP, Ruby, Node.js, and C\#.

!!! edgey - "EdgeX 3.2"
After v3.2, we added a new Configuration and Registry Service, Core Keeper, and the APIs is under [Core Keeper API documents](Ch-APICoreKeeper.md)
!!! edgey - "EdgeX 4.0"
After v4.0, we added a new Configuration and Registry Service, Core Keeper, and the APIs is under [Core Keeper API documents](Ch-APICoreKeeper.md)

For the client libraries of different languages, please refer to the
list on this page:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -307,8 +307,8 @@ The `URLFormatter` option allows you to override the default formatter with your
...
```

!!! edgey - "EdgeX 3.2"
ConnectToBroker is new in EdgeX 3.2
!!! edgey - "EdgeX 4.0"
ConnectToBroker is new in EdgeX 4.0

!!! example - "Subscribe from MQTT Broker"
```go
Expand All @@ -328,8 +328,8 @@ The `URLFormatter` option allows you to override the default formatter with your
}
```

!!! edgey - "EdgeX 3.2"
SetOnConnectHandler is new in EdgeX 3.2
!!! edgey - "EdgeX 4.0"
SetOnConnectHandler is new in EdgeX 4.0

```go
type MQTTSecretConfig struct {
Expand Down Expand Up @@ -378,8 +378,8 @@ type WillConfig struct {
}
```

!!! edgey - "EdgeX 3.2"
MaxReconnectInterval setting is new in EdgeX 3.2
!!! edgey - "EdgeX 4.0"
MaxReconnectInterval setting is new in EdgeX 4.0

See [MQTT Last Will](https://cedalo.com/blog/mqtt-last-will-explained-and-example) for more details on MQTT Last Will capability.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -212,8 +212,8 @@ This environment variable overrides the [`-o/--overwrite` command-line option](.
EDGEX_OVERWRITE_CONFIG: "true"
```

!!! edgey "EdgeX 3.2"
The `EDGEX_OVERWRITE_CONFIG` variable is new to EdgeX 3.2.
!!! edgey "EdgeX 4.0"
The `EDGEX_OVERWRITE_CONFIG` variable is new to EdgeX 4.0.

## Configuration Overrides

Expand All @@ -223,8 +223,8 @@ This environment variable overrides the [`-o/--overwrite` command-line option](.
!!! important - "Configuration Provider is the **System of Record** for all configurations"
When using the Configuration Provider, it is the **System of Record** for all configurations. Environment variables are only applied when the configuration is first read from file. These overridden values are used to seed the services' configuration into the Configuration Provider. Once the Configuration Provider has been seeded, services always get their configuration from the Configuration Provider on start up. Any subsequent changes to configuration must be done via the Configuration Provider. Changing an environment variable override for configuration and restating the service will not impact the service's configuration. The services configuration must first be removed from the Configuration Provider for any new/updated environment variable override(s) to impact the service's configuration.

!!! edgex - "EdgeX 3.2"
New in EdgeX 3.2. When overwrite configuration flag is used, either add the command line flag -o/--overwrite or the environment variable `EDGEX_OVERWRITE_CONFIG` is set to true, the local configuration file and the environment variable overrides will be pushed to the Configuration Provider. The environment variables for configuration overrides become the highest precedence again.
!!! edgex - "EdgeX 4.0"
New in EdgeX 4.0. When overwrite configuration flag is used, either add the command line flag -o/--overwrite or the environment variable `EDGEX_OVERWRITE_CONFIG` is set to true, the local configuration file and the environment variable overrides will be pushed to the Configuration Provider. The environment variables for configuration overrides become the highest precedence again.

### Service Configuration Overrides

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@

The EdgeX registry and configuration service provides other EdgeX Foundry micro services with information about associated services within EdgeX Foundry (such as location and status) and configuration properties (i.e. - a repository of initialization and operating values). Today, EdgeX Foundry uses [Consul by Hashicorp](https://www.consul.io/) as its reference implementation configuration and registry providers. However, abstractions are in place so that these functions could be provided by an alternate implementation. In fact, registration and configuration could be provided by different services under the covers. For more, see the [Configuration Provider](ConfigurationAndRegistry.md#configuration-provider) and [Registry Provider](ConfigurationAndRegistry.md#registry-provider) sections in this page.

!!! edgey - "EdgeX 3.2"
After v3.2, we added a new Configuration and Registry Service, Core Keeper.
!!! edgey - "EdgeX 4.0"
After v4.0, we added a new Configuration and Registry Service, Core Keeper.

## Configuration

Expand Down
4 changes: 2 additions & 2 deletions docs_src/microservices/device/sdk/DeviceSystemEvents.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ If an error occurs, the SDK reports a system event with a status of -1 to show f

## System Event DTO

!!! edgey - "EdgeX 3.2"
System Event actions `discovery`, and `profilescan` are new in EdgeX 3.2
!!! edgey - "EdgeX 4.0"
System Event actions `discovery`, and `profilescan` are new in EdgeX 4.0

The System Event DTO for the Device Service SDK APIs has the following properties:

Expand Down
4 changes: 2 additions & 2 deletions docs_src/microservices/support/cronScheduler/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ Below are only the additional settings and sections that are specific to Support
|Timeout|5s|DB connection timeout|
|Type|postgres|Indicates the type of database to use, only postgres is supported for this release|

!!! edgey "EdgeX 3.2"
For EdgeX 3.2 the Support Cron Scheduler service only supports `postgres` as persistence layer.
!!! edgey "EdgeX 4.0"
For EdgeX 4.0 the Support Cron Scheduler service only supports `postgres` as persistence layer.
=== "Retention"
|Property|Default Value|Description|
|---|---|---|
Expand Down
2 changes: 1 addition & 1 deletion docs_src/microservices/support/scheduler/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Support Scheduler - Getting Started
# Support Scheduler - Getting Started

!!! Warning
Support Scheduler service has been deprecated in EdgeX 3.2. The service will not be immediately removed, but adopters should note that it has been tagged for eventual replacement.
Support Scheduler service has been deprecated in EdgeX 4.0. The service will not be immediately removed, but adopters should note that it has been tagged for eventual replacement.

Use the new EdgeX Support Cron Scheduler service instead. The Support Cron Scheduler service is a more flexible and powerful service that provides the same functionality as the Support Scheduler service, but with additional features and improvements.

Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
site_name: EdgeX Foundry Documentation
docs_dir: docs_src
site_dir: docs/3.2
site_dir: docs/4.0
site_description: 'Documentation for use of EdgeX Foundry'
site_author: 'Michael Johanson'
site_url: 'https://docs.edgexfoundry.org/3.2'
site_url: 'https://docs.edgexfoundry.org/4.0'
repo_url: 'https://github.com/edgexfoundry/edgex-go'
repo_name: 'edgex/edgex-go'
copyright: 'Copyright © 2023 EdgeX Foundry'
Expand Down

0 comments on commit f2be343

Please # to comment.