Skip to content

Commit

Permalink
fix: docs build error
Browse files Browse the repository at this point in the history
Signed-off-by: Melody <melody@iotechsys.com>
  • Loading branch information
jumpingliu committed Mar 8, 2024
1 parent 89c5253 commit 3eb1aad
Show file tree
Hide file tree
Showing 27 changed files with 89 additions and 88 deletions.
38 changes: 19 additions & 19 deletions docs_src/V3TopLevelMigration.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,12 @@ The [tool here](https://www.convertsimple.com/convert-toml-to-yaml/) can be used

The following are where you can find the configuration migration specifics for individual EdgeX services

- [Core Data](../microservices/core/data/Ch-CoreData/#v3-configuration-migration-guide)
- [Core Metadata](../microservices/core/metadata/Ch-Metadata/#v3-configuration-migration-guide)
- [Core Command](../microservices/core/command/Ch-Command/#v3-configuration-migration-guide)
- [Support Notifications](../microservices/support/notifications/Ch-AlertsNotifications/#v3-configuration-migration-guide)
- [Support Scheduler](../microservices/support/scheduler/Ch-Scheduler/#v3-configuration-migration-guide)
- [Application Services](../microservices/application/V3Migration/#configuration)
- [Core Data](#core-data)
- [Core Metadata](#core-metadata)
- [Core Command](#core-command)
- [Support Notifications](#support-notifications)
- [Support Scheduler](#support-scheduler)
- [Application Services](#application-services)
- [Device Services (common)](../microservices/device/V3Migration/#configuration)
- [Device MQTT](../microservices/device/V3Migration/#device-mqtt)
- [Device ONVIF Camera](../microservices/device/V3Migration/#device-onvif-camera)
Expand Down Expand Up @@ -115,7 +115,7 @@ The Event/Reading data stored by Core Data is considered transient and of little
- Add Event
To identify which device service generating the new event, POST endpoint is now changed from `/event/{profileName}/{deviceName}/{sourceName}` to `/event/{serviceName}/{profileName}/{deviceName}/{sourceName}`

See [Core Data API Reference](../api/core/Ch-APICoreData) for complete details.
See [Core Data API Reference](./microservices/core/data/ApiReference.md) for complete details.
#### Reading

- Added `tags` field in reading.
Expand Down Expand Up @@ -150,14 +150,14 @@ Most of the data stored by Core Metadata will be recreated when the V3 versions
- Removed the boolean field `notify` which is never used
- Added the new field `tags` and `properties`

See [Core Metadata API Reference](../api/core/Ch-APICoreMetadata) for complete details.
See [Core Metadata API Reference](./microservices/core/metadata/ApiReference.md) for complete details.

### Core Command
#### API Change
- Get Command
- Updated `ds-pushevent` and `ds-returnevent` to use bool value, `true` or `false`, instead of `yes` or `no`

See [Core Command API Reference](../api/core/Ch-APICoreCommand) for complete details.
See [Core Command API Reference](./microservices/core/command/ApiReference.md) for complete details.

### Support Notifications

Expand All @@ -167,20 +167,20 @@ Any `Subscriptions` created via the V2 REST API will have to be recreated using
#### API Change
- Added `authmethod` to support-scheduler actions DTO, which indicates how to authenticate the outbound URL. Use `NONE` when running in non-secure mode and `JWT` when running in secure mode.

See [Support Scheduler API Reference](../api/support/Ch-APISupportScheduler) for complete details.
See [Support Scheduler API Reference](./microservices/support/scheduler/ApiReference.md) for complete details.

The statically declared `Interval` and `IntervalAction` will be created automatically. Any `Interval` and/or `IntervalAction` created via the V2 REST API will have to be recreated using the V3 REST API. If you have created a custom configuration with additional statically declared `Interval`s and `IntervalActions` see the [Configuration File](#configuration-file) section under [Customized Configuration](#customized-configuration) below.

### Application Services

Application services use the database only when the [Store and Forward](../microservices/application/AdvancedTopics/#store-and-forward) capability is enabled. If you do not use this capability you can skip this section. This data collection only has data when that data could not be exported. It is recommended not to upgrade to V3 while the Store and Forward data collection is not empty or you are certain the data is no longer needed. You can determine if the Store and Forward data collection is empty by setting the Application Service's log level to `DEBUG` and look for the following message which is logged every `RetryInterval`:
Application services use the database only when the [Store and Forward](./microservices/application/sdk/details/StoreAndForward.md) capability is enabled. If you do not use this capability you can skip this section. This data collection only has data when that data could not be exported. It is recommended not to upgrade to V3 while the Store and Forward data collection is not empty or you are certain the data is no longer needed. You can determine if the Store and Forward data collection is empty by setting the Application Service's log level to `DEBUG` and look for the following message which is logged every `RetryInterval`:

!!! example
```
msg=" 0 stored data items found for retrying"
```
!!! note
The `RetryInterval` is in the `app-services` section of [common configuration](../microservices/configuration/CommonConfiguration). Changing it there will apply to all Application Services that have the [Store and Forward](../microservices/application/AdvancedTopics/#store-and-forward) capability enabled.
The `RetryInterval` is in the `app-services` section of [common configuration](../microservices/configuration/CommonConfiguration). Changing it there will apply to all Application Services that have the [Store and Forward](./microservices/application/sdk/details/StoreAndForward.md) capability enabled.

### Clearing Redis Database

Expand All @@ -207,31 +207,31 @@ This will not work if running EdgeX in running in secure mode since you will not

## Custom Device Service

If you have custom Device Services they will need to be migrated to the V3 version of the Device SDK. See [Device Service V3 Migration Guide](../microservices/device/V3Migration) for complete details.
If you have custom Device Services they will need to be migrated to the V3 version of the Device SDK. See [Device Service V3 Migration Guide](./microservices/device/V3Migration.md) for complete details.

## Custom Device Profile

If you have custom V2 Device Profile(s) for one of the EdgeX Device Services they will need to be migrated to the V3 version of Device Profiles. See [Device Service V3 Migration Guide](../microservices/device/V3Migration#device-profiles) for complete details.
If you have custom V2 Device Profile(s) for one of the EdgeX Device Services they will need to be migrated to the V3 version of Device Profiles. See [Device Service V3 Migration Guide](./microservices/device/V3Migration.md#device-profile) for complete details.

## Custom Pre-Defined Device

If you have custom V2 Pre-Defined Device(s) for one of the EdgeX Device Services they will need to be migrated to the V3 version of Pre-Defined Devices. See [Device Service V3 Migration Guide](../microservices/device/V3Migration/#device-files) for complete details.
If you have custom V2 Pre-Defined Device(s) for one of the EdgeX Device Services they will need to be migrated to the V3 version of Pre-Defined Devices. See [Device Service V3 Migration Guide](./microservices/device/V3Migration.md#device-files) for complete details.

## Custom Applications Service

If you have custom Application Services they will need to be migrated to the V3 version of the App Functions SDK. See [Application Services V3 Migration Guide](../microservices/application/V3Migration) for complete details.
If you have custom Application Services they will need to be migrated to the V3 version of the App Functions SDK. See [Application Services V3 Migration Guide](./microservices/application/V3Migration.md) for complete details.

## Security

If you have an add-on services running in secure mode you will need to use the new names of the environment variables in EdgeX V3. See [Security Services V3 Migration Guide](../security/V3Migration) for more details.
If you have an add-on services running in secure mode you will need to use the new names of the environment variables in EdgeX V3. See [Security Services V3 Migration Guide](./security/V3Migration.md) for more details.

### API Gateway configuration

The API gateway has changed in EdgeX V3. See [Security Services V3 Migration Guide](../security/V3Migration) for more details.
The API gateway has changed in EdgeX V3. See [Security Services V3 Migration Guide](./security/V3Migration.md) for more details.

### Authenticated REST APIs

When security is enable, all V3 EdgeX services REST APIs require a JWT authorization token. See [Security Services V3 Migration Guide](../security/V3Migration) for more details.
When security is enable, all V3 EdgeX services REST APIs require a JWT authorization token. See [Security Services V3 Migration Guide](./security/V3Migration.md) for more details.

## eKuiper

Expand Down
2 changes: 1 addition & 1 deletion docs_src/api/core/Ch-APICoreCommand.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

EdgeX Foundry's Command microservice is a conduit for other services to
trigger action on devices and sensors through their managing Device
Services. See [Core Command](../../../microservices/core/command/Ch-Command/) for more details about this service.
Services. See [Core Command](../../microservices/core/command/GettingStarted.md) for more details about this service.

The service provides an API to get the list of commands that
can be issued for all devices or a single device. Commands are divided
Expand Down
2 changes: 1 addition & 1 deletion docs_src/design/adr/0026-Common Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
- Revised for Configuration Provider as System of Record when used.

## Referenced Use Case(s)
- [Common Configuration UCR](URL of use case link TBD)
- [Common Configuration UCR] - URL of use case link TBD

## Context
This ADR describes the architecture of the new common configuration capability which impacts all services. Requirements for this new capability are described in the above referenced UCR. This is deemed architecturally significant due to the cross-cutting impacts.
Expand Down
6 changes: 3 additions & 3 deletions docs_src/design/adr/013-Device-Service-Events-Message-Bus.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Currently EdgeX Events are sent from Device Services via HTTP to Core Data, whic

> *Note: Though this design is centered on device services, it does have cross cutting impacts with other EdgeX services and modules*
> *Note: This ADR is dependent on the [**Secret Provider for All**](TBD) to provide the secrets for secure Message Bus connections.*
> *Note: This ADR is dependent on the **Secret Provider for All** (Link TBD) to provide the secrets for secure Message Bus connections.*
## Decision

Expand Down Expand Up @@ -231,14 +231,14 @@ SubscribeTopics="edgex/events/#"

### Secure Connections

As stated earlier, this ADR is dependent on the [**Secret Provider for All**](TBD) ADR to provide a common Secret Provider for all Edgex Services to access their secrets. Once this is available, the MessageBus connection can be secured via the following configurable client authentications modes which follows similar implementation for secure MQTT Export and secure MQTT Trigger used in Application Services.
As stated earlier, this ADR is dependent on the **Secret Provider for All**(Link TBD) ADR to provide a common Secret Provider for all Edgex Services to access their secrets. Once this is available, the MessageBus connection can be secured via the following configurable client authentications modes which follows similar implementation for secure MQTT Export and secure MQTT Trigger used in Application Services.

- **none** - No authentication
- **usernamepassword** - Username & password authentication.
- **clientcert** - Client certificate and key for authentication.
- The secrets specified for the above options are pulled from the `Secret Provider` using the configured `SecretPath`.

How the secrets are injected into the `Secret Provider` is out of scope for this ADR and covered in the [**Secret Provider for All**](TBD) ADR.
How the secrets are injected into the `Secret Provider` is out of scope for this ADR and covered in the **Secret Provider for All**( Link TBD) ADR.

## Consequences

Expand Down
2 changes: 1 addition & 1 deletion docs_src/design/adr/security/0029-authentication-e2ee.md
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,6 @@ third-party service integration.
- [Microservice Authentication UCR](../../ucr/Microservice-Authentication.md)
- [ADR 0015 Encryption between microservices](./0015-in-cluster-tls.md)
- [ADR 0020 Delay start services (SPIFFE/SPIRE)](./0020-spiffe.md)
- [ADR 0028 Microservice authentication via tokens](./0028-authentication/)
- [ADR 0028 Microservice authentication via tokens](./0028-authentication.md)
- [OpenZiti zero-trust networking fabric](https://openziti.github.io/)
- [SPIFFE](https://spiffe.io/)
2 changes: 1 addition & 1 deletion docs_src/getting-started/Ch-GettingStartedHybrid.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,4 @@ http://localhost:59880/api/{{api_version}}/event/count
*For this example, you can check that the virtual device service is sending data into Core Data by checking the event count.*
!!! Note
If you choose, you can also import the service into GoLand and then code and run the service from GoLand. Follow the instructions in the [Getting Started - Go Developers ](Ch-GettingStartedGoDevelopers#edgex-foundry-in-goland) to learn how to import, build and run a service in GoLand.
If you choose, you can also import the service into GoLand and then code and run the service from GoLand. Follow the instructions in the [Getting Started - Go Developers ](./Ch-GettingStartedGoDevelopers.md#edgex-foundry-in-goland) to learn how to import, build and run a service in GoLand.
4 changes: 2 additions & 2 deletions docs_src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ EdgeX Foundry is a vendor-neutral open source project hosted by The Linux Founda
<div class="home-nav-row">
<div class="home-nav-column">
<div class="home-nav-card">
<a href="./getting-started/Ch-GettingStartedSDK/">
<a href="./microservices/device/sdk/devicesdk-getting-started/GettingStartedSDK-Go/">
<b>Build a Device Service</b>
<p>Build a custom device service to connect to your sensor or device.</p>
<img class="home-nav-icons" src="sensor.png"/>
Expand All @@ -41,7 +41,7 @@ EdgeX Foundry is a vendor-neutral open source project hosted by The Linux Founda
</div>
<div class="home-nav-column">
<div class="home-nav-card">
<a href="./getting-started/Ch-GettingStartedSDK/">
<a href="./microservices/application/ApplicationServices.md">
<b>Build an Application Service</b>
<p>Build or configure a new application service to get data to the cloud, database, enterprise application or other external system.</p>
<img class="home-nav-icons" src="cloud-upload.png"/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ This API will replace placeholders of the form `{context-key-name}` with the val

`SecretProvider() interfaces.SecretProvider`

This API returns reference to the SecretProvider instance. See [Secret Provider API](../../../security/Ch-SecretProviderApi/) section for more details.
This API returns reference to the SecretProvider instance. See [Secret Provider API](../../../../security/Ch-SecretProviderApi.md) section for more details.

## Store and Forward

Expand All @@ -208,7 +208,7 @@ The APIs in this section are related to the Store and Forward capability. See th

`SetRetryData(data []byte)`

This method can be used to store data for later retry. This is useful when creating a custom export function that needs to retry on failure. The payload data will be stored for later retry based on `Store and Forward` configuration. When the retry is triggered, the function pipeline will be re-executed starting with the function that called this API. That function will be passed the stored data, so it is important that all transformations occur in functions prior to the export function. The `Context` will also be restored to the state when the function called this API. See [Store and Forward](../AdvancedTopics/#store-and-forward) for more details.
This method can be used to store data for later retry. This is useful when creating a custom export function that needs to retry on failure. The payload data will be stored for later retry based on `Store and Forward` configuration. When the retry is triggered, the function pipeline will be re-executed starting with the function that called this API. That function will be passed the stored data, so it is important that all transformations occur in functions prior to the export function. The `Context` will also be restored to the state when the function called this API. See [Store and Forward](../details/StoreAndForward.md) for more details.

!!! note
`Store and Forward` must be enabled when calling this API, otherwise the data is ignored.
Expand Down
Loading

0 comments on commit 3eb1aad

Please sign in to comment.